Purpose

NIST publications are numbered according to an identification scheme.

This gem implements a mechanism to parse and utilize NIST publication identifiers provided in the NIST-Tech-Pubs repository.

Historic identifier patterns

There are at least three major "pattern series" of identifiers due to historical reasons:

• NIST publications produced by the PubID scheme (202X-)

• NIST publications produced prior to the PubID scheme (1988-)

• NBS publications, produced under the National Bureau of Standards (the previous name of NIST, 1901 to 1988)

This implementation attempts to support all three types of publication identifier patterns.

NIST PubID

NIST is currently developing a unified publication identifier scheme ("PubID") for their technical series of publications, which allows machine-readable identifier parts.

This scheme is described in “Publication Identifier Syntax for NIST Technical Series Publications” authored by Jim Foti of the CSD, ITL, and Kathryn Miller and Kate Bucher of the ISO, Management Resources.

Note	This scheme is still at proposal stage.

This gem implements the NIST PubID scheme and allows the conversion to and from historic patterns.

Use cases to support

PubID:

1. Given a PubID (full-form title, abbreviated-form title, short-form title), generate the corresponding machine-readable (MR) PubID format

2. Given a MR PubID:

   1. generate the full-form title

   2. generate the abbreviated-form title

   3. generate short-form title

   4. generate the DOI (which is just DOI ID + MR)

Historic compatibility:

1. Parse a historic publication identifier into its components:

   1. output the original publication identifier (i.e. store the contents in the object)

   2. output a MR PubID

2. Parse a historic DOI into a PubID:

   1. output the original DOI (i.e. store the contents in the object)

   2. output a MR PubID

Elements of the PubID

Publisher

Name	Abbrev	Short
National Institute of Standards and Technology	Natl. Inst. Stand. Technol.	NIST
National Bureau of Standards	Natl. Bur. Stand.	NBS

Series

Publisher	Prefix	Name	Abbrev	MR (with Publisher)	Example
NIST	NIST AMS	Advanced Manufacturing Standard	Adv. Man. Ser	NIST.AMS	NIST AMS 200-2
NIST	NIST BSS	Building Science Series	Bldg. Sci. Ser.	NIST.BSS	NIST BSS 181
NBS	NBS BSS	Building Science Series	Bldg. Sci. Ser.	NBS.BSS	NBS BSS 94
NBS	NBS BMS	Building Material Structures Report	N/A	NBS.BMS	NBS BMS 140 Ed. 2
NBS	NBS BRPD-CRPL-D	Basic Radio Propagation Predictions Series	N/A	NBS.BRPD-CRPL-D	NBS BRPD-CRPL-D 209
NBS	NBS BH	Building and Housing Reports	N/A	NBS.BH	NBS BH 18
NBS	NBS CRPL	Central Radio Propagation Laboratory Reports	N/A	NBS.CRPL	NBS CRPL 6-3
NBS	NBS CRPL-F-A	CRPL Ionospheric Data	N/A	NBS.CRPL-F-A	NBS CRPL-F-A 245
NBS	NBS CRPL-F-B	CRPL Solar-Geophysical Data	N/A	NBS CRPL-F-B245	NBS CRPL-F-B245
NBS	NBS IP	CRPL Ionospheric Predictions	N/A	NBS.IP	NBS IP 25
NBS	NBS CIRC	Circulars	N/A	NBS.CIRC	NBS CIRC 460sup1962
NBS	NBS CIS	Consumer Information Series	N/A	NBS.CIS	NBS CIS 10
NBS	NBS CS	Commercial Standards	N/A	NBS.CS	NBS CS 113-51
NBS	NBS CSM	Commercial Standards Monthly	N/A	NBS.CSM	NBS CSM v9n10
NIST	FIPS PUB	Federal Information Processing Standards Publication	Federal Inf. Process. Stds.	NIST.FIPS	FIPS PUB 202
NIST	NISTGCR	Grant/Contract Reports	N/A	NIST.GCR	NIST GCR 17-917-45
NBS	NBS GCR	Grant/Contract Reports	N/A	NBS.GCR	NBS GCR 77-82
NIST	NIST HB	Handbook	Handb.	NIST.HB	NIST Handbook 150-872
NBS	NBS HB	Handbook	Handb.	NBS.HB	NBS Handbook 137
NBS	NBS HR	Hydraulic Research in the United States	N/A	NBS.HR	NBS HR 14A
NBS	NBS IRPL	Interservice Radio Propagation Laboratory	N/A	NBS.IRPL	NBS IRPL 27
NIST	ITL Bulletin	ITL Bulletin	N/A	NIST.ITLB	NIST ITL Bulletin August 2020
NIST	NIST LC	Letter Circular	N/A	NIST.LCIRC	NIST LC 1136
NBS	NBS LC	Letter Circular	N/A	NBS.LCIRC	NBS LC 1128
NIST	NIST MN	Monograph	Monogr.	NIST.MN	NIST Monograph 175
NBS	NBS MN	Monograph	Monogr.	NBS.MN	NIST Monograph 125, NIST Monograph 125, Supp. 1
NBS	NBS MP	Miscellaneous Publications	N/A	NBS.MP	NBS MP 260e1968
NIST	NIST NCSTAR	National Construction Safety Team Report	Natl. Constr. Tm. Act Rpt.	NIST.NCSTAR	NIST NCSTAR 1-1A
NIST	NIST NSRDS	National Standard Reference Data Series	Natl. Stand. Ret. Data Ser.	NIST.NSRDS	NIST NSRDS 100-2021
NBS	NSRDS-NBS	National Standard Reference Data Series	Natl. Stand. Ret. Data Ser.	NBS.NSRDS	NSRDS-NBS 1
NIST	NISTIR	Interagency or Internal Report	N/A	NIST.IR	NISTIR 8347
NBS	NBSIR	Interagency or Internal Report	N/A	NBS.IR	NBSIR 79-1776
NIST	NIST OWMWP	Office of Weights and Measures White Papers	N/A	NIST.OWMWP	NIST OWMWP 06-13-2018
NBS	NBS PC	Photographic Circulars	N/A	NBS.PC	NBS RPT 10394
NBS	NBS RPT	Reports	N/A	NBS.RPT	NBS PC 1
NIST	NIST PS	Voluntary Product Standards	Prod. Stand.	NIST.PS	NIST PS 20-20
NBS	NBS SIBS	Special Interior Ballistics Studies	N/A	NBS.SIBS	NBS SIBS 1
NBS	NBS PS	Voluntary Product Standards	Prod. Stand.	NBS.PS	NBS PS 15-69
NIST	NIST SP	Special Publication	Spec. Publ.	NIST.SP	NIST SP 800-115
NBS	NBS SP	Special Publication	Spec. Publ.	NBS.SP	NBS SP 500-137
NIST	NIST TN	Technical Note	Tech. Note	NIST.TN	NIST TN 2156
NBS	NBS TN	Technical Note	Tech. Note	NBS.TN	NBS TN 876
NBS	NBS TIBM	Technical Information on Building Materials	N/A	NBS.TIBM	NBS TIBM 61
NIST	NIST TTB	Technology Transfer Brief	N/A	NIST.TTB	NIST TTB 2
NIST	NIST DCI	Data Collection Instruments	Data Collect. Instr.	NIST.DCI	NIST DCI 002
NIST	NIST EAB	Economic Analysis Brief	N/A	NIST.EAB	NIST EAB 3
NIST	NIST Other	Other	Other	NIST.O	Report to the President
NIST	CSRC White Paper	Cybersecurity Resource Center White Paper	CSWP	NIST.CSWP	NIST.CSWP.04282021
NIST	CSRC Book	Cybersecurity Resource Center Book	CSRC Book	NIST.CSB	Executive Guide to Computer Security, Metrics to Security
NIST	CSRC Use Case	Cybersecurity Resource Center Use Case	CSRC Use Case	NIST.CSUC	Wireless Medical Infusion Pumps: Medical Device Security
NIST	CSRC Building Block	Cybersecurity Resource Center Building Block	CSRC Building Block	NIST.CSBB	Domain Name System-Based Security for Electronic Mail
NIST	JPCRD	Journal of Physical and Chemical Reference Data	J. Phys. & Chem. Ref. Data	JPCRD	(excluded from PubID scheme)
NIST	JRES	Journal of Research of NIST	J. Res. Natl. Inst. Stan.	NIST.JRES	(excluded from PubID scheme)

Stage

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.

Name	Value
Initial Public Draft	IPD
Second Public Draft (to the Nth Public Draft)	2PD (…​ nPD)
Final Public Draft	FPD
Work-in-Progress Draft	WD
Preliminary Draft	PreD

Report number

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

Possible values:

• number

• subseries-number

• number-volume

• number-edition

• subseries-number-edition

• etc.

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

Part

Name	Abbrev and Short	MR
Part	Pt.	pt
Volume	Vol.	v
Section	Sec.	sec
Supplement	Suppl.	sup
Index	Index	indx
Addendum	Add.	add (TBC with NIST)
Insert	Ins.	ins (TBC with NIST)
Errata	Err.	err (TBC with NIST)
Appendix	App.	app (TBC with NIST)

Edition

Name	Abbrev and Short	MR
Revision	Rev.	r
Edition	Ed.	e
Version	Ver.	ver

Translation

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:

Name	Correct value	MR	Legacy values seen in DOI
Spanish	(ESP)	esp	es
Vietnamese	(VIE)	vie	viet
Portuguese	(POR)	por	port
Chinese	(ZHO)	zho	chi

Update

General

When a document is updated with an errata, the original edition may be reissued to include the errata.

These documents will display the text "includes updates as of…​".

In this case the document identifier will include the element "Update".

Name	Abbrev and Short	MR
Update	Upd.	u

Note	This is similar to the ISO/IEC "Amd." and "Cor." except that the NIST "Upd." is applied to the original document and (typically) does not exist separately.

Update number

A sequential integer numbering of the update counting from the original document.

The first update is numbered 1, and so forth.

Update year

The year last updated, shown as a suffix to the identifier.

• "identifier:update-year"

PubID patterns

Presentation

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}

Full PubID

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)

Abbreviated PubID

This form is used in the Authority section.

Natl. Inst. Stand. Technol. {abbrev(series)} {reportnumber} {part | abbrev(volume)}, {abbrev(revision)}

• 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)

Short PubID

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:

{abbrev(series)} {reportnumber} {abbrev(volume)} {abbrev(revision)} {edition, optional}

Note	For FIPS, reportnumber is the full FIPS number, including revision, e.g., 140-2.

(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 PubID

Machine-readable syntax:

{publisher}.{series}.[{stage}.]{reportnumber}.{part}.{revision}.[{lang}.]{update-date}

{publisher}.{series}.[{stage}.]{reportnumber}.{part}.{revision}.[{lang}.][{update}]{update-date}

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)

Examples of PubID

• SP 800 series

  • NIST SP 800-40r3

  • NIST SP 800-45ver2

  • NIST SP 800-53r4/Upd 3:2015

  • NIST SP IPD 800-53r5

  • NIST SP 800-53Ar4/Upd 1:2014

  • NIST SP 800-60v1r1

  • NIST SP 800-57pt1r4

  • NIST SP 800-73-4/Upd 1:2016

  • NIST SP 2PD 800-188

• SP 1800 series

  • NIST SP 2PD 1800-13B

  • NIST SP PreD 1800-19B

• NIST IR series

  • NIST IR 8011v3

  • NIST IR 8204/Upd 1:2019

  • NIST IR 8115(spa)

• Other NIST Series

  • NIST HB 130e2019

  • NIST SP 1041r1/Upd 1:2012

  • NIST NCSTAR 1-1Cv1

Addendum

NIST SP 800-38A has an Addendum.

In NIST MR let’s call this part add-X, e.g. "NIST SP 800-38A Addendum" ⇒ NIST.SP.800-38A.pt-A.add-1

1. Full form title: "Addendum to publisher series reportnumber | volume, edition"

2. Abbreviated form title: "Add. to abbrev(publisher) abbrev(series) reportnumber | abbrev(volume), abbrev(edition)"

3. Short form title: "short(series) reportnumber | abbrev(volume), abbrev(edition) Addendum"

4. Machine-readable form NIST.SP.800-38A.pt-A.add-1

Originally from https://github.com/metanorma/metanorma-nist/issues/259.