Confluence 6 用户宏示例 - Formatted Panel

时间:2021-05-27 19:06:34

下面的用演示了如果还写一个用户宏,并在这个宏中创建一个格式化的面板,并且指定颜色。将会创建下面的面板:

(Title)
 

注意:这个面板的标题为空,如果你没有给这个面板标题参数的话。

Macro name formpanel
Visibility Visible to all users in the Macro Browser
Macro Title Formatted Panel
Description Creates a panel preformatted with specific colors
Categories Formatting
Icon URL 可以设置为空
Documentation URL 可以设置为空
Macro body processing Escaped
Template

在下面的模板字段中输入代码。请查看下面获得更多有关细节的解释。

## @param Title:title=Title|type=string|desc=Title
<ac:structured-macro ac:name="panel">
        <ac:parameter ac:name="titleBGColor">#ccc</ac:parameter>
        <ac:parameter ac:name="borderStyle">solid</ac:parameter>
        <ac:parameter ac:name="borderColor">#6699CC</ac:parameter>
        <ac:parameter ac:name="borderWidth">2</ac:parameter>
        <ac:parameter ac:name="titleColor">#000000</ac:parameter>
    <ac:parameter ac:name="title">$!paramTitle</ac:parameter>
    <ac:rich-text-body>$body</ac:rich-text-body>
</ac:structured-macro>

有关宏模板代码中的细节解释

下面为使用宏模板代码的的一些细节说明。

## @param Title:title=Title|type=string|desc=Title

@param 为你的宏参数定义了元数据。

@param Title

这个参数被称为 "Title"。

title=Title

定义了参数标题,这个标题将会在宏浏览器中显示为 "Title"。

type=string

为参数文本字段定义了字段类型。

desc=Title

为宏浏览器定义了描述的参数。

<ac:structured-macro ac:name="panel">

这个被称为 Confluence Panel Macro 宏。

最容易找到 Confluence 宏名称的的方法是通过查看在页面中包含有宏的存储格式。你将会需要 Confluence 管理员权限来查看存储的格式。

<ac:parameter ac:name="titleBGColor">#ccc</ac:parameter>
<ac:parameter ac:name="borderStyle">solid</ac:parameter>
<ac:parameter ac:name="borderColor">#6699CC</ac:parameter>
<ac:parameter ac:name="borderWidth">2</ac:parameter>
<ac:parameter ac:name="titleColor">#000000</ac:parameter>

为这个宏设置参数:背景颜色,边界样式,边界颜色,边界宽度和标题颜色。

希望在 Confluence 宏发现擦书的名称,请查看上面描述的中存储的格式。

<ac:parameter ac:name="title">$!paramTitle</ac:parameter>

输入存储在 'Title' 参数中变量,这个部分将会显示为宏的标题。

! 标记告诉宏这部分显示为空,当 "Title" 参数中没有数据的话。

<ac:rich-text-body>$body</ac:rich-text-body>
用户可以输入保存在宏内容中的数据。这行将会启用宏方法存储在内容中的数据。
</ac:structured-macro>
这个标记标记宏的结束。

https://www.cwiki.us/display/CONFLUENCEWIKI/Writing+User+Macros