To annotate single words, use inline markup. The markup encloses the word(s) and you do not need to begin a new line.
Inline markup allows you to:
Link to external resources with hyperlinks
Create internal cross-references
Create index entries
Create Bibliographic entries
General text markup
The simplest form of inline markup is to emphasize text. typical AsciiDoc allows you to:
Bold text by wrapping text with asterisks (
Italicise words by wrapping text with underscores (
monospaceformatting by wrapping text with backticks
Superscript and subscript characters (like CO2 or x4)
*bold* _italic_ `monospace` ^superscript^ ~subscript~
Metanorma extends these simple formats with:
Strikethrough text (strike through text)
Smallcaps text (small caps text)
Underline text (underline text)
[strike]#strike through text# [smallcap]#small caps text# [underline]#underline text#
OGC specific text markup
Metanorma-OGC supports highlighting of text [added in https://github.com/metanorma/metanorma-ogc/releases/tag/v1.2.16]:
This is #text to be highlighted#.
Metanorma supports automatic character replacements, for example the
copyright symbol © can be entered using
Metanorma also recognizes HTML and XML character references, as well as decimal and hexadecimal Unicode code points.
|For more information about automatic character replacements, see AsciiDoc documentation.|
Footnotes are a great option to add a remark to your content without disturbing reading flow.
In standards however, footnotes are discouraged as they hide potentially important information in the footer. It also becomes unclear whether the footnote is normative or informative in nature.
Footnotes can be added to the document using the footnote command
Just add the footnote where you want it to appear, like this:
Metanorma provides the footnote command
footnoteblock:[id] which allows
multi-paragraph notes to be treated as footnotes.
Multi-paragraph footnotes can be entered using the command
footnoteblock:[id] [added in https://github.com/metanorma/metanorma-standoc/releases/tag/v1.6.4],
id is the identifier of a note containing the contents of the footnote.
This is a paragraph.footnoteblock:[id1] This continues the paragraph. [[id]] [NOTE] -- This is a multi-paragraph footnote --
The popular AsciiDoc processor, Asciidoctor, supports only
single-paragraph footnotes through its