This page last changed on Jun 08, 2009 by ggaskell.

The Metadata Summary macro presents a tabulated summary of selected metadata, which has been embedded using the Metadata Macro on any page or blog post in the current Confluence space.

The left-most column of the metadata summary shows the name of each page or blog post within current space that contains the selected metadata. Each page or blog post is presented on a single row and is hyperlinked to its appropriate destination page.

Each subsequent column represents a unique field within the selected metadata. The value associated with each metadata field on a page or blog post is presented in the appropriate cell of the metadata summary table. For example, the following Metadata Summary macro shows all Metadata macros tagged with the 'test' label in the current space.

  Is-Secret Author-Nickname Author-Firstname
Metadata Macro Yes Banana Split  
Metadata Summary Macro   Strawberry Sundae Fred
Metadata macro 'label's are completely unrelated to page labels. A Metadata macro's label is only used by the Metadata Summary macro for the purpose of generating its summary.


On this page:

Usage with the Macro Browser

To insert the metadata summary macro into a page using the Macro Browser,

  1. Open your desired Confluence page, then click the 'Edit' button. The 'Edit Page' mode opens.
  2. Next, click the Macro Browser icon on the editor toolbar. The Macro Browser will open in the middle of the screen.
  3. In the Macro Browser, type the name of your desired macro into the search box at the top right of the window. Macros with a matching name will appear in the centre pane. Click on the desired macro to see its options screen. Here, you can set the macro parameters then click 'insert' to put the macro into the page.

Once you've found the metadata summary macro, click 'insert' to add it to your page.

Usage with the Wiki Markup Editor

{detailssummary:label=test}

This shows a metadata summary based on all Metadata macros in pages or blog posts of the current space, which have been labelled with 'test'.

Parameters

Parameters are settings for Confluence macros that allow the user to control their content or presentation. The table below lists relevant parameters for this macro.

Parameter names are displayed differently in the macro browser interface and in wiki markup. Below, parameter names used in the macro browser are indicated in Bold text, while their equivalents in wiki markup are indicated in (bracketed) text. If the latter is not shown, then in wiki markup, the parameter's name should be omitted and only its value should be added immediately after the colon symbol (:).

Parameter Required in Wiki Markup? Default Description
Metadata Label
(label)
yes none Restricts the Metadata Summary macro to summarise the contents of Metadata macros throughout the current space, which have been tagged with this label only.

Another Metadata Macro Example

The following Metadata macro example generates the second line in the Metadata Summary macro (above).

Author-Nickname: Strawberry Sundae
Author-Firstname: Fred


RELATED TOPICS

Working with Macros

Take me back to the Confluence User Guide.

Document generated by Confluence on Nov 05, 2009 23:35