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,
- Open the Confluence page or blog post that you want to edit, then click the 'Edit' button.
- Click the Macro Browser icon
on the toolbar. The macro browser window will open. - Scroll through the list of macros to find the one you want. Alternatively, start typing the macro name into the search box at the top right of the macro browser. Macros with a matching name will appear in the main pane.
- Click the desired macro.
- Set the macro parameters to your requirements. If desired, you can preview these changes by clicking 'Refresh'.
- Click 'Insert' to add the macro onto the page.
You can also insert macros via autocomplete. For more information, see Using Autocomplete in the Rich Text Editor.
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 |
|---|---|
| Unknown macro: {nomarkup}
|
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 |
no |
100 |
Specifies the total number of labels to display in the heatmap. |
Restrict Labels to this Space Key |
no |
none |
Restricts the list of popular labels to the specified space. |
Style of Labels |
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
Using Label Macros to Categorise Wiki Content
Related Labels Macro
User-contributed extension: Sortable Popular Labels
[User-contributed extension: Tagcloud Macro]
Take me back to the Wikis Help Guide.