Metanorma IHO document attributes

Note

The document attributes listed below are unique to Metanorma’s processing of IHO documents.

For common document attributes, see Document attributes reference in general Metanorma author’s documentation. That page describes attributes that apply to all Metanorma flavors, not just IHO.

For an introduction to Metanorma AsciiDoc document attributes and how Metanorma uses them, see the corresponding topic.

Document information

:series:

Series that the document belongs to. Mandatory. Permitted values:

Example 1. Example for IHO S-102

:series: S

B: Bathymetric Publications
C: Capacity Building Publications
M: Miscellaneous Publications
P: Periodic Publications
S: Standards and Specifications

docnumber

The designation number for the document. Do not include the series prefix. Mandatory.

Example 2. Example for IHO S-102

:docnumber: 102

:doctype:

Document type. Mandatory. Permitted types:

Example 3. Example for IHO S-102

:doctype: standard

standard: IHO Standard
specification: IHO Specification
resolution: IHO Resolution
regulation: Regulation-related

:status:

Document status. Synonym: :docstage:. Refer to IHO M-3, "Principles and procedures for making changes to IHO technical standards and specifications" (2/2007 as amended), for the relationships between stages. Permitted types:

Example 4. Example for IHO S-102

:status: in-force

draft-proposal: Draft at the proposal stage.
draft-development: Draft at the development stage.
draft-testing: Draft at the testing stage.
draft-implementation: Draft at the implementation stage.
in-force: Document is in-force.
retired: Document has been retired.

edition

The edition number of the document. The format of IHO edition numbers fits in a pattern of major.minor.patch. Please refer to IHO M-3, "Principles and procedures for making changes to IHO technical standards and specifications" (2/2007 as amended), 4.2, for the numbering pattern.

Example 5. Example for IHO S-102

:edition: 2.1.0

edition-major

The major component of the edition number of the document [added in https://github.com/metanorma/metanorma-iho/releases/tag/v0.7.4]. If this attribute is present, it is used instead of edition, combined with edition-minor and edition-patch if they are also present.

edition-minor

The minor component of the edition number of the document [added in https://github.com/metanorma/metanorma-iho/releases/tag/v0.7.4].

edition-patch

The patch component of the edition number of the document [added in https://github.com/metanorma/metanorma-iho/releases/tag/v0.7.4].

:comment-from:

The beginning of the period during which comments may be submitted to the document draft. Accepted values: ISO 8601 date.

:comment-to:

The end of the period during which comments may be submitted to the document draft. The end of the period may change, and may be left open-ended (omitted). Accepted values: ISO 8601 date.

:copyright-year:

Year the document was published.

Example 6. Example for IHO S-102

:copyright-year: 2022

:published-date:

Example 7. Example for IHO S-102

:docnumber: 102

:implemented-date:

The date a document becomes effective. YYYY-MM-DD.

:obsoleted-date:

The date a document becomes no longer effective. YYYY-MM-DD.

Document contributors

General

An IHO publication is typically developed under an IHO working group within a committee.

The basic information of these groups are entered as document attributes, including:

the working group
the committee

Committee

:committee:

Mandatory. Name of relevant IHO committee. A second, third etc. committee is named as :committee_2:, :committee_3:, etc. Permitted values:

Example 8. Example for IHO S-102

:committee: hssc

hssc: Hydrographic Services and Standards Programme (HSSC)
ircc: Inter-Regional Coordination Committee (IRCC)

Working group

:workgroup:

Mandatory. Name of relevant IHO working group. All working groups have an associated committee. A second, third etc. committee is named as :workgroup_2:, :workgroup_3:, etc.

Example 9. Example for IHO S-102

:workgroup: tsmad