Popular Labels Macro

The Popular Labels macro displays the most popular labels used throughout your Confluence site or within a space. A popular label is a label that has been added to many pages.

Using the Popular Labels Macro

To add the Popular Labels macro to a page:

In the Confluence editor, choose Insert > Other Macros.
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 Using 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	Default	Description
Number of Labels to Display `(count`)	100	Specifies the total number of labels to display in the heatmap.
Restrict Labels to this Space Key `(spaceKey`)	none	Restricts the list of popular labels to the specified space.
Style of Labels `(style`)	list	list – displays the popular labels as a bulleted list, ordered by popularity (highest first). heatmap – displays the popular labels using different font sizes for each label depending on the label's popularity, ordered by label names.

Code examples

The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page.

Macro name: popular-labels

Macro body: None.

Storage format example

  <ac:structured-macro ac:name="popular-labels">
    <ac:parameter ac:name="count">20</ac:parameter>
    <ac:parameter ac:name="spaceKey">
      <ri:space ri:space-key="ds"/>
    </ac:parameter>
  </ac:structured-macro>

Wikimarkup example

{popular-labels:style=heatmap|count=20|spaceKey=ds}

Page tree