The popular labels macro renders a list/heatmap of the most popular labels used throughout your Confluence site or within a space. For example:

{popular-labels:style=heatmap|count=15}

On this page:

Usage with the Macro Browser

To insert the popular labels macro into a page using the Macro Browser,

  1. Open your desired Confluence page, then click the 'Edit' button. The 'Edit Page' mode opens.
  2. Next, click the Macro Browser icon on the editor toolbar. The Macro Browser will open in the middle of the screen.
  3. In the Macro Browser, type the name of your desired macro into the search box at the top right of the window. Macros with a matching name will appear in the centre pane. Click on the desired macro to see its options screen. Here, you can set the macro parameters then click 'insert' to put the macro into the page.

Once you've found the popular labels macro, click 'insert' to add it to your page.

Usage with the Wiki Markup Editor

What you need to type

What you will get

{popular-labels:style=heatmap|count=15}

Parameters

Parameters are settings for Confluence macros that allow the user to control their content or presentation. The table below lists relevant parameters for this macro.

(info) Parameter names are displayed differently in the macro browser interface and in wiki markup. Below, parameter names used in the macro browser are indicated in Bold text, while their equivalents in wiki markup are indicated in (bracketed) text. If the latter is not shown, then in wiki markup, the parameter's name should be omitted and only its value should be added immediately after the colon symbol (:).

Parameter

Required?

Default

Description

Number of Labels to Display
(count)

no

100

Specifies the total number of labels to display in the heatmap.

Restrict Labels to this Space Key
(spaceKey)

no

none

Restricts the list of popular labels to the specified space.

Style of Labels
(style)

no

list

Displays the list of popular labels in standard bullet-point 'list' form or as a 'heatmap'. The heatmap style uses different font sizes depending on their rank of popularity, ordered by label names. The list style orders labels by popularity (highest first).

Examples

Show the 5 most popular labels in all spaces as a list

{popular-labels:count=5}

Show the 20 most popular labels in the DOC space as a heatmap

{popular-labels:style=heatmap|spaceKey=DOC|count=20}
RELATED TOPICS

Label Macros
Related Labels Macro
User-contributed extension: Sortable Popular Labels
User-contributed extension: Tagcloud Macro

Take me back to the Confluence User Guide.

1 Comment

  1. Normen Maaß

    Dec 04, 2009

    Is there a way to configure the font-size of a headmap label? I want to do it, because I want to create a box of labels with a width of 200px. And the most popular labels are often to long for this box  If I can reduce the font size this behavour will not occur so much.

    thanks

    normen maass

Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 2.5 Australia License.