Confluence 6 创建一个用户宏

简介: 如果你想创建自定义的宏的话,用户宏能够帮你完成这个任务。这个可以在你系统中应用特定的操作,比如说应用自定义格式等。用户用是在 Confluence 创建和和管理的,你需要有一定的编码基础才可以。

如果你想创建自定义的宏的话,用户宏能够帮你完成这个任务。这个可以在你系统中应用特定的操作,比如说应用自定义格式等。

用户用是在 Confluence 创建和和管理的,你需要有一定的编码基础才可以。

你需要具有系统管理员权限来创建和应用用户自定义宏。

希望创建一个新的用户宏:

  1. 进入  > 基本配置(General Configuration) > 用户宏(User Macros)
  2. 选择 创建一个用户宏(Create a User Macro)
  3. 输入宏的一些详细信息(请查看下面列表)
  4. 单击 添加(Add)
宏名称(Macro name) 宏的名字,将会出现在代码中。

可见(Visibility

这个选项控制谁可以在宏浏览器中查看这个宏或者自动完成功能。选项有:

  • 所有用户可见(Visible to all users)
  • 仅系统管理员可见(Visible only to system administrators)

请注意,如果你选择仅系统管理员可见的话,用户任然可以看到用在页面中输出的结果,宏的占位符也还是在编辑页面中出现的,这个仅仅在宏浏览器和自动完成的时候隐藏了。

所有宏的信息都是可以找到的,包括宏的标题,描述,参数名称和其他元数据。尽管宏只能被系统管理员查看到,也请不要在用户宏中定义任何敏感信和保密信息。

宏标题(Macro Title) 在宏浏览器和自动完成功能中出现的宏标题。
描述(Description) 这个描述信息将会出现在宏浏览器中。宏浏览器的查找将会对查找字段在宏标题和描述中的文字进行匹配。
分类(Categories) 为你的宏在宏浏览器中选择一个或多个分类。
图标 URL(Icon URL 如果你希望宏浏览器为你的宏显示图标的话,输入绝对地址(例如 http://mysite.com/mypath/status.png)或相对于 Confluence base URL 的相对地址(例如:/images/icons/macrobrowser/status.png) 。
文档 URL(Documentation URL) 如果你的宏有文档的话,请在这里输入文档的 URL。
宏内容处理(Macro Body Processing)

指定 Confluence 应该如何处理你的宏的内容。

宏的内容中包含了在 Confluence 页面中如何处理的信息。如果你的宏有一个内容,所有宏的内容将会在 $body 变量字段中可用。

处理宏内容字段选项包括有:

  • No macro body
    选择这个选项,如果你的宏没有任何内容的话。
  • Escaped
    Confluence 将会添加在 HTML 标记中添加转义字符。如果你希望显示 HTML 标记在生产的页面中的时候,你可以使用转义字符。例如:如果内容为 <b>Hello World</b> 那么将会在生成页面中显示   <b>Hello World</b>。
  • Unrendered
    内容中的 HTML 将会在模板输出之前进行处理。请确定模板中的 HTML 是非再生的。
  • Rendered
    Confluence 将会对 HTML 宏内容的部分进行让浏览器进行解析。例如宏内容为 <b>Hello World</b> 这个内容将会显示 Hello World。

模板(Template

这里是你写的代码去确定宏应该是什么样子的。

  • 在宏模板中使用 HTML 和 Confluence 自定义 XML 元素。
  • 你可以使用  Velocity 模板语言。这里是有关 Velocity project 项目的相关信息。
  • 如果你的宏有 body 内容,你的宏可以将 body 的文本引用为 '$body'。
  • 每个参数变量必须有一个与之对应的元数据定义。在你的宏参数中使用 @param 来定义元数据。
  • 当使用参数传递信息,请参考 $paramXXX 在 'XXX' 的参数,是你定义 @param 元数据后来引用的参数。
  • 如果你的宏不能接受参数,请使用 @noparams

请查看 Writing User Macros 要么获得更多的信息和示例。

希望使用插件完成编辑?

如果你希望将你的自定义宏按照插件进行分发的话,请参考  User Macro plugin module 页面中的内容。如果你希望使用更加复杂,更加程序化的宏的话,你需要写成 Macro plugin 宏。

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

目录
相关文章
你需要来自XX的权限才能对此文件夹进行更改 win10(不改权限)
最近,在下载某软件时,因为在之前已经下载了盗版。但是没有完全删除干净,因此打算手动删除。 其中,在C盘中手动删除文件时,发现许多文件夹需要来自’'system‘’的权限才能进行删除。
你需要来自XX的权限才能对此文件夹进行更改 win10(不改权限)
|
Linux
linux第四课:改变文件的权限和属性(内含:1.修改权限命令chmod+2.临时切换用户用 sudo+3.chowm:改变文件所有者)
linux第四课:改变文件的权限和属性(内含:1.修改权限命令chmod+2.临时切换用户用 sudo+3.chowm:改变文件所有者)
358 0
linux第四课:改变文件的权限和属性(内含:1.修改权限命令chmod+2.临时切换用户用 sudo+3.chowm:改变文件所有者)
|
Linux Go
linux中的chmod改变权限、修改bigbig.txt文件使其所属主用户只有读权限、修改bigbig.txt文件使其所属组用户具有写权限linux中的文件权限类、rwx 作用文件和目录的不同解释
linux中的chmod改变权限、修改bigbig.txt文件使其所属主用户只有读权限、修改bigbig.txt文件使其所属组用户具有写权限linux中的文件权限类、rwx 作用文件和目录的不同解释
linux中的chmod改变权限、修改bigbig.txt文件使其所属主用户只有读权限、修改bigbig.txt文件使其所属组用户具有写权限linux中的文件权限类、rwx 作用文件和目录的不同解释
Confluence 6.15 附件宏参数
参数参数名称 默认值 描述 Filename Patterns(patterns) all Attachment Labels(labels) (None) 标签(labels)的列表,用来过滤附件的显示。
815 0
Confluence 6.15 使用附件宏
希望添加附件宏到一个页面中: 从编辑工具栏中,选择 插入(Insert)   > 其他宏(Other Macros)找到并且选择需要的宏。 可用使用自动完成加快这个过程:输入 { 然后开始输入你希望插入的宏的名字,你将会看到建议的宏的列表。
916 0
Confluence 6 跟踪你安装中的自定义修改
在 Confluence 中的系统信息(System Information)部分,有一个 修改(Modification)的选项。
751 0
|
缓存
Confluence 6 自定义 Decorator 模板的宏和针对高级用户
宏 页面的某些部分使用的是 Velocity  宏进行创建的,包括导航栏。有关宏的创建,你可以参考页面 Working With Decorator Macros 页面中的内容。
1428 0
Confluence 6 用户宏示例 - NoPrint
这个示例演示了如何创建一个用户宏,这个宏包括了在查看页面中显示的内容,但是不被打印。 Macro name noprint Visibility Visible to all users in the Macro...
911 0
|
安全
Confluence 6 用户宏最佳实践
这个页面为你在创建用户宏的最佳实践中包含了一些小技巧和建议。 为你的宏添加一个简短的描述 我们鼓励你为你的宏在 模板(Template )添加一个备注的描述,可以参考下面的显示的内容: ## Macro title: ...
1134 0

热门文章

最新文章