This documentation relates to an earlier version of Confluence.
View this page in the current documentation or visit the current documentation home.

Skip to end of metadata
Go to start of metadata

The Content by Label macro lists content which has been tagged with specific labels.

On this page:

Usage with the Macro Browser

To insert the content by label 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 content by label macro, click 'insert' to add it to your page.

Usage with the Wiki Markup Editor

To display all pages with the label needs-fixing, use:

Below is a working example of the 'Content by Label' macro. In the example, we have restricted the display to 5 results. By default, Confluence lists all the labels for each result displayed. See the optional parameters below for more information.

What you need to type

What you will get

{contentbylabel:label=documentation|maxResults=5}

Showing first 5 of 640 results

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

Default

Description

(author)

None

Filter the results by author. The macro will display only the pages etc which are written or updated by the author(s) you specify here.

You can specify one or more authors, separated by a comma.

Label(s)
(label) or (labels)

None

This parameter is required.

Use this parameter to filter the results by label. The macro will display only the pages etc which are tagged with the label(s) you specify here.

You can specify one or more label values, separated by a comma or a space.

  • To exclude content which matches a given label, put a minus sign (-) immediately in front of that label value. For example: If you specify a label value of -badpage you will get only content which is not labelled with 'badpage'.
  • To indicate that the results must match a given label value, put a plus sign (+) immediately in front of that label value. For example: If you specify a label value of +superpage,+goodpage you will get only content which has at least two labels, being 'superpage' and 'goodpage'.

Maximum Number of Pages
(max) or (maxResults)

15

Specify the maximum number of results to be displayed. Note that the results are sorted first, and then the maximum parameter is applied.

(operator)

OR

The operator to apply to the supplied lists of labels. By default, a page with any of the non-prefixed labels (that is, labels without a plus (+) or minus (-) sign immediately preceding it) will be listed. By using operator=AND, only pages with all of the supplied non-prefixed labels will be listed.

(info) Be aware that this parameter only modifies the behaviour of the 'Label(s)' parameter and only affects label values without a plus (+) or minus (-) sign prefix. To avoid confusion or unexpected results, it is not recommended that the operator parameter be used in conjunction with any label values prefixed with '+' or '-' signs.

Show Labels for Each Page
(showLabels)

true

Show or hide labels for results.

Show Space Name for Each Page
(showSpace)

true

Show or hide spaces for results.

Reverse Sort
(reverse)

false

Use this parameter in conjunction with the sort parameter described below. Set reverse=true to change the sort from ascending to descending.

(info) this parameter is ignored if the sort parameter is not specified.

Sort By
(sort)

modified

Specify how the results should be sorted. To change the sort order from ascending to descending, use the reverse parameter described above.

Note: If this parameter is not specified, the sort order defaults to descending order based on the last modification date.

Values:

  • creation — Sort by the date on which the content was added.
  • title — Sort alphabetically by title.
  • modified — Sort by the date on which the content was last updated.

Restrict to these Spaces
(space) or (spaces)

@all, i.e. all spaces in your Confluence site.

This parameter allows you to filter content by space. The macro will display only the pages etc. which belong to the space(s) you specify here.

You can specify one or more space keys, separated by a comma or a space.

  • To exclude content in a specific space, put a minus sign (-) immediately in front of that space key. For example: If you specify a space key of -BADSPACE you will get only content which is not in the BADSPACE.
  • To indicate that the results must come from a specific space, put a plus sign (+) immediately in front of that space key. For example: If you specify a space key of +GOODSPACE you will get only content in GOODSPACE. (Note that this is not particularly useful, because each content item belongs to one space only. If you put a plus sign next to one space key and list other space keys too, the other space keys will be ignored.)

Special values:

  • @self — The current space.
  • @personal — All personal spaces.
  • @global — All global spaces.
  • @favorite — The spaces you have marked as favourite.
  • @favourite — The same as @favorite above.
  • @all — All spaces in your Confluence site.
  • * — The same as @all above.

(info) When specifying a personal space, remember to use the tilde (~) sign in front of the username, such as ~jbloggs or ~jbloggs@example.com.

List Title
(title)

None

Adds a title or heading to the list.

Include these Content Types Only
(type)

all

This parameter allows you to filter content by content type. The macro will display only the content of the type you specify here.

You can specify one or more types, separated by a comma or a space.

To exclude content of a given content type, put a minus sign (-) immediately in front of that content type. For example: If you specify a content type of -blogpost you will get pages and all other content except for blog posts.

Available values:

  • pagePages.
  • blogpost or newsBlog posts, also known as news items.

Display Excerpts
(excerpts)

false

Displays the first line of excerpts for each page.

Examples

1. Show content from a specific space

2. Show only results in current space

3. Show results from all spaces

4. Show only content of a specified type

The code below will show only pages (but not news items or other content types) with the labels 'dogs' or 'cats':

5. Do not show the labels in the results

6. Do not show the space names in the results

7. Display excerpts in the results

8. Specify the maximum number of results to display

9. Sort by modification date

10. Change the sort order

RELATED TOPICS

Related Labels Macro
Navmap Macro
Recently Used Labels Macro
Working with Labels Overview
Working with Macros

Take me back to the Confluence User's Guide.