Metanorma
On this page

ISO identifier patterns

This page collects the identifier-construction rules, stage-code mappings, and title-component guidance that accompany the Metanorma ISO document attributes reference. The attributes themselves (including :publisher:, the :title-* family, and the committee metadata attributes) are documented there.

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, addenda, 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. (These will be rendered with the expected / in the document identifier.)

The prefixes occur in the order that they are given in publisher.

The :publisher: attribute and its accepted values are documented in the ISO document attributes reference.

.Setting IEC and ISO as copyright holders for an IEC/ISO document

Example
:publisher: IEC;ISO
:copyright-holder: IEC;ISO

Document type and stage

ISO document stages in document identifiers are mapped as follows.

International Standard
00.00 to 00.99
“PWI”
10.00 to 10.98
“NP”
10.99 to 20.00
“AWI”
20.20 to 20.99
“WD”
30.00 to 30.99
“CD”
40.00 to 40.99
“DIS”
50.00 to 50.99
“FDIS”
60.00
“PRF”
60.60
empty designation
Technical Specification, Technical Report
00.00 to 00.99
“PWI {TR,TS}”
10.00 to 10.98
“NP {TR,TS}”
10.99 to 20.00
“AWI {TR,TS}”
20.20 to 20.99
“WD {TR,TS}”
30.00 to 30.99
“CD {TR,TS}”
40.00 to 40.99
TS/TRs do not have DIS stage because they are not international standards.
50.00 to 50.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 to 00.99
“{base-document-id}/PWI Amd {num}”
10.00 to 10.98
“{base-document-id}/NP Amd {num}”
10.99 to 20.00
“{base-document-id}/AWI Amd {num}”
20.20 to 20.99
“{base-document-id}/WD Amd {num}”
30.00 to 30.99
“{base-document-id}/CD Amd {num}”
40.00 to 40.99
“{base-document-id}/DAmd {num}”
50.00 to 50.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 to 00.99
“{base-document-id}/PWI Cor {num}”
10.00 to 10.98
“{base-document-id}/NP Cor {num}”
10.99 to 20.00
“{base-document-id}/AWI Cor {num}”
20.20 to 20.99
“{base-document-id}/WD Cor {num}”
30.00 to 30.99
“{base-document-id}/CD Cor {num}”
40.00 to 40.99
“{base-document-id}/DIS Cor {num}”
50.00 to 50.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.

.Differentiating single and dual publisher document identifiers

Example
  • ISO/NP 33333 but ISO/IEC NP 33333
  • ISO/NP TR 33333 but ISO/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})?

.Examples of ISO International Standard document identifiers

Example
  • 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})?

.Examples of ISO TR and TS document identifiers

Example
  • ISO/IEC/FDIS TS 33333-2
  • ISO/TR 33333-2:2030(E)
  • ISO/IEC TR 33333-2:2030(E)
Amendment, Technical Corrigendum, Addendum
{source document ID}/{document type and stage} {update number} (: {copyright year}) ({ISO 639 language code})?

.Examples of ISO Amendment, Technical Corrigendum, and Addendum document identifiers

Example
  • ISO 33333-2:2030/DIS Amd 2:2031
  • ISO 33333-2:2030/Cor 2:2032
  • ISO/IEC 33333-2:2030/Add 2:2032

Title

ISO deliverables have titles that support different title components, and can be multilingual:

  • Introductory title (optional)
  • Main title (mandatory)
  • Complemnentary title or Part title (optional)
Note
A complementary title and a part title do not coexist.
Note
As per the latest ISO/IEC DIR 2 of 2024, a new notion of the "complementary title" has been introduced, which is used to represent a third element of titles for documents that are not parts themselves. The examples below have hence been updated accordingly to such new feature supported by Metanorma.
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 title with 3 elements does not necessarily mean that the document has a part title. It may be the case where the introductory title has two elements, or the complementary title has two elements, or other cases.
Example of title with a complementary 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
:title-main-en: Information security management systems
:title-complementary-en: Requirements

Notice that there is a complementary title not a part title, as it is not a part standard (e.g. "Part 1").

Another example of title with a complementary title

ISO/TS 32004:2024 "Document management -- Portable Document Format -- Integrity protection in encrypted documents in PDF 2.0" is encoded as:

:title-intro-en: Document management
:title-main-en: Portable Document Format
:title-complementary-en: Integrity protection in encrypted documents in PDF 2.0
Example of title with a part title

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, not a complementary title.

The :title-* document attributes are documented in the ISO document attributes reference.

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:

  1. the drafting group: where the deliverable is created and worked on (mandatory);
  2. the approval group: where the deliverable gets approved for publication, typically a TC or SC (optional);
  3. the distribution group: where the deliverable is distributed for review, depending on where the deliverable gets distributed to (optional).

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 the drafting group attributes in the ISO document attributes reference).

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].

.Example of setting approval group metadata

Example

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

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]. The relation attributes (:revises:, :replaces:, :amends:, and so on) are documented in the ISO document attributes reference.

.Example encoding of a document relationship

Example
:informatively-cited-in: ISO 639;IEC 60050-112;W3C XML,Extensible Markup Language (XML)