The easiest way to ensure that you are following the document structure that IHO demands, is to use a Metanorma template.
If you author a document type that doesn’t have a template, check a sample document for better understanding how to structure that document.
Typically, an IHO document contains the following content order:
The document history of the publication is marked up as a table.
[.preface] == Document History [%unnumbered] [cols="a,a,a,a",options="headers"] |=== |Version Number |Date |Approved By |Purpose |1.0.0 |April 2012 |TSMAD |Approved edition of S-102 ... |===
Automatic generated content
The templated material ("boilerplate") of the document front matter is all automatically provided by Metanorma:
Cover page: IHO contact information.
Inner cover: Copyright statement.
Participants and contributors
An IHO publication is typically created by a working group that belongs to a committee.
Please refer to the document attributes on document contributors, on how they are specified.
Metanorma supports IHO publications developed under two committees:
Terms and definitions
The terms and definitions is used to define important terms and cite them throughout the standard.
Learn how to enter terms and definitions.
The references section contains normative references, it is considered a “bibliography” section.
Learn how to enter bibliographic entries.
|In IHO there are two “bibliography” sections. The “References” section for normative references, and the “Bibliography” section which is for informative references.|
After the sections above, any number of content sections can be added.
Annex sections are declared by prepending the
[appendix] tag above the section
Annexes can be added as necessary.
An annex can either be normative or informative. By default an annex is marked informative.
In order to declare a normative annex, use the obligation attribute in
the following manner:
// Without declaration, an annex is informative. [appendix] == Informative annex title ... // A normative annex. [appendix,obligation=normative] == Normative annex title ... // A informative annex with explicit declaration [appendix,obligation=informative] == Informative annex title ...
Annex clauses are placed after all content sections, right before the bibliography section.
IHO documents support an extra definitions section that represents informative terms, as a "Glossary" section in the annex.
It can be encoded as follows:
[appendix] == Glossary === My term My definition ...