摘要宏在页面中被标记和存储可以重用的内容。当你定义一个摘要宏以后,这个摘要宏可以在其他宏中被引用,例如: 包含摘要(Excerpt Include)宏 和 博客页面(Blog Posts)宏,然后能够显示被标记的内容。
你只能在一个页面中定义一个摘要宏。换句话说,在一个页面中你只能插入摘要宏一次。
使用摘要宏
在页面中使用摘要宏:
- 打开你希望编辑 Confluence 页面,然后单击 编辑(Edit)按钮。页面的编辑模式将会被打开。
- 下一步,在编辑工具栏中单击宏浏览器图标。这时候宏浏览器将会在屏幕的中间打开。
- 在宏浏览器中,在窗口的右上角的对话框中输入你希望插入的宏的名称。当找到与你输入的宏名称接近的宏后将会在中间的面板上显示。单击需要的宏然后来查看可用进行配置的宏选项,在这里你可以对需要插入的宏设置相关参数,然后单击 插入(insert)来将需要的宏插入到页面中。
向宏中加入可以重用的内容:
- 将你需要插入的内容写入到摘要宏中的占位符中。
- 选择宏的占位符来查看边框的可选项。你可以选择在新的一行中显示还是在本行中显示。默认的情况下,内容会在新的一行中显示。如果你选择了在行内显示的选项,那么摘要宏的内容将会插入到同一个段落中。注意:,这个选项仅仅是在页面包含有摘要宏的时候有效,这个对引用这个宏的页面是无效的。
屏幕截图:摘要宏占位符和可选项
参数
宏参数的定义为,你可以使用这些参数在宏输出的内容和格式上进行定义。
Confluence 使用的存储格式或者 wikimarkup 格式中使用的参数和在宏浏览器中使用的标签是不同的,这些将会在下面在括号内容中列出(example
)。
参数 | 默认值 | 说明 |
---|
隐藏扩展宏的内容(Hide Excerpted Content)
(hidden ) | false | 控制在摘要宏占位符中的内容是否在页面上显示。 注意:这个值对页面包含有摘要宏的时候有效。当页面内容被重用的时候是无效的。 |
代码示例
下面的代码是提供给希望进一步编辑 Confluence 页面的高级用户使用的。
宏名称: excerpt
宏内容: 接受富文本
下面的扩展参数在存储格式和维基标签格式的时候有效。下面提供了与在编辑器中格式相同的功能。
参数 | 是否必须 | 默认值 | 说明和可以接受的参数 |
---|
atlassian-macro-output-type | No | BLOCK | 确定摘要宏是在新行中显示还是在本行中显示。 可用的值: BLOCK – 在新行中显示宏中的内容。
INLINE – 在本行中显示宏的内容,这个内容将会在同一个段落中进行显示,不会插入其他分段符或者回车。
注意:这个值对页面包含有摘要宏的时候有效。当页面内容被重用的时候是无效的。 |
存储格式示例
< ac:structured-macro ac:name = "excerpt" >
< ac:parameter ac:name = "hidden" >true</ ac:parameter >
< ac:parameter ac:name = "atlassian-macro-output-type" >BLOCK</ ac:parameter >
< ac:rich-text-body >
< p >This is the < strong >text</ strong > I want to reuse in other pages. This text is inside an Excerpt macro.</ p >
</ ac:rich-text-body >
</ ac:structured-macro >
|
Wiki 标记格式示例
{excerpt:hidden= true |atlassian-macro-output-type=BLOCK}
This is the *text* I want to reuse in other pages. This text is inside an Excerpt macro.
{excerpt}
|