Popular Labels Macro

Add the Popular Labels macro to a page to highlight 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. 

This is great for surfacing labels that might be trending in your site, for example in a knowledge base. 


On this page:

Screenshot: The Popular Labels macro showing a heatmap of the 20 most popular labels.


For general information about using labels in Confluence, see Add, Remove and Search for Labels.

Add this macro to your page

To add the Panel Map macro to a page:

  1. From the editor toolbar, choose Insert > Other Macros.
  2. Choose Popular Labels from the Reporting category.
  3. Enter any parameters and choose how you want the labels to display. 
  4. Choose Insert

You can then publish your page to see the macro in action. 

Screenshot: specifying a space key, number of labels, and heatmap display style. 

Change the macro parameters

Macro parameters are used to change the behaviour of a macro.

To change the macro parameters:

  1. In the editor, click the macro placeholder and choose Edit.
  2. Update the parameters as required then choose Insert.

Here's a list of the parameters available in this macro. 

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.

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).

Other ways to add this macro

Add this macro as you type

Type followed by the start of the macro name, to see a list of macros. 

Add this macro using wiki markup

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

Macro name: popular-labels

Macro body: None.

{popular-labels:style=heatmap|count=20|spaceKey=ds}
Last modified on Jul 29, 2022

Was this helpful?

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