Confluence 6 建立一个用户宏

若是你想建立自定义的宏的话,用户宏可以帮你完成这个任务。这个能够在你系统中应用特定的操做,好比说应用自定义格式等。html

用户用是在 Confluence 建立和和管理的,你须要有必定的编码基础才能够。apache

你须要具备系统管理员权限来建立和应用用户自定义宏。api

但愿建立一个新的用户宏:浏览器

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

可见(Visibility app

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

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

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

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

宏标题(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 应该如何处理你的宏的内容。url

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

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

  • 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

相关文章
相关标签/搜索