Metanorma ITU document attributes
Document attributes listed below are unique to the processing of ITU documents in Metanorma.
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 ITU.
For an introduction to Metanorma AsciiDoc document attributes and how Metanorma uses them, see the corresponding topic.
See /flavors/itu/ref/editorial-groups/ for the ITU editorial group structure.
Document information
:doctype:
recommendationDocument type. Choices below.
recommendation(default) This document is an ITU Recommendation.
recommendation-supplementThis document is a Supplement of an ITU Recommendation.
recommendation-amendmentThis document is an Amendment of an ITU Recommendation.
recommendation-corrigendumThis document is a Corrigendum of an ITU Recommendation.
recommendation-errataThis document is an Errata of an ITU Recommendation.
recommendation-annexThis document is an Annex of an ITU Recommendation.
focus-groupThis document is the output of a Focus Group.
implementers-guideThis document is an ITU Implementers Guide.
technical-paperThis document is an ITU Technical Paper.
technical-reportThis document is an ITU Technical Report.
joint-itu-iso-iecThis document is a “Common Text” Recommendation between ITU and ISO/IEC JTC 1.
resolutionThis document is an ITU Resolution.
service-publicationThis document is an ITU Service Publication (e.g. an Annex to the ITU Operational Bulletin).
handbookThis document is an ITU Handbook.
questionThis document is an ITU Question.
contributionThis document is an ITU Contribution.
:status:
Document status. Synonym: :docstage:. Choices below.
In general, the document stages are:
- Draft Recommendation (the text of the Recommendation is being developed and
may be quite mature, but it has not yet been approved)
- Once the text is mature, the SG may decide to “Consent it” (APP) or
“Determine it” (TAP). The draft Recommendation is then in “Consented” (AAP) or “Determined” (TAP) state.
- As soon as it has been approved, the Recommendation is no longer a draft
Recommendation, but an in-force Recommendation.
- TSB then prepublishes the Recommendation. Prepublished Recommendations are
in-force texts that are not yet in their final form. Because they are not final, they are made available only to the Membership.
- TSB copy-edits and publishes the Recommendation. This final in-force version
is made available to all for free download.
- If the Recommendation is revised, it will be superseded by the revision as
soon as the revision is approved.
- Recommendations are seldom withdrawn, but it may happen when the SG decides to
do so.
Please refer to the Traditional Approval Process (TAP) (WTSA Resolution 1) and the Alternative Approval Process (AAP) (Recommendation A.8) for further details.
in-forceThis document is In-force.
in-force-prepublishedThis document is In-force but the text is not final.
supersededThis document has been superseded.
withdrawnThis document has been withdrawn.
draft**Do not use this value!** NOTE: If the document is a draft, use the general
:draft:document attribute instead of:status:to indicate so (see Document attributes reference).
:docnumber:
The identifier for the document, including the series, the document number, and any suffix, but excluding the bureau. For instance, H.781, G.108.2, G.709/Y.1331.
:td-number:
Temporary Document number for the document. Used for study group meetings.
:amendment-number:
Number of amendment, if this is an amendment.
:amendment-title:
Title of amendment, if this is an amendment.
:corrigendum-number:
Number of corrigendum, if this is a corrigendum.
:corrigendum-title:
Title of corrigendum, if this is a corrigendum.
:recommendation-number:
For implementation guides, the recommendation that this document is an implementation guide for. If this is a guide for multiple recommendations, they are slash-delimited. If this is a guide for a subseries of recommendations, the recommendations as specified as .\*, e.g. H.350.*.
:common-text-docnumber:
For “Common Text” Recommendations between ITU and ISO/IEC JTC 1 (joint-itu-iso-iec). The full document identifier for the recommendation assigned by ISO/IEC.
:series:
Series that the Recommendation belongs to. Use full title, for example: “H: Audiovisual and Multimedia Systems”
:series1:
First level subseries, for example: “IPTV multimedia services and applications for IPTV” (= “H.700--H.789”)
:series2:
Second level subseries, for example: “Digital Signage” (= “H.780--H.789”)
:intended-type:
Intended type for this document (for technical reports) (R, C, TD)
:language:
enThe language of the document (only en for now; will eventually support ar, zh, en, fr, ru, es) (default: en)
:provisional-name:
A provisional identifier allocated to the document if the proper document identifier (:docnumber:) is not yet known.
:ip-notice-received:
falseITU has received a notice of intellectual property, protected by patents, which may be required to implement this Recommendation. (default: false)
title-{en, fr, es, ar, ru, zh}
The title to use, in each of the official languages of the ITU.
:annex-id:
The ID to use for the annex, if this document is an annex.
annex-title-{en, fr, es, ar, ru, zh}
The title to use for the annex, if this document is an annex, in each of the official languages of the ITU.
subtitle-{en, fr, es, ar, ru, zh}
The subtitle to use, in each of the official languages of the ITU; appears only at the start of the document body, not in the front cover.
:collection-title:
The collection of documents that this document appears in. Accepts a text value. Appears on the top left of the cover page for some collections.
"Recommendations", "Articles", "Final Acts".
:slogan-title:
The slogan that this document is branded with, in connection with an event.
Slogan that this document is branded with, in connection with an event. Some Flagship publications allow the slogan title.
When using the slogan title, be aware that the ITU official style guide specifies proprietary fonts for the slogan title that are not freely available cross-platforms.
- "Adelle Italic" for Latin and Cyrillic scripts;
- "Traditional Arabic" for Arabic;
- "STKaiti" for Chinese.
These are fonts that Fontist cannot directly install, and the user is responsible for pre-installing them on their machine.
:document-scheme:
Switch between old and new PDF formats. Legal values: legacy and current (default).
legacycurrent
Inherited from Metanorma (all flavors) (27 attributes)
:publisher{_i}:
The standards agency publishing the standard. NOTE: Prior to 1.7.0, this field accepted comma-delimited values. NOTE: Prior to 2.7.0, this field accepted semicolon-delimited values. These are processed via CSV, recognising quote marks. This functionality is maintained in later versions, but other attributes of organisations are ignored (publisher_logo, pub-address, etc.)
:publisher_abbr{_i}:
The abbreviation of the publisher; if not provided, and the standards organisation is the home organisation of the standard, the SDO's abbreviation will already be available to Metanorma, and will be supplied.
:publisher_logo{_i}:
The path to the logo of the publisher, specified as an image file; the numbers in the attribute align to the :publisher{_i}: attributes.
:sponsor{_i}:
An organization sponsoring the publication of this document. NOTE: If a person needs to be nominated as the responsible party for a sponsoring organization, that person should be treated as a personal contributor (:surname{_i}:, :affiliation{_i}:, etc.), with a :role: attribute of enabler.
:sponsor_logo{_i}:
The path to the logo of the sponsoring organization, specified as an image file; the numbers in the attribute align to the :sponsor{_i}: attributes.
:copyright-holder:
The copyright holder, if distinct from the publisher; can be multiple (semicolon-delimited: processed via CSV, recognising quote marks).. NOTE: Prior to 1.7.0, this field accepted comma-delimited values.
:docidentifier:
The :docidentifier: attribute is an alternative to docnumber and other attributes (such as doctype and docstage). WARNING: :docidentifier: should be avoided unless absolutely necessary due to the limitations its usage brings. Metanorma maintains the pubid-* set of software libraries to generate document identifiers for different Metanorma flavours, and those libraries should be updated to deal with the novel use case. The value here is the "full document identifier" and overrides the composition of the automatically-constructed document identifier. If :docidentifier: is supplied, :docnumber: and the other related attributes are ignored when composing the identifier for the document. The :docidentifier: attribute is used for document identifiers that do not follow normal SDO conventions, and for which the identifier cannot be constructed out of :docnumber: in the normal way.
:docidentifier: is a preformatted value and is opaque to Metanorma. This means that Metanorma cannot make any inference about the internal structure of the identifier. For example, Metanorma cannot generate undated or language-specific variants of the identifier, or mark up the part number separately from the document number, as is required by ISO.
However, the :docidentifier: content can be a Liquid template.
Refer to Default metadata values for the typical values that can be used in metadata-driven Liquid templates under Metanorma.
:docidentifier-additional:
This attribute provides additional primary identifiers for the document, to be used alongside the native identifier generated from docnumber or docidentifier. It is intended for copublished standards with multiple primary identifiers. The list of identifiers is comma-delimited, and is specified as TYPE:VALUE; e.g. :docidentifier-additional: IDF:IDF 21, RFC:RFC 97.
:version:
The document version. The distinction between :edition: and :version: is specific to the SDO, but the overall trend is that :edition: corresponds to major versions, and are what corrigenda and amendments apply to, while :version: corresponds to minor versions and patches, including pre-publication versions (drafts). However, only :version: is used if the SDO uses semantic versioning throughout. Before :version: was added to Metanorma, :draft: fulfilled that function instead.
:revdate:
The date the document was last updated.
:library-ics:
The ICS (International Categorization for Standards) number for the standard. There may be more than one ICS for a document; if so, they should be comma-delimited. (The ICS identifier is added to the document metadata, but may not be visible in the resulting document, depending on Metanorma flavor.)
:isbn:
The ISBN-13 number of the document. This value is optional.
:isbn10:
The ISBN-10 number of the document This value is optional.
:title:
The title of the document. If not supplied, the built-in AsciiDoc title (first line of document header) is used instead.
:title-{langcode}:
The title of the document in the language langcode. langcode is a ISO 639-1 code.
:title-en:, :title-fr:
:title-{type}-{langcode}:
The title of the document in the language langcode, and of type type.
The title of the document in the language langcode, and of type type. Note: this was previously supported only in individual flavours.
:title-main-en:, :title-intro-fr: + NOTE: This was previously supported only in individual flavours that required title parts, such as ISO that supports main, intro, part, complementary, addendum. It is now supported generically in Metanorma.
:doctype-abbrev:
The document type abbreviation; e.g. TN for "technical note". Can be used in document metadata, e.g. cover page. .
:docsubtype:
The document subtype; by default, used to provide an ad hoc, user defined document class, unless provided for explicitly in the flavour, as in OGC
:docstage:
:docstage-abbrev:
The document stage abbreviation; e.g. D for "draft". Can be used in document metadata, e.g. cover page. .
:docstage-published:
Whether the current document stage should be considered as published. Boolean. If not provided, and if there is no setting specific to the flavor, the default is that only the stage "published" is considered published.
:docstage-valid:
Comma-delimited list of the statuses recognised as valid for this document, superseding the flavour's own repertoire in status validation. Normally set by a Metanorma taste rather than by authors: a taste that defines its own stages advertises through this attribute the base stages it maps them to, so that the underlying flavour does not report them as unrecognised.
:docsubstage:
The substage code for the document status, where applicable.
:iteration:
The iteration of a stage, in case there have been multiple drafts (e.g. 2 on a CD: this is the second iteration through the CD stage).
:keywords:
Comma-delimited list of keywords associated with the document.
:classification:
Comma-delimited list of classification tokens, expressed as type:value pairs; if no prefix is given to a value, "default" is supplied as the type. There can only be one value per type in a token; if there are multiple classification values of the same type, repeat the type in a new token; e.g. :classification: Dewey:563.5.081, Dewey:537.71.
:draft:
If present, reviewer notes will be rendered (otherwise those are suppressed). Is also ued as a legacy equivalent of :version:.
Author Information
:bureau_{i}:
TMandatory. Bureau that the document belongs to. Choices are listed below.
TTelecommunication Standardization Bureau (TSB), ITU-T. (default)
RRadiocommunication Bureau (RRB), ITU-R.
DTelecommunication Development Bureau (BDT), ITU-D.
:sector:
Standardization sector that publishes the document, if the document is published outside of the defined bureaus. Only use this attribute if it does not belong to the ITU-{D/R/T} sectors, otherwise use :bureau: instead.
:group_{i}:
Mandatory. Top-level group that the document belongs to.
:group-type_{i}:
Type of top-level group that the document belongs to. Permitted values listed below.
tsagTelecommunication Standardization Advisory Group (TSAG)
study-groupStudy Group (SG)
focus-groupFocus Group (FG)
adhoc-groupAd-hoc Group
correspondence-groupCorrespondence Group
joint-coordination-activityJoint Coordination Activity (JCA)
working-partyWorking Party (WP)
working-groupWorking Group (WG)
rapporteur-groupRapporteur Group (RG)
intersector-rapporteur-groupIntersector Rapporteur Group (IRG)
regional-groupRegional Group. ITU-T Study Groups can have Regional Groups.
:group-acronym_{i}:
Acronym of top-level editorial group that the document belongs to.
:group-year-start_{i}:
Year that the editorial group study period started.
:group-year-end_{i}:
Year that Project group study period ended.
:subgroup_{i}:
Editorial subgroup that the document belongs to.
:subgroup-type_{i}:
Type of editorial subgroup that the document belongs to. Permitted values are as for group-type.
The "TSAG Rapporteur Group" is to be encoded as :group-type: tsag and :subgroup-type: rapporteur-group.
:subgroup-acronym_{i}:
Acronym of editorial subgroup that the document belongs to.
:workgroup_{i}:
Project workgroup (third-level editorial group) that the document belongs to.
:workgroup-type_{i}:
Type of Project workgroup that the document belongs to. Permitted values are as for group-type.
:workgroup-acronym_{i}:
Acronym of Project workgroup that the document belongs to.
:question:
The Questions that the document addresses. A document can address multiple questions. This attribute is formatted as a comma-delimited list of questions, each optionally prefixed by an identifier and colon.
:question: Q10/17: Identity management and telebiometrics architecture and mechanisms, "Q11/17: Generic technologies (such as Directory, PKI, formal languages, object identifiers) to support secure applications":meeting:
Name of meeting that generated this document (for resolutions, technical reports, technical papers, implementers guides)
:meeting-date:
Date of meeting that generated this document (for resolutions, technical reports, technical papers, implementers guides). If the date is a range, it is given slash-delimited.
2000-01-01/2000-01-02
:meeting-place:
Place of meeting that generated this document (for resolutions).
:meeting-acronym:
Acronym of meeting that generated this document (for resolutions).
:source:
Source for this document (for technical reports, technical papers, implementers guides)
:fullname_{i}:
Name of contact for this document (for technical reports, technical papers, implementers guides)
:affiliation_{i}:
Name of organization or company for contact for this document (for technical reports, technical papers, implementers guides)
:address_{i}:
Country for this document (for technical reports, technical papers, implementers guides)
:phone_{i}:
Phone number of contact for this document (for technical reports, technical papers, implementers guides)
:fax_{i}:
Fax number of contact for this document (for technical reports, technical papers, implementers guides)
:email_{i}:
Email of contact for this document (for technical reports, technical papers, implementers guides)
:role_{i}:
Role of contact for this document (for implementers guides): may be either editor (default) or rapporteur
Document Status
:recommendation-from:
Date from which Recommendation status applies
:recommendation-to:
Date to which Recommendation status applies
:approval-process:
Approval Process for Recommendation status. Legal values are listed below.
tapTraditional Approval Process (TAP), as described in WTSA Resolution 1, Section 9.
aapAlternative Approval Process (AAP), as described in Recommendation A.8.
:approval-status:
Approval status code for Recommendation status. Legal values are listed below.
When :approval-process: is tap::: (refer to WTSA Resolution 1, Figure 9.1 “Approval of new and revised Recommendations using TAP -- Sequence of events”)
When :approval-process: is aap::: (refer to Recommendation A.8, Figure 1 “Sequence of Events”)
determined: Determinedin-force: In-forcea: Approvedac: Approved with Substantial Changesaj: Additional Review Judgementar: Additional Reviewat: Approved with Typographical Correctionslc: Last Callc: Consentedlj: Last Call Judgment (includes Last Call Comment resolution)na: Not Approvedri: Re-Initiate Last Callsg: Referred to Study Group Approvaltap: Moved to TAP (ITU-T A.8 / §5.2)
:edition:
In the case of Resolutions, this attribute is used to indicate whether the current document is a revision of an earlier document; if it is, it should have a value other than "1". (Resolutions are identified through place and year, regardless of whether they constitute revisions or not.)
:complement-of:
Identifier of document that this is a complement or supplement of; used in particular for recommendation supplements, to nominate the document or documents that this is a supplement of. Semicolon-delimited.
:timing:
For contributions: the timeframe when a proposed document is expected to be realised by.
Visual appearance
:smartquotes:
In ITU, quotes and apostrophes default to straight. When this attribute is set, Metanorma will convert quotes and apostrophes to smart quotes and smart apostrophes. In the rest of Metanorma, if this attribute is not supplied, quotes and apostrophes default to “smart”.
:document-schema:
Used to specify the document scheme that this document aligns to. If the value legacy is provided, the resulting behaviour is as with the document attribute :legacy-do-not-insert-missing-sections:.
:legacy-do-not-insert-missing-sections:
If set, do not insert the sections “Scope”, “References”, “Definitions”, “Abbreviations and acronyms”, “Conventions” if missing. Use this if you have a legacy Recommendation document with clauses with names preceding this requirement (e.g. “Prerequisites”, “Process”, “General”), and you do not want the compulsory new sections to be added in at the start of the document.
:hierarchical-object-numbering:
If set, do not number objects (tables, figures etc.) consecutively throughout the body of the document, but restart numbering with each clause (hierarchically). Use in complex documents, with multiple tables or figures, that need to be tracked against clauses for ease of lookup (so Figure 6-3, 6-4, instead of Figure 21, 22.) Note that equations in ITU are always numbered hierarchically.
:coverpage-image:
Comma-delimited list of image locations, for images to be included on the PDF cover page of ITU "Service Publications" (and title page for logos). All image locations are relative to the source document..
:presentation-metadata-color-cover-title:
blackTitle color on the PDF cover page. Specify the color depends on the contrast with the background image (:coverpage-image:). Valid values are:
blackBlack title color (default).
whiteWhite title color.
:presentation-metadata-cover-header-hide:
falseWhether to hide page header titles. The header titles are the "ITUPublications", "International Telecommunication Union", with the Sector or Bureau name on the cover page. NOTE: Some Flagship publications opt to omit the cover page header. Some Flagship publications opt to omit the cover page header. Valid values are:
false(default) Show the page header titles on the PDF.
trueHide the page header titles on the PDF.
:presentation-metadata-color-cover-itu-logo:
#1DA0DBColor of the ITU logo on the PDF cover page. Specify color depending on the contrast with background. Valid values are:
#1DA0DB(default) Default ITU blue logo color.
whiteWhite logo color.
{custom-color-in-hex}Any custom color, specified as a hex color code.
Build and configuration
Inherited from Metanorma (all flavors) (8 attributes)
:document-class:
The flavor of Metanorma used to compile the document; e.g. iso, nist, ogc. Needs to be a supported version of the document.
:flavor:
:output-extensions:
The output formats to generate for the document, comma-delimited; e.g. xml,presentation,html,doc,pdf. The formats supported vary for each flavor, but all flavors support xml (Semantic XML), presentation (Presentation XML), and one of html or pdf.
:imagesdir:
(Optional) Directory in which images are located: all local image file locations are prefixed with this directory. Accepts a directory path.
:nodoc:
Instructs Metanorma to not generate Word and HTML output, means only XML output will be generated.
:novalid:
Suppress document validation.
:index-terms:
Terms (and symbols) are indexed automatically in postprocessing. See automatic terms indexing.
:relaton-output-file:
Output the bibliographic record describing the document as a Relaton XML file (with the suffix .rxl).
Bibliography
Inherited from Metanorma (all flavors) (11 attributes)
Reference lookup
:no-isobib:
If set, do not use the relaton or iev gem functionality to look up ISO and IEV references online, nor the cache of relaton and iev searches.
Publication date cutoff
:bibliography-cutoff-date:
Override the publication date used for the bibliographic cutoff, instead of deriving it from the document's own date attributes. Accepts a date (YYYY, YYYY-MM, or YYYY-MM-DD); the value none (or false) disables the cutoff entirely, so references resolve to their latest editions and current status.
Caching
:no-isobib-cache:
If set, use the relaton and iev gem functionality to look up ISO and IEV references online, but do not use the cache of relaton and iev searches.
:local-cache:
Use the local Relaton and iev search caches to override the global relaton and iev search caches. If a directory name is given for the attribute, that name overrides relaton as the cache name.
:local-cache-only:
Use the local Relaton and iev search caches to the exclusion of the global relaton and iev search caches. If a directory name is given for the attribute, that name overrides relaton as the cache name.
:flush-caches:
If set, delete and reinitialise the cache of Relaton searches.
:relaton-data-source:
Allows specification of an external bibliographic file to be imported. The value of the field is the file name. If the format also needs to be specified, this is done as file=PATH/TO/FILE,format=FORMAT. Valid formats are follows.
bibtexThe BibTeX format. Currently, only this is supported as a format, all other formats will raise an error.
:relaton-data-source-{id}:
Allows specification of multiple external bibliographic files to be imported. The different bibliographic sources are differentiated through the value of the {id} identifier.
:relaton-data-source-bib1: PATH/TO/FIRST/FILE
:relaton-data-source-bib2: PATH/TO/SECOND/FILEReference sort order
:sort-biblio:
If set to false, do not sort the bibliography; references are left in document order. Sorting is on by default.
Sort bibliographies in the document according to criteria set by the flavor Default: true. .
:sort-biblio-{abbrev}:
Override the publisher sort ranking for the bibliography, one attribute per publisher. The attribute-name suffix {abbrev} is the publisher's abbreviation; the value is the sort rank (lower sorts earlier) followed by the publisher's full name, separated by a colon ({rank}: {name}). A reference is matched to a publisher by its abbreviation (case-insensitive) or its name; matched publishers sort in the given rank order, followed by other standards, then other references. This is the mechanism a Metanorma taste uses to set a house bibliographic sort order: the taste configuration compiles to these document attributes. Because they are ordinary document attributes, an author can equally set them directly in a single document to override the sort order for that document alone.
:sort-biblio-OIML: 1: International Organization of Legal Metrology
:sort-biblio-ISO: 2: International Organization for Standardization
:sort-biblio-IEC: 3: International Electrotechnical CommissionReference rendering
:relaton-render-config:
Override the default configuration of Relaton Render selectively, with attributes from the named configuration YAML file. See Relaton Render specification for description of the configuration file format. We recommend you inspect the configuration compiled into the flavor gem (lib/relaton/render/config.yml) and include modifications of that in the override config file.
Math and scientific formatting
Inherited from Metanorma (all flavors) (6 attributes)
:keep-asciimath:
Do not translate Asciimath in the document to MathML.
:suppress-asciimath-dup:
By default, MathML in the Metanorma XML has equivalent AsciiMath added to it in a comment. This AsciiMath can be used as an accessibility alternative to the MathML expression. The generation of this AsciiMath can be suppressed.
:stem:
asciimath(Defaults to asciimath) The default language for stem:[...] and [stem] blocks expressions in the document. (AsciiMath, MathML, or LaTeX). For example, if you want the stem expressions in your document to be interpreted as LaTeX by default, use :stem: latexmath.
Read more about mathematical expressions.
:number-presentation:
Sets the formatting options for the number:[] command in the document. Please refer to the dedicated section at numbers for usage.
:number-presentation: attribute:number-presentation: notation=e,exponent_sign=plus,precision=4number:341[]
:number-presentation-profile-{NAME}:
Sets the formatting options for the number:[] command in the document as profile {NAME}. Please refer to the dedicated section at numbers for usage.
:number-presentation-profile-{NAME}: attribute:number-presentation-profile-3: notation=scientific,exponent_sign=nil,decimal=","number:342[profile=3]
:number-presentation-formula:
Sets the formatting options for numbers contained in formulas. Please refer to the dedicated section at numbers in formulas.
Languages and localization
Inherited from Metanorma (all flavors) (5 attributes)
:i18nyaml:
Name of YAML language template file. Use if you wish to output an standard in a language that's not supported out of the box. For more on how to customize localization, see Localization.
:script:
LatnThe script of the document (ISO 15924). Defaults to Latn. Must be supplied as Hans for Simplified Chinese.
:locale:
The locale of the document (currently expected to be a two-letter country code, ISO 3166-1 alpha-2).
:boilerplate-authority:
File containing predefined text of document, in Metanorma XML. The document predefined text needs to follow the structure described in Predefined text; compare examples of Metanorma predefined text files such as that in ITU .
:localize-number:
Template for how to present localized numbers. The localization template string is in the following form: :localize-number: +++#,##0.### ###+++ TIP: See Number localization for how numbers are localized in Metanorma.
Generic metadata
Inherited from Metanorma (all flavors) (11 attributes)
:semantic-metadata-{name}:
Comma-delimited list of values, relating to name as semantic metadata about the document. Stored in the document under //metanorma-extension/semantic-metadata/{name}, with repeating tags for each value.
:presentation-metadata-{name}:
Comma-delimited list of values, relating to name as presentation metadata about the document. Stored in the document under //metanorma-extension/presentation-metadata/{name}, with repeating tags for each value.
The following instances of generic metadata are applicable to all flavors of Metanorma; other instances are specific to flavors, and are documented there:
:semantic-metadata-headless:
This document is to be compiled without adding initial document boilerplate to it. This is used for compiling Metanorma AsciiDoc boilerplate documents themselves.
:presentation-metadata-doctype-alias:
Specify how the document type is to be rendered. This overrides the language-specific internationalization of the supplied document type, and is used in Metanorma tastes, to override the base flavor document type rendering.
:presentation-metadata-custom-charset-font:
Specify a custom character set for Unicode "Private Use Area" (PUA) character codepoints
presentation-metadata-publisher-{doc|html|pdf}-{width|height}[{_i}]
Specify height and width of the publisher logo, for each of the standard output formats of Metanorma. The publishers are read in the same sequence for logo attributes as they are for publisher names and abbreviations, and the numbering includes the primary publisher of the document as the first publisher (for which a logo typically does not need to be specified.)
For example, presentation-metadata-publisher-pdf-height_2 specifies the height of the coverpage logo in PDF of the second specified publisher.
:presentation-metadata-ul-label-list:
Specify the characters to be used as bullets for unordered lists, as a comma-delimited list of strings, each string corresponding to a deeper level of list. The bullet list rotates once the list is exceeded. NOTE: Custom unordered list bullets are only processed for PDF output.
:presentation-metadata-ul-label-list: *,–,"x,x" will use * at level 1; – at level 2, x,x at level 3, then go back to * at level 4.
:presentation-metadata-annex-delim:
Delimiter between the line heading giving the number of an annex, and the title of the annex (Metanorma XML, default <br/><br/>) .
:presentation-metadata-middle-title:
Presentation XML Liquid template for middle title (document title at the start of the main section of the document) (Metanorma XML, default "<p class='zzSTDTitle1'>{{ doctitle }}</p>") . Refer to Default metadata values for the typical values that can be used in metadata-driven Liquid templates under Metanorma.
:presentation-metadata-admonition-icon-{type}:
Add the Unicode character as an icon in front of the label for all admonitions of type {type}; overrides any value given in admonition-icon under the i18n internationalization file . If the admonition type contains spaces, replace them with underscores in the attribute name: an admonition of type Safety Precautions is matched by :presentation-metadata-admonition-icon-safety_precautions: .
:presentation-metadata-html-details-open:
Whether the details element in HTML (used for collapsible examples) should be open or closed for HTML documents. Defaults to true, and corresponds to <details open="open"> vs <details>. .
Document relations
Inherited from Metanorma (all flavors) (2 attributes)
Part of
:part-of:
document identifier that the current document is a part of.
Translated from
:translated-from:
document identifier that the current document is a translation of.
URIs
Inherited from Metanorma (all flavors) (6 attributes)
:uri:
The URI to which this standard is published.
:xml-uri:
The URI to which the (Metanorma) XML representation of this standard is published.
:html-uri:
The URI to which the HTML representation of this standard is published.
:pdf-uri:
The URI to which the PDF representation of this standard is published.
:doc-uri:
The URI to which the DOC representation of this standard is published.
:relaton-uri:
The URI to which the Relaton XML representation of this standard is published.
Timestamps
Inherited from Metanorma (all flavors) (16 attributes)
:copyright-year:
The year which will be claimed as when the copyright for the document was issued.
:announced-date:
The date on which the publication of the standard was announced by the issuing authority.
The date on which the document was announced as forthcoming.
:issued-date:
The date on which the standard was issued (authorised for publication by the issuing authority).
:published-date:
The date on which the standard was published (distributed by the publisher).
:implemented-date:
The date on which the standard became active.
:created-date:
The date on which the first version of the standard was created.
:updated-date:
The date on which the current version of the standard was updated.
:corrected-date:
The date on which the current version of the standard was corrected, without that correction amounting to a distinct update.
:obsoleted-date:
The date on which the standard was obsoleted/revoked.
:confirmed-date:
The date on which the standard was reviewed and approved by the issuing authority.
:unchanged-date:
The date on which the standard was last renewed without any changes in content.
:circulated-date:
The date on which the unpublished standard was last circulated officially as a preprint. For standards, this is associated with the latest transition to a formally defined preparation stage, such as Working Draft or Committee Draft.
:accessed-date:
The date on which the standard was last accessed by the compiler of the bibliography; e.g. for a cited online resource, the date on which the document author viewed the resource.
:date:
An arbitrary date in the production of the standard. Content of the attribute should be a token, giving the type of date, then space, then the date itself. Multiple dates can be added as :date_2:, :date_3:, etc.
:vote-started-date:
The date on which the voting process starts for this document.
:vote-ended-date:
The date on which the voting process ends for this document.
Author information
Inherited from Metanorma (all flavors) (51 attributes)
:technical-committee_{1}:
The name of the relevant editorial group. The document attribute name for editorial groups varies by flavor, and there can be multiple types of editorial group, each with its own document attribute; see Contributor metadata: Groups for the value for each flavor.
In the following list, technical-committee can be replaced by each of the allowed editorial group labels; for example, if workgroup is an editorial group label, then :workgroup-label: and :workgroup-type: are document attributes, instead of :technical-committee-label: and :technical-committee-type:.
:technical-committee-number{_i}:
The identifier of the editorial group.
:technical-committee-type{_i}:
The type of the editorial group. Typically this is used as the abbreviation prefixed to the editorial group number.
:technical-committee-number: 2, :technical-committee-type: TC, giving TC 2.
:technical-committee-agency{_i}:
The agency that the editorial group lies under, if it is other than the home agency (the publisher of the document). Only needed for multiple editorial groups.
:technical-committee-agency-abbr{_i}:
The abbreviation of the agency that the editorial group lies under. In most flavors, the abbreviation of the SDO is already available for lookup in Metanorma, and users need not provide this attribute.
For example, under metanorma-iso, :technical-committee-agency: can be specified as ISO, rather than needing to specify both :technical-committee-agency: International Standardization Organization and :technical-committee-agency-abbr: ISO.
:technical-committee_logo{_i}:
The logo of the editorial group, specified as an image file.
:committee-types:
Comma-delimited list of committee types to be recognized for the document. Overrides the preset committee types set for the flavor. .
:corporate-author{_i}:
The organization authoring the standard. This document attribute **should not** be provided if the authoring organization is identical to the publishing body, as its value is automatically set to that of :publisher:. Use :corporate-author: **only when** a standard is authored or co-authored by an agency distinct from the publishing body, and only the publishing agency is credited as the publisher. Multiple agencies can be specified as corporate authors (similar to :publisher:). The first agency specified is expected to be the publishing body. Use :corporate-author_2:, :corporate-author_3:, etc. for additional agencies. NOTE: For personal authors, use :fullname: or :surname: and :givenname: instead.
:fullname{_i}:
The full name of a person who is a contributor to the document. A second person is indicated by using a numeric suffix: :fullname:, :fullname_2:, fullname_3:, &c. The same convention applies to all the following attributes. (This and the other personal name attributes are not displayed in all standards.)
:surname{_i}:
The surname of a person who is a contributor to the document.
:givenname{_i}:
The given name(s) of a person who is a contributor to the document.
:initials{_i}:
The initials(s) of a person who is a contributor to the document.
:contributor-credentials{_i}:
Credentials of the person, appearing after their name in Metanorma flavour-specific contexts.
The credentials of the person (e.g. "PhD, F.R.Pharm.S"); these are often displayed inline with the person's name.
:role{_i}:
The role of a person who is a contributor to the document. By default, they are coded as an editor; they can also be represented as an author, or (if they are the responsible party for a sponsoring organization) enabler. Is meant to draw from the constrained vocabulary of Relaton: author, editor, adapter, translator, performer, realizer, publisher, distributor, owner, authorizer, enabler, subject; see Relaton specification.
:role-description{_i}:
A more detailed description of the role of a person who is a contributor to the document.
:affiliation{_i}:
The organization that a person who is a contributor to the document is affiliated with.
:affiliation_abbrev{_i}:
The abbreviation of the organization that a person who is a contributor to the document is affiliated with.
:affiliation_subdiv{_i}:
The subdivision of the organization that a person who is a contributor to the document is affiliated with. The subdivisions can be multiple (semicolon-delimited: processed via CSV, recognising quote marks), and they can also be hierarchical, with multiple levels of subdivision (comma-delimited, from larger to smaller) ; the different hierarchical levels can optionally be prefixed with type and a colon.
:affiliation_logo{_i}:
The logo of the organization that a person who is a contributor to the document is affiliated with, specified as an image file.
:contributor-position{_i}:
The position of the person within the organization.
:address{_i}:
The organizational address of a person who is a contributor to the document. Mutually exclusive with street/city/region/country/postcode.
:street{_i}:
The street component of the organization address of a person who is a contributor to the document.
:city{_i}:
The city component of the organization address of a person who is a contributor to the document.
:region{_i}:
The region component of the organization address of a person who is a contributor to the document.
:country{_i}:
The country component of the organization address of a person who is a contributor to the document.
:postcode{_i}:
The postcode component of the organization address of a person who is a contributor to the document.
:contributor-uri{_i}:
The URI of a person who is a contributor to the document.
:email{_i}:
The email of a person who is a contributor to the document.
:phone{_i}:
The phone number of a person who is a contributor to the document.
:fax{_i}:
The fax number of a person who is a contributor to the document.
:subdivision:
The subdivision of the organization that is responsible for this document. The subdivisions can be multiple (semicolon-delimited: processed via CSV, recognising quote marks), and they can also be hierarchical, with multiple levels of subdivision (comma-delimited, from larger to smaller) ; the different hierarchical levels can optionally be prefixed with type and a colon.
:subdivision-abbr:
The abbreviation of the subdivision of the organization that is responsible for this document.
:pub-address{_i}:
The address of the organization responsible for this document, if it overrides the default.. The number of this and subsequent attributes aligns with the number of :publisher{_i}:
Each line in a multi-line address must end with + \, e.g.
:pub-address: 1 Infinity Loop + \
California + \
United States of AmericaNOTE: As of 2.7.0, if :publisher: is semicolon-delimited, instead of using numbered attributes, this and subsequent publisher attributes are ignored.
:pub-phone{_i}:
The phone number of the organization responsible for this document, if it overrides the default.
:pub-fax{_i}:
The fax number of the organization responsible for this document, if it overrides the default.
:pub-email{_i}:
The email of the organization responsible for this document, if it overrides the default.
:pub-uri{_i}:
The URI of the organization responsible for this document, if it overrides the default.
:sponsor-address{_i}:
The address, phone number, fax number, email, URI of an organization sponsoring this document.
:sponsor-phone{_i}:
:sponsor-fax{_i}:
:sponsor-email{_i}:
:sponsor-uri{_i}:
:sponsor-subdivision{_i}:
The subdivision of the organization that is sponsoring this document. The subdivisions can be multiple (semicolon-delimited: processed via CSV, recognising quote marks), and they can also be hierarchical, with multiple levels of subdivision (comma-delimited, from larger to smaller) ; the different hierarchical levels can optionally be prefixed with type and a colon.
:authorizer{_i}:
The organisation that authorised this document.
:authorizer_logo{_i}:
The path to the logo of the authorizing organization, specified as an image file; the numbers in the attribute align to the :authorizer{_i}: attributes .
:authorizer-address{_i}:
The address, phone number, fax number, email, URI of an organization authorizing this document.
:authorizer-phone{_i}:
:authorizer-fax{_i}:
:authorizer-email{_i}:
:authorizer-uri{_i}:
:authorizer-subdivision{_i}:
The subdivision of the organization that is authorizing this document. The subdivisions can be multiple (semicolon-delimited: processed via CSV, recognising quote marks), and they can also be hierarchical, with multiple levels of subdivision (comma-delimited, from larger to smaller) ; the different hierarchical levels can optionally be prefixed with type and a colon.
Style customization
Inherited from Metanorma (all flavors) (26 attributes)
Fonts
:fonts:
Semicolon-delimited listing of fonts to be used for this document, in addition to the fonts predefined for the flavour.
Valid values are font names supported by Fontist. The full font name listing is available from the Fontist Formulas repository.
NOTE: This is currently only used in PDF generation.
The Euphemia font is an openly licensed font for end-users only commonly used to render Canadian Syllabics. The font name Euphemia is supported by Fontist for unattended install. In a document that contains Canadian Syllabics, the following attributes can be used.
:fonts: Euphemia
:font-license-agreement: agree-to-terms:font-license-agreement:
The response to the license agreement prompt by fontist for the fonts specified in :fonts:.
Valid values are:
no-install-fonts(default) do not install any additional fonts, even when listed in
:fonts:.agree-to-termsagree to all terms of the fonts that will be installed in an unattended manner.
continue-without-fontsdo not warn if a font is not available on the system.
:body-font:
Font for body text; will be inserted into CSS, overriding the default set for the particular Metanorma flavour.
:header-font:
Font for headers; will be inserted into CSS, overriding the default set for the particular Metanorma flavour.
:monospace-font:
Font for monospace; will be inserted into CSS, overriding the default set for the particular Metanorma flavour.
HTML
:html-stylesheet:
SCSS stylesheet to use for HTML output. Defaults to built-in stylesheet for the particular Metanorma flavour. Overriding is not recommended.
:html-stylesheet-override:
CSS stylesheet to use for HTML output, inserted after the built-in stylesheet for the particular Metanorma flavour, and can be used to override it.
:html-cover-page:
HTML template for cover page. Defaults to built-in template for the particular Metanorma flavour. Overriding is not recommended.
:html-intro-page:
HTML template for introductory section. Defaults to built-in template for the particular Metanorma flavour. Overriding is not recommended.
:scripts:
JavaScript scripts for HTML output. Defaults to built-in scripts for the particular Metanorma flavour. Overriding is not recommended.
:scripts-override:
JavaScript scripts for HTML output. Inserted after any built-in scripts for the particular Metanorma flavour, and can be used to override them.
:scripts-pdf:
JavaScript scripts for HTML to PDF output. Defaults to built-in scripts for the particular Metanorma flavour. Overriding is not recommended.
:presentation-metadata-papersize:
PDF document page size. Can be used to override the page size in built-in stylesheet for the particular Metanorma flavour. Valid values are: Letter, letter, A4 or a4.
LetterletterA4a4
:pdf-stylesheet:
XSLT stylesheet to use for PDF output. Defaults to built-in stylesheet for the particular Metanorma flavour. Overriding is not recommended.
:pdf-stylesheet-override:
XSLT stylesheet to use for PDF output, inserted after the built-in stylesheet for the particular Metanorma flavour, and can be used to override it.
Word
:word-stylesheet:
Primary SCSS stylesheet to use for Word output. Defaults to built-in stylesheet for the particular Metanorma flavour. Overriding is not recommended.
:standard-stylesheet:
Secondary SCSS stylesheet use for Word output. Defaults to built-in template for the particular Metanorma flavour. Overriding is not recommended.
:word-stylesheet-override:
CSS stylesheet to use for Word output, inserted after the built-in stylesheet for the particular Metanorma flavour, and can be used to override it.
:header:
Header and footer file for Word output. Defaults to built-in template the particular Metanorma flavour. Overriding is not recommended.
:word-cover-page:
Word template for cover page. Defaults to built-in template for the particular Metanorma flavour. Overriding is not recommended.
:word-intro-page:
Word template for introductory section. Defaults to built-in template for the particular Metanorma flavour. Overriding is not recommended.
:ulstyle:
Word CSS selector for unordered lists in supplied stylesheets. Defaults to value for built-in stylesheet. Overriding is not recommended.
:olstyle:
Word CSS selector for ordered lists in supplied stylesheets. Defaults to value for built-in stylesheet. Overriding is not recommended.
Cover page
:innercoverpage-image:
Same, for images to be included on the (PDF) inside cover page. Currently only supported for BSI.
:tocside-image:
Same, for images to be included on the (PDF) Table of Contents side page. Currently only supported for BSI.
:backpage-image:
Same, for images to be included on the (PDF) back page. Currently only supported for BSI, JIS.
Image handling
Inherited from Metanorma (all flavors) (5 attributes)
Data URI
:data-uri-image:
Encode all images in Metanorma XML and HTML output as inline data-URIs. Defaults to true..
:data-uri-maxsize:
Set the maximum permitted size of a Data URI-encoded image, in bytes. Defaults to 13981013 bytes (size of the Base-64 encoding of a 10 MB image). If set to 0, no maximum is enforced..
:data-uri-attachments:
Encode all attachments in Metanorma XML as inline data-URIs. Defaults to true..