NIST publication identifiers ("NIST PubID")

The only prerequisite is to have Ruby installed. Please refer to the official Ruby installation guide.

The pubid-nist tool can be installed as follows.

Now you should be able to use the pubid-nist command.

When called without arguments (or as pubid-nist help) the help screen will be shown.

The command pubid-nist provides a convert subcommand that converts a legacy Nist Tech Pubs identifier into the NIST PubID format.

Here’s how it can be used:

The convert command also supports DOI conversion.

In addition to outputting PubID short style, we can also output other styles and formats of the resulting PubID.

This is the nice part — a single command that generates the full table of converted PubIDs from the NIST Tech Pubs database, comprising of 19,333 entries.

The report command can be used as follows:

The purpose of this command is to aid the NIST PubID team in assessing the impact and type of changes to be made in enacting this new scheme.

By default, the report command generates a table to indicate which migrated identifiers have changed, focusing on changes of two styles:

• PubID in short style vs legacy publication ID

• PubID in machine-readable style vs legacy DOI

As seen in the following output, a ✅ or a - will be shown in the appropriate column of change.

Better yet, the report command supports CSV output. The "changes" fields will display true or false accordingly.

The best part is that this CSV will work properly with spreadsheet editors like Excel and Pages. All you need is to export the CSV values to a CSV file, and open it in your favorite program.

It is easy to filter these columns in Microsoft Excel with the following steps:

1. Open the CSV file in Excel

2. Convert the header row into a filter row: first highlight the header row, then click on "Data > Filter"

3. Filter the columns accordingly

Now it’s easy to screen through the anomalies and surface the data issues!

The stage code element only applies to non-final publications.

In most series, documents are only released as final publications, and therefore their PubIDs will not contain a stage code.

Only some series support stage codes, e.g. SP 800 and SP 1800.

The contents and pattern of the report number are dependent on the series.

Possible values:

• {sequence number}

• {subseries}-{sequence number}

• {sequence number}-{volume}

• {sequence number}-{edition}

• {subseries}-{sequence number}-{edition}

• etc.

A "Part" can also be indicated by an appended alphabetic character to the end.

An ISO 639-2 code that represents a translated document from English.

If a document is translated from English, suffix the document with a 3-letter ISO 639-2 code within parentheses.

Raw values seen in legacy DOIs include:

Generally in this order:

• No update: {series} {stage} {report number}{part}{edition}({translation})

• With update: {series} {stage} {report number}{part}{edition}({translation})/{update} {update number}:{update year}

Samples:

• National Institute of Standards and Technology Federal Information Processing Standards Publication 199

• National Institute of Standards and Technology Special Publication 800-27, Revision A

• National Institute of Standards and Technology Special Publication 800-39 (Second Public Draft)

(originally described in https://github.com/metanorma/metanorma-nist/issues/98)

This form is used in the Authority section.

• abbrev(series) represent the abbreviation of the Series title

• (Note: there is no {update-date})

Examples:

• "Natl. Inst. Stand. Technol. Spec. Publ. 800-78-4"

• "Natl. Inst. Stand. Technol. Spec. Publ. 800-116"

• "Natl. Inst. Stand. Technol. Spec. Publ. 800-57 Part 1, Revision 4"

(originally from https://github.com/metanorma/metanorma-nist/issues/88)

The "short form" is used to cite the documents within text.

It is used in these situations:

1. Locality references. "In Section 3.2 of SP 800-187…" (the "SP 800-187" is a link).

   Note	NIST pubs are composed of "Sections" not "Clauses"

2. A generic document reference. "SP 800-53 describes…". This form does not specify a revision or update date.

3. "All parts". "The SP 800-57 subseries describes key management…".

("NISTIR 6885 2003 Edition (February 2003)" is a poor indicator.)

The correct rule should be:

(originally from https://github.com/metanorma/metanorma-nist/issues/88)

Short form date:

• Month YYYY

Examples:

• NIST SP 800-53r4 (20152201) supersedes NIST SP 800-53r4 (20140115)

• NIST SP 800 63A (December 2017) supersedes NIST SP 800-63A

• NIST SP 800 57 Part 1 Revision 4 supersedes NIST SP 800-57 Part 1 Revision 3 ("Rev." is also accepted, and converted to "Revision")

• NIST SP 800 160 Volume 1 supersedes NIST SP 800-160 (20180103) ("Vol." is also accepted, and converted to "Volume")

• Undated form "NIST SP 800 53r4"

Strip Revision and Date from title, only if the Revision and Date are unique for each document number. These are identified as "Rev. …​", "Revision …​." and " (Month YYYY)", whichever comes first.

Machine-readable syntax:

Generally, this rule should be able to uniquely identify an edition of a document.

• {part}

  • Part

    • A "Part 1" document is encoded as "pt1";

    • When a letter part is indicated, e.g. "800-63A", we should keep it as part of the reportnumber (i.e., don’t indicate "pt").

  • Volumes

    • "Volume 1" is encoded as "v1";

• {revision}

  • "Revision 1" is encoded as "r1"

  • If a superseding edition is a full revision, it will get the next Rev. #.

  • If a superseding edition is just an errata update, we use the update date from the title page ("includes updates as of …​") to uniquely identify this edition. Preferably in the -yyyymmdd format.

• {update}

  • "Update 1" is encoded as "upd1"

Some examples:

• NIST.SP.800-53r4-20152201 supersedes NIST.SP.800-53r4-20140115

• NIST.SP.800-63A-20171201 supersedes NIST.SP.800-63A

• NIST.SP.800-57pt1r4 supersedes NIST.SP.800-57pt1r3

• NIST.SP.800-160v1 supersedes NIST.SP.800-160-20180103

• NIST.IR.8204.upd1-2019 supersedes NIST.IR.8204

• The undated form is NIST.SP.800-53r4

(originally from https://github.com/metanorma/metanorma-nist/issues/88)