小工具（Gadget）宏

小工具（Gadget）是一个小应用程序，这个应用程序可以向页面中提供动态内容。通常这个服务是运行在 Web 应用程序上的，但是可以被其他的 Web 应用程序重用。

在 Confluence 中，使用小工具宏可以向页面和博客页面中添加内容。

Confluence 自带了一些小工具宏，你可以添加到页面或者博客页面中。Confluence 自带的小工具在 Confluence 小工具列表页面中能够找到。

如果你的 Confluence 系统管理员进行了下面的一些操作，你通常可以访问到更多的小工具：

在 Confluence 中安装了其他一些扩展的小工具（通常这些都是 Confluence 的插件）或者
从一个外部的 Web 应用程序或者网站上注册了小工具（例如，JIRA 安装实例或者 iGoogle）。

不像其他的宏，小工具的宏名字可以不是唯一的，并且使用下面的格式进行表述 "<gadget-name> macro"，其中 <gadget-name> 小工具自己的名字。

向 Confluence 页面和博客页面中插入小工具宏

向页面中插入小工具宏：

编辑你的页面或者博客页面。
选择 插入 > 其他宏（Insert > Other Macros）。
单击 外部内容（External Content）来查看你安装 Confluence 实例的可用小工具的列表。
单击期望使用的小组件然后来配置参数和属性。
机会所有的小组件都可以让你设置基本的参数（参数列表），这些将会在右侧显示到宏的对话框中。每个小工具也许有可能使用自己的参数，这些将会显示在左侧的对话框中。
根据你的需求设置参数。Set the parameters to your requirements.
单击 刷新（Refresh）来使你的修改生效。
单击 插入（Insert ）来将小工具宏插入到你的页面中。

在 Confluence 页面或者博客页面中编辑小工具

希望编辑页面或者博客页面中的小工具宏：

编辑你的页面和博客页面。
单击小工具宏的占位符，然后选择 编辑（Edit）或者双击占位符。
根据你的需要为你的小工具宏设置参数。
单击 刷新（Refresh）来使你的修改生效，查看宏的运行情况。
保存（Save）这个小工具宏。

标准小工具参数

几乎所有的小工具宏都可以让你设置基本的参数，参数列表如下。

基本参数的设置将会在右侧显示到宏的对话框中。每个小工具也许有可能使用自己的参数，这些将会显示在左侧的对话框中。

参数

默认值

说明

宽度（Width）

450 pixels

设置小工具宏的宽度，使用下面的任意一种表示方式：

如果将宽度设置为像素的话，使用 px 或者仅用数字。例如 500px 或者 500 。
使用页面的百分比，使用 % 来表示。例如， 50%。
自动将小工具和的宽度扩展到 100%，这里使用参数：auto。

边框（Border）

true

为你的小工具宏设置一个灰色的边框。

小工具宏的内容

在除了标准参数，小工具宏包含'参数一样“的内容，它代表特定的属性设置，尤其适用于每个小工具。

因此，他们没有在这里列出。通常情况下，这些内容只能通过使用宏浏览器自定义小工具的默认属性更改。

代码示例

下面的代码是提供给希望进一步编辑 Confluence 页面的高级用户使用的。

宏名称： gadget

宏内容： None

下面是在存储格式为 wiki 标记格式中可用的一些附加参数。

参数名称	是否是必须的	默认值	参数说明和可以接受的值
`url`	Yes	(none)	这个定义了宏的特定值（XML 文件）。
`preferences`	No	(Gadget-dependent)	具体的属性设置对每个小工具都适用。

有关在标记中编辑小工具（参数或者属性）需要注意的地方： 在维基标记格式和存储格式中直接编辑属性变量是可行的。但是，这样你有可能会输入无效的变量。如果小工具宏的属性变量中支持特定类型的一些变量，那么宏浏览器将会需要用户只输入符合要求的变量。所以，如果使用宏浏览器来编辑变量的属性值的话可以避免这个错误，我们也推荐用户采用宏浏览器来编辑属性值。

存储格式示例

在 Confluence 页面中显示小工具的示例：

<ac:structured-macro ac:name="gadget">
  <ac:parameter ac:name="width">500</ac:parameter>
  <ac:parameter ac:name="border">false</ac:parameter>
  <ac:parameter ac:name="url">rest/gadgets/1.0/g/com.atlassian.confluence.plugins.gadgets:confluence-page-gadget/gadgets/confluence-page-gadget.xml</ac:parameter>
  <ac:parameter ac:name="preferences">spaceName=Documentation&spaceKey=DOC&quickfind-space=Documentation&pageId=753666&pageName=Documentation%20Home&quickfind-page=Documentation%20Home&isEditable=true&isConfigured=true&refresh=15&showLink=false</ac:parameter>
</ac:structured-macro>

在 Confluence 新页面中显示的示例：

<ac:structured-macro ac:name="gadget">
<ac:parameter ac:name="url">rest/gadgets/1.0/g/com.atlassian.confluence.plugins.gadgets:confluence-news-gadget/gadgets/confluence-news-gadget.xml</ac:parameter>
<ac:parameter ac:name="preferences"/>
</ac:structured-macro>

Wiki 标记示例

在 Confluence 页面中显示小工具的示例：

{gadget:width=500|border=false|url=rest/gadgets/1.0/g/com.atlassian.confluence.plugins.gadgets:confluence-page-gadget/gadgets/confluence-page-gadget.xml}
spaceName=Documentation&spaceKey=DOC&quickfind-space=Documentation&pageId=753666&pageName=Documentation%20Home&quickfind-page=Documentation%20Home&isEditable=true&isConfigured=true&refresh=15&showLink=false
{gadget}