Metanorma ISO document attributes
Note
|
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. |
Document information
:docnumber:
-
The ISO document number without any part.
Example 1. Example of setting:docnumber:
For ISO 8601-1:2019, the
docnumber
is8601
.For ISO 24229:2022, the
docnumber
is24229
. :partnumber:
-
The ISO document part number. This can be “part-subpart” if this is an ISO/IEC or IEC document.
Example 2. Example of setting:partnumber:
For ISO 10303-2:2022, the
partnumber
is2
.For ISO 8000-118, the
partnumber
is118
. :doctype:
-
Has its possible values defined by ISO deliverables: The different types of ISO publications (mandatory). Permitted types are:
international-standard
-
International Standard (IS)
technical-specification
-
Technical Specification (TR)
technical-report
-
Technical Report (TR)
publicly-available-specification
-
Publicly Available Specification (PAS)
international-workshop-agreement
-
International Workshop Agreement (IWA)
guide
-
Guide (Guide)
technical-corrigendum
-
Technical Corrigendum (Cor) [added in https://github.com/metanorma/isodoc/releases/tag/v1.3.25]
amendment
-
Amendment (Amd) [added in https://github.com/metanorma/isodoc/releases/tag/v1.3.25]
:updates-document-type:
-
(only when
doctype
is set toamendment
ortechnical-corrigendum
) The document type that this amendment or technical corrigendum is updating [added in https://github.com/metanorma/isodoc/releases/tag/v1.3.25]. :docsubtype:
-
A subclass of doctype for which special processing rules apply.
vocabulary
-
The "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. [added in https://github.com/metanorma/metanorma-iso/releases/tag/v1.8.2]
:docstage:
-
The stage code for the document status (see International harmonized stage codes). Synonym of
:status:
.NoteTypically, ISO authors create Metanorma documents at stages 00
through40
(PWI00.
, AWI, NP, WD, CD, DIS). Documents at the final stages,50
and60
(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. :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”.)
:horizontal:
-
Whether the document is a horizontal standard. [added in https://github.com/metanorma/metanorma-iso/releases/tag/v1.5.13]
true
-
The document is a horizontal standard.
false
-
(default) The document is not a horizontal standard.
Document identifier
General
The ISO document identifier is assembled out of these metadata elements:
- publisher
-
publisher of the document
- document stage
-
stage of development of document, according to the Harmonized Stage Codes
- document number
-
numeric identifier of document
- update number
-
serial number of update (for amendments and technical corrigenda)
- document type
-
type of ISO deliverable
- copyright year
-
year of publication of document
- language
-
language of document
Publisher
This is the abbreviation of the publishing organization, typically ISO
if
ISO is the only publisher.
If the document is published under co-publishing agreements, it can contain the
abbreviations of other publishing SDOs, delimited by /
after ISO
. An IWA
document has publisher abbreviation of IWA
.
The prefixes occur in the order that they are given in publisher
.
Attributes:
:publisher:
-
Publisher of the document. Accepted values are:
ISO
-
ISO.
ISO/IEC
-
Joint ISO and IEC. (e.g. ISO/IEC JTC 1 and ISO/IEC JTC 2 documents)
IEC/ISO
-
Joint IEC and ISO. (e.g. IEC/ISO SMART documents)
ISO/IEC/IEEE
-
Joint ISO/IEC/IEEE.
ISO/IEEE
-
Joint ISO/IEEE.
ISO/SAE
-
Joint ISO/SAE.
IWA
-
International Workshop Agreement.
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.
:publisher: IEC;ISO
:copyright-holder: IEC;ISO
Note
|
ISO is no longer forced to appear
first [added in https://github.com/metanorma/metanorma-iso/releases/tag/v2.0.9].
|
Document type and stage
ISO document stages in document identifiers are mapped as follows.
- International Standard
-
00.00
to00.99
-
“PWI”
10.00
to10.98
-
“NP”
10.99
to20.00
-
“AWI”
20.20
to20.99
-
“WD”
30.00
to30.99
-
“CD”
40.00
to40.99
-
“DIS”
50.00
to50.99
-
“FDIS”
60.00
-
“PRF”
60.60
-
empty designation
- Technical Specification, Technical Report
-
00.00
to00.99
-
“PWI {TR,TS}”
10.00
to10.98
-
“NP {TR,TS}”
10.99
to20.00
-
“AWI {TR,TS}”
20.20
to20.99
-
“WD {TR,TS}”
30.00
to30.99
-
“CD {TR,TS}”
40.00
to40.99
-
TS/TRs do not have DIS stage because they are not international standards.
50.00
to50.99
-
TS/TRs do not have FDIS stage because they are not international standards.
60.00
-
“PRF {TR,TS}”
60.60
-
“{TR,TS}”
- Amendment
-
00.00
to00.99
-
“{base-document-id}/PWI Amd {num}”
10.00
to10.98
-
“{base-document-id}/NP Amd {num}”
10.99
to20.00
-
“{base-document-id}/AWI Amd {num}”
20.20
to20.99
-
“{base-document-id}/WD Amd {num}”
30.00
to30.99
-
“{base-document-id}/CD Amd {num}”
40.00
to40.99
-
“{base-document-id}/DAmd {num}”
50.00
to50.99
-
“{base-document-id}/FDAmd {num}”
60.00
-
“{base-document-id}/PRF Amd {num}”
60.60
-
“{base-document-id}/Amd {num}”
- Technical Corrigendum
-
00.00
to00.99
-
“{base-document-id}/PWI Cor {num}”
10.00
to10.98
-
“{base-document-id}/NP Cor {num}”
10.99
to20.00
-
“{base-document-id}/AWI Cor {num}”
20.20
to20.99
-
“{base-document-id}/WD Cor {num}”
30.00
to30.99
-
“{base-document-id}/CD Cor {num}”
40.00
to40.99
-
“{base-document-id}/DIS Cor {num}”
50.00
to50.99
-
“{base-document-id}/FDCor {num}”
60.00
-
“{base-document-id}/PRF Cor {num}”
60.60
-
“{base-document-id}/Cor {num}”
When the Publisher element contains a “slash” (“/”), the separation in front of the document stage will be converted into an empty space.
-
ISO/NP 33333
butISO/IEC NP 33333
-
ISO/NP TR 33333
butISO/IEC NP TR 33333
Document stage iteration number
According to ISO Directives Part 1 (11ed), SE.2:
“Working drafts (WD), committee drafts (CD), draft International Standards (DIS), final draft International Standards (FDIS) and International Standards” and "`Successive DIS on the same subject will carry the same number but will be distinguished by a numerical suffix (.2, .3, etc.).
Metanorma names the stage iteration number accordingly for all stages, which is patterned as:
-
No suffix if iteration is 1:
{document stage}
-
Suffix including iteration number after 1:
{document stage}.{iteration number}
Once the document is published (stage 60 substage 60), no status abbreviation is given.
Full document identifier patterns
The patterns are as follows:
- International Standard
-
{publisher} (/{document type and stage})? ({document number}) (- {part number})? (: {copyright year}) ({ISO 639 language code})?
Example 5. Examples of ISO International Standard document identifiers-
ISO/IEEE/FDIS 33333-2
-
ISO/IEEE 33333-2:2030(E)
-
- Technical Report, Technical Specification
-
{publisher} (/{document type and stage}) ({document number}) (- {part number})? (: {copyright year}) ({ISO 639 language code})?
Example 6. Examples of ISO TR and TS document identifiers-
ISO/IEC/FDIS TS 33333-2
-
ISO/TR 33333-2:2030(E)
-
ISO/IEC TR 33333-2:2030(E)
-
- Amendments, Technical Corrigendum
-
{source document ID}/{document type and stage} {update number} (: {copyright year}) ({ISO 639 language code})?
Example 7. Examples of ISO Amendment and Technical Corrigendum document identifiers-
ISO 33333-2:2030/DIS Cor 2:2031
-
ISO 33333-2:2030/Cor 2:2032
-
ISO/IEC 33333-2:2030/Cor 2:2032
-
Title
ISO deliverables have titles that support different title components, and can be multilingual:
-
Introductory title (optional)
-
Main title (mandatory)
-
Part title (optional)
Note
|
In the case where an ISO deliverable title has multiple elements, care should be taken when assigning them to title components. For instance, a not necessarily mean that the document has a part title. |
ISO/IEC 27001:2022 has the title: "Information security, cybersecurity and privacy protection — Information security management systems — Requirements" that is encoded as:
:title-intro-en: Information security, cybersecurity and privacy protection -- Information security management systems
:title-main-en: Information security management systems -- Requirements
Notice that there is no part title, as it is not a part standard (e.g. "Part 1").
ISO 10303-11:2004 has the title: "Industrial automation systems and integration — Product data representation and exchange — Part 11: Description methods: The EXPRESS language reference manual" and is encoded as:
:title-intro-en: Industrial automation systems and integration
:title-main-en: Product data representation and exchange
:title-part-en: Description methods: The EXPRESS language reference manual
Since this is a part standard ("Part 11"), the last title element is assigned as the part title.
Attributes:
: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-amendment-{en,fr}:
-
(only when
doctype
is set toamendment
ortechnical-corrigendum
) The English or French title of the amendment [added in https://github.com/metanorma/isodoc/releases/tag/v1.3.25] :amendment-number:
-
(only when
doctype
is set toamendment
) The number of the amendment [added in https://github.com/metanorma/isodoc/releases/tag/v1.3.25] :corrigendum-number:
-
(only when
doctype
is set totechnical-corrigendum
) The number of the technical corrigendum [added in https://github.com/metanorma/isodoc/releases/tag/v1.3.25]
Note
|
These :title-* document attributes are used instead
of the metanorma-standoc :title: attribute and the default AsciiDoc title
(the first line of the document header, prefixed with = ),
due to the complexity of ISO deliverable titles.
|
Note
|
This document template presupposes authoring in English; a different template will be needed for French, including French titles of document components such as annexes. |
Authorship and editorial information
General
There are potentially three types of groups involved in an ISO deliverable:
-
the drafting group: where the deliverable is created and worked on (mandatory);
-
the approval group: where the deliverable gets approved for publication, typically a TC or SC (optional);
-
the distribution group: where the deliverable is distributed for review, depending on where the deliverable gets distributed to (optional).
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.
:technical-committee-type:
-
The type of the relevant technical committee. Typical values are:
TC
-
(default) technical committee
JTC
-
joint technical committee
PC
-
project committee
JPC
-
joint project committee
:technical-committee:
-
The name of the relevant ISO technical committee (mandatory)
:subcommittee-number:
-
The number of the relevant ISO subcommittee.
:subcommittee-type:
-
The type of the relevant ISO subcommittee. Typical values are:
SC
-
(default) subcommittee
JSC
-
joint subcommittee
:subcommittee:
-
The name of the relevant ISO subcommittee.
:workgroup-number:
-
The number of the relevant ISO working group.
:workgroup-type:
-
The type of the relevant ISO working group. Typical values are:
WG
-
(default) working group
JWG
-
joint working group
JAG
-
joint advisory group
AG
-
advisory group
AHG
-
ad-hoc group
SWG
-
special working group
SG
-
strategic/steering group
MA
-
maintenance agency
CORG
-
co-ordination group
JCG
-
joint co-ordination group
CAG
-
chair advisory group
: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 wheren
is a sequential number after 1.Example 10. Setting a responsible technical committee, subcommittee and working group (1)For ISO/TC 211/WG 9:
:technical-committee-number: 211 :technical-committee: Geographic information/Geomatics :workgroup-number: 9 :workgroup: Information management
Example 11. Setting 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 resources
Example 12. Setting multiple responsible technical committees:technical-committee-number: 184 :technical-committee: Automation systems and integration :subcommittee-type: SC :subcommittee-number: 4 :subcommittee: Industrial data :technical-committee-number_2: 184 :technical-committee_2: Automation systems and integration :subcommittee-type_2: SC :subcommittee-number_2: 5 :subcommittee_2: Interoperability, integration, and architectures for enterprise systems and automation applications
Approval group
The approval group is typically the ISO Technical Committee, Subcommittee or Working Group responsible for approving a draft. The method of specifying metadata of the approval group is identical to that of specifying the drafting group (see Drafting group).
If at least the :approval-technical-committee-number:
is not provided, the
editing groups are assumed to also be the
approval group. [added in https://github.com/metanorma/metanorma-iso/releases/tag/v2.1.2].
:approval-agency:
-
The agency or agencies of the approval group. Defaults to
ISO
if not supplied; the only alternate value isISO/IEC
, for JTCs. (For the drafting group, the agencies are taken from thepublisher
attribute.) :approval-technical-committee-number:
-
The number of the relevant ISO technical committee.
:approval-technical-committee-type:
-
The 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:
-
The 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:
-
The type of the relevant ISO working group. Defaults to
WG
if not supplied. :approval-workgroup::
-
The name of the relevant ISO working group.
For ISO/TC 154/WG 5 "Date and time":
:approval-technical-committee-type: TC
:approval-technical-committee-number: 154
:approval-technical-committee: Processes, data elements and documents in commerce, industry and administration
:approval-workgroup-type: WG
:approval-workgroup-number: 5
:approval-workgroup: Date and time
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;
Example 14. Setting the N-document number for a distribution groupFor a document circulated in ISO/TC 154 as "N 1218" (instead of "N 1218"):
:tc-docnumber: ISO/TC 154 N 1218
Document relations
Metanorma allows for encoding of document relations supported by ISOSTS.
They are populated in the same manner of other document relation attributes. Please refer to Document relations for details.
The following document relations are compatible with ISOSTS with their individual mappings shown [added in https://github.com/metanorma/metanorma-iso/releases/tag/v1.10.4].
: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
:related-directive:
-
ISOSTS
relatedDirective
:related-mandate:
-
ISOSTS
relatedMandate
:supersedes:
-
ISOSTS
supersedes
:annotation-of:
-
ISOSTS
commentOn
:related:
-
ISOSTS
""
(empty value)
:informatively-cited-in: ISO 639;IEC 60050-112;W3C XML,Extensible Markup Language (XML)
Visual appearance
:iso-word-template:
-
For Word output, pick the styles template to use [added in https://github.com/metanorma/metanorma-iso/releases/tag/v2.1.2]. Options are:
simple
-
using the styles of the ISO Simple Template (default for stages before 40)
dis
-
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:
-
The “ISO Edited DIS template” introduces background colouring of spans in order to ensure correct semantic markup, as validated by ISO editors.
true
-
(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. [added in https://github.com/metanorma/metanorma-iso/releases/tag/v2.2.3].
false
-
Retain background colors of semantically-annotated spans.