Topic and chapter labels
Use labels to mark a topic or chapter that describes a commercial or internal feature, something that is still in development, or applies to a specific version or technology. Labels help your readers understand at a glance whether content is relevant for them.
Each header can have only one primary label and multiple secondary labels. Your readers can hover over any label to see a tooltip with details about what the label means. If you define a URL for a primary label, readers can also click it to go to this URL, for example, to see a comparison of plans or editions.
Define labels
To define labels, add the labels.list file to the help module root next to writerside.cfg.
Here is an example of the labels.list file:
Use the <primary-label>
and <secondary-label>
elements to define labels.
Every label must have an id
used to reference the label. The name
defines the text that renders next to the header, while short-name
is used for primary labels in the topic navigation block. Primary labels can also define a href
to point to some URL when the reader clicks the label.
Use the color
attribute to define the color of the label.
To set the tooltip text for a label, define it as text inside the element, between the opening and closing tags.
Insert labels
To use labels, add them as <primary-label>
and <secondary-label>
elements inside <topic>
and <chapter>
.