<related-object>

Related Object Information

Description of an object (for example, book, book chapter, figure, or table) related to the article content but published separately. May include a link to the related object.

Remarks

For example, the related object might be a related book, a chapter in a book, a dataset, a spreadsheet, or a figure or graphic from another published source.
This element represents the link’s reference to its target in three parts:
  1. The source is the largest publishable unit (named in analogy to the <source> element used in citations). In the case of a reference to somewhere in a book, @source-id would represent the book as a whole, perhaps via its ISBN.
  2. The document is the part of the source that is typically delivered when a user follows the link in electronic form. For example, when linking into a book it may be desirable to transfer only the relevant chapter, section, or other structural unit. That unit would be specified on the @document-id, perhaps via its XML ID.
  3. The object is the location within the document of the precise destination of the link. For example, the object might be a particular list, paragraph, figure, table, subsection, or other element specified by its XML ID (and a viewing application might scroll to it). In scanned data, the object might be a page specified by number, or an area-to-highlight specified by co-ordinates. In a relational database, the object might be a specific row, selection, or view specified by a query.
Best Practice: For each source, document, and object, an identifier should be specified on the corresponding attribute. For any related-object link, the @source-id attribute points to the largest publishable unit, for example, an entire book. The @document-id attribute points to a major component of the source; for example a chapter, front matter section (Preface) or back matter section (Appendix) of a book. Use the @object-id attribute to point to any item within the specified major document component; for example a section, figure, table, or reference within the chapter of the book.
Where the more specific attributes are populated, the less specific attributes should also be populated. For example, if @object-id is specified, then both @document-id and @source-id should also be populated. If @source-id points to the intended target (an entire book), then neither @document-id nor @object-id should be specified.
The <related-object> element can also provide a name for the type of each identifier used, for example, ISBN, ISSN, DOI, XMLID, URI, and so on. These go on @source-id-type, @document-id-type, and @object-id-type as appropriate.
Finally, the <related-object> element can provide a name for the type of destination data each identifier actually points to, for example, Book, Part, Chapter, Section, Table, Glossary, Figure, Page, and so on. These go on @source-type, @document-type, and @object-type as appropriate. An application might, as one example, use @object-type values to display links to Figures in a different style than links to Chapters or Tables. When applicable, these types may, but need not, correspond to XML element type names.
Historical Note: This element (<related-object>) was new in the last NLM version of this Tag Set, although some users had added a custom element of the same name to prior versions. The values and/or usage in this NISO JATS version may not be backward-compatible with such customizations.

Related Elements

A similar element <related-article> points to related journal articles.

Attributes

content-type Type of Content
document-id Document Component Identifier
document-id-type Document Identifier Type
document-type Document Type
ext-link-type Type of External Link
id Document Internal Identifier
link-type Type of Link (for a Related Object)
object-id Object Identifier
object-id-type Object Identifier Type
object-type Object Type
source-id Source Identifier
source-id-type Source Identifier Type
source-type Source Type
specific-use Specific Use
xlink:actuate Actuating the Link
xlink:href Href (Linking Mechanism)
xlink:role Role of the Link
xlink:show Showing the Link
xlink:title Title of the Link
xlink:type Type of Link
xml:base Base
xml:lang Language
xmlns:xlink XLink Namespace Declaration

Content Model

<!ELEMENT  related-object
                        (#PCDATA %related-object-elements;)*         >

Expanded Content Model

(#PCDATA | bold | fixed-case | italic | monospace | overline | roman | sans-serif | sc | strike | underline | ruby | named-content | styled-content | annotation | article-title | chapter-title | collab | collab-alternatives | comment | conf-acronym | conf-date | conf-loc | conf-name | conf-sponsor | data-title | date | date-in-citation | day | edition | email | elocation-id | etal | ext-link | fpage | gov | institution | institution-wrap | isbn | issn | issn-l | issue | issue-id | issue-part | issue-title | lpage | month | name | name-alternatives | object-id | page-range | part-title | patent | person-group | pub-id | publisher-loc | publisher-name | role | season | series | size | source | std | string-name | supplement | trans-source | trans-title | uri | version | volume | volume-id | volume-series | year | sub | sup)*

Description

Any combination of:

This element may be contained in:

<article-meta>, <attrib>, <bold>, <comment>, <fixed-case>, <italic>, <license-p>, <monospace>, <named-content>, <overline>, <p>, <product>, <roman>, <sans-serif>, <sc>, <strike>, <styled-content>, <sub>, <sup>, <td>, <term>, <th>, <underline>

Example 1

Related object is a book, with much book metadata given:
...
<p>The toll of AIDS in Africa far exceeds its proportion of
the world population. Only 12% of the world's population
inhabit Africa, but the continent has over 60% of the
AIDS-infected population. Mortality statistics are complicated
by the relationship between Tuberculosis and HIV.
<related-object source-id="http://www.ncbi.nlm.nih.gov/entrez/
query.fcgi?cmd=Retrieve&amp;dopt=Expanded&amp;db=nlmcatalog&amp;list_uids=1252893"
source-id-type="url" source-type="book">
<person-group person-group-type="editor">
<name><surname>Jamison</surname>
<given-names>Dean T.</given-names></name>
...
</person-group>
<source>Disease and Mortality in Sub-Saharan Africa</source>
<edition>2</edition><sup>nd</sup>
<publisher-name>The World Bank</publisher-name>
<publisher-loc>Washington, DC</publisher-loc>
<year iso-8601-date="2006">2006</year>
<isbn>0-8213-6397-2</isbn>
<size units="pages">416</size>
</related-object>
</p>
...

Example 2

Identifying and linking to a Clinical Trial (mentioned in the text):
...
<related-object 
  link-type="clinical-trials-registry" 
  content-type="pre-result" 
  source-type="clinical-trials-registry" 
  source-id-type="ISRCTN" 
  source-id="ISRCTN69423238"
  xlink:href="http://dx.doi.org/10.1186/ISRCTN69423238">
  <source>Spontaneous Urinary Stone Passage Enabled by Drugs</source>
</related-object>
...

Example 3

Related objects are a chapter in a book and a section in that chapter:
...
<p>From my personal experience, which is also informed by the 
research findings reported in <related-object
  id="wt605845_ch4_1" 
  link-type="booklink" 
  source-id="wt605845" 
  source-type="book"
  document-id="ch4" 
  document-type="chapter">chapter four</related-object> (<related-object
  id="wt605845_ch4_ch4.s6_1" 
  link-type="booklink" 
  source-id="wt605845" 
  source-type="book"
  document-id="ch4" 
  document-type="chapter" 
  object-id="ch4.s6" 
  object-type="sec">section 4.3.3</related-object>), the belief that a 
vegan diet can be nutritionally adequate is much disputed.</p>
...

Example 4

Related objects are an appendix and a bibliographic citation from a book:
...
<p>[...] As the nutrition literature is complicated and may 
distract from the moral argument in spite of its importance 
for that very same moral argument, my narrow, nutritionally-based
answer to the first question of importance in this book has
been reserved for the book&#x02019;s <related-object 
  id="wt605845_app1_1" link-type="booklink"
  source-id="wt605845" 
  source-type="book" 
  document-id="app1" 
  document-type="book-app"
>appendix</related-object>, which provides a detailed overview 
of the academic literature on vegan nutrition. A similar 
appendix was provided in the first edition of
<related-object id="wt605845_rl1_r520_1" 
  link-type="booklink" 
  source-id="wt605845"
  source-type="book" 
  document-id="rl1" 
  document-type="ref-list" 
  object-id="r520"
  object-type="bibr">Singer (1975)</related-object>&#x02019;s 
<italic>Animal Liberation</italic>, but no longer featured in 
the second edition due to his view that the &#x02018;nutritional 
adequacy of a vegetarian diet is not in dispute.</p>
...

Article Authoring Tag Library NISO JATS Version 1.2 (ANSI/NISO Z39.96-2019)

Version of May 2019

Back to Top