使用子页面显示宏可以在页面中列出所有的子页面列表和子页面中的子页面列表。换句话说可以在这里进行列表的多层显示。
在默认情况下,子页面显示宏将子页面显示为链接,显示的结果如下图所示。
当用户对页面进行访问的时候,用户将会看到具有查看权限的页面。例如,某个页面对访问的用户来说,不具有访问权限,那么在子页面列表中是不会显示的。
屏幕截图:Confluence 的子页面显示(Children Display )宏
使用子页面显示列表宏
希望在页面中使用子页面显示列表宏:
- 打开你希望编辑 Confluence 页面,然后单击 编辑(Edit)按钮。页面的编辑模式将会被打开。
- 下一步,在编辑工具栏中单击宏浏览器图标。这时候宏浏览器将会在屏幕的中间打开。
- 在宏浏览器中,在窗口的右上角的对话框中输入你希望插入的宏的名称。当找到与你输入的宏名称接近的宏后将会在中间的面板上显示。单击需要的宏然后来查看可用进行配置的宏选项,在这里你可以对需要插入的宏设置相关参数,然后单击 插入(insert)来将需要的宏插入到页面中。
参数
宏参数的定义为,你可以使用这些参数在宏输出的内容和格式上进行定义。
Confluence 使用的存储格式或者 wikimarkup 格式中使用的参数和在宏浏览器中使用的标签是不同的,这些将会在下面在括号内容中列出(example
)。
参数 | 默认值 | 说明 |
---|
显示所有子页面(Show Descendants)(all)
| false | 选择是否显示所有页面中的子页面。 如果将这里把值设置为: true 那么将会在这里显示完整的页面树结构。如果你有设置参数 下级页面深度(Depth of Descendants)将不会产生作用。 |
上级页面(Parent Page)(page)
| current | 指定需要显示子页面的页面,你可以是当前页面,也可以是其他页面。输入: '/' — 列出当前空间中的最顶层的页面。这些页面一级没有上级页面了。'pagename' — 需要对子页面进行列表的特定页面。'spacekey:' — 列出指定空间的顶级页面。'spacekey:pagename' — 列出指定空间中的指定页面,这个宏需要显示这个页面的子页面。
|
子页面数量(Number of Children)(first) | none | 设置需要显示子页面的数量。 |
下级页面深度(Depth of Descendants)(depth) | none | 输入数字来确定页面的显示深度。例如,如果这个值为 2,那么这个宏将会显示 2 层子页面。 当你设置了参数 显示所有子页面(Show Descendants )后,这个参数就失效了。 |
标题样式(Heading Style)(style) | none | 选择用于显示子页面的样式。 |
包含摘要(Include Excerpts)(excerpt) | false | 如果子页面中有摘要的话,那么连同摘要一同显示。 |
子页面按什么排序(Sort Children By)(sort) | 如果你指定了这个参数,那么将会按照你指定的参数排序。 否则默认情况下按照字母顺序排序。 | 可选的: - creation — 按照页面创建日期排序。
- title — 按照标题字母排序。
- modified — 按照页面的最后更新日期排序。
|
反向排序(Reverse Sort)(reverse) | false | 需要和 子页面按什么排序(Sort Children By)参数一同使用。 如果设置了这个参数,那么页面的排序方式将会有升序变成降序。 |
代码示例
下面的代码是提供给希望进一步编辑 Confluence 页面的高级用户使用的。
宏名称:children
宏内容: None
存储格式示例
< ac:structured-macro ac:name = "children" >
< ac:parameter ac:name = "reverse" >true</ ac:parameter >
< ac:parameter ac:name = "sort" >creation</ ac:parameter >
< ac:parameter ac:name = "style" >h4</ ac:parameter >
< ac:parameter ac:name = "page" >
< ac:link >
< ri:page ri:content-title = "Home" />
</ ac:link >
</ ac:parameter >
< ac:parameter ac:name = "excerpt" >true</ ac:parameter >
< ac:parameter ac:name = "first" >99</ ac:parameter >
< ac:parameter ac:name = "depth" >2</ ac:parameter >
< ac:parameter ac:name = "all" >true</ ac:parameter >
</ ac:structured-macro >
|
Wiki 标记示例
{children:reverse= true |sort=creation|style=h4|page=Home|excerpt= true |first= 99 |depth= 2 |all= true }
|