Page tree

Labels

Last updated

Search is an integral part of how users will find what they want on your site. Labels (known to some as tags) are how searches are made effective. Without accurate labels, searches will often produce too many or too few results.

Search is an integral part of how users will find what they want on your site. Labels (known to some as tags) are how searches are made effective. Without accurate labels, searches will often produce too many or too few results.

Free-form Labels versus Structured Labels

Confluence allows users to label their content with any label they wish in a free-form manner. This is useful when users wish to add a label that wasn't a part of your site taxonomy. In general, however, it's much better to have structured and pre-defined labels for users to choose from. They provide consistency, and prevent situations such as different users labeling the same type of content as human_resources, hr, personnel, or staff. Pre-structured labels also prevent unnecessary typographical errors.

Creating Labels

Labels can be created in the Confluence interface from either the "likes and labels" layer or when editing a page (click the  icon). This is the easiest way to add labels to a page. If you need more refined controls for adding labels, use one of the mechanisms below.

Creating Filter Groups

You can structure your labels by pre-configuring your Targeted Search filter groups in the Confluence Administrator. Go to the General Configuration Panel under Brikit Targeted Search and either edit the groups and labels there or import a CSV.

Label Select Macro

This macro is not the primary mechanism for managing labels, but does provide some additional functionality. It is intended to allow editors to add/change labels within a specific subset of filter groups. It provides a way to elevate the visibility of labels on a page by placing them anywhere in the content. You can use the label select field macro to control the labels that users can attach to a page of content they create or a document they upload. If you click the "Allow Multiple Selections" option, users can add more than one label. The groups that the labels appear in are defined by the search filter groups that you create. You'll choose the search label grouping based on your site taxonomy.

Avoid hyphens

Due to an issue in Confluence (CONF-41459), labels with hyphens, such as part-time or world-class, could be treated as separate labels when searching (becoming part, time, world, and class). To avoid unexpected results, use underscores instead (such as part_time or world_class).

And if you're using Targeted Search, you can display more friendly versions of labels (such as Part Time and World Class), so the hyphen-versus-underscore choice won't matter as much.


Notes on application of this URL:

  • The "newLabel" must exist
  • The "newLabel" must be applied to at least one page
  • This change will impact ALL pages, including archived spaces and trash
  • There are no security controls on this URL

Still need help?