内容列表(Table of Contents)宏将会扫描当前 Confluence 页面中的标题然后创建一个表格来显示这些标题。这个有助于读者在很长的页面中通过提供的标题来快速定位页面结构。
使用内容列表宏
提示: 如果希望从页面编辑框中快速插入,可以选择 插入 > 表格内容(Insert > Table of Contents)。
希望在页面中添加内容列表宏:
- 打开你希望编辑 Confluence 页面,然后单击 编辑(Edit)按钮。页面的编辑模式将会被打开。
- 下一步,在编辑工具栏中单击宏浏览器图标。这时候宏浏览器将会在屏幕的中间打开。
- 在宏浏览器中,在窗口的右上角的对话框中输入你希望插入的宏的名称。当找到与你输入的宏名称接近的宏后将会在中间的面板上显示。单击需要的宏然后来查看可用进行配置的宏选项,在这里你可以对需要插入的宏设置相关参数,然后单击 插入(insert)来将需要的宏插入到页面中。
参数
宏参数的定义为,你可以使用这些参数在宏输出的内容和格式上进行定义。
Confluence 使用的存储格式或者 wikimarkup 格式中使用的参数和在宏浏览器中使用的标签是不同的,这些将会在下面在括号内容中列出(example
)。
参数
默认值
说明
输出类型(Output Type) |
list |
|
显示标题的数字(Display Section Numbering) |
clear |
选择这个选择框,你的标题前面将会加上数字的排序。例如:1.1, 1.2, 1.3。 |
列表样式(List Style) |
disc |
为每一个主题选择标题列表的样式。你可以选择有效的 CSS 样式表。例如:
|
标题缩进(Heading Indent) |
设置标题缩进的样式情况。输入 |
|
分离器(Separator) |
brackets |
这个参数只在屏幕显示列表的时候使用,你可以输入下面的值。
|
最小标题级别(Minimum Heading Level) |
1 |
选择你希望列出标题的最高级别。例如,输入 2 的话,标题列表将会列出第二级标题(包括第二级)和第二级以下的所有标题列表,但是这里是不会包括第一级标题的。 |
最大标题级别(Maximum Heading Level) |
7 |
选择你希望列出标题的最低级别。例如,输入 2 的话,标题列表将会列出第二级标题(包括第二级)和第二级以上的所有标题列表,这里将会显示第一级标题和第二级标题,但是这里是不会包括第三及其以下的标题的。 |
包含标题(Include Headings) |
根据特殊的查询条件来过滤标题。你可以使用通配符字符。查看 正则表达式 中的示例来构建正则表达式。 |
|
不包含标题(Exclude Headings) |
根据特殊的查询条件来过滤标题。你可以使用通配符字符。查看 正则表达式 中的示例来构建正则表达式。 |
|
是否打印(Printable) |
checked |
在默认情况下,TOC 是被打印出来的。如果你不对这个选择框选择的时候, TOC 将会在你打印的时候不被显示。 |
CSS 样式表名称(CSS Class Name) |
如果你在 CSS 样式表中自定义 TOC 样式,使用这个参数来讲 TOC 放置到 |
来源:http://cwiki.ossez.com/pages/viewpage.action?pageId=2393367