<content-version> Book Current Version Status or Number

Holds version information such as a version type, version status, version statement, or version number for the current document.


Book “versions” and book “editions” are not the same thing, and both books and book parts need the ability to name a “<version>” as well as well as an <edition> . The element <content-version> acts for books and book parts as “<article-version>” does for articles. A <content-version> for a book may contain (for example) a word or phrase from a controlled version vocabulary, an uncontrolled version status word (“draft” or “revised proof”), a version statement (“Second revised print version”), or a publisher’s version number (“B-385R5” or “ver. 2.0”).
With the recent increase in availability of early versions of books and book chapters, it is becoming more important to record, within the XML document, a status, version name, version number, lifecycle stage, or similar descriptor. Many publishers are making more than one “version” (ordinary English word) of a document available to the public, for example, making public a proof, then a corrected proof, and then the copy of record. This practice argues in favor of allowing version information as part of the metadata that travels with the XML document rather than treating it as production metadata that is stored externally. This <content-version> element was created to hold that version information. A new version need not change the edition.
The <content-version> element is free form and may contain any content from a complicated version description, to a controlled vocabulary descriptor, to a simple version number. There seems to be little consensus among publishers as to what constitutes a “version” of a book or chapter, and even less agreement concerning how to name (or number or describe) that version. As an example, the JATS Standing Committee (which originally defined this element for JATS) was not even able to reach consensus concerning whether a “proof” is a version, a status, a stage in the publication life-cycle, or something else. Experience indicates that a document might record its version as “Proof”, “copy-edited”, “ITH-12609” or “0.4”.

Attribute Best Practice

Because the <content-version> element is so loosely defined, the element should always be given either a @vocab element naming the controlled vocabulary from which the status descriptor is taken or a @content-version-type attribute naming the type or kind of status identifier given. The @specific-use attribute is also available to provide a rationale.
For example:
  • Controlled Vocabulary: If the book version element content is from a recognized thesaurus, ontology, index or similar term source, the @vocab attribute should name the vocabulary and the @vocab-identifier provide a URI or other identifier to the vocabulary. The @vocab-term attribute can provide the term source canonical version, if the element content does not, and the @vocab-term-identifier attribute may point to the term, if appropriate.
  • Version Number or Uncontrolled Vocabulary: For <content-version> content that is not based on a controlled vocabulary, the @content-version-type can be used to explain what the content means, as expressed in the Publisher’s vocabulary, for example, “status”, “web-host-version-identifier”, or “publisher-control-number”.
  • If a publisher wishes to record a URI, this can be recorded using the @xlink:href.
Related Elements
More Than One Version Descriptor: A book or book-part should be given only a single version identifier in any given system at one time. However a book or book-part may be described by several version descriptors from different systems that all apply to the document at the same time, for example, a book might be described with both a controlled vocabulary version phrase and a publisher or aggregator version number. The element <content-version-alternatives> is provided as a container element to hold multiple simultaneous versions. Multiple version descriptors can be very useful when moving XML between a vendor and a customer, with each side using a different internal version number. The attributes @content-version-type and @specific-use are both available to make distinctions between different version descriptors.
Expanded Version Description: To provide a more complete description of a version, the <event> element can be used.

Base Attributes


Models and Context
May be contained in
Text, numbers, or special characters
Content Model
<!ELEMENT  content-version
                        (#PCDATA)                                    >
Tagged Sample

A version statement and a version number

   >Mulberry Version of Record</content-version>