Labels List Macro

Still need help?

The Atlassian Community is here for you.

Ask the community

The Labels List macro displays a list of all labels within the current space. Each label in the list links to a page that displays all pages in the current space that contain that label. 

Using the Labels List macro

To add the Labels List macro to a page:

  1. In the Confluence editor, choose Insert > Other Macros
  2. Find and select the required macro

Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Keyboard Shortcuts, Markdown, and Autocomplete.

To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro.

Parameters

Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example).

Parameter name

Required

Default

Parameter description and accepted values

Restrict to this Space Key
(spaceKey

No

Current space

The key of the space whose labels you want to display.

Excluded label(s)
(excludedLabels
No Blank The labels that you do not want to appear in the list.

Wiki markup example

Wiki markup is useful when you need to add a macro outside the editor, for example as custom content in the sidebar, header or footer of a space.

Macro name: listlabels

Macro body: None.

{listlabels:spaceKey=DOC}
Last modified on Sep 27, 2017

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.