This page last changed on Dec 07, 2009 by ggaskell.

This page describes the purpose of the 'Confluence Gadgets' window, how to access it and provides information about the gadgets which are bundled with Confluence.

On this page:

The Confluence Gadgets Window

The 'Confluence Gadgets' window displays a list of all Confluence gadgets available in your Confluence installation. These are gadgets that:

  • Interact with and provide access to data in your Confluence installation
  • Can be used externally such as on a JIRA 4+ server's dashboard, a page or blog post of another Confluence server, or any compatible page on a web site that accepts gadgets, such as iGoogle.

Refer to Adding a Confluence Gadget to a JIRA Dashboard or Configuring Confluence Gadgets for Use in Other Applications for more information on adding Confluence gadgets to external applications. However, a Confluence gadget can also be used within the same Confluence installation, by adding it to a page or blog post using the gadget macro.

The Confluence gadgets bundled with Confluence are described below. However, if your Confluence administrator has installed more Confluence gadgets (typically as Confluence plugins), these will also appear in this list. If there are more gadgets in the list than what will fit within this window, a scrollbar will appear on the right. To find the gadget you want, use this scroll bar to move up and down the list of gadgets.

To access the Confluence Gadgets window,

  • Open the 'Browse' menu and select 'Confluence Gadgets'. The 'Confluence Gadgets' window will open.

Screenshot: The Confluence Gadgets Window

Confluence Gadgets

This section describes the gadgets which are bundled with Confluence.

Activity Stream Gadget

The activity stream gadget is similar to the recently updated macro and shows a list of the most recently changed content within your Confluence site.

In addition to showing a list of most recently changed content, the activity stream gadget also provides the following features:

  • The ability to add comments to pages and blog posts, by clicking the 'add comment' icon at the top-right of an added or edited page or blog post in the activity stream.
  • The ability to reply to a comment by clicking the 'add comment' icon at the top-right of a comment in the activity stream.
  • Activities are grouped by separate date.
  • An RSS feed link to its content in the top-right corner of the gadget.

Screenshot: Adding a Comment in the Activity Stream Gadget

Activity Stream Gadget Properties

Properties are settings for Confluence gadgets that allow the user to control the content or presentation of data retrieved by the gadget. These are similar to a Confluence macro's parameters. The table below lists relevant properties for this gadget.

Property Required? Default Description
Title Yes None Adds a title to the top of the Activity Stream.
Projects No None specified i.e. display all content This property allows you to filter content by space. This gadget will display only the pages etc. which belong to the space(s) you specify here.
Username No None specified i.e. display all content Filter the results by user. The macro will display only the pages etc. which were last modified by the user(s) you specify here.

You can specify one or more user, separated by a comma or a space.
Number of Entries No 10 Specify the maximum number of results to be displayed. A maximum of 10 results will be displayed by default. The maximum value that this property can accept is 100.
Refresh Interval No Never/false Specify the time interval between each refresh that the activity stream gadget will perform to update is content (and reflect any new activity that has been conducted on the Confluence site).

Confluence QuickNav Gadget

The Confluence QuickNav gadget provides the Quick Navigation Aid functionality for searching the Confluence site. For more information on how to use this feature, refer to the Quick Navigation Aid section of Searching Confluence.

Screenshot: Using the QuickNav Gadget

Confluence QuickNav Gadget Properties

This gadget has no properties and cannot be customised.

Confluence: News Gadget

The Confluence news gadget is an example of a 'news feed' gadget that shows a list of recent Confluence Product Blogs and events at Atlassian.

Clicking an item in the Confluence news gadget takes you directly to the selected blog post of the Confluence Product Blogs feed or event details on the events at Atlassian page.

Clicking More news takes you to the Confluence Product Blogs feed page and clicking More events takes you to the events at Atlassian page.

Screenshot: Using the QuickNav Gadget

Confluence: News Gadget Properties

Properties are settings for Confluence gadgets that allow the user to control the content or presentation of data retrieved by the gadget. These are similar to a Confluence macro's parameters. The table below lists relevant properties for this gadget.

Property Required? Default Description
Show News? No True Shows a short list of the most recent Confluence Product Blogs.
Show Events? No True Shows a short list of the most recent events at Atlassian.
Show Banners? No True Shows any banner advertisements (if available).
RELATED TOPICS

Adding a Confluence Gadget to a JIRA Dashboard
Configuring Confluence Gadgets for Use in Other Applications
Gadget Macro


Document generated by Confluence on Dec 10, 2009 18:45