Related Labels Macro
Macros
- Anchor Macro
- Attachments Macro
- Blog Posts Macro
- Change History Macro
- Chart Macro
- Cheese Macro
- Children Display Macro
- Code Block Macro
- Column Macro
- Content by Label Macro
- Content by User Macro
- Content Report Table Macro
- Contributors Macro
- Contributors Summary Macro
- Create from Template Macro
- Create Space Button Macro
- Excerpt Include Macro
- Excerpt Macro
- Expand Macro
- Favorite Pages Macro
- Gallery Macro
- Global Reports Macro
- HTML Include Macro
- HTML Macro
- IM Presence Macro
- Include Page Macro
- Info, Tip, Note, and Warning Macros
- Jira Chart Macro
- Jira Issues Macro
- Labels List Macro
- Livesearch Macro
- Loremipsum Macro
- Multimedia Macro
- Navigation Map Macro
- Network Macro
- Noformat Macro
- Office Excel Macro
- Office PowerPoint Macro
- Office Word Macro
- Page Index Macro
- Page Properties Macro
- Page Properties Report Macro
- Page Tree Macro
- Page Tree Search Macro
- Panel Macro
- PDF Macro
- Popular Labels Macro
- Profile Picture Macro
- Recently Updated Dashboard Macro
- Recently Updated Macro
- Recently Used Labels Macro
- Related Labels Macro
- Roadmap Planner Macro
- RSS Feed Macro
- Search Results Macro
- Section Macro
- Space Attachments Macro
- Space Details Macro
- Spaces List Macro
- Status Macro
- Table of Contents Macro
- Table of Content Zone Macro
- Task Report Macro
- User List Macro
- User Profile Macro
- View File Macro
- Widget Connector Macro
On this page
Related content
- No related content found
Add the Related Labels macro to give people a way to navigate to related content in your site.
It works by finding labels that pages have in common. It takes the label used on the current page, looks for other pages that use this label, and then lists any other labels that are found on those pages.
This macro is great for:
- Knowledge base articles
- Process and procedure documentation.
Basically any situation where you want a map of related pages in your site. The list updates automatically, as labels are added and removed from pages over time.
On this page:
Screenshot: the Related Labels macro guiding people to related articles in a knowledge base.
Add this macro to your page
To add the Related Labels macro to a page:
- From the editor toolbar, choose Insert > Other Macros.
- Choose Related Labels from the Confluence content category.
- Enter specific labels the macros should look for, or leave blank to use any labels on the page.
- Choose Insert.
You can then publish your page to see the macro in action.
Screenshot: configuring the Related Labels macro in the macro browser.
Change the macro parameters
Macro parameters are used to change the behaviour of a macro.
To change the macro parameters:
- In the editor, click the macro placeholder and choose Edit.
- Update the parameters as required then choose Insert.
Here's a list of the parameters available in this macro.
Parameter | Default | Description |
---|---|---|
Restrict to these Labels | none | Specify the labels for which you want to view related labels. For example, |
Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example
).
Other ways to add this macro
Add this macro as you type
Add this macro using wiki markup
This is useful when you want to add a macro outside the editor, for example as custom content in the sidebar, header or footer of a space.
Macro name: related-labels
Macro body: None.
{related-labels:labels=choc,cake}
Related content
- No related content found