This page last changed on Dec 17, 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.

  Author-Firstname Author-Nickname Is-Secret
Metadata Macro   <p>Banana Split</p> <p>Yes</p>
Metadata Summary Macro <p>Fred</p> <p>Strawberry Sundae</p>  

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. In the Confluence editor, choose Insert > Other Macros.
  2. Find and select the required macro.

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

When editing, you can click on the macro placeholder and choose Edit to display the parameters for this macro in the Macro Browser.

Parameters are options that you can set for Confluence macros to control the content or format of the macro output. The table below lists parameters for this macro that can be set in the Macro Browser.

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's Guide.

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