This content applies to the legacy editor and the new editor.
Labels are key words that you can add to pages and attachments to make them easier to group and find. For example, you could assign the label accounting to all accounts-related pages on your site. You can then browse all pages with that label in a single space or across the site, display a list of pages with that label, or search based on the label.
You can also use labels to categorize spaces. Head over to the page to learn more about using space labels to keep Confluence neat and organized.
Label a page
Anyone with permission to edit a page can add labels to it. These appear in the bottom right of the page, above the comments section.
To add a label to a page you’re editing:
Tap ••• to open the more actions menu, then select Add labels
Enter the name of the label you’d like to add, then hit enter to create it
Tap Add to add the label to the page
Label an attachment
- Do either of the following:
- On the page that contains the attachment: Go to > Attachments
- Click on the space name in the navigation. Click Space Settings (, > Content tools tab > Attachments )
- Choose the edit icon beside the list of labels and type in a new label (existing labels are suggested as you type), then click Add.
You can also add labels in a list of attachments displayed by the Attachments macro, by choosing the edit icon beside each label.
Labels do not accept spaces, and are lower case only. This means that you can type in multiple labels at once just by adding spaces between each label, and that any capitals will be automatically converted to lower case. If you want to use a label that has more than one word, try using an underscore or hyphen, like so: this_is_a_label or this-is-a-label.
View all labels in a space or site
From the labeled content page, click on the cog icon > all labels to see all the labels in that space.
Alternatively, use the following URL. Make sure you use your own site address, and replace SPACEKEY with the actual space key of a space.
At the top of the page, there'll also be an option to see all labels across the site.
View popular labels in a space or site
From the other views, you can click on the cog icon and select Popular Labels. This displays a word cloud, where the bigger a label is displayed, the more popular it is. There's also an option to see popular content across whole site.
Screenshot: The Labeled content page
Search by label
You can use the
labelText: prefix to search for content that has a specific label. For example, if you're looking for pages with the label chocolate, type
labelText:chocolate into the search field in the Confluence header. For more examples of searching by label, see Confluence Search Syntax.
Search for labeled content by URL
To see all content on your site with a specified label, navigate to the Labeled content page. For example, to see everything with the label "documentation" on
mysite.atlassian.com, you'd navigate to the following URL:
To see content with more than one specified labels, you need to include all labels in the URL and insert + between each of them. For example, to see all pages and attachments with the how-to label and the documentation label on mysite.atlassian.com, you'd navigate to the following URL:
Tap the x next to a label to remove it from a page or attachment. To get rid of a label entirely, you'll need to remove it from all the pages and attachments it appears on.
If you have deleted pages that contain a label, you may need to purge the deleted pages from the space's trash to ensure that the label disappears too.
Use macros to categorize or display labels
Using labels with these macros, you can categorize pages, blogs, and attachments, and display them in Confluence in a number of ways:
- Content by label macro: lists all content with a specified label or labels.
- Content report table macro: displays information about pages and blog posts with a specified label in a table.
- Labels list macro: lists all labels in a space alphabetically.
- Navigation map macro: renders the list of pages associated with a specified label as a navigation map.
- Popular labels macro: displays popular labels as a word cloud.
- Recently used labels macro: lists labels that have been used recently.
- Related labels macro: lists other labels associated with the label you're viewing.