search

metanorma / pubid-iso

Implementation of ISO pubid
BSD 2-Clause "Simplified" License
1 stars 0 forks source link

Return typed_stage_abbrev for identifier #126

Closed mico closed 2 years ago

mico commented 2 years ago

closes #125

ronaldtse commented 2 years ago

I think we need to differentiate what data we need to produce here. As per https://github.com/metanorma/pubid-iso/issues/128#issuecomment-1267880492:

There are a few things that relate to type and stage in an ISO PubID:

  1. typed_stage_abbr, is the abbreivation of the combination of the type and stage name of a document, like "DTR"
  2. typed_stage_name, is a combination of the type and stage name of a document, like "Draft Technical Report"
  3. the actual stage name in the International Harmonized Stage Code (IHSC) system, i.e. Stage 30 is "Committee" (https://www.iso.org/stage-codes.html)
  4. the document name of the ISO deliverable at a particular IHSC code, i.e. a document at stage 30 will be called a "Committee draft".
  5. the document abbreviation of the ISO deliverable at a particular IHSC code, i.e. a document at stage 30 will be called a "CD". Notice that this is not to be rendered because in case of a CD Amendment the rendered typed_stage_abbr is "CDAM" not "CD".

We need to distinguish these properly.

mico commented 2 years ago

Added typed_stage_name closes #128

ronaldtse commented 2 years ago

Looks much better!

ronaldtse commented 2 years ago

Let's merge this first and leave the remaining work at #133. Thanks!