[jats-list] JATS4R Article Versioning feedback requested

["Nick Nunes nunes@xxxxxxxxxxxx" <jats-list-service@xxxxxxxxxxxxxxxxxxxxxx>]

At the 2016-09-15 JATS4R discussion we touched on the question of how best
to model an association between an article and another version of itself.

There are three potential elements which are under consideration, each with
its own pros and cons. We'd like to solicit opinions on the modeling of
these associations.

Ultimately we'd like to devise a modeling recommendation that can be
implemented with the JATS Publishing (Blue) 1.1 DTD for maximum
compatibility.

These are the elements we discussed along with a brief summary of the
arguments for and against each.

1. related-object
Pro
- has the most robust linking model using the @document-* @object-* and
@source-* values as well as the @xlink:* values
Con
- the JATS documentation implies that related-object is intended to link to
non-journal content (not necessarily other articles)

2. related-article
Pro
- since we're linking to another version of an *article* this seems like a
natural fit
Con
- general practice seems to be that related-article is used to point to
*other* articles

3. self-uri
Pro
- the documentation specifically says "URI for another version of a
document"
Con
- general practice seems to be that self-uri is used to point to things
that are intended to represent the same point in the versioning history of
the article
- has the poorest linking model, only offering the @xlink:* values

The JATS4R group initially intended to recommend that this version
association be a child of the history element but none of the above are
allowed there in the Blue DTD (related-object and related-article are in
Green).

There is a fourth option, which is to request that the JATS committee
consider adding a new element to the Tag Suite to facilitated the modeling
of these associations. For example:

4. related-version as a child of history e.g.
<!ELEMENT related-version (#PCDATA %related-object-elements;)* >

<!ATTLIST related-version
  source-id         CDATA                             #IMPLIED
  source-id-type    CDATA                             #IMPLIED
  source-type       CDATA                             #IMPLIED
  document-id       CDATA                             #IMPLIED
  document-id-type  CDATA                             #IMPLIED
  document-type     CDATA                             #IMPLIED
  document-version  CDATA                             #IMPLIED
  content-type      CDATA                             #IMPLIED
  specific-use      CDATA                             #IMPLIED
  xmlns:xlink       CDATA                             #IMPLIED
  xlink:type        (simple)                          #IMPLIED
  xlink:href        CDATA                             #IMPLIED
  xlink:role        CDATA                             #IMPLIED
  xlink:title       CDATA                             #IMPLIED
  xlink:show
    (embed | new | none | other | replace)            #IMPLIED
  xlink:actuate
    (none | onLoad | onRequest | other)               #IMPLIED >

This is not intended to be a recommendation but serves to illustrate the
type of element that could be created to model intra-version associations
of articles. NB: @document-version is added to allow for a way to
differentiate between article versions for cases where the above elements
may be deficient (all versions of an articles share a DOI or do not have a
specific URI).

Thanks you for your interest in this subject.