Metanorma ISO document attributes
The document attributes listed below are unique to Metanorma's processing of ISO 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 ISO.
For an introduction to Metanorma AsciiDoc document attributes and how Metanorma uses them, see the corresponding topic.
See /flavors/iso/ref/identifier-patterns/ for identifier construction rules, stage-code mappings, and title-component guidance.
Document information
:docnumber:
The ISO document number without any part.
:docnumber:For ISO 8601-1:2019, the docnumber is 8601.
For ISO 24229:2022, the docnumber is 24229.
:partnumber:
The ISO document part number. This can be “part-subpart” if this is an ISO/IEC or IEC document.
:partnumber:For ISO 10303-2:2022, the partnumber is 2.
For ISO 8000-118, the partnumber is 118.
:docidentifier:
The full document identiifer assembled out of component metadata, rather than relying on the provided metadata to build it up.
NOTE: For a committee document, provide the N-document number for this attribute. The N-document number is normally specified to Metanorma as :tc-docnumber for drafts: see Distribution group.
:doctype:
Has its possible values defined by ISO deliverables: The different types of ISO publications (mandatory). Permitted types are:
international-standardInternational Standard (IS)
technical-specificationTechnical Specification (TR)
technical-reportTechnical Report (TR)
publicly-available-specificationPublicly Available Specification (PAS)
international-workshop-agreementInternational Workshop Agreement (IWA)
guideGuide (Guide)
technical-corrigendumisodoc ≥ v1.3.25Technical Corrigendum (Cor)
amendmentisodoc ≥ v1.3.25Amendment (Amd)
committee-documentmetanorma-iso ≥ v2.7.2Committee Document (for internal documents)
addendummetanorma-iso ≥ v2.8.8Addendum (Add)
supplementmetanorma-iso ≥ v3.4.6Supplement (Suppl)
extractmetanorma-iso ≥ v3.4.6Extract (Ext)
recommendationRecommendation (Rec)
:updates-document-type:
(only when doctype is set to amendment, technical-corrigendum, addendum, supplement, or extract) The document type that this amendment, technical corrigendum, addendum, supplement or extract is updating.
:docsubtype:
A subclass of doctype for which special processing rules apply. Valid values are listed below.
vocabularymetanorma-iso ≥ v1.8.2The "vocabulary" document type is defined in the ISO House Rules and title requirements defined in the ISO/IEC Directives, Part 2, 2018, 11.5.2. The initial clause of the terms section, “For the purposes of this document, the following terms and definitions apply”, is deleted; terminological entries are permitted outside of Clause 3.
:docstage:
The stage code for the document status (see International harmonized stage codes). Synonym of :status:. NOTE: Typically, ISO authors create Metanorma documents at stages 00 through 40 (PWI 00., AWI, NP, WD, CD, DIS). Documents at the final stages, 50 and 60 (FDIS, PRF, IS), are created by ISO Editorial Program Managers at ISO/CS (aka ISO EPMs, ISO Editors), and the EPMs are expected to provide the Project Leader with Authors using Metanorma are not expected to edit documents at those stages, and are not necessary in a normal submission process. These stages, however, can be used for mirroring and tracking of final stage and published standards, which many authors do.
00Preliminary stage (PWI).
10Proposal stage (NP, AWI).
20Preparatory stage (WD).
30Committee stage (CD).
40Enquiry stage (DIS).
50Approval stage (FDIS).
60Publication stage (
60.00is the PRF proof,60.60the published document).90Review stage.
95Withdrawal stage.
:docsubstage:
The substage code for the document status (see International harmonized stage codes). If this is left out, a substage of “00” is assumed, with the exception of stage “60” (published), where a substage of “60” is assumed. (“60.00” is the final proof “PRF stage”, “60.60” the published document “published”.)
00Assumed substage when omitted (except at stage
60).20Substage 20.
60Assumed substage at stage
60(60.00= PRF proof,60.60= published).90Substage 90.
92Substage 92.
93Substage 93.
98Substage 98.
99Substage 99.
:horizontal:
Whether the document is a horizontal standard.
trueThe document is a horizontal standard.
false(default) The document is not a horizontal standard.
:fast-track:
Whether the document is a fast-track standard.
trueThe document is a fast-track standard.
false(default) The document is not a fast-track standard.
:document-scheme:
Specifies the version of the ISO document specification that should be used in generating the Metanorma document.
When omitted, the scheme to apply is inferred from the :copyright-year: document attribute, if set. Otherwise, the current default scheme is applied.. NOTE: Currently used only to specify the PDF layout.
2024(default) Latest document layout as of 2024 (default)
2013Document layout used from 2013 to early 2024.
2012Document layout used from mid-2012 to 2013. It is equivalent to the
1989layout with a logo change.1989Document layout used from 1989 to mid-2012.
1987Document layout used from 1987 to 1989.
1972Document layout used from 1972 to 1987.
1951Document layout used from 1951 to 1971. The first available published ISO layout.
1979Document layout used from 1979 to 1987.
:semantic-metadata-feedback-link:
(only for document-scheme value 2024) Specifies the URL for any feedback to be provided for the ISO document. In the PDF layout of 2024 it is used to generate cover page QR code.
:library-ics:
The ICS (International Categorization for Standards) number for the document. There may be more than one ICS for a document; if so, they should be comma-delimited.
:classification:
(for document-scheme values of 1989 and prior, and a publication date before 1994)
The Universal Decimal Classification (UDC) code(s) for the document. In publication years prior to 1994, ISO used UDC instead of ICS (which was published in 1992) in publications. This corresponds to document schemes of 1989 and prior.
UDC is a rather complex scheme with logical operators.
Values are prefixed with UDC:. Note that UDC uses punctuation symbols, including colon, but not comma.
If multiple values are present, the classification token is repeated, and comma delimited.
NOTE: The exception is that ISO | CIE co-publications use UDCs in addition to ICS as CIE uses UDC.
:classification: UDC:536.5.081:531.71UDC code for ISO 3402:1991
:classification: UDC:663.971/.976:620.1:551.511.12UDC code for ISO 9833:1993
:classification: UDC:635.61:664.8.037(083.13)UDC codes for ISO 10526:2007 | CIE S 014-2/E:2006
:classification: UDC:535.65:006, UDC:535.643.2:price-code:
Price code group of publication. Valid values are as documented in the IEC Data Feeds: Technical documentation document
:iso-cen-parallel:
Indication that the project is under the ISO/CEN Vienna Agreement. This means that the document is developed in parallel by ISO and CEN and goes through parallel approval processes.
Document identifier / Publisher
:publisher:
Publisher of the document. Accepted values are:
In the case of IEC/ISO, both :publisher: and :copyright-holder: need to be set for the document identifier and the logos to be in correct order.
NOTE: ISO is no longer forced to appear first.
ISOISO.
ISO;IECJoint ISO and IEC. (e.g. ISO/IEC JTC 1 and ISO/IEC JTC 2 documents)
IEC;ISOJoint IEC and ISO. (e.g. IEC/ISO SMART documents)
ISO;IEC;IEEEJoint ISO/IEC/IEEE.
ISO;IEEEJoint ISO/IEEE.
ISO;SAEJoint ISO/SAE.
IWAInternational Workshop Agreement.
Title
title-intro-{en,fr}
The introductory component of the English or French title of the document.
title-main-{en,fr}
The main component of the English or French title of the document (mandatory).
title-part-{en,fr}
The English or French title of the document part.
title-complement-{en,fr}
The English or French complementary title
title-amendment-{en,fr}
(only when doctype is set to amendment or technical-corrigendum) The English or French title of the amendment
title-addendum-{en,fr}
(only when doctype is set to addendum) The English or French title of the addendum
title-supplement-{en,fr}
(only when doctype is set to supplement) The English or French title of the supplement
title-extract-{en,fr}
(only when doctype is set to extract) The English or French title of the extract
:amendment-number:
(only when doctype is set to amendment) The number of the amendment
:addendum-number:
(only when doctype is set to addendum) The number of the addendum
:supplement-number:
(only when doctype is set to supplement) The number of the supplement
:extract-number:
(only when doctype is set to extract) The number of the extract
:corrigendum-number:
(only when doctype is set to technical-corrigendum) The number of the technical corrigendum
Inherited from Metanorma (all flavors) (23 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-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.
:edition:
The document edition.
: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.
: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. .
:status:
The status of the document; e.g. draft, published.
: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.
: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.
:draft:
If present, reviewer notes will be rendered (otherwise those are suppressed). Is also ued as a legacy equivalent of :version:.
Authorship and editorial information
Drafting group
:secretariat:
The national body acting as the secretariat for the document in the drafting stage.
:technical-committee-number:
The number of the relevant ISO technical committee (or equivalent body).
:technical-committee-type:
TCThe type of the relevant technical committee or equivalent body. Typical values are:
TC(default) technical committee
JTCjoint technical committee
PCproject committee
JPCjoint project committee
SEGstandards evaluation group (IEC)
JSEGjoint standards evaluation group (IEC/ISO)
othermetanorma-iso ≥ v2.3.4group not otherwise described (type acronym omitted from rendering)
:technical-committee:
The name of the relevant ISO technical committee or equivalent (mandatory)
:technical-committee-agency:
The agency that the technical committee lies under, if it is other than the home agency (ISO for metanorma-iso, IEC for metanorma-iec) Can be given as an abbreviation if it is IEC or ISO.
:technical-committee-agency-abbr:
The abbreviation of the agency that the technical committee lies under. Should be given if the agency is other than IEC or ISO.
:subcommittee-number:
The number of the relevant ISO subcommittee.
:subcommittee-type:
SCThe type of the relevant ISO subcommittee. Typical values are:
SC(default) subcommittee
JSCjoint subcommittee
othermetanorma-iso ≥ v2.3.4group not otherwise described (type acronym omitted from rendering)
:subcommittee:
The name of the relevant ISO subcommittee.
:workgroup-number:
The number of the relevant ISO working group.
:workgroup-type:
WGThe type of the relevant ISO working group. Typical values are:
WG(default) working group (e.g. ISO/TC 154/WG 5)
JWGjoint working group (e.g. ISO/TC 154/JWG 1)
JAGjoint advisory group
AGadvisory group (e.g. ISO/TC 211/AG 10)
AHGad-hoc group
SWGspecial working group
SGstrategic/steering group
MAmaintenance agency (e.g. ISO 3166/MA)
CORGco-ordination group
JCGjoint co-ordination group
CAGchair advisory group (e.g. ISO/TC 154/CAG)
WSworkstream (e.g. IEC/ISO JSEG 15/WS 1)
othermetanorma-iso ≥ v2.3.4group not otherwise described (type acronym omitted from rendering)
:workgroup:
The name of the relevant ISO working group. In the case of multiple responsible groups (technical committees, subcommittees, working groups), the :technical-committee:, :subcommittee: and :workgroup: attributes can be used to encode multiple groups by suffixing _n to the attribute where n is a sequential number after 1. Each suffix corresponds to one nesting grouping of technical committee, subcommittee, and working group.
For ISO/TC 211/WG 9:
:technical-committee-number: 211
:technical-committee: Geographic information/Geomatics
:workgroup-number: 9
:workgroup: Information managementSetting a responsible technical committee, subcommittee and working group (2)
For ISO/TC 184/SC 4/WG 12:
:technical-committee-number: 184
:technical-committee: Automation systems and integration
:subcommittee-type: SC
:subcommittee-number: 4
:subcommittee: Industrial data
:workgroup-type: WG
:workgroup-number: 12
:workgroup: STEP product modelling and resourcesSetting multiple responsible technical committees
:technical-committee: Widgets etc.
:technical-committee_agency: Institute of Electrical and Electronic Engineers
:technical-committee_agency_abbr: IEEE
:technical-committee-number_2: 184
:technical-committee_2: Automation systems and integration
:subcommittee-type_2: SC
:subcommittee-number_2: 4
:subcommittee_2: Industrial data
:technical-committee-number_3: 184
:technical-committee_3: Automation systems and integration
:technical-committee_agency_3: IEC
:subcommittee-type_3: SC
:subcommittee-number_3: 5
:subcommittee_3: Interoperability, integration, and architectures for enterprise systems and automation applicationsApproval group
:approval-agency:
ISOThe agency or agencies of the approval group. Defaults to ISO if not supplied; the only alternate value is ISO/IEC, for JTCs. (For the drafting group, the agencies are taken from the publisher attribute.)
:approval-technical-committee-number:
The number of the relevant ISO technical committee.
:approval-technical-committee-type:
TCThe type of the relevant technical committee. Defaults to TC if not supplied.
:approval-technical-committee:
The name of the relevant ISO technical committee.
:approval-subcommittee-number:
The number of the relevant ISO subcommittee.
:approval-subcommittee-type:
SCThe type of the relevant ISO subcommittee. Defaults to SC if not supplied.
:approval-subcommittee:
The name of the relevant ISO subcommittee.
:approval-workgroup-number:
The number of the relevant ISO working group.
:approval-workgroup-type:
WGThe type of the relevant ISO working group. Defaults to WG if not supplied.
:approval-workgroup:
The name of the relevant ISO working group.
Distribution group
:tc-docnumber:
The document number assigned by a distribution group (also called the “N-document number” or the “N-number”), typically a Technical Committee, a Subcommittee or a Working Group. Must include the short reference of the distribution group, since documents may circulate widely;
For a document circulated in ISO/TC 154 as "N 1218" (instead of "N 1218"):
:tc-docnumber: ISO/TC 154 N 1218Document relations
:revises:
ISOSTS revises
:replaces:
ISOSTS replaces
:amends:
ISOSTS amends
:corrects:
ISOSTS corrects
:informatively-cited-in:
ISOSTS informativelyReferencedBy
:informatively-cites:
ISOSTS informativelyReferences
:normatively-cited-in:
ISOSTS normativelyReferencedBy
:normatively-cites:
ISOSTS normativelyReferences
:identical-adopted-from:
ISOSTS isIdenticalNationalStandardOf
:modified-adopted-from:
ISOSTS isModifiedNationalStandardOf
:successor-of:
ISOSTS isProgressionOf
:manifestation-of:
ISOSTS isPublishedFormatOf
:supersedes:
ISOSTS supersedes
:annotation-of:
ISOSTS commentOn
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.
Visual appearance
:iso-word-template:
For Word output, pick the styles template to use. Options are:
simpleCommonly called the "Simple Template". Using the styles of the ISO Simple Template (default for stages before 40).
disCommonly called the "DIS Template". Using the styles of the “ISO Edited DIS template”, introduced by the ISO editors at the DIS stage of editing, through to publication. (default for stages 40 through 95)
:iso-word-bg-strip-color:
true(only for the dis template) The “ISO Edited DIS template” introduces background colouring of spans in order to ensure correct semantic markup, as validated by ISO editors.
truemetanorma-iso ≥ v2.2.3(default) Remove background colors of semantically-annotated spans (equivalent to "Pattern: Clear"). This option is necessary for draft submission of the stage 40 onwards (DIS/FDIS) documents to ISO editors..
falseRetain background colors of semantically-annotated spans.
:presentation-metadata-linenumbers:
falseAllows to render the line numbers for the document text. NOTE: Currently used only for the PDF layout.
trueDisplay the line numbers for the document text.
false(default) Don't display the document line numbers.
Validation
:validate-years:
If not set, four-digit numbers that could plausibly be years (between 1900 and 2050) are not warned about. If set, they are included in validation.
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) (6 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.
:language:
enTwo-letter code (ISO 639-1) of the language the document is written in. Defaults to en.
: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>. .
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) (27 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
:coverpage-image:
Comma-delimited list of image locations, for images to be included on the (PDF) cover page. All image locations are relative to the source document. Currently only supported for BSI, ITU, JIS, Plateau. If the supplied image(s) is to replace the cover page(s) of the document in its entirety, and already includes title information, add the attribute :presentation-metadata-full-coverpage-replacement: true (supported for all flavours).
: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..