| Date | Description | Version |
|---|---|---|
| See consolidated revision history page |
Silverchair has created a new tag set for loading standalone multimedia XML wrappers into SCM. We used newly created high-level elements (<multimedia>, <multimedia-meta>, <media-group>, and <multimedia-back>) and then used standard JATS for the child elements and attributes.
Because this implementation of multimedia is unique to Silverchair, the recommendations below represent a very limited selection of elements. 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.
Packaging requirements for Zipline loading are available in the Zipline User Guide via the client tool portal.
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 in a zip package on the main specifications site http://specifications.silverchair.com/.
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; SCMM-multimedia.xsd, for standalone multimedia; and a SC-common.xsd file that serves as the base XSD for all formats.
The following sample files have been provided in the Silverchair specifications zip package to illustrate commonplace examples of platform features. These XML files are provided alongside the Silverchair XSD files as representative, but not authoritative, samples and should be considered supplemental only.
XML must be well-formed conformant XML according to the W3C XML Recommendation, fully tagged, and valid to the SCMM schema. XML must also meet the requirements in this Silverchair specification.
Declarations required at the top of each XML file are:
Example:
<?xml version="1.0" encoding="UTF-8"?>
UTF–8 character encoding is required to ensure that characters are translated properly upon import into the SCM database. Content XML may also contain numeric character references (e.g., ř or ř) 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 V̇ which will produce this: V̇.
Silverchair defines standalone multimedia as any image, video, link, or other file format that comes to us independent of another XML-based resource. Examples include independent videos hosted by a third-party (such as Cadmore) with metadata and XML wrappers for independent PDF objects. Standalone multimedia must be loaded as an independent object and may even constitute a content set that has no other journal, conference, or book content counterpart.
By contrast, integral multimedia consists of media that are part of the content of a larger XML resource. For example, a textbook may contain a number of images that are called out in the text and should be imported as assets of that resource.
Standalone multimedia may link to other pieces of content even though they are independent content objects. In other words, they may designate other XML-based resources as related content. Related content can be declared in the XML wrapper submitted with the multimedia (see Related content, below).
Below is a very basic template for structuring a standalone multimedia XML wrapper. Keep in mind that the overall structure of the xml file will depend on the kind of media being submitted and the metadata requirements for that object.
<?xml version="1.0" encoding="UTF-8"?>
<multimedia
multimedia-type="xray" xml:lang="en"
xmlns:mml="http://www.w3.org/1998/Math/MathML"
xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://specifications.silverchair.com/xsd/1/39/SCMM-multimedia.xsd"
xsi:schemaLocation="http://specifications.silverchair.com/xsd/1/39/SCMM-multimedia.xsd SCMM-multimedia.xsd">
<multimedia-meta>
<object-id pub-id-type="publisher-id">publisher-id.object</object-id>
<object-id pub-id-type="doi">10.1234/id_value</object-id>
<subj-group subj-group-type="category-multimedia-collection">
<subject>Silverchair Multimedia of Demonstrable Diseases</subject>
</subj-group>
<title-group>
<label>Multimedia 1.</label>
<title>Title of Multimedia</title>
</title-group>
<contrib-group>
<contrib>
<name>
<surname>Smith</surname>
<given-names>John Q.</given-names>
</name>
<degrees>MD</degrees>
</contrib>
</contrib-group>
<pub-date publication-format="epub" iso-8601-date="2020-07-23"/>
<permissions/>
<related-object document-type="article" document-id-type="doi"
document-id="10.9999/SSC_20200723_044.fakearticle"/>
<related-object document-type="book" document-id-type="isbn13" document-id="123-4-56-789012-8"
object-type="chapter" object-id-type="publisher-id" object-id="legacySectionID-value"/>
</multimedia-meta>
<media content-type="image" xlink:href="image.png">
<caption>
<p>This is an image with a caption.</p>
</caption>
</media>
<multimedia-back>
<ref-list>
<title>References</title>
<ref id="bib1">
<label>1.</label>
<element-citation publication-type="journal" publication-format="print">
...
</element-citation>
</ref>
</multimedia-back>
</multimedia>
Every file must receive a unique identifier for automatic replacements and related content linking to work. Many clients choose to assign DOIs to their digital objects and use these as the unique identifier, but in the absence of these, Silverchair relies on the publisher to create and manage unique publisher IDs. Note that although DOIs are not required in general, the Glencoe API relies on DOIs to retrieve multimedia objects, so a DOI should be included when the standalone multimedia file includes multimedia hosted by Glencoe.
Zipline will use the multimedia’s DOI or publisher ID to automatically identify duplicate multimedia and make replacements. DOI will take precedence over publisher ID for the purpose of matching multimedia. To replace content, the value of the DOI or publisher ID must be unique and remain stable for the revised content to correctly replace the originals on the site.
Use the following nodes to designate the multimedia’s unique ID:
| ID | node |
|---|---|
| DOI | <object-id pub-id-type="doi"> |
| publisher ID | <object-id pub-id-type="publisher-id"> |
For content without DOIs, please consult with Silverchair if there is any question about how best to assign IDs to new content.
We also ask that, whatever your system of choice for assigning IDs, please use it for assigning IDs to filename and image naming conventions as well.
Every standalone multimedia record must have the root element of <multimedia>. The following elements are contained within the root element:
<multimedia-meta>: contains the information about the multimedia (i.e., metadata).<media-group>: contains the <media> element and <alternatives> element, and allows grouping of multiple media of one type.<media>: contains the media itself and its caption.<alternatives>: contains the media of video or audio when supplying a media file to be archived for downstream purposes.<multimedia-back>: contains the multimedia’s references or bibliographic citations.Please note that you have a choice to use one of <media-group>, <media>, or <alternatives> to meet your needs and cannot use more than one.
The @multimedia-type attribute on the root <multimedia> element is required and is used for indexing and retrieval. Any value may be used for multimedia type, but all multimedia types must be set up in SCM before importing the multimedia. Note that spaces and variations in punctuation and spelling will be read and processed as different multimedia types, though values supplied for @multimedia-type are not case-sensitive. See example below:
<multimedia multimedia-type="podcast">
The element <multimedia-meta> provides information on the individual object being submitted. It contains all the metadata directly related to the object itself. This element is required. The following sections describe what is available in the <multimedia-meta> element.
The standalone multimedia object must also carry a unique ID in the <object-id> element. See Unique identifiers for more detail.
The object you are submitting can belong to a general collection set for the site. This general collection set might be a browsable feature on the site (perhaps there is a “Browse Multimedia” option in the navigation) or it might be accessible only through its declared related content objects. Either way, the <subj-group subj-group-type="category-multimedia-collection"> element is set aside for telling our system which collection set the object is a part of.
See the snippet from the example above:
<subj-group subj-group-type="category-multimedia-collection">
<subject>Silverchair Multimedia of Demonstrable Diseases</subject>
</subj-group>
In this example, <subj-group>, and its child element, <subject>, is the name of the overall collection set to which the multimedia object belongs, and <subject> is a required element. Please keep in mind that, if the content set is meant to be browsed on your site, the value of <subject> should reflect how you want that content set to appear on your site. Also, these values must be set up ahead of time in SCM.
Content can be assigned to categories. Use the <subj-group subj-group-type="category"> and <subject> elements to designate categories for the content. 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>:
These categories are not created on the fly. They must be set up in SCM before importing. Categories—factoring in category type and hierarchy—must be unique.
SCM 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>
Because 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.
Please note that although @content-type is allowed on the <subject> element, its use is intended for pass-through only and does not drive any functionality on SCM.
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 SCM 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, please consult the Zipline User Guide via the client tool portal.
Every object must contain a title using <title-group> tagging. Please include a <title> element with a value. Use of the <label> element is optional.
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 unless configured with the development team prior to loading. Please note that any @contrib-type value other than “author” will need a configuration turned on by the development team to display.
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 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">. Please note that equal contributor information is not currently imported into our system for books.
You can use the @initials attribute on <surname> and <given-names> if contributor initials are made available in your XML authoring workflow. This attribute is not imported by our platform.
Include an ORCID iD 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 iD. Specify the ORCID iD 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. |
To be accepted by Crossref, the ORCID iD must pass a checksum using a check digit, which is the last character of the ORCID iD.
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. For the author to display as corresponding, you must link the author to contact information contained in a <corresp> within <author-notes>, using <xref ref-type="corresp"> that points to the element’s @id. See Author notes for more information.
If a single author has more than one version of their name, use the <name-alternatives> element within the <contrib> element. The element <string-name> can be used for personal names where the order of the name components should not be enforced.
<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>
If the intention is to provide the author’s name in multiple languages, the @name-style and @xml:lang attributes should be used when supplying multiple versions of a name for proper display. The value for the @xml:lang attribute needs to be a valid ISO 639–1 language code.
<contrib contrib-type="author">
<name-alternatives>
<name name-style="western">
<surname>Zhang</surname>
<given-names>Y. P.</given-names>
</name>
<string-name name-style="eastern" xml:lang="zh">张轶泼</string-name>
</name-alternatives>
</contrib>
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, 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.
An ROR (research organization registry) ID can be included within <institution-wrap> in the <aff> node to connect a contributor to a given research organization. If ROR IDs are included in the xml, they will be stored in our database and deposited downstream. Please note that ROR IDs will not display.
Within the <institution-wrap> element, use <institution-id> with @institution-id-type="ror" to contain the ROR ID and <institution> to contain the associated organization name.
<aff id="aff1">
<label>a</label>
<institution-wrap>
<institution-id institution-id-type="ror">https://ror.org/03vek6s52</institution-id>
<institution>Harvard University</institution>
</institution-wrap>
Cambridge, MA 02138, <country country="us">United States</country>
</aff>
If a contributor is affiliated with more than one research organization, please include a separate <institution-wrap> for each organization within the <aff> element. Note that although <institution-wrap> is allowed in other locations, it will only be imported as a contributor ROR ID when used in <aff>. In other locations, such as within <funding-source>, this information will simply be copied.
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.
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.
Please note that this feature is currently only supported for journals and proceedings. Although <on-behalf-of> is allowed in SCBITS, it is not currently imported into our system or displayed for books.
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:
<author-comment content-type="disclosure"><author-comment content-type="deceased"><author-comment content-type="other"><author-comment content-type="occupation"><author-comment content-type="url">Please note that import and display of author comments with a @content-type value of “occupation” or “url” is currently only supported for books. Please also note that for books the display of these types of author comment (ie, “occupation” and “url”) is configurable by client, so consult with your development team about whether you would like these to appear on your site.
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.
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.
The publication date for the multimedia should be included in a <pub-date> node. To supply a date, please include the following information:
@iso-8601-date attribute and the format YYYY-MM-DD.@publication-format attribute.Use the <supplementary-material> tag in <multimedia-meta> to include supplementary files associated and imported with the standalone multimedia.
The value @content-type="featured-figure" is reserved for a featured image that is available to unauthenticated users. See Featured images for more details.
For all other types of supplementary data, use content-type="data-supplement". 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.
Any file type listed in the packaging requirements of the Zipline User Guide is acceptable for supplementary material (the guide is available via the client tool portal).
Use the <label> tag for a label, and the <title> tag inside the <caption> for a title. Other explanatory text should go in <p> elements within the <caption> tag.
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, SCM will use the value of the @id as the publisher-id.
To designate a featured image, include a <supplementary-material> element with @content-type="featured-figure" in the multimedia-meta. Use a <graphic> element for the pointer to the image file.
<supplementary-material id="featured" content-type="featured-figure">
<label>Some title for the image</label>
<caption>
<p>A caption for the featured image.</p>
</caption>
<graphic xlink:href="FeaturedImage.png"/>
</supplementary-material>
If the same image should appear as part of the standalone multimedia object, it should also be included in <media>.
Note that only one image will be used as the featured image.
The <permissions> element holds copyright information and license material.
Copyright should include:
<copyright-statement>: The information that will display on the site should be the complete statement of copyright for the content. It is likely that this will duplicate information in the <copyright-year> and <copyright-holder> elements.<copyright-year>: The year of copyright.<copyright-holder>: The name of the copyright holder.<permissions>
<copyright-statement>Copyright © 2020 by Silverchair. Reproduction for the purposes of education is permitted: all other uses must receive written permission from Silverchair.</copyright-statement>
<copyright-year>2020</copyright-year>
<copyright-holder>Silverchair</copyright-holder>
...
</permissions>
The <ali:free_to_read> element is a simple flag that 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 that 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>
Please also note that this tagging will not drive any access functionality unless enabled to do so in ProductBuilder.
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 content object.
@license-type attribute: The access type to be stored in the database for the content object. The following licenses have various default behavior. Some license types will default to private and others will make the content available on the site without authentication. If there is no license element in the xml file or the @license-type is not specified, the content will default to private. By default, the “cc-by” license types will display boiler plate text when no <license-p> has been provided in the XML. Please consult with your build team if you wish to have the boiler plate text shown instead in all cases, even when text has been provided in <license-p>.| license type | description |
|---|---|
@license-type="free" |
Free multimedia |
@license-type="open-access" |
Open Access multimedia |
@license-type="crown-copyright" |
CrownCopyright content (defaults to private, but access requirement can be configured with the build team) |
@license-type="us-gov" |
USGov multimedia (defaults to private, but access requirement can be configured with the build team) |
@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) |
@license-type can also be used to indicate that the content should be excluded from on-site purchase. Simply use the attribute @license-type="not-for-sale".@xlink:href attribute: A URL to a resource describing the license.<license-p>: A paragraph of text within the description of a <license>. If you want the license information to display on the site, it must be included in <license-p>.<ali:license_ref>: A reference to a URI that carries the license terms specifying how a work may be used. Note the namespace must be included on the element or declared in the document header.@xlink:href on <license> or <ali:license_ref>.<permissions>
…
<license license-type="open-access" xlink:href="https://creativecommons.org/licenses/by/4.0/">
<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>
OR
<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>
To reference a PDF transcript of the multimedia object, use the <self-uri> element. The content-type attribute is required and must have a value of @content-type="transcript".
Reference the PDF file using the @xlink:href attribute. Put the exact PDF file name, including the extension, and do not include a file path:
<self-uri content-type="transcript" xlink:href="transcript.pdf"/>
An abstract can be included in the <abstract> node. The authored abstract should have no @abstract-type attribute, or it should have the attribute @abstract-type="abstract". Only one authored abstract is allowed on a multimedia object. The attributes @abstract-type="teaser" and @abstract-type="precis" will also be imported. Teasers are a short summary or descriptive text that will appear in various places on the site, such as in Search Results. If you would like for a multimedia object to have a teaser, encode it in the metadata as <abstract abstract-type="teaser">.
The abstracts appear on the article in the order in which they are tagged in the xml. We recommend placing the authored abstract first, before other types of abstracts. This aligns with best practices for SEO, accessibility, and usability.
The <media> element is used to reference the object being submitted, and will have a value such as the file name or URL of the multimedia file itself. The @xlink:href value should be exactly the same as the object’s filename, if the multimedia is a file submitted with the Zipline package.
For file names, provide only the literal file name relative to the directory specified for the file in the appropriate packaging guidelines. For example, an image stored directly in the Assets directory should use xlink:href="image.png" without a file path preceding the file name.
Silverchair does not directly host video and audio multimedia. Thus, publishers are expected to upload their multimedia files to a 3rd party host, preferably one of those described in the table below. If your multimedia is currently hosted by a provider that is not listed below, please consult with your development team.
The @content-type value must be identified on the <media> element. Only one type of media is supported within a <media-group> (ie, all <media> within a <media-group> must have the same @content-type value). The list of accepted values for the media @content-type and the corresponding @xlink:href expectations are as follows. Please note that a few types require the <object-id> element, or, in the case of Glencoe, an @id on the <media> element. These values should correspond to values provided by your multimedia hosting service to identify multimedia on their platform.
| @content-type | type of value in @xlink:href | other required elements and attributes |
|---|---|---|
| image | file name | |
| file name | ||
| excel | file name | |
| csv | file name | |
| powerpoint | file name | |
| word | file name | |
| txt | file name | |
| url | URL | |
| brightcove | URL | <object-id pub-id-type="videoid"> and/or <object-id pub-id-type="referenceid"> (note that the “brightcove” value is used for video only; see below for the value for Brightcove audio) |
| brightcove-audio | URL | <object-id pub-id-type="videoid"> and/or <object-id pub-id-type="referenceid"> |
| jwplayer | URL | |
| youtube | URL (note that the url structure should be https://youtu.be/[idOfVideo]) | |
| glencoe | URL | <media id="videoid"...> |
| soundcloud | URL (note that you need to use the embed URI) | |
| libsyn | URL | |
| cadmore | NA | <object-id pub-id-type="videoid"> (note that the “cadmore” value is used for video only; see below for the value for Cadmore audio) |
| cadmore-audio | NA | <object-id pub-id-type="videoid"> |
File name example:
<media content-type="image" xlink:href="image.png"/>
URL example:
<media content-type="soundcloud" xlink:href="https://w.soundcloud.com/player/?url=https%3A//api.soundcloud.com/tracks/000000006"/>
Brightcove example:
<media content-type="brightcove" xlink:href="http://bcove.me/1xyjm06i">
<object-id pub-id-type="videoid">123456789</object-id>
<object-id pub-id-type="referenceid">myVideo1</object-id>
</media>
Cadmore example:
<media content-type="cadmore">
<object-id pub-id-type="videoid">123456789-5cc5-4b22-82f0-168f1606f00</object-id>
</media>
Glencoe example:
<media content-type="glencoe" id="video1" xlink:href="https://movie.scpress.org/media/by_doi/10.0000/201904144.v1/source"/>
<caption>
<p>sample caption</p>
</caption>
</media>
To call out more than one <media> element per multimedia object, use the <media-group> element.
If the media file is in the package and is to be archived for downstream deposits at Silverchair, use the <alternatives> tag with child media elements. Under <alternatives>, provide <media content-type="media-archive"> and put the video file name in @xlink:href. If <media content-type="media-archive"> is provided, it must have a sibling element media element, with the media host provider specified in @content-type, for example, <media content-type="glencoe">. The physical media file will not be hosted, and is included only for downstream full text deposits.
<alternatives>
<media id="video3" content-type="glencoe" xlink:href="https://movie.scpress.org/media/by_doi/10.0000/201904144.v1/source"/>
<media content-type="media-archive" xlink:href="SSC_20120928_v107i3_043_video3.mp4"/>
</alternatives>
Store captions in the <caption> element, either under the <media-group> or at the individual <media> level. Captions are optional, and there can be more than one. Example:
<caption>
<p>Test Description: A caption that describes various interesting aspects of the image file.</p>
</caption>
You may link content to other content that is published separately in the SCM 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 the <multimedia-meta> to designate a relation to another piece content. Use the @document-type, @document-id-type, and @document-id attributes to designate the type of content and document to target. To link to a chapter within a piece of content, also include the @object-type, @object-id-type, and @object-id attributes with the appropriate values (see example below). You must designate both the document and the object when linking to a chapter.
Links to the following content types can be created from the multimedia content. The XML containing the <related-object> needs to be imported after the target content is imported.
| Target document/content type | tagging format |
|---|---|
| Article (using DOI) | <related-object document-type="article" document-id-type="doi" document-id="11.1111/11111111"/> |
| Article (using publisher ID) | <related-object document-type="article" document-id-type="publisher-id" document-id="article.11.12.30"/> |
| Book (using ISBN 13) | <related-object document-type="book" document-id-type="isbn13" document-id="123-4-56-789012-8"/> |
| 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 a chapter (in book only), you must additionally include the following attributes:
< … object-type="chapter" object-id-type="publisher-id" object-id="book1.ch1"/>
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.”
Cross-reference links to items within the same XML document are indicated with the <xref> element. The @ref-type attribute indicates the element type of the cross-reference target and the @rid provides its id value.
SCM supports the following different <xref> types for multimedia, and specific behavior should be confirmed with the build team. Attribute types for <xref ref-type>:
| ref-type attribute | Notes |
|---|---|
| aff | Affiliation |
| author-notes | Author notes |
| award | Award group, funding |
| bibr | Bibliographic reference |
| corresp | Corresponding author |
| supplementary-material | Supplementary material file |
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, and Conflict of Interest statements, the content of the element must be included. Provide literal content for display as shown by the “4(g)” in this example:
See reference <xref ref-type="bibr" rid="ref4">4</xref>.
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 references 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 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 …
SCM accepts keywords in <multimedia-meta>. Speak to your build team about using keywords to create quick search links on the multimedia content object page. Keywords do not require advance setup in SCM and will be created on the fly during import.
<kwd-group kwd-group-type="author">
<kwd>chlorantraniliprole</kwd>
</kwd-group>
Include information about funding of the research in the <funding-group> tag. Zipline can import the funder’s name, funder’s identifier, and associated award identifiers, and SCM can match this information to the Funder Registry. Inside the <funding-source> element, use the <institution-wrap> element with child elements <institution> and <institution-id> to designate the name and identifiers of an institution, respectively. On <institution-id>, the attribute @institution-id-type="DOI" must be present if the ID comes from the Open Funder Registry.
In addition, you can optionally add information in the <funding-source> element to indicate individual(s) or institution(s) to whom the award was given (ie, <principal-award-recipient>) and the person(s) responsible for the intellectual content of the work reported in the document (ie, <principal-investigator>). These will display as given on the site. You can also add in a funding statement that will display on the site, using <funding-statement> in <funding-group>.
<funding-group specific-use="FundRef">
<award-group award-type="grant" id="award1">
<funding-source id="fundingsource1">
<institution-wrap>
<institution>National Science Foundation</institution>
<institution-id institution-id-type="DOI">10.13039/100000001</institution-id>
</institution-wrap>
</funding-source>
<award-id>WU4001</award-id>
<principal-award-recipient id="recipient1">
<name>
<surname>Carberry</surname>
<given-names>Josiah Stinkney</given-names>
</name>
<contrib-id contrib-id-type="orcid" authenticated="true">
https://orcid.org/0000-0002-1825-0097</contrib-id>
</principal-award-recipient>
<principal-investigator id="investigator1">
<name>
<surname>Carberry</surname>
<given-names>Josiah Stinkney</given-names>
</name>
<contrib-id contrib-id-type="orcid" authenticated="true">
https://orcid.org/0000-0002-1825-0097</contrib-id>
</principal-investigator>
</award-group>
<funding-statement id="statement1"><bold>Funding:</bold> This is a funding statement.</funding-statement>
</funding-group>
If an embargo period is stored in SCM for a funder, multimedia associated with an award from that funder will automatically become available outside the paywall after that embargo period. Embargo periods for funding agencies are maintained in SCM and are not included in the XML.
The initial access type for multimedia is set during import. A license URL for an article can also be sent to Crossref. See section Permissions for information about setting access type and including licensing information.
The funder’s name, award id, award recipient name, investigator name, and funding statement will display under the author and article information on the article. The funding information can be cross-referenced in the caption of the multimedia with an <xref ref-type="award"> that references the award group’s @id.
<body>
...
<p><xref rid="award1" ref-type="award">This author</xref> received funding for this work.</p>
...
</body>
References or bibliographic citations should be tagged inside <multimedia-back> using <ref-list>. Each bibliographic entry should be in a <ref> element.
References should be tagged at as granular a level as possible to enable SCM 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:
<source><article-title> (for journal and proceedings articles)<chapter-title> (for books)<volume><issue><fpage><surname><year><month><day>SCM can create links to PubMed and Crossref for journal articles, conference proceedings, or books referenced in the references section. For SCM to determine and create these links, specific @publication-type values must be included in the <element-citation> or <mixed-citation> element. The values that are supported are @publication-type="journal" for journal articles, @publication-type="confproc" for conference proceedings, and @publication-type="book" for books.
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: <element-citation> should be reserved for citations that have consistent tagging, where automatic formatting is likely to be satisfactory. If that is not the case, we recommend using <mixed-citation> to preserve more controlled formatting.
The <ref> element must have an @id attribute if it is linked from elsewhere in the content using an <xref>.
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. The version number of the dataset should appear in <version>, with a machine-readable number in the @designator attribute.
<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>. <version designator="16.2">16th version, second release</version>.</mixed-citation>