You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 42 Next »

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 or blog post, then click the 'Edit' button. The page or blog post opens in edit mode.
  2. Click the Macro Browser icon on the toolbar. The macro browser window opens in the middle of the screen in 'macro selection' mode.
  3. Scroll through the list of macros. Alternatively, start typing part of the name of your desired macro into the search box at the top right of the macro browser window. Macros with a matching name will appear in the main pane.
  4. Click on the desired macro to access its parameters and preview parameter changes ('preview mode').
  5. Set the macro parameters to your requirements. If desired, you can preview these changes by clicking 'Refresh'.
  6. 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 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?

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's Guide.

  • No labels

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