Text roles
What stands inside a line of text.
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.
:badge:`Closed <ok>` :badge:`Under review <warn>` :badge:`New`:badge:`Closed <ok>` :badge:`Under review <warn>` :badge:`New`The element is sds-badge. The Markdown twin writes the label in square
brackets.
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 :state:`Available <ok>` :state:`In part <warn>`
Installation :state:`Missing <error>` :state:`Not stated`
============ ========================= =================================== ========================= =======================
Source In CI From a checkout
============ ========================= =======================
Package :state:`Available <ok>` :state:`In part <warn>`
Installation :state:`Missing <error>` :state:`Not stated`
============ ========================= =======================| Source | In CI | From a checkout |
|---|---|---|
| Package | ||
| Installation |
The element is sds-icon with its tone. The Markdown twin writes the words.
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.
* - :anchor:`P2 <step-p2>`
- Add nine sections to the page
The step :ref:`P2 <step-p2>` fails in the extension.* - :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.
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.
The grid element :id:`B10 <feat-b10>` comes after the MVP.The grid element :id:`B10 <feat-b10>` comes after the MVP.The Markdown twin writes the link.