Home | Public Area

Comment #00257 - @id for top-level elements/@id-everywhere - z39.96-2012.pdf

Comment 257
Addressed (Unresolved)
ANSI/NISO Z39.96-2012, JATS: Journal Article Tag Suite (version 1.0) (Revision 0)
Comment Submitted by
Jeffrey Beck
2013-05-10 11:08:59
This request is submitted by Jeff Beck on behalf of the BITS working group. It was originally submitted by Kevin Hawkins <kevin.s.hawkins@ultraslavonic.info> through the JATS List.

Request: On behalf of my colleagues at the University of Michigan Library, I am requesting the addition of @id attribute to <front>, <body>, and <back>.

Background: In constructing http://www.lib.umich.edu/mpach , we will be storing JATS (and potentially BITS) documents plus embedded media, supplemental material, and optionally a user-provided typeset PDF with a METS "wrapper" in the HathiTrust repository. HathiTrust METS files include a <structMap> pointing to the salient structural features of the digital object (each identified with a unique ID), which allows for traversal of the item in the interface. We want to be able to point not only to each <sec> but also to <front> and to any text in a <body> or a <back> which might lack <sec>s inside it.

Request: Consider adding IDS to all elements.

Background: Frankly, we think it would be best to make @id a global attribute. WE feel that you can't really decide in advance what use cases users will have for putting an @id on an element, even if that element can only occur once according to the DTD. We, for example, also need IDs for fulltext indexing purposes so that all #PCDATA within a JATS/BITS document has a parent
element with an ID.
Submitter Proposed Solution
We recommend that @ids be added to all the big structural parts of document, such as <front>, <body>, and <back>.

Please note: The documentation needs to make a clear distinction between XML-type-IDs (used for internal linking within the boundaries of a single XML document) and elements which may contain a real world identifier such as a DOI or ORCID.
Jeffrey Beck
2013-11-27 10:45:25

Thank you for your comment. The JATS Standing Committe has addressed your request. Non-normative supporting materials including schemas with these additions in place should be available soon.

The Standing Committee's recommendation is:

• Add the @id attribute to all elements in each Tag Set.


• Document clearly the distinction between @id attribute values, which are internal document identifiers used
by software to perform a simple link, and identifier elements (such as <contrib-id> and <article-id>), which
are part of the metadata for a document and hold as their content externally defined identifiers such as an
ORCID personal identifier.


• Change the prose name of the @id attribute to “Document Internal Identifier”.