在线查询(Livesearch )宏允许你在 Confluence 页面中添加查找对话框。当用户在查找对话框中输入要查找的字符串后,Confluence 将会在系统中动态查询所有的内容然后显示符合条件的查询结果。
使用实例
在当前空间中使用这个宏的实例。
使用在线查询(Livesearch )宏
在页面中使用在线查询(Livesearch )宏:
- 打开你希望编辑 Confluence 页面,然后单击 编辑(Edit)按钮。页面的编辑模式将会被打开。
- 下一步,在编辑工具栏中单击宏浏览器图标。这时候宏浏览器将会在屏幕的中间打开。
- 在宏浏览器中,在窗口的右上角的对话框中输入你希望插入的宏的名称。当找到与你输入的宏名称接近的宏后将会在中间的面板上显示。单击需要的宏然后来查看可用进行配置的宏选项,在这里你可以对需要插入的宏设置相关参数,然后单击 插入(insert)来将需要的宏插入到页面中。
参数
宏参数的定义为,你可以使用这些参数在宏输出的内容和格式上进行定义。
Confluence 使用的存储格式或者 wikimarkup 格式中使用的参数和在宏浏览器中使用的标签是不同的,这些将会在下面在括号内容中列出(example
)。
参数 | 默认值 | 描述 |
---|
参数 | 默认值 | 描述 |
---|
限制空间的关键字(Restrict to this Space Key)
(spaceKey ) | 所有空间(all spaces) | 指定查找空间关键字,如果指定了关键字将会在在指定的空间中进行查找。这个是大小写敏感的。 |
限制标签(Restrict to label(s))
(labels ) |
| 返回结果中必须含有指定的标签。如果这个参数没有指定的话,将会默认返回所有的标签。 |
大小(Size )
(size ) | medium | 选择查找字段的大小,可以使用中等或者大。 |
占位符文本(Placeholder text)
(placeholder ) |
| 指定在页面占位符中显示文本文本,例如可以显示 '在本空间中查找'。 |
类型(Type)
(type ) | all | 指定可以查找的内容类型 - 可以选择页面,博客页面,评论,空间描述或者所有的内容。默认情况下在所有类型中进行查找。 |
附加的(Additional)
(additional ) | space name | 显示空间的名字,页面的摘要或者在查询结果中不显示任何内容。 |
代码示例
下面的代码是提供给希望进一步编辑 Confluence 页面的高级用户使用的。
宏名称: livesearch
宏内容: None
存储格式代码示例
< ac:structured-macro ac:name = "livesearch" >
< ac:parameter ac:name = "additional" >page excerpt</ ac:parameter >
< ac:parameter ac:name = "placeholder" >Search this space</ ac:parameter >
< ac:parameter ac:name = "labels" >myLabel</ ac:parameter >
< ac:parameter ac:name = "spaceKey" >
< ri:space ri:space-key = "SS" />
</ ac:parameter >
< ac:parameter ac:name = "type" >page</ ac:parameter >
< ac:parameter ac:name = "size" >large</ ac:parameter >
</ ac:structured-macro >
|
Wik 标记格式示例
{livesearch:spaceKey=DOC|size=large|placeholder=Search this space}
|