---
title: "Text roles"
description: "What stands inside a line of text."
canonical: text-roles.html
navigation-title: "Text roles"
---

<a id="text-roles"></a>

# Text roles

- [badge](#badge)
- [state](#state)
- [anchor](#anchor)
- [id](#id)

What stands inside a line of text.

<a id="directive-badge"></a>

<a id="badge"></a>

## badge

A short state in a line, as a text role: `` :badge:`Closed <ok>` ``. The
tone stands in angle brackets after the label: `ok`, `warn`, `error`
or `accent`. Without one, the badge is neutral. A word in brackets that is
no tone stays part of the label.

[Closed] [Under review] [New]

The element is `sds-badge`. The Markdown twin writes the label in square
brackets.

<a id="directive-state"></a>

<a id="state"></a>

## state

A state as a glyph, for a cell of a matrix: `` :state:`Available <ok>` ``. The
words name the glyph for a reader who cannot see it, and they do not show. The
word in angle brackets picks the glyph and its colour: `ok`, `warn` or
`error`. Without one, the glyph is the stated boundary, in the ink of the text.

| Source | In CI | From a checkout |
| --- | --- | --- |
| Package | Available | In part |
| Installation | Missing | Not stated |

The element is `sds-icon` with its `tone`. The Markdown twin writes the words.

<a id="directive-anchor"></a>

<a id="anchor"></a>

## anchor

An address in a line, as a text role: `` :anchor:`P2 <step-p2>` ``. A label
stands before a block, so a word in a table cell has none. This role gives
it one. The words stay as they are, and the address in angle brackets is
what a `:ref:` names. Without brackets, the words are the address too.

```text
* - :anchor:`P2 <step-p2>`
  - Add nine sections to the page

The step :ref:`P2 <step-p2>` fails in the extension.
```

The Markdown twin writes the words.

<a id="id"></a>

## id

A reference to an id in mono, as a text role: `` :id:`B10 <feat-b10>` ``.
It is `:ref:` with the link in the mono face. An id is a name the machine
gave the thing, and mono says so. A `:ref:` cannot hold a literal in its
words, so this role is the route.

```text
The grid element :id:`B10 <feat-b10>` comes after the MVP.
```

The Markdown twin writes the link.