Book and Collection Tag Library version 3.0

<related-object>

Related Object Information

Container element for a text link to a published related object other than a journal article, possibly accompanied by a very brief description of the object. For example, the related object might be a related book, a chapter in a book, or a figure or graphic from another published source.

Remarks

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 unit. That unit would be specified on 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, 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.

For each of source, document, and object, an identifier is specified on the corresponding attribute. If the source and document are the same, the @source-id attribute should be empty. If the document and object are the same, the <object-id> attribute should be empty. The @document-id attribute should always 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.

This element (<related-object>) is new in version 3.0 of the Tag Set, although some users have added a custom element of the same name to prior versions. The values and/or usage in version 3.0 may not be backward-compatible with such customizations.

Attributes

content-type Type of Content
document-id Document Identifier
document-id-type Document Identifier Type
document-type Document Type
id 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

Content Model

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

Expanded Content Model

(#PCDATA | bold | italic | monospace | overline | overline-start | overline-end | roman | sans-serif | sc | strike | underline | underline-start | underline-end | named-content | styled-content | annotation | article-title | chapter-title | collab | comment | conf-date | conf-loc | conf-name | conf-sponsor | date | date-in-citation | day | edition | email | elocation-id | etal | ext-link | fpage | gov | institution | isbn | issn | issue | issue-id | issue-part | issue-title | lpage | month | name | 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 | volume | volume-id | volume-series | year | sub | sup)*

Description

Any combination of:

This element may be contained in:

<abstract>, <ack>, <aff>, <alt-title>, <app>, <app-group>, <article-title>, <attrib>, <bio>, <body>, <bold>, <book-title>, <boxed-text>, <collection-member>, <collection-name>, <comment>, <def-head>, <disp-quote>, <glossary>, <italic>, <kwd>, <license-p>, <meta-value>, <monospace>, <named-content>, <notes>, <overline>, <p>, <product>, <ref-list>, <roman>, <sans-serif>, <sc>, <sec>, <speaker>, <strike>, <styled-content>, <sub>, <subtitle>, <sup>, <td>, <term>, <term-head>, <th>, <title>, <trans-abstract>, <trans-subtitle>, <trans-title>, <underline>

Example

<collection>
<collection-meta>
...
<collection-name>Disease Control Priorities Set</collection-name>
<collection-list>
<collection-member>
<title>Disease Control Priorities in Developing Countries</title>
<ext-link ext-link-type="URL"
xlink:href="http://www.ncbi.nlm.nih.gov/books/
bv.fcgi?call=bv.View..ShowTOC&amp;rid=dcp2.TOC&amp;depth=2"
xmlns:xlink="http://www.w3.org/1999/xlink" xlink:type="simple"></ext-link>
<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>2006</year>
<isbn>0-8213-6397-2</isbn>
<size units="page">416</size>
</related-object>
</collection-member>
<collection-member>
<title>Global Burden of Disease and Risk FactorsS</title>
<ext-link ext-link-type="URL"
xlink:href="http://www.ncbi.nlm.nih.gov/books/
bv.fcgi?call=bv.View..ShowTOC&amp;rid=gbd.TOC&amp;depth=2"
xmlns:xlink="http://www.w3.org/1999/xlink" xlink:type="simple"></ext-link>
</collection-member>
...
</collection-list>
</collection-meta>
</collection>

Module

related-object3.ent

Book and Collection Tag Library version 3.0

Version of November 2008