- 由 郭春晓创建, 最后修改于一月 05, 2018
贡献人摘要(Contributors Summary)宏在一系列页面根据贡献的状态将贡献人显示为列表。这个贡献的状态可以根据单独的页面或者单独的贡献人分组。
这个宏默认使用的区域为一个独立页面,但是可以扩展到这个页面的子页面或者这个页面的所有下级页面。
贡献的状态可以包括有下面的状态:
- 对页面进行编辑的
- 向页面添加了评论的
- 向页面添加了标签的
- 关注了页面的
下面的实例显示了本页面的贡献人摘要。这个摘要显示了贡献人对本页面进行了编辑,添加评论,添加标签的情况。
使用实例:本页的贡献人摘要
用户 | 编辑 | 注释 | 标签 |
---|---|---|---|
HoneyMoose | 9 | 0 | 0 |
在上面的实例中,我们只使用的默认的参数。
有关这个宏中可以使用的参数和有关参数的说明,请参考本页中的 参数 部分的说明。
使用贡献人摘要宏
希望向页面中添加贡献人摘要宏:
- 打开你希望编辑 Confluence 页面,然后单击 编辑(Edit)按钮。页面的编辑模式将会被打开。
- 下一步,在编辑工具栏中单击宏浏览器图标。这时候宏浏览器将会在屏幕的中间打开。
- 在宏浏览器中,在窗口的右上角的对话框中输入你希望插入的宏的名称。当找到与你输入的宏名称接近的宏后将会在中间的面板上显示。单击需要的宏然后来查看可用进行配置的宏选项,在这里你可以对需要插入的宏设置相关参数,然后单击 插入(insert)来将需要的宏插入到页面中。
参数
宏参数的定义为,你可以使用这些参数在宏输出的内容和格式上进行定义。
Confluence 使用的存储格式或者 wikimarkup 格式中使用的参数和在宏浏览器中使用的标签是不同的,这些将会在下面在括号内容中列出(example
)。
参数 | 默认值 | 说明 |
---|---|---|
按什么进行分组(Group By) | 贡献人 | 指定在内容显示的时候按照什么方式进行分组:
|
显示的列(Columns to Display) | 编辑,评论,标签 | 为贡献人摘要列表中显示列的内容。可用的类型信息可以通过按照什么进行分组的参数进行选择。 可用的显示列如下:
|
按什么进行排序(Sort By) | edits | 指定贡献人的排序方式。这个参数会和分组方式(Group By)同时进行使用。 可用采用的排序方式如下:
|
逆向排序(Reverse Sort) | false | 在贡献人列表中采用逆向排序。这个参数必须要和排序方式参数组合使用。单独设置这个参数而不设置排序方式的参数的话,系统将会忽略这个参数设置。 |
显示的最大数量(Maximum Number of Items) | 没有限制 | 限制贡献人列表中显示的人员数量。如果没有为这个设定任何值,那么所有的贡献人将会被显示出来。 |
是否显示匿名用户的贡献(Show Anonymous Contributions) | false | 是否在页面中显示匿名用户的贡献。 |
是否显示 0 数量(Show Zero Counts) | false | 设置贡献人摘要宏中是否显示贡献人数量为 0 的贡献人。 |
页面名称(Page Name) | current | 当你指定页面后,生成的贡献人列表将会从你指定的页面内进行过滤。 如果页面名称和空间名称是空的话,那么默认认为你选择的是当前页面。 |
标签(Label) | none | 当你指定标签后,系统将会对指定标签包含的页面中的贡献人进行过滤。你可以指定一个或者多个标签,如果是多个标签的话,标签之间采用逗号分隔符。 |
空间(Space) | current | 通过指定 Confluence 空间的 Key 来为页面名称设定一个确定的空间。可选的,你可以通过查找来找到空间的 Key。空间的关键字是大小写敏感的。 这个参数也可以使用一些特殊的值,包括:
你可以使用一个或者多个空间关键字。空间关键字直接采用逗号分隔符。 |
内容类型(Content Type) | 页面和博客页面 | 当创建贡献人内容列表的时候限制使用的内容类型,可用的值为
如果在宏流浪器中没有指定这个值,那么将会同时读取页面和博客页面。 |
博客页面日期(Blog Post Date) | none | 为一个博客页面指定发布的日期。可以接受的日期格式为:YYYY/MM/DD。 |
如何包含子页面内容(Include Page Hierarchy) | 仅特定页面 | 当创建列表的时候指定特定的一些其他页面:
如果没有指定值,那么只包含你指定的页面,不包括子页面。 |
代码示例
_宏代码说明文字
下面的代码是提供给希望进一步编辑 Confluence 页面的高级用户使用的。
宏名称: contributors-summary
宏内容: None
存储格式示例
针对博客页面的贡献人摘要存储格式示例:
|
针对页面的贡献人摘要存储格式示例:
|
Wiki 标记格式示例
针对博客页面的贡献人摘要存储格式示例:
|
针对页面的贡献人摘要存储格式示例:
|
- 无标签