Effectively Using Labels

Table of Contents

Overview

• Labels are user-defined tag words that can be assigned to pages and spaces, to categorise, identify or bookmark content in Confluence.
• You can assign a label to certain pages and then browse all pages with that label in an individual space or search the entire site based on that label.
• Since labels are user-defined, you can add any word (or even make up your own) that helps you identify the content in the site.
• You can find labels for pages below the page tabs in a page, and they can be added or removed without affecting the content of the page.

Types of Labels

• Global Labels - A global label is available to all users across the site. Once a global label is added, any user with permission to view a page can also view its labels. Any user with permission to edit a page can add a global label to a page.
• Personal Labels - A personal label is only available to the user that created it. You can use personal labels to mark content that you personally are interested in. Any user with 'view' permission can add a personal label to a page.
• Space Labels - A space label is used to group a space with other content you've labeled in Confluence
• Team Labels - Team labels are used to group together related spaces.

Adding Labels

To Add a Global Label:

• Navigate to the page you wish to add a label to.
• Click on the EDIT button next to the 'Labels' section on the top of View page. (the EDIT button is highlighted in yellow)
• There will be a list of Suggested Labels that you can choose from. If you want to use a Suggested Label, just click on it, and that label will be added to the page.
• Otherwise, you can enter a new label into the input field and click on Add.
• When you are finished, click the Done button.

You must have 'edit' permissions to add a global label to a page.

To Add a Personal Label:

• Navigate to the page you wish to add a label to.
• Click on the EDIT button next to the 'Labels' section on the top of View page. (the EDIT button is highlighted in yellow)
• If you want to add a new personal label, type it in the input field using the format 'my:label'. (e.g. my:documentation)
• Click the Done button to add the label.

Only 'view' permissions are needed to add a personal label. Personal labels are visible only to the user who created them.

To Add a Space Label:

• Navigate to the page you wish to add a label to.
• Click on the Browse Space button on the menu bar in the top right-hand corner.
• Click on the Space Admin button in the menu bar next to 'Advanced'.
• Click on the Edit Space Labels link in the 'Space Operations' menu of the left side.
• In the 'Labels, section on the left, you can type in labels in the input field and then click the Add button to add them

You must have 'space administrator' permissions for the space you wish to add labels to.

To Add a Team Label:

• Navigate to the page you wish to add a label to.
• Click on the Browse Space button on the menu bar in the top right-hand corner.
• Click on the Space Admin button in the menu bar next to 'Advanced'.
• Click on the Edit Space Labels link in the 'Space Operations' menu of the left side.
• In the 'Team Labels, section on the right, you can type in labels in the input field and then click the Add button to add them
• There is also a list of current team labels that you can pick from to add the space to that team.

You must have 'space administrator' permissions for the space you wish to add team labels to.

Removing Labels

Removing a label from a page:

• Navigate to the page you wish to remove a label from
• Click on the yellow EDIT button next to the labels
• On this page, each label will have a next to it
• Click on the to delete that label

Removing a space label:

• Navigate to page in the space you wish to remove a label from
• Click on the Browse Space button in the upper right-hand corner of the menu bar
• Click on the Space Admin tab on the top menu bar
• Click on the Edit Space Labels link on the left-hand side under 'Space Operations'
• The list of space labels will appear under the 'Labels' section. Click on the Remove link next to the space label you wish to remove

Removing a team label:

• Complete the first 4 steps from the section above ('Remove a space label'). You should be at the 'Edit Space Labels' page.
• The list of team labels will appear under the 'Team Labels' section. Click on the Remove link next to the team label you wish to remove

Viewing Labels

Viewing Global/Space/Team Labels:

• Navigate to page in the space you wish to view the labels from
• Click on the Browse Space button in the menu bar
• Click on the Labels tab
• A list of the most popular labels will be listed (You can sort the labels alphabetically or by popularity)
• Click on the All Labels link to view an alphabetical list of all the labels used in the space

Viewing Personal Labels:

• Navigate to your personal profile (Click on your 'username' in the top right-hand corner)
• Click on the Labels tab in your personal profile
• A list of your personal labels along with the number of pages that contain the label is displayed
• Clicking on a label will list all content with that label

Viewing Pages by Labels

• The easiest way to view pages by a certain label is to do a search for that label (input the label name in the SearchBox in the top right-hand corner)
• At the top of the search results, there will be list of 'Matching labels' from your search parameters
• Click on the label you wish to see content from

Advanced Page Searching by Labels

Using the Search Box:

• You can use the labelText: prefix in the search box to search specifically for page labels. (e.g. labelText:labelName)
• For example:

Typing in URLs:

• In the URL bar of your web browser, you can type URLs like the following to search for multiple labels in pages:

  http://wikis.sun.com/label/sun+appserver
  

• On pressing enter, the 'View Labels' page will load, showing search results on pages with the labels sun and appserver.

Using Label Macros

Content By Label Macro:

• The Content By Label macro lists content associated with specific labels.
• You must specify a label for this macro. (e.g. contentbylabel:label_name)
• You can specify more than one label to list content for (e.g. contentbylabel:label1,label2)
• Parameters:
  • key - lists only content from the space specified by the key (default: all)
  • type - filter content by type (default: false)
  • showLabels/showSpace - show or hide labels and spaces for the results (default: true)
  • excerpt - show or hide excerpts for he result (default: false)
  • maxResults - specify the maximum number of result pages to display (default: 5)
  • sort - you can sort the results by 'recent', 'creation', 'title', 'modified', or 'reverse' (default: recent)
  • operator - you can specify to view only pages with all of the supplied labels using operator=AND (by default, pages with any of the supplied labels will be listed)
• Example:

{contentbylabel:macro|key=tips|sort=modified}

Navmap Macro:

• The Navmap macro displays the list of pages associated with a specified label as a navigation map.
• You must specify a label for this macro. (e.g. navmap:label_name)
• Parameters:
  • title - specify a title for the navigation map
  • wrapAfter - specify the number of cells in each row (default: 5)
  • cellWidth/cellHeight - specify the number of pixels for the width and height of the cell (default: width=90, height=60)
• Example:

{navmap:macro|title=Macro Information Pages|wrapAfter=3|cellWidth=60}

Recently Used Labels Macro:

• The Recently-Used-Label macro renders a list of the most recently used labels in a specified scope (Global/Space/Personal)
• Click on a label from the list to view pages that contain that label
• Parameters:
  • count - specify the number of labels to be displayed (default: 10)
  • scope - specify the scope of the labels, 'global', 'space', 'personal' (default: global)
  • style - you can display the labels in a table with 'style=table'
  • title - specify a title for the table view
• Example:

{recently-used-labels:count=5|style=table|title=Recent Global Labels}

Related Labels Macro:

• The Related-labels macro lists the labels commonly associated with the current page's labels or user specified labels
• Click on a label from the list to view pages that contain that label
• Parameters:
  • labels - specify certain labels for which you want to view related labels (if this optional parameter is not used then the current page's labels will be used)
• Example:

{related-labels:labels=usage}

• beta
• ccsit
• download
• fsds
• ms
• flops
• confluence
• windows
• high
• documentation
• power
• staroffice
• topaz
• soldes