贡献人宏用于在 Confluence 中显示显示用户列表。这些用户是对页面进行了更新的用户。通常我们可以用这个宏来显示关注某个页面的用户列表。
这个宏的范围可以被扩展到到某一个页面的子页面或者某一个页面的子页面的下级页面。贡献人的列表通常使用下面的判断条件进行列出。
通常列出的用户通常进行了下面的一些操作:
- 页面的编辑人或者创建的人
- 或者向页面贡献了评论或者向页面添加了标签
- 或者仅仅简单的关注了页面。
屏幕截图:贡献人列表示例
在上面的这个示例中,显示格式(Display Format)参数被设置为了列表(list)。
使用贡献人宏
希望在页面中使用贡献人宏:
打开你希望编辑 Confluence 页面,然后单击 编辑(Edit)按钮。页面的编辑模式将会被打开。
下一步,在编辑工具栏中单击宏浏览器图标。这时候宏浏览器将会在屏幕的中间打开。
在宏浏览器中,在窗口的右上角的对话框中输入你希望插入的宏的名称。当找到与你输入的宏名称接近的宏后将会在中间的面板上显示。单击需要的宏然后来查看可用进行配置的宏选项,在这里你可以对需要插入的宏设置相关参数,然后单击 插入(insert)来将需要的宏插入到页面中。
参数
宏参数的定义为,你可以使用这些参数在宏输出的内容和格式上进行定义。
Confluence 使用的存储格式或者 wikimarkup 格式中使用的参数和在宏浏览器中使用的标签是不同的,这些将会在下面在括号内容中列出(example)。
参数
|
默认值
|
说明
|
贡献人类型(Contribution Type) (include) | authors | 对贡献人的类型进行过滤。贡献人可能只是贡献了页面的内容,或者贡献人贡献了评论内容。可用的贡献人类型如下:
- authors - 包括对页面进行了新建或者编辑的用户
- comments - 包括新增了评论的用户
- labels - 包括了对页面增加了标签的用户
- watches - 包括了对页面进行了关注的用户
你可以指定一个或者多个贡献人类型,多个贡献人类型通过逗号分隔符进行分隔。 |
排序方式(Sort By) (order) | count | 指定贡献人的排序方式。可以采用的排序方式为:
- count - 对所有用户的排序基于用户的贡献数量。
- name - 按照贡献人的名字字母进行排序。
- update - 按照贡献人对内容进行贡献的最后时间进行排序。
|
逆向排序(Reverse Sort) (reverse) | false | 在贡献人列表中采用逆向排序。这个参数必须要和排序方式参数组合使用。单独设置这个参数而不设置排序方式的参数的话,系统将会忽略这个参数设置。 |
贡献人的最多数量(Maximum Number of Contributors)
(limit)
| no limit | 限制贡献人列表中显示的人员数量。如果没有为这个设定任何值,那么所有的贡献人将会被显示出来。 |
显示格式(Display Format) (mode) | inline | 设置贡献人名字列表采用何种显示格式:
- inline — 一个逗号分隔符列表
- list — 一个大纲列表
|
显示匿名贡献人(Show Anonymous Contributions) (showAnonymous) | false | 是否在页面中显示匿名用户的贡献。 |
显示数量(Show Count) (showCount) | false | 对确定的贡献类型来确定是否为每个人显示共享的数量。 |
显示最后的贡献时间(Show Last Contribution Time) (showLastTime) | false | 对确定的贡献类型来确定是否为每个人显示最后的贡献时间。 |
页面名称(Page Name) (page) | current | 当你指定页面后,生成的贡献人列表将会从你指定的页面内进行过滤。
如果页面名称和空间名称是空的话,那么默认认为你选择的是当前页面。
|
标签(Label) (labels) | none | 当你指定标签后,系统将会对指定标签包含的页面中的贡献人进行过滤。你可以指定一个或者多个标签,如果是多个标签的话,标签之间采用逗号分隔符。 |
空间(Space) (spaces) | current | 通过指定 Confluence 空间的 Key 来为页面名称设定一个确定的空间。可选的,你可以通过查找来找到空间的 Key。空间的关键字是大小写敏感的。
这个参数也可以使用一些特殊的值,包括:
- @global — 所有的站点空间。
- @personal — 所有的个人空间。
- @all — Confluence 内的所有空间。
你可以使用一个或者多个空间关键字。空间关键字直接采用逗号分隔符。 如果没有页面名称或者标签值,指定的空间将会包括所有的页面。 |
内容类型(Content Type) (contentType) | 页面和博客页面 | 当创建贡献人内容列表的时候限制使用的内容类型:
- pages — 页面
- blogposts — 博客
|
博客添加日期(Blog Post Date) (publishDate) | none | 为一个博客页面指定发布的日期。可以接受的日期格式为:YYYY/MM/DD。 |
Include Page Hierarchy (scope) | 仅特定的页面 | 当创建列表的时候指定特定的一些其他页面:
- children — 仅仅是指定页面的子页面
- descendants — 指定页面的所有下级页面
|
显示选择的页面(Show Selected Pages) (showPages) | false | 设置是否显示页面的列表,这些页面被用来显示贡献人的列表。 |
自定义页面没有找到("None Found")的消息 (noneFoundMessage) | 默认消息 | 指定可以将默认消息进行重载的消息,这个消息被用来在没有贡献人找到的时候显示。 |
来源:http://cwiki.ossez.com/pages/viewpage.action?pageId=2393249