<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:
- 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.
- 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.
- 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.
Attributes
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:
- Text, numbers, or special characters
- Emphasis Elements
- <named-content> Named Special (Subject) Content
- <styled-content> Styled Special (Subject) Content
- <annotation> Annotation in a Citation
- <article-title> Article Title
- <chapter-title> Chapter Title in a Citation
- <collab> Collaborative (Group) Author
- <collab-alternatives> Collaboration Alternatives
- <comment> Comment in a Citation
- <conf-acronym> Conference Acronym
- <conf-date> Conference Date
- <conf-loc> Conference Location
- <conf-name> Conference Name
- <conf-sponsor> Conference Sponsor
- <data-title> Data Title
- <date> Date
- <date-in-citation> Date within a Citation
- <day> Day
- <edition> Edition Statement, Cited
- Linking Elements
- <elocation-id> Electronic Location Identifier
- <etal> Et Al.
- <fpage> First Page
- <gov> Government Report, Cited
- <institution> Institution Name: in an Address
- <institution-wrap> Institution Wrapper
- <isbn> ISBN
- <issn> ISSN
- <issn-l> ISSN-L (Linking ISSN)
- <issue> Issue Number
- <issue-id> Issue Identifier
- <issue-part> Issue Part
- <issue-title> Issue Title
- <lpage> Last Page
- <month> Month
- <name> Name of Person
- <name-alternatives> Name Alternatives
- <object-id> Object Identifier
- <page-range> Page Ranges
- <part-title> Part Title in a Citation
- <patent> Patent Number, Cited
- <person-group> Person Group for a Cited Publication
- <pub-id> Publication Identifier for a Cited Publication
- <publisher-loc> Publisher’s Location
- <publisher-name> Publisher’s Name
- <role> Role or Function Title of Contributor
- <season> Season
- <series> Series
- <size> Size
- <source> Source
- <std> Standard, Cited
- <string-name> Name of Person (Unstructured)
- <supplement> Supplement Information
- <trans-source> Translated Source
- <trans-title> Translated Title
- <version> Version Statement
- <volume> Volume Number
- <volume-id> Volume Identifier
- <volume-series> Volume Series
- <year> Year
- Baseline Change Elements
This element may be contained in:
<aff>, <alt-title>, <app>, <app-group>, <article-meta>, <article-title>, <attrib>, <bio>, <body>, <bold>, <boxed-text>, <comment>, <def-head>, <disp-quote>, <fixed-case>, <front-stub>, <glossary>, <italic>, <license-p>, <meta-value>, <monospace>, <named-content>, <notes>, <overline>, <p>, <product>, <ref-list>, <roman>, <sans-serif>, <sc>, <sec>, <see>, <see-also>, <strike>, <styled-content>, <sub>, <subtitle>, <sup>, <td>, <term>, <term-head>, <th>, <title>, <trans-subtitle>, <trans-title>, <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&dopt=Expanded&db=nlmcatalog&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’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)> Singer (1975)</related-object>’s <italic>Animal Liberation</italic>, but no longer featured in the second edition due to his view that the ‘nutritional adequacy of a vegetarian diet is not in dispute.</p> ...