Method to customize document identifiers

[ronaldtse]

Users who use this gem will want to customize their document identifiers. Let's use the ISO document identifier scheme as an example to adapt for.

The ISO document identifier scheme differs by stage:

Template for unpublished:

• ISO {stage} {report number}[-{part number}]:{year}

Template for published:

• ISO {stage} {report number}[-{part number}]:{year}

Examples:

• ISO CD XXXX–2 (“Committee Draft of ISO XXXX Part 2”);
• ISO YYYY-3:2020 (“ISO YYYY Part 3, 2020 edition”).

Template for unpublished amendments:

• ISO {stage} {report number}[-{part number}]:{year}/{“Cor”|“Amd”} {number}:{year}

For example:

• ISO/IEC 14888-2:2008/Cor 1:2015 (“First correction—issued in 2015—to ISO/IEC 14888 Part 2, 2008 edition”);
• ISO/IEC 18031:2011/Amd 1:2017 (“First amendment—issued in 2017—to ISO/IEC 18031, 2011 edition”)

We can use a YAML structure to express this.

If it is simple:

docid_scheme: "{orgid} {docnumber}"

If more complex:

docid_scheme:
  - doctype: [ standard, technical-report ]
    stages:
       published: "ISO {report number}[-{part number}]:{year}"
       working-draft: "ISO {stage} {report number}[-{part number}]:{year}"
       committee-draft: "ISO {stage} {report number}[-{part number}]:{year}"
    ...
  - doctype: [ amendment ]
    stages:
      published: "ISO {report number}[-{part number}]:{year}/{“Cor”|“Amd”} {number}:{year}"
      working-draft: "ISO {stage} {report number}[-{part number}]:{year}/{“Cor”|“Amd”} {number}:{year}"
      committee-draft: "ISO {stage} {report number}[-{part number}]:{year}/{“Cor”|“Amd”} {number}:{year}"
    ...

This ticket needs more discussion when it gets tackled. Ping me for details!

[opoudjis]

This ticket is an elaboration of #18

[ronaldtse]

This implementation should support mechanisms including:

• Provide URN for every "ISO" and "ISO/IEC" document according to RFC 5141 relaton/relaton-iso#85
• https://github.com/metanorma/metanorma-nist/issues/168

[opoudjis]

This only makes sense if you can identify recurring attributes, preferably populated as document attributes, that can fit into a YAML one-liner. I suspect that in the general case, it will not work; you certainly could never implement ISO identifiers in it.