Labels

How to define labels

You can store a single line of formatted text as a label under a given role using the syntax .ROLE LABEL. Labels are not rendered directly, but attached to the next document node. In the documentation of each node, you will find the list of labels it supports and the role they have in the rendering.

.details This is a label with role "details"

The label above will be attached to this paragraph.

How to use labels

Labels are stored inside a node an are available for the visitor to be inserted in the rendered text. The way they are used, however, depends entirely on the template. While the template engine is a topic for a later chapter, it is worth showing here that labels can be rendered. The following example uses a custom template for a paragraph that attaches all labels as a list under it.

.details Some details
The labels above will be attached to this paragraph and rendered in a list below (thanks to a custom template).

Multiple labels

You can define as many labels as you want with different roles.

.notes Some notes
.details Some details
The labels above will be attached to this paragraph and rendered in a list below (thanks to a custom template).

Labels and styled text

Labels can contain Mau syntax just like normal paragraphs.

.details This is *a label* with _styles_
The labels above will be attached to this paragraph and rendered in a list below (thanks to a custom template).

Default role

The default role for a label is title, so you can add a title in two different ways.

.title This is a title
This paragraph shows the labels attached to it thanks to a custom template.

. This is also a title
This paragraph shows the labels attached to it thanks to a custom template.

Blank lines

There can be any amount of blank lines between the label and the node it is attached to.

.title This is a title
This paragraph shows the labels attached to it thanks to a custom template.



.title This is a title

This paragraph shows the labels attached to it thanks to a custom template.



.title This is a title


This paragraph shows the labels attached to it thanks to a custom template.

Multiple labels with the same role

Labels are stored in a buffer and attached to the first document node that appears after them. The label buffer contains one single slot per role, so defining two labels with the same role results in the second definition overwriting the first.

.details This is the first label
.details This overwrites the previous label
.title This doesn't overwrite any label
This paragraph shows the labels attached to it thanks to a custom template.