页面属性(Page Properties)宏是可以嵌入在页面上的数据,然后这个嵌入的数据可以另一个页面上以表格形式显示。
你可以和使用 页面属性报表宏 一样在一个页面中插入多个页面属性宏。
你也可以选择隐藏包含有页面属性宏页面的 metadata 数据。
这个宏在早期被称为 Metadata 细节宏。
页面属性(Page Properties)宏和页面属性报表(Page Properties Report)宏的基本使用
页面属性宏被用来与页面属性报表宏进行连接。
希望使用这个宏:
- 添加页面属性宏到你的页面中,然后在宏中指定一个标签(例如,Status)。
添加一个两列表格到宏占位符中,在表格中分别对应 metadata 数据 keys 和 values。
- 在其他页面中重复上面的过程来添加页面属性宏。
- 创建一个新的页面包含你的报表(例如,状态报表)。
- 添加一个页面属性报表宏到页面中,然后制定相同的标签(例如,Status)。
- 刷新你新的报表页面状态。你页面属性宏中包含的数据将会被报表中显示。
屏幕截图:'Status' 报表实例
- 选择行的头来对报表进行排序。
当你添加页面属性宏到页面中后,Confluence 将会自动的将标签添加到页面中。你可以在页面中添加一个或者多个页面属性宏,但是他们将会继承同样的标签(例如,你不能有 2 个页面属性宏在同一个页面中包含有 2 个不同的标签)。
使用页面属性(Page Properties)宏
希望在页面中使用页面属性(Page Properties)宏
- 打开你希望编辑 Confluence 页面,然后单击 编辑(Edit)按钮。页面的编辑模式将会被打开。
- 下一步,在编辑工具栏中单击宏浏览器图标 。这时候宏浏览器将会在屏幕的中间打开。
- 在宏浏览器中,在窗口的右上角的对话框中输入你希望插入的宏的名称。当找到与你输入的宏名称接近的宏后将会在中间的面板上显示。单击需要的宏然后来查看可用进行配置的宏选项,在这里你可以对需要插入的宏设置相关参数,然后单击 插入(insert)来将需要的宏插入到页面中。
- 使用宏参数添加一个标签到宏
在宏浏览器中,添加一个标签(Label)。例如: "Status"。
添加 metadata 关键字和值在表格行中,这个在宏占位符的内部。
在宏的占位符内部,添加一个 2 列表格。在表格的左列指定 键值(keys)这个键值被用来在报表宏中显示头,你必须使用纯文本。在表格的右列为每一个键值指定一个值(values)。
屏幕截图:Confluence 编辑器的宏占位符
参数
宏参数的定义为,你可以使用这些参数在宏输出的内容和格式上进行定义。
Confluence 使用的存储格式或者 wikimarkup 格式中使用的参数和在宏浏览器中使用的标签是不同的,这些将会在下面在括号内容中列出(example
)。
参数 | 默认值 | 说明 |
---|---|---|
标签(Label) | (None) | 标签被用来在页面中确定 metadata 数据。Confluence 将会在页面中添加这个标签,所有的页面属性宏将会继承这个标签。 |
隐藏(Hidden) | False | 确定在当前页面中的页面属性参数是不是被显示。这个参数的设置不会对页面属性报表宏的详细信息产生影响。 |
示例
下面的示例程序说明了你如何使用页面属性宏和页面属性报表宏来创建一个 Status 报表或者 Risk 报表。
代码示例
下面的代码是提供给希望进一步编辑 Confluence 页面的高级用户使用的。
宏名称: details
宏内容:接受富文本。
存储格式示例
下面的示例代码中包含有 2 部分的数据 - 所有者和日期。
|
注意
- 当你在页面属性宏中添加一个标签参数的话,Confluence 将会添加标签到页面中。
- 如果你从页面属性宏删除这个标签,页面中的标签是不会被自动删除的。
- 如果你从页面中删除这个标签,但是这个标签还保存在页面属性宏中,那么这个标签将会重新出现,换句话说你不能从页面中直接删除这个标签。
- 你可以在页面中添加一个或者多个页面属性宏,但是所有的页面属性宏将会继承同样的标签。例如,如果你在一个页面中有 2 个页面属性宏,其中一个宏使用标签 "risk" 另外的一个宏使用标签 "status",这 2 组 metadata 将会同时在页面报表宏中显示。这是因为你的页面有 2 个这个标签,但是宏内部是没有这 2 个标签的。
- 你不能在左侧的列表中使用有任何格式的文本和宏,因为左侧的列表中的文字是被用来生成页面属性报表宏中的头的。
- 如果你的表格有头的话,这个头信息将会在页面属性报表宏中被忽略。你应该删除这个表格的头。
- 在页面中是没有办法来参考引用元数据(metadata )的,在其他页面中也没有办法进行参考引用。
其他 元数据(metadata) 宏
还有其他的一些 元数据(metadata) 宏没有在本页中被提到和说明,但是还是值得提起注意的。
{metadata-list} – 添加 元数据的 键和值。请参考 Atlassian Answers。
- {metadata-values:pagename} – 在没有键的情况下显示元数据值。你可以使用 @self 来获得当前页面的元数据。请参考 Atlassian Answers。
- {metadata-report}
- 通过 Confluence Metadata Plugin 2 添加的宏。