Metanorma: Aequitate Verum

Metanorma for IHO

Text formatting

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:

  • Emphasize text

  • Link to external resources with hyperlinks

  • Create internal cross-references

  • Create index entries

  • Create Bibliographic entries

Text markup

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 (_)

  • Apply monospace formatting by wrapping text with backticks

  • Superscript and subscript characters (like CO2 or x4)

Example 1. Example of general text markup syntax
*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#
Illustration of strikethrough text in Metanorma
Figure 1. Illustration of strikethrough text in Metanorma.
Illustration of small caps text in Metanorma
Figure 2. Illustration of small caps text in Metanorma.
Illustration of underlined text in Metanorma
Figure 3. Illustration of underlined text in Metanorma.

IHO specific text markup

Inline

Cross-references

Omission of "clause" at the start of a sentence for cross-references to subclauses is done automatically by Metanorma. If Metanorma’s detection of the start of a sentence is incorrect, you can override Metanorma’s auto-generated text, by providing it explicitly within the cross-reference, e.g. Clause 3.1.

References to the bibliography are automatically populated by designator and bibliographic number (e.g. ISO 639-2, [B1]), if the reference is to a standard or technical report, or otherwise by title and bibliographic number. If you wish to override that, e.g. by using authors instead of title, you should populate the cross-reference text, e.g. Boswell and Johnson [B2].

Footnotes

If a footnote is repeated, Metanorma automatically detects that and converts it into a cross-reference ("See Footnote 1.")

A repeat footnote can be marked up using the footnote macro target (abc in the following example; any identifier can be used), and with the repeat footnote text left blank.

Hello.footnote:abc[This is a footnote]

Repetition.footnote:abc[]

Character substitutions

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.

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

Footnotes

General

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.

Single-line footnotes

Footnotes can be added to the document using the footnote command (footnote:[]).

Just add the footnote where you want it to appear, like this:

Oryza sativa footnote:[Sativa means "cultivated"], is rice that is farmed
commercially.

Multi-paragraph footnotes

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], where id is the identifier of a note containing the contents of the footnote.

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

[[id]]
[NOTE]
--
This is

a multi-paragraph

footnote
--
Note
 The popular AsciiDoc processor, Asciidoctor, supports only single-paragraph footnotes through its footnote command (which can only contain a single line of text).