查找结果(Search Results)宏将会使用你给出的关键字来在 Confluence 站点中进行查找,然后将找到的页面显示出来。
使用查找结果宏
希望在页面中使用查找结果宏
- 打开你希望编辑 Confluence 页面,然后单击 编辑(Edit)按钮。页面的编辑模式将会被打开。
- 下一步,在编辑工具栏中单击宏浏览器图标。这时候宏浏览器将会在屏幕的中间打开。
- 在宏浏览器中,在窗口的右上角的对话框中输入你希望插入的宏的名称。当找到与你输入的宏名称接近的宏后将会在中间的面板上显示。单击需要的宏然后来查看可用进行配置的宏选项,在这里你可以对需要插入的宏设置相关参数,然后单击 插入(insert)来将需要的宏插入到页面中。
参数
宏参数的定义为,你可以使用这些参数在宏输出的内容和格式上进行定义。
Confluence 使用的存储格式或者 wikimarkup 格式中使用的参数和在宏浏览器中使用的标签是不同的,这些将会在下面在括号内容中列出(example
)。
参数 | 默认值 | 说明 |
---|
查找字符(Search Terms)
(query ) | none | 通过查找字符中确定显示结果。
你可以使用逻辑关键字来对你的查找字符进行运算。你可以使用的逻辑关键字有 'AND' 和 'OR'。示例如下: my_query1 AND my_query2 有关更多的内容,请参考页面 Confluence 中有关查找句法的章节。 |
显示结果的最大数量(Maximum Number of Results)
(maxLimit ) | 10 | 设置查找结果的数量显示限制。 |
限制空间的关键字(Restrict to this Space Key) | all | 通过输入空间的名字来找到需要的空间,或者空间的关键字也可以。这里是大小写敏感的。 |
内容类型(Content Type)
(type ) | all | 指定内容的类型。可以使用内容内心有:页面,评论,博客页面,附件用户信息(用的属性信息)和空间描述。 |
最后更新(Last Modified)
(lastModified ) | all | 指定时间周期,可以使用周,天,小时,和/或 分钟,来调制显示的时间区间。 你可以使用下面的一些值:例如: 注意: - 如果你没有指定时间的分类的话,Confluence 默认使用的是分钟。
- 如果你指定了多个时间区间(例如,小时和天)的话,你必须使用空格对多个时间空间进行分隔。顺序没有关系。
- 时间的分类不是大小写敏感的,例如 '
4d ' 和 '4D ' 是一样的。
|
限制这个用户名(Restrict to this Username)
(contributor ) | all | 指定 Confluence 用户的用户名,来在显示只由这个用户提供的内容。 |
注意
权限:当一个用户查看查找结果宏中显示的页面的时候,查找结果宏仅会显示用户具有查看权限的页面。如果某个页面用户没有查看权限的话,查找结果是不会显示的。
代码示例
下面的代码是提供给希望进一步编辑 Confluence 页面的高级用户使用的。
宏名称: search
宏内容:None
存储格式示例
< ac:structured-macro ac:name = "search" >
< ac:parameter ac:name = "lastModified" >3w</ ac:parameter >
< ac:parameter ac:name = "query" >choc</ ac:parameter >
< ac:parameter ac:name = "contributor" >
< ri:user ri:userkey = "1235678912345678912345678912345" />
</ ac:parameter >
< ac:parameter ac:name = "maxLimit" >10</ ac:parameter >
< ac:parameter ac:name = "type" >page</ ac:parameter >
< ac:parameter ac:name = "spacekey" >
< ri:space ri:space-key = "ss" />
</ ac:parameter >
</ ac:structured-macro >
|
Wiki 标记格式示例
{search:lastModified=3w|query=choc|contributor=admin|maxLimit= 10 |type=page|spacekey=ds}
|