Skip to content
Metanorma
On this page

Text markup

Text formatting

The simplest form of inline markup is to emphasize text. AsciiDoc allows you to:

  • Make words bold using asterisks
  • Italicise words with underscores
  • Apply monospacing using backticks
  • Superscript and subscript characters (like CO2 or x4)

---- bold italic monospace superscript subscript

Metanorma extends these simple formats with:
* Strikethrough text ([strike]#strike through text#)
* Smallcaps text ([smallcap]#small caps text#)
* Underline text ([underline]#underline text#)
[source, AsciiDoc]
---- 
[strike]#strike through text#
[smallcap]#small caps text#
[underline]#underline text#

Character substitutions

Metanorma also supports automatic character replacements, for example the copyright symbol © can be entered using (C). Metanorma AsciiDoc also recognises HTML and XML character references, and decimal and hexadecimal Unicode code points.

For more information about automatic character replacements, see the AsciiDoc documentation.

Footnotes

Footnotes are a great option to add a remark to your content without disturbing the reading flow. AsciiDoc allows you to enter single line footnotes. Metanorma extends this functionality and provides the option to enter multi-paragraph footnotes.

Single-line footnotes

You can add footnotes to your document using the footnote macro (1). Just add the footnote where you want it to appear, like this:

Oryza sativa Sativa means "cultivated", is rice that is farmed commercially.

Multi-paragraph footnotes

Native Asciidoctor supports only single-paragraph footnotes through its footnote macro (which can only contain a single line of text).

Metanorma introduces a footnote macro footnoteblock:[id] which allows multi-paragraph notes to be treated as footnotes.

Multi-paragraph footnotes can be entered using the macro footnoteblock:[id] metanorma-standoc ≥ v1.6.4, where id is the identifier of a note containing the contents of the footnote:

Example of a multi-paragraph footnoteasciidoc
This is a paragraph.footnoteblock:[id1] This continues the paragraph.
[[id]]
[NOTE]
--
This is
a multi-paragraph
footnote
--

Practice time

:exercise-file: exercise-2-4-1 include::exercises.adoc[tags=intro;exercise-2-4-1]

Let’s look at a more advanced form of inline formatting: index entries.

+++ <div class="cta tutorial"><a class="button" href="/learn/lessons/lesson-2-4-2/">Start next lesson »</a></div> ++++

1

Edit this page on GitHub →