platform-documentation

Supplements

AUP journal articles, book chapters and whole books can have supplementary materials (“supplements” for short).

Figshare

AUP policy is to place supplements on Figshare. I don’t know how this is done, who does it, and whether the proper citation, with DOI, is mandatory. Nor do I know if this is the only place of supplements.

example

Take the images here. As you can see, Figshare allows users to share quite a bit of information. It also has search functionality and usage metrics. Every (?) Figshare object has a citation and a DOI:

G. Massiot & cie (2017). Temple of Concord: View of front facade. University of Notre Dame. Figure. https://doi.org/10.7274/24734862.v1

https://doi.org/10.7274/24734862.v1

How to upload supplements onto AUP Online?

There are two ways: through the XML and manually.

XML

It has to go through the XML. But how? The description here here is less than useless as it tells us nothing about metadata or how files should be loaded. The only thing we know is that we must use the <supplementary-material> element within article/front/article-meta.

Manual

Supplementary material can also be uploaded through the content editing tools in the site. General documentation for the tool is provided here.

If you access an article when logged in as admin you can click on Edit Article in the left side tools menu and one of the fields in the pop up allows you to create supplementary material. Supplementary material can be added for books in a similar way.

Figshare

Edify supports integration with Figshare. This can be enabled in the site through a change request.

Here is an example of the Figshare integration in another Edify site.

XML again

The relevant tag in JATS/BITS is <supplementary-material>. Do not confuse this with <supplement> which is only used as part of a bibliographic reference (<element-citation> and <mixed-citation>).

The tag may be contained in a <sec> in the article <body> for journal articles, and in <book-meta> and <book-part-meta> for books. Other places are possible, too, but I recommend regularity.

The tag may contain a link to, and a description of, supplementary material. Given that AUP uses Figshare, this is an example of what such a tag can look like:

<supplementary-material id="S0" xmlns:xlink="http://www.w3.org/1999/xlink" xlink:title="local_file" xlink:href="Italy-Girgenti-temple-Concord.jpg" mimetype="image/jpeg">
  <caption><p>G. Massiot &#038; cie (2017). Temple of Concord: View of front facade. University of Notre Dame. Figure. https://doi.org/10.7274/24734862.v1</p></caption>
</supplementary-material>

Important

  1. the <supplementary-material> tag has to go BETWEEN <publisher> AND <permissions> or the upload will fail.
  2. only LOCAL files are permitted. This basically means that everything is uploaded twice: onto Edify and onto Fighare. It looks like the name of the file is irrelevant, but you haver to get the MIME type right. The file is included in the zip that is uploaded onto the FTP.
  3. Only the <caption> element and its children <title> and <p> are processed by the application (and reduced to <span> so no mark-up)..

supplements tab on Edify

If the XML is tagged correctly, the supplements metadata will be displayed on the supplements tab in Edify. (Silly example here). Also, an icon (and some text) will be displayed for the supplement itself. Click on the icon and the supplement will open in a new tab. (Silly example here).

Note that access to the supplements tab is determined by the user’s access to the content. For example, not anyone can see the supplements for a subscribed-to article, only the paying user.

see also