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.
| Title | Author-Firstname | Author-Nickname | Is-Secret |
|---|---|---|---|
| Metadata Summary Macro | Fred | Strawberry Sundae | |
| Metadata Macro | Banana Split | Yes |
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,
- Open the Confluence page or blog post that you want to edit, then click the 'Edit' button.
- Click the Macro Browser icon
on the toolbar. The macro browser window will open. - Scroll through the list of macros to find the one you want. Alternatively, start typing the macro name into the search box at the top right of the macro browser. Macros with a matching name will appear in the main pane.
- Click the desired macro.
- Set the macro parameters to your requirements. If desired, you can preview these changes by clicking 'Refresh'.
- Click 'Insert' to add the macro onto the page.
You can also insert macros via autocomplete. For more information, see Using Autocomplete in the Rich Text Editor.
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 options that you can include in Confluence macros to control the content or format of the macro output. The table below lists relevant parameters for this macro.
Parameter names are different in the macro browser and in wiki markup. Below we show the macro browser parameter names in bold text, and the equivalent wiki markup parameters in (bracketed) text. If we do not show any parameter name for the wiki markup, then you should leave out the parameter name and simply include the parameter value as the first parameter, immediately after the colon (:).
Parameter |
Required in Wiki Markup? |
Default |
Description |
|---|---|---|---|
Metadata 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).
RELATED TOPICS
Take me back to the Wikis Help Guide.