Assigning metadata in the document header
The header contains information about the document (metadata). You specify these metadata by using predefined document attributes, that look like this: :document-attribute:. Most of the attributes take a value, while others are simple flags without a value, like :draft:.
Some of the metadata will be visible in your document, such as :title:, while others are not visible but still affect how your document is generated. The order of attributes doesn’t matter to Metanorma. You can specify metadata about:
- Authors: Issuing organization, authors, and their location
- Document info: Language, document stages (draft, published, etc.) copyright holder, etc.
- Dates: Draft dates, revision dates, publishing date, copyright year, etc.
- Identifiers: Document numbers, ISBNs, URIs (Uniform Resource Identifiers)
Note
Other metadata influence how the document is generated and should only be used by advanced users. Often, they will require familiarity with your organization's structures and processes.
Here’s an example:
= Document title <1>
:docnumber: 12345 <2>
:doctype: standard <3>
:copyright-year: 2022
:language: en
:mn-document-class: ogc <4>
:technical-committee: Committee name <5>
:fullname: Your Name <6>
:fullname_2: Co-Authors Name
:address: Address line 1+ \ <7>
Zip code + \
City + \
Country
:draft: <8>
:mn-output-extensions: xml,html,doc,html_alt <9>Practice time
:exercise-file: exercise-2-1 include::exercises.adoc[tags=intro;exercise-2-1]