This page last changed on Sep 15, 2011 by edawson.

Gadgets are small applications that can offer dynamic content. They are typically served from a web application server and can be re-used in many other web applications. In Confluence, add gadgets to pages or blog posts with the gadget macro.

Confluence comes bundled with a few of its own gadgets which can be added to your pages or blog posts using the gadget macro via the macro browser. Refer to Confluence Gadgets for more information. However, you can access additional gadgets in this list if your Confluence Administrator has:

  • Installed additional gadgets locally within your Confluence installation (typically as a Confluence plugin) or
  • Registered gadgets served from an external web application or website (such as those from a JIRA installation or iGoogle) via the External Gadgets page.

Unlike other macros in the macro browser, the name of each gadget macro in the macro browser is typically unique and follows the convention " '<gadget-name>' macro", where <gadget-name> is the name supplied by the gadget itself.


Inserting Gadgets into a Confluence Page or Blog Post

To insert a gadget into a page using the Macro Browser:

  1. Edit your page or blog post.
  2. Choose Insert > Other Macros.
  3. Click External Content to see a list of gadgets configured for use in your Confluence installation.
    Info Some Confluence macros like the  JIRA Issues, JIRA Portlet, RSS Feed, Tasklist and Widget Connector macros also appear in this category because they can also access external content.
  4. Click on the desired gadget to access its parameters and properties and preview any changes to these values.
    Info Almost all gadgets allow you to set basic parameters (listed below), which appear on the right of the Macro Browser. Each gadget may also have its own set of modifiable properties.
  5. Set the gadget's parameters and properties to your requirements.
    • Click Refresh to update the gadget with any changes to parameters, properties or external data.
  6. Click Insert when finished.

Editing Gadgets on a Confluence Page or Blog Post

To edit an existing gadget on a page or blog post using the Macro Browser:

  1. Edit your page or blog post.
  2. Double-click on the Gadget macro placeholder.
  3. Set the gadget's parameters and properties to your requirements.
    • Click Refresh to update the gadget with any changes to parameters, properties or external data.
  4. Save the gadget.

Info Almost all gadgets allow you to set basic parameters (listed below), which appear on the right of the Macro Browser. Each gadget may also have its own set of modifiable properties.

Parameters

Parameters are settings for Confluence gadgets, controlling presentation.

Parameter

Default

Description

Width

450 pixels

Expands or shrinks the size of the gadget to match the specified width. The width can be specified in pixels (using px or plain numbers, for example, 500px or 500), as a percentage of the page width (using %, for example, 50%), or automatically resized to fit 100% of the page width (using the value auto).

Border

false

Places a thin grey border around the perimeter of the gadget.

Contents of a Gadget Macro

The body of a gadget macro contains 'parameter-like' content, which represents specific property settings that are particular to each gadget. Hence they are not documented here. Typically, this content would only be changed by customising the gadget's default properties using the macro browser.

Related Topics

The big list of Atlassian gadgets

Document generated by Confluence on Sep 19, 2011 02:35