metanorma / pubid-nist

BSD 2-Clause "Simplified" License
1 stars 2 forks source link

NIST PubID scheme: identifiers that need clarification #28

Open ronaldtse opened 2 years ago

ronaldtse commented 2 years ago

A number of Tech Pubs have current pub IDs that contain both Edition/Revision and also Year. Some of them have Month information.

What should the patterns be for those? I’m listing them below where the left shows the original pub ID, the right shows a proposed PubID.

What do we do with the month when given? (still an issue in PubID 1.0)

Should we omit the year information if there is an edition number already provided? (still an issue in PubID 1.0)

Should we omit the edition number if it is 1? (still an issue in PubID 1.0)

Should we omit the revision number if it was mis-marked? (still an issue in PubID 1.0)

Should we automatically assign the edition number if the edition is given as a year? (No, an edition can be yyyy or 1-9, described in #155)

Sometimes revision numbers are inconsistently assigned: (still an issue in PubID 1.0, source data needs to be fixed)

Should the Part number, if in alphabet, be capitalised? (now decided in #154)

Should PubID fix minor issues like these? (still an issue in PubID 1.0, source data needs to be fixed)

“Part” representation sometimes goes with “p” or “pt”: (decided in #87)

There are also some funny ones that need consideration: (still an issue in PubID 1.0, potentially data source issues)

ronaldtse commented 2 years ago

Updated list according to Final PubID scheme. Remaining questions/identifiers have been sent for clarification.