Special tags#
All tags may be introduced using the :tag-name: <contents> :: notation. However,
some tags admit an alternative notation.
Shorthand#
Some tags allow for shorthand notation. Shorthand notation does not need tag names or
Halmoses to modify the contained text, it uses different delimiters instead. For
example, the following are two different ways for introducing bold text, one using the
standard :span: tag and another using shorthand notation and double asterisks **.
This text is :span: {:strong:} bold ::, as
is **this one**.
Similarly, italic text also has a shorthand version using single asterisks *.
This text is :span: {:emphas:} italic ::,
as is *this one*.
Math tags allow shorthand notation using one dollar sign $ for inline and two $$
for blocks.
Either :math:2 + 2 = 4:: or
$2 + 2 = 4$.
Either
:mathblock:
2 + 2 = 4
::
or
$$
2 + 2 = 4.
$$
Code allows shorthand notation using one backtick ` for inline or three ``` for blocks.
Either :code:var = "value":: or
`var = "value"`.
Either
:codeblock:
var = "value"
::
or
```
2 + 2 = 4.
```
Tip
Either standard or shorthand notation allow meta tags. For example, to assign a
label to an inline math region, you may use either :math:{:label:some-lbl} 2+2=4
:: or ${:label:some-lbl} 2+2=4 $.
Tip
The standard notation using colons and Halmos as delimiters is easy to parse by automated tools. The shorthand notation is easy to read by humans.
The Appendix Stamp#
Some tags deviate from the standard :tag-name: <contents> :: syntax in that they do
not allow contents nor need a closing Halmos. These are called stamp tags. One example
is the :appendix: tag, whose role is to mark the place in the manuscript where the
Appendix starts.
## First section
## Second section
:appendix:
## First appendix
Among other things, the :appendix: stamp restarts the numbering of the following
sections and changes it from numbers to letters.
Paragraphs#
Paragraphs of text need no tag. However, if you want to refer to an entire paragraph of text, you need to add a label. Labels can only be specified in meta tags, and meta tags can only go immediately after the opening tag of a block or inline. Then how can we label a paragraph of text?
The :paragraph: tag exists for this reason. It does not need a closing Halmos after
the paragraph contents.
:paragraph: {:label:my-para} This is how
you refer to a paragraph of text.
And now we refer to the entire previous
:ref:my-para,paragraph::.