Silverchair logo

Document Revision History
Date Description Version
See consolidated revision history page

Introduction

Silverchair has created SCBITS-Book, a custom XML specification for loading book XML into SCM6. SCBITS-Book is based on the Book Interchange Tag Suite (BITS) version 2.0, which is maintained by the NLM and based on NISO’s Journal Article Tag Suite (JATS). XML content for book content must be valid against the SCBITS-Book XML Schema and additional rules stated herein.

Due to the size of the BITS tag set, SCBITS-Book does not accommodate all features available in the BITS tag set. This document describes SCBITS-Book—the SCM6 implementation of the BITS tag set. Content that is valid against this specification will also be valid against the BITS tag set, but the reverse is not necessarily true.

The documentation provided by the NLM at https://jats.nlm.nih.gov/extensions/bits/tag-library/2.0/index.html is an excellent resource to supplement the information contained in this document. The key to transforming data to conform to the SCBITS-Book specification is using the correct elements to tag consistently. Transforming correctly and consistently will ensure a smooth and accurate load of content to the platform.

Silverchair staff are available to answer questions about any of the elements discussed herein or to help handle any situations not covered by this document.

Guidelines appearing here address two areas: (1) tagging requirements for processing; and (2) guidelines on how to optimize data for Silverchair’s system, taking advantage of functionalities and features of SCM6.

Packaging requirements for Zipline loading are in the Package Requirements for Zipline CTE. Copies may be requested from your Product Owner or other Silverchair representative.

Silverchair’s XSDs

Silverchair’s custom XML specifications are in an XSD format, and are hosted alongside this narrative specification. Our recommendation is that users replace their entire set of specification files upon each release, as the XSDs refer to each other, and are meant to be used as a single unit. The latest release of the XSDs can be found here: SilverchairSpecifications1_22.zip.

Silverchair’s custom XSDs include SCJATS-journalpublishing.xsd, for articles and proceedings; SCJATS-journalissue.xsd, for journal issue-meta files; SCBITS-book.xsd, for books; and a SC-common.xsd file that serves as the base XSD for all formats.

XML encoding

XML must be well-formed, conformant XML according to the W3C XML Recommendation, fully tagged, and valid to the SCJATS XML Schema. Content must also meet the requirements in this Silverchair specification.

Silverchair accepts content in both fully tagged (full-text) and so-called metadata-only or PDF-only forms. Metadata-only content merely omits the body of the content from the XML; there is no flag to identify content as full text or metadata-only. Content metadata for both forms must be complete as described here.

XML declaration

Declarations required at the top of each XML file are:

Example:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>

Special characters

UTF–8 character encoding is required to ensure that characters are translated properly upon import into the SCM6 database. Content XML may also contain numeric character references (e.g. &#345; or &#x159;) or the character entity references that JATS supports for special characters. Predefined entities for the ampersand, less-than, and greater-than should be used where the intent is to display the actual characters ampersand (&), less-than (<), or greater-than (>) respectively; the predefined entities should not be used where those characters are part of markup or encodings.

Some characters do not have a unique encoding. Examples are a capital V with a dot over it, used to indicate ventilation rate in medical texts. To encode a V with a dot, use combining diacritical marks. For example, to encode V dot, use &#x0056;&#x0307; which will produce this: V̇.

Translating print books to the web

The layout and formatting of a print book and its presentation on the web are different things. There are a number of consequences that are not immediately apparent that require XML prepared for the web to be different from XML prepared for print. Some of these differences are things that if incorporated into the authoring process early enough, can save time and effort down the road and result in a highly readable book both in print and online. An excellent example of this is found in Referencing other parts of the text.

Referencing other parts of the text

References in the text such as, “See page 288,” do not work on the web because page numbers don’t exist on the web. Instead, phrases such as “See Figure 2–1” and “See Chapter 45, Section 3: The Body’s Response to Insulin” work well on the web because one can navigate to and find these items.

You cannot specify exact placement of components on the web the way you can in print. Thus, text such as “See top image” is better written as “See Image 54” for use on the web. Image 54 might not be above the referencing text in the online display.

It is also possible to create hyperlinks in the XML document by using internal identifiers. Ideally, referenced content would have an ID and the referring text would have a jump link that uses the ID to point to the referenced text.

Word-wrap

Words that wrap on the printed page and therefore have a hyphen between syllables do not need that treatment on the web because you cannot control the width of the text display area. Various devices such as mobile phones, tablets, laptops, and desktop monitors may have a variety of screen sizes that web display must accommodate. If you are converting a book originally designed for print into web format, the hyphens that exist solely for word-wrapping reasons need to be removed. The same is true of long URLs where a space was inserted at the end of a line. These URLs will not work as links with spaces in them.

Tables

You can do things with tables in print that are not supported by today’s browsers and markup languages or that are not compatible with the web. For example, tables cannot be turned sideways on the web. Very large tables that are displayed over several print pages need to be reassembled into a single table for web display.

List numbering

Numbers and bullets do not need to be included in the XML text for lists that are tagged as numbered or bulleted lists. The system will automatically number or bullet lists based on the list tagging. If the numbers are included in the text, the display on the web will show two numbers or bullets in front of each list item, one from the system automation and one from the text.

Section titles

Section titles are converted into HTML headings on the site. These headings are styled based on the hierarchy of the sections within the document.

SCM6 does not support figures or tables as part of a section title. Inline-graphics are supported.

Display Attributes

Although not supported on the front-end, SCM6 does allow you to upload content containing certain display attributes for use in print or other non-SCM6 purposes. Note that not all of these values are retained in the output XML that is downstreamed for deposits or other services.

attribute value Meaning
align Sets the horizontal alignment inside a table cell.
border Thickness, in pixels, of the border to draw around a table.
cell-padding Amount of space, measured in pixels, between the borders of a cell and the contents of a table cell.
cell-spacing Width of space between cells in a table.
disp-level Indicates the level at which to display a section when the display level and hierarchical level are different.
frame Specifies which sides of a table should be given rules.
orientation Indicates whether an object should be positioned in a tall manner (“portrait”) or in a wide manner (“landscape”).
position Typically indicates whether a display object must be anchored in its exact location or may float to a different location in the document.
rules Defines which rules to draw between rows and columns of an XHTML 1.1 table.
style Names the style or rendering to be applied to the element.
valign Sets the vertical alignment inside a table cell.
width Used within a NISO JATS table to specify width.

Book File Structure

The root element of a book must be the either the <book> element or the <book-part-wrapper> element from the SCBITS-Book format.

Silverchair accepts book XML in one of two ways:

  1. The entire book in one XML file.
  2. Separate XML files for each part or chapter.

Book as single XML file

When a book is sent as a single XML file, the book file root element is <book>. Parts and chapters are identified throughout the XML with <book-part> elements.

Book as multiple XML files

For book parts sent as separate XML files, the root element is <book-part-wrapper>.

Book type attribute

Book types are used for indexing and retrieval by engines like Google Scholar. This attribute is optional. If no book type is provided, the value will default to “book” in our system.

@book-type attribute value Meaning
book Default value with no specific meaning. The book will not be indexed by Google Scholar.
edited-volume Composed of papers written by many different authors. Individual chapters will be indexed by Google Scholar.
monograph Multi-chapter authored book on a single topic. Individual chapters will not be indexed by Google Scholar. Instead the Monograph Preview (frontmatter, table of contents, introduction chapter, and references) will be indexed

Identifiers

ISBN

The ISBN uniquely identifies books in SCM6 and is required. For example, to match a new chapter to its already-created book in the system, Zipline uses the ISBN values.

The ISBN will be displayed on the site exactly as shown in the XML, so be sure to use dashes as appropriate. Use the <isbn> element with the following attributes to designate the ISBN:

ISBN type tag
10-digit ISBN <isbn publication-format="print" content-type="ISBN10">0-77-043740-0</isbn>
13-digit ISBN <isbn publication-format="print" content-type="ISBN13">978-0-77-043740-4</isbn>
ISBN of digital version <isbn publication-format="electronic">978-0-31-603221-6</isbn>

Publisher ID - book

For publisher-unique IDs assigned to the book, use <book-id book-id-type="publisher-id">. The book-level publisher ID is optional and does not affect Zipline behavior.

Publisher ID - Parts and Chapters

Assign publisher-unique IDs to book parts (e.g. parts and chapters) using the @id attribute on the element that creates the book part (e.g. <book-part>).

Publisher IDs must be unique within the book. They can be any combination of numbers and letters but must start with a letter, per XML rules.

Publisher ID - other elements

Publishers may have IDs on as many other elements as they like and this is encouraged by Silverchair. Publisher IDs at levels below the book part must also be unique across the book (they cannot duplicate the Publisher IDs on book parts).

Unique identifiers allow for the replacement of content while maintaining semantic tagging, retaining statistical usage data, Learning Module links, user bookmarks and cross-site links.

DOI

For DOIs assigned to the book, use <book-id book-id-type="doi">.

For DOIs assigned to a book chapter or other book parts, use <book-part-id book-part-id-type="doi">.

<book-part-id book-part-id-type="doi">10.1234/myBook_3352.2013</book-part-id>

For DOIs assigned to figures, tables, supplementary material or any other components within the book, use the <object-id> element with a @pub-id-type="doi" attribute. Example:

<fig>
<object-id pub-id-type="doi">10.1234/ch8fig1.20130413</object-id>
...
</fig>

DOIs are optional and do not drive replacement functionality in Zipline.

DOIs within citations are tagged differently. They use the <pub-id> element. See DOIs in References for more information.

ISSN

To assign an ISSN to a book (optional), use <issn> with the @publication-format="electronic" attribute.

Book Series

To assign a Book Series to a book (optional), use <collection-meta collection-type="series"> with a <title-group> with a child element <title>. Example:

     <collection-meta collection-type="series">
        <title-group>
           <title>Book Series</title>
        </title-group>
     </collection-meta>

Collection

To assign a generic Collection to a book that is not a series or edition set (optional), use <collection-meta collection-type="collection"> with a <title-group> with a child element <title>. Example:

     <collection-meta collection-type="collection">
        <title-group>
           <title>Collection Name</title>
        </title-group>
     </collection-meta>

Edition Set

To designate an Edition Set for a book (optional), use <collection-meta collection-type="edition-set"> with <collection-id collection-id-type="editionSet">.

 <collection-meta collection-type="edition-set">
    <collection-id collection-id-type="editionSet">9790000000204</collection-id>
 </collection-meta>

This identifier is used to connect multiple editions of the same book. Only one <collection-meta collection-type="edition-set"> is allowed per book.

Book metadata: The book-meta Tag

The first file imported for a book must include at least the following in the <book-meta>, so that the system can populate the data when the book is created:

Element Required attributes Notes
<pub-date> 4-digit year required, with month and day optional, e.g. <pub-date><year>2013</year></pub-date>
<isbn> At least one ISBN is required.
<book-title>
<alt-title alt-title-type="short-name">

Book metadata replacements

When replacing a book’s meta-data for a book that has been published, the following values must match what is already in the system; these values cannot be modified after a book is published:

Consult the Zipline user guide for instructions on how to replace book metadata.

Book IDs

The ISBNs serve as unique identifiers for books in SCM6. The first file that is imported to a book will create the book in the system, and establish the ISBNs for the book. All subsequent imports to the book must contain the ISBN so that the system can match the file to the existing book. The subsequent files do not need to contain all of the ISBN types, but cannot contain more ISBN types than are in the system.

Book titles

Provide the book title in the <book-title> element.

SCM6 supports three ways to store a title: title, display name and citation name. Additionally, books have a short name, which is usually a short code to identify the book. Title is the official title of the book. Display name is what is actually shown on the site, and can be different from the official title if the publisher wishes. Citation name is used when creating citations for the book or when the book is sent to a third-party site such as PubMed.

The title and short name are required when creating a new book; the others are optional. If no alternate titles are provided, the title will be used.

Provide alternate titles as follows:

Alternate title type Element Notes
display name <alt-title alt-title-type="display"> If display name is not provided, the book-title will display.
citation name <alt-title alt-title-type="citation"> If citation is not provided, the book-title will display.
short name <alt-title alt-title-type="short-name"> Required. Short code to identify the book, often used to prefix image names and ID values. This does not usually display on the site anywhere.

Edition

Provide the book’s edition in the <edition> element. Do not include the edition in the title of the book. Use the @designator attribute to include the edition number as an unadorned numeric or alphabetic value. In the example below, the value “1” will be stored for purposes such as sorting, while “1st edition” could be used for display.

<edition designator="1">1<sup>st</sup> edition</edition>

Volume

Provide a book’s volume number in the <book-volume-number> element.

    <book-volume-number>13</book-volume-number>

Contributors

Book level vs. chapter level contributors

Contributors at the book level go in the <contrib-group> at the <book-meta> level.

Part and chapter level contributors go into the <contrib-group> at the <book-part-meta> level.

Contributors may also be included at the section level by putting a <contrib-group> at the <sec-meta> level.

<book>
    <book-meta>
    …
    <contrib-group>
        <contrib id="ed1">
            <name>
                <surname>Bear</surname>
                <given-names>Paddington</given-names>
                <prefix>Dr</prefix>
                <suffix>Jr</suffix>
            </name>
                <degrees>MD, PhD</degrees>
                <role>Editor</role>
        </contrib>
    </contrib-group>
    …
    </book-meta>
    <book-body>
        <book-part id="chapter_1" book-part-type="chapter">
            <book-part-meta>
                <title-group>
                    <title>Forest Fire Safety</title>
                </title-group>
                <contrib-group>
                    <contrib id="auth1">
                        <name>
                            <surname>Bear</surname>
                            <given-names>Smokey</given-names>
                            <prefix>Dr</prefix>
                        </name>
                        <degrees>PhD</degrees>
                    </contrib>
                </contrib-group>
                …
            </book-part-meta>
        </book-part>
    </book-body>
</book>

Tagging

Authors and other contributors that should appear in the content by-line should be placed in a <contrib-group> node.

Place each contributor in a <contrib> node with a @contrib-type value of “author”, “editor”, “chair”, or “translator”. A <contrib> element with no @contrib-type attribute will default to @contrib-type="author". <contrib> elements with a @contrib-type attribute value other than “author”, “editor”, “chair”, or “translator” will be ignored.

Other @contrib-type values can be configured with the build team.

Use the <role> sub-element to include the role of the contributor to be displayed.

Use the @equal-contrib attribute on <contrib> to indicate whether all contributors contributed equally. If the contributor whom this attribute modifies contributed equally with all other contributors, this attribute should be set to “yes”; if their contribution was greater or lesser, then this attribute should be set to “no”. These contributors may contain a link to a footnote in <author-notes> for further description, such a link should use <xref ref-type="author-notes">.

ORCID ID

Include an ORCID for an individual author in a <contrib-id> element with @contrib-id-type="orcid". Only individual authors and individual members of an organization (members of a <collab>) may have an ORCID. Specify the ORCID as a full URI—e.g. <contrib-id contrib-id-type="orcid">http://orcid.org/0000-0002-1825-0097</contrib-id>.

The @authenticated attribute can be used with a value of “true” or “false” to indicate that the authority associated with the ID type (named in @contrib-id-type) has authenticated the value of the ID. The default value is “false”. This value is used only for Crossref metadata purposes.

Value Meaning
true This contributor identifier has been marked by the issuing authority as authenticated.
false No guarantee has been made about this contributor identifier.

Corresponding authors

To indicate that a contributor is the corresponding contributor for the content, use the optional @corresp attribute: <contrib contrib-type="author" corresp="yes">. Contact information included as a child of <contrib>, such as <email>, will be stored as metadata about the author, and will be the source for features such as toll-free links. To link this author to displayed contact information, include an <xref ref-type="corresp"> with the appropriate @rid referencing <corresp> in the <author-notes> element; see Author notes for more information.

Alternative names

If a single author has more than one version of their name, use the <name-alternatives> element within the <contrib> element.

<contrib-group>
        <contrib contrib-type="author">
            <name-alternatives>
                    <name>
                            <surname>Balzer</surname>
                            <given-names>Carsten</given-names>
                    </name>
                    <name>
                            <surname>LaGata</surname>
                            <given-names>Carla</given-names>
                    </name>
            </name-alternatives>
        </contrib>
</contrib-group>

Author affiliations

If there are author affiliations (<aff>), the <aff> nodes can be included as sibling elements to the <contrib-group> node. These <aff> nodes must include an @id attribute. In the <contrib> node for which the affiliation applies, include an <xref> node that references the appropriate <aff> node.

If your sites are designed to display separate linked text from the author to the affiliation (e.g. a superscripted number), the <aff> node must include a <label>. Do not include a label as content of the <xref> in this case.

<contrib-group> 
        <contrib contrib-type="author">
            <name>
                <surname>Keefe</surname>
                <given-names>Lindsey</given-names>
            </name>
            <degrees>PhD</degrees>
            <xref ref-type="aff" rid="aff1" />
        </contrib>
        …
</contrib-group>

<aff id="aff1">
    <label>1</label>Silverchair Information Systems, Charlottesville, VA 22902. 
</aff>

Affiliations that are not linked from a <contrib> element will be ignored.

The <aff> node can also be included as a child of the <contrib> element to which the affiliation applies. Using this method, affiliations must be repeated for each contributor if multiple contributors have the same affiliation, and the @id attribute is not required.

Each affiliated organization should be included in a separate <aff> node.

Collaborative group authors

Use <collab> instead of <name> if the author is a group credited under a single name or the author is an organization (such groups may be known by other names such as collaborative groups or collectives). Members of each group can be provided inside a <contrib-group> node that is a child of the <collab> element. These contributing members are not treated as authors and will not appear in the by-line, but will be submitted to PubMed as investigators/collaborators.

On behalf of

Use <on-behalf-of> as a child of <contrib> if a single author is writing on behalf of an organization, and use the tag as a child of <contrib-group> to apply it to a list of authors. If a subset of authors is writing on behalf of an organization and another subset isn’t, group the authors in different <contrib-group> elements. The separation of authors into different <contrib-group> elements has no other bearing on the content. Include the full content for display in the <on-behalf-of> element. For example: <on-behalf-of>for the Joint Working Group</on-behalf-of>. The <on-behalf-of> will only be imported for top-level authors; it may not be included for the individual members of a collaborative group.

Author comments

Notes that are not affiliations but are specific to a contributor can be included in an <author-comment> node within the <contrib> node to which the note applies. The @content-type attribute must be included to indicate the type of note. Permitted attribute values are:

Biographical data

Include biographical data in the <bio> element within the <contrib> node to which the bio applies. A <bio> element placed as a child of <contrib-group> will apply to all authors in that group. The <bio> element may also be used under the <collab> element.

Author notes

Use an author notes section for additional notes about contributors that are not directly tied to a single author. The author notes can be included using the <author-notes> element.

Use <corresp> to include display information concerning how and with whom to correspond about content. The <corresp> must include an @id attribute for it to link to the <contrib> element.

<author-notes>
    <corresp id="cor1">
        <email>lkeefe@university.edu</email>
    </corresp>
</author-notes>

Use <fn fn-type="COI-statement"> or <fn fn-type="conflict"> in <author-notes> to include a Conflict of Interest statement. A Conflict of Interest statement can be specifically linked to an individual contrib that contains an <xref> with @ref-type="author-notes".

 <author-notes>
    <fn fn-type="COI-statement" id="con1">
      <label>*</label>
      <p>Competing Interests: The authors have declared that no competing interests exist.</p>
    </fn>
 </author-notes>

Use <fn fn-type="equal"> to provide a statement about equal contributors. This can be used separately or in conjunction with <contrib equal-contrib="yes">.

<author-notes>
    ...
    <fn fn-type="equal" id="afn9">
      <label>*</label>          
      <p>Keefe and Hibino contributed equally to this paper.</p>
    </fn>
 </author-notes>

If your sites are designed to display separate linked text from the author to the author-notes (e.g. a statement for Conflict of Interest or equal contribution), the <fn> node must include a <label>. Do not include a label as content of the <xref> in this case.

Generally acknowledgements should be included in the <ack> section of the <book-back>. Many larger books are edited by one or more persons and chapters are authored by a different group of individuals. Use <author-comment> when an individual chapter author wishes to include an acknowledgement or comment that is relevant for that individual author only and not any of the other chapter authors. For acknowledgements or notes by all the chapter authors, use the <author-notes> tag in the <book-part-meta> section. You may also use the <author-notes> tag at the <book-meta> level for notes applicable to all book authors if there is a need to differentiate the notes from acknowledgements.

Dates

The publication date for the book should be included in a <pub-date> node.

To supply a date, the following options are available:

If the date is provided in a form other than numerical month, day, and year, then the @iso-8601-date attribute must be included to supply a numerical publication date. In this case, the year, month, and day provided can be used for display, while the @iso-8601-date value is used as the underlying publication date by the system.

If an ISO 8601 date is not provided and only a <year> is supplied, January 1st of that year will be used as the underlying publication date by the system.

If a distinction between print and electronic publication date is needed, then the @publication-format attribute should be included. Use <pub-date publication-format="ppub"> to indicate a print publication date and <pub-date publication-format="epub"> to indicate an electronic publication date.

Document history

The <pub-history> element is used as a container for dates related to the processing history of the document, such as received date and accepted date, or the version history of the document.

Processing history is optional and can be included in both the book and book-part levels.

<book-meta>
    …
    <pub-history>
        <date date-type="received">
            <day>05</day>
            <month>01</month>
            <year>1998</year>
        </date>
        <date date-type="rev-recd">
            <day>24</day>
            <month>05</month>
            <year>1998</year>
        </date>
        <date date-type="accepted">
            <day>06</day>
            <month>06</month>
            <year>1998</year>
        </date>
        <date date-type="reviewed">
            <day>08</day>
            <month>06</month>
            <year>1998</year>
        </date>
    </pub-history>
    …
</book-meta>

Version history is optional and can only be included at the chapter book-part level (i.e., <book-part book-part-type="chapter">). When establishing or updating a version history, you must include <event> tagging that references the original published version, and the containing book-part must have a DOI.

Element Required attributes Notes
<event> @event-type Use “published” to reference the original version, “version” for everything else
<event-desc> @specific-use="version-number" This is where the version number is stored
<pub-date> If non-numeric date used or <day>, <month>, or <year> not provided, use @iso-8601-date
<notes> Optional field for front-end description of the version
<book-part-meta>
    …
    <pub-history>
        <event event-type="published">
            <event-desc specific-use="version-number">0</event-desc>
            <pub-date iso-8601-date="2013-07-13">
                 <day>13</day>
                 <month>07</month>
                 <year>2013</year>
            </pub-date>
        </event>
        <event event-type="version">
            <event-desc specific-use="version-number">1</event-desc>
            <pub-date iso-8601-date="2013-08-12">
                 <day>12</day>
                 <month>08</month>
                 <year>2013</year>
            </pub-date>
            <notes><p>Added A to paragraph title</p></notes>
        </event>
    </pub-history>
    …
</book-part-meta>

Permissions

The <permissions> element holds copyright information and license material. For <permissions> present in <book-meta> or <book-part-meta>, @id must be used, e.g.: <permissions id="per1">.

Copyright should include:

<permissions id="per1">
  <copyright-statement>&#xA9; 2012 Silverchair Science and Communications (SSC)</copyright-statement>
  <copyright-year>2012</copyright-year>
  <copyright-holder>Silverchair Holdings, Inc.</copyright-holder>
  ...
</permissions>

Free to Read

The <ali:free_to_read> element is a simple flag whose presence indicates that the document is free-to-read, without making statements about any additional reuse rights or restrictions. Date attributes (@start_date and @end_date) can specify when the document is free to be read. The absence of both start and end dates indicates a permanent free-to-read status. Note the namespace must be included on the element, or declared in the document header.

<permissions>
    ...
    <ali:free_to_read xmlns:ali="http://www.niso.org/schemas/ali/1.0/"/>
    ...
</permissions>

License, including free and open access

The <license> element contains the set of conditions under which people are allowed to use the content, or other license-related information or restrictions. The @license-type attribute defines the type of license being granted for the book or chapter.

license type description
@license-type="free" Free book/chapter
@license-type="open-access" Open Access book/chapter
@license-type="crown-copyright" CrownCopyright book/chapter (free)
@license-type="us-gov" USGov book/chapter (free)
@license-type="cc-by" Creative Commons Attribution license (Open Access)
@license-type="cc-by-nc" Creative Commons Attribution-NonCommercial license (Open Access)
@license-type="cc-by-nc-nd" Creative Commons Attribution-NonCommercial-NoDerivs license (Open Access)
@license-type="cc-by-nc-sa" Creative Commons Attribution-NonCommercial-ShareAlike license (Open Access)
@license-type="cc-by-nd" Creative Commons Attribution-NoDerivs license (Open Access)
@license-type="cc-by-sa" Creative Commons Attribution-ShareAlike license (Open Access)
@license-type="cc-by-igo" Creative Commons Attribution-IGO license (Open Access)
<permissions id="per1">
  ...
  <license license-type="free">
      <ali:license_ref xmlns:ali="http://www.niso.org/schemas/ali/1.0/">https://creativecommons.org/licenses/by/4.0/</ali:license_ref>
      <license-p>This content is available without a subscription.  It may not be altered in any way and proper attribution is required.</license-p>
  </license>
</permissions>

Link to PDF of content

Import a PDF of the book or book part using <self-uri> in the <book-meta> or <book-part-meta> respectively. For example <self-uri xlink:href="2011.11010094.pdf"/> where the @xlink:href value is the exact file name as it occurs in the package. Do not prepend the file name with a directory path.

The <self-uri> element is intended to link to the same piece of content in different forms. For data supplements or other book-level files use the <supplementary-material> element (section Supplementary material). For links within the same document, use the <xref> element (section Cross-references). For links to external resources, use the <ext-link> element (section External links).

To import so-called “PDF-only” books, simply include <self-uri> elements for each book part’s PDF file and omit the front matter, body, and back matter from the XML.

Supplementary material

To add supplementary material to the book, use the <supplementary-material> tag in the <book-meta>; to add supplementary material to a chapter, use the <supplementary-material> tag in the <book-part-meta>

Put the exact data supplement file name, including the extension, in the @xlink:href attribute value, as in <supplementary-material content-type="data-supplement" xlink:href="supplement.pdf">. Do not include a file path.

For data supplements use the attribute @content-type="data-supplement". For disclosures use the attribute @content-type="disclosure". If no @content-type attribute is provided, the material will be treated as a data supplement.

Any file type listed in the Zipline Packaging Requirements is acceptable for supplementary material.

Use the <label> tag for a label, and the <title> tag inside the <caption> for a title. Other explanatory text should go in the <caption> tag, in <p> elements.

If a data supplement is referenced within the text, the <supplementary-material> element must have a unique identifier in the @id attribute. Use an <xref> in the text to indicate the link to the supplement.

<xref ref-type="supplementary-material" rid="sup1">Table 3</xref>

Supplementary material can be assigned a unique identifier such as a DOI using the <object-id> tag within the element. The @pub-id-type attribute must be included with a value of either “doi” or “publisher-id”. If there is no publisher-id in an <object-id> element and the <supplementary-material> element has an @id attribute, SCM6 will use the value of the @id as the publisher-id.

Book-level asset files

Books may have ancillary material at the book level such as a book cover, front matter, etc. that publishers want available on the site in non-HTML formats. To add book-level assets to the book, use the <supplementary-material> tag in the <book-meta>.

Put the exact data supplement file name, including the extension, in the @xlink:href attribute value, as in <supplementary-material content-type="cover" xlink:href="cover.png">. Do not include a file path.

The following asset types may be included, using the values listed for @content-type.

book-level file Attribute value
Cover image @content-type="cover"
Front matter @content-type="front"
Back matter @content-type="back"
Editorial Board @content-type="ed-board"
Table of Contents @content-type="toc"
MARC record @content-type="marc"
Affiliate logo @content-type="affiliate-logo"
Google Preview PDF @content-type="preview-pdf"

Any file type listed in the Zipline Packaging Requirements for book-level files is acceptable.

Abstracts

Abstracts are included in the <abstract> node within the <book-meta> or <book-part-meta> elements. The authored abstract should have no @abstract-type attribute, or it should have the attribute @abstract-type="abstract". The attributes @abstract-type="teaser" and @abstract-type="precis" will also be imported.

Hierarchical categories

Content can be assigned to categories. Use the <subj-group subj-group-type="category"> and <subject> elements to designate categories for the book or chapter. Each category should be placed in a <subject> element within the <subj-group> element.

The following content can be assigned to categories using <subj-group>:

SCM6 does not create categories on the fly, except for catgories with category type “toc-heading” (see below) or for specific book product codes. They must be set up in SCM6 before importing. Categories—factoring in category type and hierarchy—must be unique.

SCM6 supports hierarchical categories, which allows for parent-child relationships between categories. When assigning a child-level category to content, the parent categories must also be supplied in case more than one subcategory shares the same name. Zipline can currently import up to a 2-level hierarchy. The example below shows content with a category structure of:

<subj-group subj-group-type="category">
    <subject>Wireless Sensor Networks</subject>
    <subj-group subj-group-type="category">
        <subject>Alternative Energy Harvesting Systems</subject>
    </subj-group>
</subj-group>

Since the schema only allows nested <subj-group> elements after the <subject> elements, use multiple top-level <subj-group subj-group-type="category"> nodes to designate multiple parent-child categories.

If multiple facets of organization are required and the same category name exists for multiple facets, append a hyphen and the name of the category type to the end of the @subj-group-type value. For example, if the following categories have been set up in SCM6 for the same site:

then specify the former in the XML by including:

<subj-group subj-group-type="category-Book Categories">
    <subject>Research</subject>
</subj-group>

specify the latter in the XML by including:

<subj-group subj-group-type="category-Article Categories">
    <subject>Research</subject>
</subj-group>

Optionally, SCM6 may be configured to create categories on the fly during import for the category type “toc-heading” (<subj-group subj-group-type="category-toc-heading">). If this configuration is turned on, the system will create new categories under this category type when it finds new values in the XML. By default this configuration is turned off; please consult your Silverchair representative to enable the configuration.

Taxonomies

To assign content to a taxonomy, use <subj-group subj-group-type="category-taxonomy-collection"> and place each taxonomic ID in <subject>. Use only one <subject> per <subj-group>.

<subj-group subj-group-type="category-taxonomy-collection">
    <subject>T-123</subject>
</subj-group>
<subj-group subj-group-type="category-taxonomy-collection">
    <subject>T-456</subject>
</subj-group>

Note that before content can be assigned to a taxonomy, the taxonomy must exist in the SCM6 database or the content will produce an error. To add a taxonomy to the database, upload it as an RDF file via the Zipline API. For more information, see the Zipline User Guide.

In progress books (advance publication)

To designate a book as “in progress” ahead of print publication, use a <custom-meta> node with <meta-name>in-progress</meta-name> and <meta-value>in progress</meta-value>.

<custom-meta-group>
        <custom-meta>
            <meta-name>in-progress</meta-name>
            <meta-value>in progress</meta-value>
        </custom-meta>
</custom-meta-group>

Book Industry Communication (BIC) and Book Industry Standards and Communications (BISAC) Product Codes

To designate a BIC or BISAC product code for a book or book chapter, use <subj-group subj-group-type="bic"> or <subj-group subj-group-type="bisac">.

<subj-group subj-group-type="bic">
    <subject>JPVK</subject>
</subj-group>

Front matter

The front-matter section is optional. Front matter is generally shown on the book TOC page on the site, usually with its own link to view the front matter content. Publishers can use the named (predefined) book part elements from BITS in the book and book-part front matter, or use <front-matter-part> for anything not covered by the predefined elements. The @book-part-type attribute on <front-matter-part> can be used to differentiate these front matter parts.

To indicate that a piece of front matter should be suppressed from search, use the attribute @indexed on <front-matter-part> (<front-matter-part id="BDD1-ex" indexed="no">).

Table of contents

The TOC is automatically generated from the order of the chapters and parts as designated in the XML (or as reordered in the Zipline interface). For a book contained in a single XML file, arrange the parts and chapters in the order you wish them to appear on the TOC, with the correct nesting for chapters inside parts.

You may submit a pre-structured table of contents using the <toc> element in book parts or at the top level of the book-part-wrapper. The <toc> element is a presentational model and not a metadata model—it is for display only and will not affect the actual order or structure of book parts in the book.

Back matter

The <book-back> element is optional. Within <book-back>, the @book-part-type attribute on <book-part> can be used to differentiate end matter parts.

To indicate that a piece of end matter should be suppressed from search, use the attribute @indexed on <book-part> (<book-part id="9101" book-part-type="illustration" indexed="no">).

Book body

A book may include parts and chapters, tagged using the <book-part> element with either the @book-part-type="part" or @book-part-type="chapter" attribute. Other values in @book-part-type are prohibited.

To indicate that a book-part should be suppressed from search, use the attribute @indexed on <book-part> (<book-part id="5678" book-part-type="chapter" indexed="no">).

Include part and chapter numbers/designations in the <label> element under the <title-group>, along with the term you’d like used to refer to that part. Chapter “numbers” may be either numeric or non-numeric, e.g. e17 for an electronic-only chapter or 3s indicating a supplemental chapter. For example, the tagging

<book-part id="1234" book-part-type="part">
    <book-part-meta>
        <title-group>
            <label>Part 1</label>
            <title>Bees and Honey</title>
        </title-group>
    </book-part-meta>
</book-part>

will produce the following output on the site (styling shown for illustrative purpose only): Part 1 Bees and Honey

Include part and chapter titles in the <title> element under <title-group>. Include subtitle in the <subtitle> element under <title-group>.

Parts

Use Parts for any piece of the book hierarchy that does not include text content, i.e. anything above a chapter. Some books use the term “Section” instead of Part.

Book parts are indicated using the <book-part> tag with an attribute of @book-part-type="part". Parts may be nested in other parts, and parts may contain chapters.

<book-part id="1234" book-part-type="part">
    <book-part-meta>
        <title-group>
            <label>Part 1</label>
            <title>Bees and Honey</title>
        </title-group>
    </book-part-meta>
    <body>
        <book-part id="chapter_1" book-part-type="chapter">
            <book-part-meta>
                <title-group>
                    <label>Chapter 1</label>
                    <title>Honey Production</title>
                </title-group>
            </book-part-meta>
        </book-part>
        <book-part id="chapter_2" book-part-type="chapter">
            <book-part-meta>
                <title-group>
                    <label>Chapter 2</label>
                    <title>Honey Collection</title>
                </title-group>
            </book-part-meta>
        </book-part>
    </body>
</book-part>

Chapters

Chapters may contain text content. Chapters can be inside or outside a part. For example, the structure below is acceptable. Chapters may not contain other parts or chapters; the chapter must be a leaf node in the TOC structure of the book.

The chapter element is <book-part book-part-type="chapter">. Required attributes are @book-part-type="chapter", and @id.

<book-part id="1111" book-part-type="chapter">
    <book-part-meta>
        <title-group><title>Introduction</title></title-group>
    </book-part-meta>
</book-part>
<book-part id="1234" book-part-type="part">
    <book-part-meta>
        <title-group>
        <label>Part 1</label>
            <title>Bees and Honey</title>
        </title-group>
    </book-part-meta>
    <body>
        <book-part id="chapter_1" book-part-type="chapter">
            <book-part-meta>
                <title-group>
                    <label>Chapter 1</label>
                    <title>Honey Production</title>
                </title-group>
            </book-part-meta>
        </book-part>
        <book-part id="chapter_2" book-part-type="chapter">
            <book-part-meta>
                <title-group>
                    <label>Chapter 2</label>
                    <title>Honey Collection</title>
                </title-group>
            </book-part-meta>
        </book-part>
    </body>
</book-part>

Special features for books

Headings

Special characters within headings need to be Unicode entity values. Inline images are supported.

Related content

Links to content in SCM6

You may link content to other content that is published separately in the SCM6 system. Your site can use these links to surface related content to the user. Some example use cases include:

Use the <related-object> element in <article-meta>, <book-meta> or <book-part-meta> to designate a relation to another piece of content, or in the running text to link between chapters in books. Use the @document-type, @document-id-type, and @document-id attributes to designate the type of content and document to target. To link to an object (e.g. figure, table) within a piece of content, also include the @object-type, @object-id-type, and @object-id attributes with the appropriate values. You must designate both the document and the object when linking to an object.

Links to the following content types can be created from articles, books and chapters. For links to non-standard content, the target content must be imported first, or be in the same package when creating a link. For links to other content, the XML with the <related-object> tag and the target XML can be imported in any order.

Target document/content type tagging format
Non-standard <related-object document-type="non-standard" document-id-type="publisher-id" document-id="gbos123-12345"/>
Book (using ISBN 13) <related-object document-type="book" document-id-type="isbn13" document-id="1-234-56790-3"/>
Book (using ISBN 10) <related-object document-type="book" document-id-type="isbn10" document-id="7412589636"/>
Book (using eISBN) <related-object document-type="book" document-id-type="eisbn" document-id="1-234-56790-3"/>
Standalone multimedia (using DOI) <related-object document-type="multimedia" document-id-type="doi" document-id="11.1111/11111111"/>
Standalone multimedia (using publisher ID) <related-object document-type="multimedia" document-id-type="publisher-id" document-id="vid.oneoneone" />

To target objects within the document, additionally include the following attributes:

Target object tagging format
Main Division (in non-standard only) < … object-type="main-division" object-id-type="publisher-id" object-id="gbos123-12345.part1"/>
Part (in book only) < … object-type="part" object-id-type="publisher-id" object-id="book1.part1"/>
Chapter (in book only) < … object-type="chapter" object-id-type="publisher-id" object-id="book1.ch1"/>
Jump point (in multimedia only) < … object-type="jump-point" object-id-type="publisher-id" object-id="mm1234.jump001"/>
Jump point, hidden (in multimedia only) < … object-type="jump-point" object-id-type="publisher-id" object-id="mm1234.jump001"/>
Section < … object-type="sec" object-id-type="publisher-id" object-id="12345.sec01"/>
Figure < … object-type="fig" object-id-type="publisher-id" object-id="12345.fig01"/>
Table < … object-type="table" object-id-type="publisher-id" object-id="12345.table01"/>
Video < … object-type="video" object-id-type="publisher-id" object-id="12345.vid01"/>
Audio < … object-type="audio" object-id-type="publisher-id" object-id="12345.aud01"/>
Bibliographic reference < … object-type="bibr" object-id-type="publisher-id" object-id="12345.ref01"/>
Page number < … object-type="target" object-id-type="publisher-id" object-id="12345.page01"/>
End note < … object-type="end-note" object-id-type="publisher-id" object-id="12345.endnote01"/>
Supplementary data < … object-type="supplementary-data" object-id-type="publisher-id" object-id="12345.supdata01"/>

For example <related-object document-type="non-standard" document-id-type="publisher-id" document-id="gbos123-12345" object-type="fig" object-id-type="publisher-id" object-id="12345.fig01"/>

An example of chapter-to-chapter links in the running text: <related-object document-type="book" document-id-type="isbn13" document-id="9781234567890" object-type="chapter" object-id-type="publisher-id" object-id="book-9781234567890-ch1">Chapter 1</related-object>

Links to objects within non-standard content will not be maintained if the target content is replaced.

Use the @link-type attribute to designate the link type. The link-type must match a value in our system. If the link-type is directional in nature (e.g. A is a correction for B vs. B is corrected by A), the link-type should follow the logic:

“The content in this XML is a/the [linkType] of/for the target content.”

Embedding objects from other content

Use the <related-object> tag within a <p content-type="embed-container"> to include a portion of another piece of content in your content. For example, if there is a standalone video you would like to re-use in your content, you may reference that video for display without importing another copy. Referencing content in this way will not create a new copy of the content; if the referenced content is replaced, the updated version will display with your content.

The following table lists the types of objects from other content that can be referenced.

referenced content child element @object-id value in the <related-object> tag
Standalone multimedia figures <fig> Reference the id of the <fig> element; not the <graphic> element within the <fig>.
Standalone multimedia videos <media> Reference the id of the <media> element.

You may include new textual content such as a label, title, and caption with your XML.

Use the following format to include objects from other content:

<p id="sample.vid1" content-type="embed-container">
    <related-object document-type="multimedia" document-id-type="doi" document-id="11.1111/11111111" link-type="embed-consumer"/>
    <media>
        <label>Video 1</label>
        <caption>
            <title>Video title</title>
            <p>This is a new caption for the borrowed video.</p>
        </caption>
    </media>
</p>

External links to related content

You may also link content to related external links at the book (<book-meta>) and chapter level (<book-part-meta>). Your site can use these links to surface related content to the user.

Use the <related-object> element in the <book-meta> or <book-part-meta> to designate a relation to an external link. Use the @document-type, @source-id, @source-id-type, and @source-type attributes to designate the type of content and external link target.

Links to the following source types can be created from books and chapters.

Type of external link tagging format
Companion website <related-object document-type="url" source-id="http://www.companionwebsite.com" source-id-type="url" source-type="companion-website">Companion website</related-object>
Blog article <related-object document-type="url" source-id="http://blog.oxforddictionaries.com/2012/11/vsi-english-literature-text-analyser/" source-id-type="url" source-type="blog-article">Text analyser</related-object>
Video <related-object document-type="url" source-id="http://www.youtube.com/watch?v=e1Hk9yNS5ZE" source-id-type="url" source-type="video">Jonathan Bate - English Literature: A Very Short Introduction</related-object>
External resource <related-object document-type="url" source-id="http://www.externalsource.com" source-id-type="url" source-type="external-resource">External resource</related-object>

Author assigned keywords

SCM6 accepts keywords in <book-meta> and <book-part-meta>. Speak to your build team about using keywords to create quick search links on the chapter page. Keywords do not require advance setup in SCM6 and will be created on the fly during import.

<kwd-group kwd-group-type="Chemicals">
    <kwd>chlorantraniliprole</kwd>
</kwd-group>

Restricted images based on electronic rights

To designate a figure image as restricted due to lack of electronic rights, include the <permissions> element as a child of <fig>, with a <license license-type="NoElectronicRight"> element inside the <permissions>. This type of restricted image will not be displayed and should not be supplied. Instead, the user will see a notice that indicates that the image has been omitted due to lack of electronic rights.

Q&A content

SCM6 allows the ability to designate when content is Q&A content. You can designate that a piece of content is an answer or question using the following values in @specific-use on the <sec> containing the Q&A content:

Value of
@specific-use Definition
question-set a set of multiple questions
question a single question
answer-set a set of multiple answers
answer a single answer

Speak to your build team if you need specific functionality associated with these designations.

Body

Sections and paragraphs

Sections can be nested to form sub-sections. Sub-sections intended to be at the same sub-section level should appear in the XML in <sec> elements at the same nested level.

The paragraph element <p> describes block-level text. Paragraph elements cannot be nested. Each <p> element does not necessarily need to represent a single key point, thought, or topic as in the common definition of a paragraph. For example, if a list appears in the middle of a paragraph (in the common sense), then the paragraph should be split into two separate <p> elements with a <list> element in between.

Automatic numbering

Automatic numbering of figures (and analogous elements such as tables and boxed text) is not provided. If numbering is wanted the numbers should be provided in the <title> or <label> element contents.

<fig id="f1">
    <label>Fig. 1</label>
    <caption><p>A schematic of … </p></caption>
    <graphic xlink:href="JBO_17_2_026001_f001.png"/>
</fig>

The exception to this requirement is bibliographic references, which will be automatically numbered if no numbering is provided.

Nesting special content elements

Certain content elements—figures, tables, boxed-text, graphics, media, supplementary material, lists, and verse groups (poems)—can have special display characteristics enabled on SCM6. For example, clicking on a figure may enlarge the image, or tables may be listed in an index of tables.

Nesting these elements inside any other special element, or inside a paragraph element, may cause those special display characteristics to fail. In general, nesting these elements should be avoided if they need to be detected for special display logic.

Figures and graphics

Figures

Figures (<fig>) should be placed after the paragraph in which they are cited, not mid-paragraph. If more than one figure or table is cited in any particular paragraph, they should be placed in the order they are cited. If they are cited in a list item, they should be placed after the (outermost) closing list tag.

<p>... in <xref ref-type="fig" rid="f1">Fig.&#xA0;1</xref>. The ...</p>
<fig id="f1"><label>Fig. 1</label><caption><p>...</p></caption><graphic xlink:href="XXX_22_2_026001_f001.png"/></fig>

<fig> elements should be used for formal figures, especially when numbered and/or captioned. If your site includes features such as an index of figures, figure carousel, or tab of figures, the <fig> element designates the items that appear in those features.

If a figure has more than one image part, and the image parts require labels, use the <fig-group> element. For example, the group of figures may have a caption, with the internal figures each having their own label and caption.

The @id attribute must be used on the <fig> or the <fig-group> if they will be referenced from the body of the text using an <xref>.

The <graphic> element within the <fig> is used to point to the external file containing a still image. A <graphic> must have an attribute @xlink:href, whose value should be the exact file name of the image. Provide only the literal file name relative to the directory specified for the file in the appropriate packaging guidelines. For example, a figure image stored directly in the Assets directory should use @xlink:href="image.png" without a file path preceding the file name.

To designate a figure image as restricted, include the <permissions> element as a child of <fig>, with a <license license-type="restricted"> element inside the <permissions>. Restricted images can prevent download of the image, for example.

Figures can be assigned a unique identifier such as a DOI using the <object-id> tag within the element. The @pub-id-type attribute must be included with a value of either “doi” or “publisher-id”.

Graphics

The <graphic> element can also be used without a <fig>. A <graphic> can be placed either outside or inside a paragraph, and will appear on its own line in either case.

This tagging should be used for images that are not numbered and may or may not have a label, such as author headshots. These images will appear within the text of the document, without a pop up. These images will not appear in features such as the table of figures.

Inline graphics

Inline graphics appear within a line of text, and are tagged using the <inline-graphic> element. An <inline-graphic> must have an attribute @xlink:href, whose value should be the exact file name of the image.

<p>The temperatures rose 20 degrees <inline-graphic xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="sparkline.png" /> in 20 minutes. ...</p>

Tables

Use the <table-wrap> element to include tables. The element may contain a <label> and <caption>, and must contain a <table> or <graphic> element. Include XML content for the table in <table>. To provide the table content in the form of an image, use the <graphic> element to point to the image file instead of using the <table> element.

Like figures, tables should be placed after the paragraph in which they are cited, and not mid-paragraph.

A <graphic> must have an attribute @xlink:href, whose value should be the exact file name of the image. Provide only the literal file name relative to the directory specified for the file in the appropriate packaging guidelines. For example, a table image stored directly in the Assets directory should use @xlink:href="image.png" without a file path preceding the file name.

If a group of tables should be treated as a unit, group tables using the <table-wrap-group> element. For example, the group of tables may have a caption, with the internal tables each having their own label and caption.

The @id attribute must be used on the <table-wrap> or <table-wrap-group> if the table will be referenced by an <xref> from elsewhere in the article.

Tabular formatting

To apply tabular formatting to content without the full-fledged table treatment (e.g. listing in table of tables, expandable thumbnails, downloads), use either the <table-wrap> element with a @specific-use="inline" attribute or the <array> element. The element <table-wrap specific-use="inline"> allows a label, title, caption, and column headings while the <array> does not. However, the <array> element is commonly understood whereas the use of <table-wrap specific-use="inline"> is idiosyncratic to SCM6.

Sidebars and boxed-text

Use the <boxed-text> element without a @content-type attribute for a boxed-text that is not a sidebar.

For sidebars, use the <boxed-text> element with special flags on the @content-type attribute. There are three types of sidebars allowed, in three sizes, as indicated by the value of the @content-type attribute:

Placement in XML is indicative of online placement; for instance, if a sidebar or box is placed between two paragraphs, that is where it will appear on the web site.

Like figures and tables, sidebars and boxed-text may be numbered by using <label>, and can include a <caption>. The @id attribute must be used on the <boxed-text> if the boxed text will be referenced by an <xref> from elsewhere in the article.

Sidebars and boxed text should not be placed mid-paragraph.

Multimedia

Include video, audio, or models in a <fig> element with attribute @fig-type="video", @fig-type="audio", @fig-type="model", respectively. The <fig> element for multimedia must have a child <media> element instead of a <graphic> element. The <media> element within the <fig> designates the multimedia file or location.

Place the <fig> element after the paragraph in which it is cited, not mid-paragraph. If more than one figure or table is cited in any particular paragraph, they should be placed in the order they are cited. If they are cited in a list item, they should be placed after the (outermost) closing list tag.

Do not include multimedia inside a <fig-group>.

The @id attribute must be used on the <fig> if the multimedia will be referenced from the body of the text using an <xref>.

Multimedia can be assigned a unique identifier such as a DOI using the <object-id> tag as a child of the <fig> element. The @pub-id-type attribute must be included with a value of either “doi” or “publisher-id”.

Brightcove

Use Brightcove content for multimedia by using @content-type="brightcove" on the <media> element.

To identify the video in Brightcove, one of either the Brightcove Video ID or Brightcove Reference ID must be included using <object-id pub-id-type="videoid"> and <object-id pub-id-type="referenceid">, respectively, as a child of the <media> element. Both may be included. Optionally, include Brightcove’s shortened URL for the video in the @xlink:href attribute. Do not include other Brightcove metadata in the XML.

Note that the <object-id> under the <media> element points to the video in Brightcove, while the <object-id> under the <fig> assigns an ID to the figure/video/audio.

<fig id="video1" fig-type="video">
    <object-id pub-id-type="doi">10.9999/SSC_20120928_v107i3_043_video1</object-id>
    <label>Video 1</label>
    <caption><title>Fluoroscopy</title><p>Video of fluoroscopy.</p></caption>
    <media content-type="brightcove" xlink:href="http://bcove.me/hky4pn1o">
        <object-id pub-id-type="videoid">123456789</object-id>
        <object-id pub-id-type="referenceid">myVideo1</object-id>
    </media>
</fig>

Sketchfab

Use Sketchfab content for multimedia by using @content-type="sketchfab" on the <media> element.

To identify the model in Sketchfab, the model ID must be included using <object-id pub-id-type="modelid"> as a child of the <media> element.

Note that the <object-id> under the <media> element points to the model in Sketchfab, while the <object-id> under the <fig> assigns an ID to the model in our system.

<fig id="model1" fig-type="model">
    <object-id pub-id-type="doi">10.9999/SSC_20120928_v107i3_043_model1</object-id>
    <label>Model 1</label>
            <caption><title>Model Title</title><p>Description of the model.</p></caption>
            <media content-type="sketchfab">
                 <object-id pub-id-type="modelid">123cf4cc5d67e89f1bf0000ad123df456</object-id>
            </media>
    </fig>

Math and equations

Equations must be placed in a <disp-formula> element or an <inline-formula> element. Both formula elements may contain text, MathML, LaTeX, TeX or images. The <inline-formula> may not contain a <graphic>, but may contain an <inline-graphic>.

Equations appearing on their own line should be contained in a <disp-formula> element. The <disp-formula> element may be placed inside or outside a <p>. To label the formula—for example, with a number that appears to the right of the formula—include the label text in a <label> within the <disp-formula>. The <disp-formula> may be referenced by an <xref>; if the formula will be referenced, an @id attribute must be included.

Equations appearing within a line of text should be placed in an <inline-formula> element. The element should appear within a paragraph (<p>) or other element containing text. Inline formulas cannot be referenced by an <xref>.

Mathematical equations can be described using MathML contained in the <mml:math> element. If both an image and MathML have been provided for a particular equation, we will display the image. The image file name is declared in the @altimg attribute value on the <mml:math> element and it must match the file supplied. If no image is provided, we will display the formatted MathML.

XML Schema allows use of any namespace prefix for the MathML elements. However, the MathML elements must use “mml” as the namespace prefix to validate to the JATS DTD.

Mathematical equations can also be described using LaTeX or TeX contained in the <tex-math> element. Further wrap the LaTeX markup in CDATA or escape special literal characters (e.g. ampersands) to prevent them from invalidating your XML document.

Details in the MathML documentation may be found at http://www.w3.org/TR/MathML2/.

Statements

Include formal statements such as theorems, lemma, and proofs in a <statement> element.

Lists

Place lists inside the <list> element. The <list> element should not be placed within a <p> element. The @list-type attribute can be used to designate the type of list as follows. If no @list-type is provided, the list will default to a simple list. Do not include the list item character (i.e. numbering or bullets) in the content; this will be generated automatically.

List types
list-type attribute Default list item character Notes
simple n/a Gets list indentation, but no character in front of each item. Sometimes called “unordered”.
bullet
number 1, 2, 3
alpha-lower a, b, c
alpha-upper A, B, C
roman-lower i, ii, iii, iv
roman-upper I, II, III, IV

Poems

Poems can be included in the <verse-group> element. The <verse-group> element should not be placed within a <p> element.

Cross-references

Cross-reference links to items within the same XML document are indicated with the <xref> element. (However, for a book supplied as one XML document, chapter-to-chapter links must use <related-object> as described in Related content.) The @ref-type attribute indicates the element type of the cross-reference target and the @rid provides its id value; @rid is required except for links to the list of supplementary data (see Supplementary material).

SCM6 supports the following different <xref> types, and specific behavior should be confirmed with the build team. Attribute types for <xref ref-type>:

Ref types
ref-type attribute Notes
aff Affiliation
app Appendix
author-notes Author notes
bibr Bibliographic reference
boxed-text Textbox or sidebar
corresp Corresponding author
disp-formula Display forumula
fig Figure or group of figures
fn Footnote
other None of the other items listed
sec Section
supplementary-material Supplementary material file
table Table or group of tables
table-fn Table footnote

An <xref> element used to designate an affiliation for a contributor must also have a @ref-type="aff" attribute. An <xref> element used to connect a contributor to a Conflict of Interest statement in <author-notes> should have a @ref-type="author-notes". Similarly, an <xref> element used to connect a contributor to a footnote indicating equal contribution in <author-notes> should have a @ref-type="author-notes".

Except for references to author affiliations, correspondence information for authors, bibliographic references, and Conflict of Interest statements, the content of the element—often the figure number—must be included. Provide literal content for display as shown by the “4(g)” in this example:

See figure <xref ref-type="fig" rid="f4">4(g)</xref>.

If the bibliographic references in the <ref-list> section have an @id attribute, then SCM6 can generate the display text for the link automatically, and this method is preferred.

Jones<xref ref-type="bibr" rid="bib2" /> shows that…

The @rid attribute may have multiple values; separate each value with a space. If a document has a string of cross references either a single <xref> can link to all the reference in the string or each reference can have an <xref>. So, if a document contains:

… widely discussed [1, 2, 3] in the …

you may either tag:

… widely discussed [<xref ref-type="bibr" rid="r1" />, <xref ref-type="bibr" rid="r2" />, <xref ref-type="bibr" rid="r3" />] in the …

(cross references to bibiographic references can take the label from the target)

or

… widely discussed [<xref ref-type="bibr" rid="r1 r2 r3">1, 2, 3</xref>] in the …

or

… widely discussed [<xref ref-type="bibr" rid="r1">1</xref>, <xref ref-type="bibr" rid="r2">2</xref>, <xref ref-type="bibr" rid="r3">3</xref>] in the ….

You may also include the content as a range. The following would appear as “… widely discussed [1–3] in the …”.

… widely discussed [<xref ref-type="bibr" rid="r1 r2 r3">1–3</xref>] in the …

Content outside of the XML file can be cross-referenced using the <related-object> element. See Related content for guidance in structuring those links.

Use the <ext-link> element for links external to SCM6 from the content’s text. The @xlink:href attribute should be used to indicate the location of the external content.

References

References or bibliographic citations should be tagged inside <ref-list>. Each bibliographic entry should be in a <ref> element.

References should be tagged at as granular a level as possible to enable SCM6 to query PubMed, Crossref or other online databases; retrieve citation information and turn it into a live link; and format citations on the site. Granular tagging also enables any other functionality based on references that may be desired on the site.

Silverchair recommends that at least these elements should be tagged:

SCM6 can create links to PubMed and Crossref for journal articles referenced in the references section. For SCM6 to determine and create these links, the @publication-type="journal" attribute must be included in the <element-citation> or <mixed-citation> element.

Crossref, PubMed, arXiv, and Web of Science information may optionally be supplied with the references by including a <pub-id> element. Use the attribute @pub-id-type="doi" for a DOI, @pub-id-type="pmid" for PubMed ID, @pub-id-type="arxiv" for arXiv, and @pub-id-type="wos" for Web of Science.

The system provides formatting and punctuation for <element-citation>, while <mixed-citation> is formatted and punctuated from the source data.

If you are using <element-citation>, we suggest you preview the rendition of your data in our system to ensure good results.

<element-citation publication-type="journal" publication-format="print">
    <name><surname>Carila</surname><given-names>RC</given-names></name>
    <name><surname>Poole</surname><given-names>JM</given-names></name>
    <name><surname>Keefe</surname><given-names>LE</given-names></name>
    <name><surname>Wan</surname><given-names>L</given-names></name>   
    <article-title>Blood pressure levels among sedentary workers</article-title>   
    <source>J Dem Diseases</source>
    <year>2012</year>
    <month>Jan</month>
    <volume>32</volume>
    <issue>1</issue>
    <fpage>112</fpage>
    <lpage>116</lpage>   
</element-citation>

If you are using <mixed-citation> the XML must include all punctuation and spacing (such as the space between the <surname> and <given-names> below) as it should be displayed.

<mixed-citation publication-type="journal" publication-format="print"><string-name><surname>Carila</surname> <given-names>RC</given-names></string-name>, <string-name><surname>Poole</surname> <given-names>JM</given-names></string-name>, <string-name><surname>Keefe</surname> <given-names>LE</given-names></string-name>, <string-name><surname>Wan</surname> <given-names>L</given-names></string-name>. <article-title>Blood pressure levels among sedentary workers</article-title>. <source>J Dem Diseases</source>. <year>2012</year> <month>Jan</month>; <volume>32</volume>(<issue>1</issue>): <fpage>112</fpage>–<lpage>116</lpage>.</mixed-citation>

Note: some users prefer to use <element-citation> for citations types such as articles, where automatic formatting is likely to be satisfactory and use <mixed-citation> for unusual citation types (e.g., court cases, unpublished letters) where the citation format is more unique.

The <ref> element must have an @id attribute if it is linked from elsewhere in the content using an <xref>.

Data citations

When citing a data set, use @publication-type="data". Use @person-group-type="curator" on <person-group> when appropriate. Include at least one of <data-title> (name of data set) or <source> (name of repository holding the data). Wrap the repository ID in <pub-id> and include the full URI to the data, if known, in @xlink:href. Use @assigning-authority on <pub-id> when appropriate to identify the group responsible for the identifier.

 <mixed-citation publication-type="data"> ... <data-title>Dataset 10</data-title> <source>FigShare</source>. <pub-id pub-id-type="doi" assigning-authority="figshare" xlink:href="http:doi.org/10.6084/m9.figshare.815894">10.6084/m9.figshare.815894</pub-id>.</mixed-citation>

Footnotes

Footnotes should be included in an <fn-group> element, with each footnote in an <fn>. The <fn> element must have an @id attribute if it is linked from elsewhere in the content using an <xref>. Footnotes provided in any other section of the document will display in the section where they appear instead of as a separate footnotes section.

Image maps

To include an image map, list the coordinates and corresponding links in <ext-link> elements inside the <graphic> node. Put the coordinates in a <named-content content-type="coordinates"> element. Linked areas will be rectangular. List the coordinates in order x1,y1,x2,y2, where: