Description

Supplementary files for the whole article. These usually contain additional information and data that cannot be captured as source code, source data, tables or figures, videos, figure supplements etc. They can also be used to avoid overly large tables in the main article e.g. if the Key resources table is huge, it may be moved to a supplementary file.

User Stories

Author

(1) As an author, I want to be able to see any supplementary files associated with my article so that I can make sure none are missing.
(2) As an author, I want to be able to download any supplementary files associated with my articles so that I can check the files themselves are correct.
(3) As an author, I want to be able to update a supplementary file so that I can fix errors in the file originally supplied.
(4) As an author, I want to be able to edit the title and caption of a supplementary file, so that I can correct any errors.
(5) As an author, I want to be able to add reference or asset citations to my supplementary file title and legend so that I can cite other articles and assets in this context.
(6) As an author, I want to be able to adjust the type and placement of supplementary files so that I can ensure that they display correctly within the manuscript. [E.g. change a supplementary file to source code, or to change it to source data for a figure]

Production staff

(7) As production staff, I want to be able to add supplementary files so that I can include any missing assets.
(8) As production staff, I want to be able to remove supplementary files, so that I eliminate anything that has been incorrectly supplied.
(9) As production staff, I want to know why an author has changed a supplementary file so that I am aware of the reason for the change.
(10) As production staff, I want to provide an explanation for why I am replacing a supplementary file so that I can record the reason for the change.

But what if . . . ?

Considerations

The eLife labelling scheme for these files is Supplementary file 1, Supplementary file 2 etc.
In the future, we will hopefully be able to take some of the files we currently include as Supplementary files and make them meaningful file types in their own right. Audio files, for example, really should be hosted as a media type but this is beyond our current hosting solution.
Labels will vary from publisher to publisher.
Euridit and PKP require the ability to have separate supplementary file sections for separate translations of the same content.

XML requirements

Captured as a supplementary-material in back/sec[@sec-type="supplementary-material"] element. The value of the label is 'Supplementary file X.'

<back>
     ...
     <sec sec-type="supplementary-material">
          <title>Additional files</title>
          ...
          <supplementary-material id="supp1">
                    <label>Supplementary file 1.</label>
                    <caption>
                              <title>Individual data of the participants included in analysis.</title>
                    </caption>
                    <media mime-subtype="docx" mimetype="application" xlink:href="elife-31549-supp1-v1.docx"/>
          </supplementary-material>
          <supplementary-material id="supp2">
                    <label>Supplementary file 2.</label>
                    <caption>
                              <title>Selected <italic>P. falciparum</italic> gene targets and primers of qRT PCR assays.</title>
                    </caption>
                    <media mime-subtype="docx" mimetype="application" xlink:href="elife-31549-supp2-v1.docx"/>
          </supplementary-material>
          ...
     </sec>
     ...
<back>

Erudit and PKP require the attribute xml:lang to be allowed on the following elements:

sec
supplementary-material
title
label

For example:

<sec sec-type="supplementary-material" xml:lang="en">
    <title>Title in english</title>
    <supplementary-material id="scode1" content-type="source-code">
         <label>Label in english 1</label>
         <caption>
              <title>Title in english.</title>
         </caption>
        <media mime-subtype="zip" mimetype="application" xlink:href="elife-31549-code1-v1.zip"/>
    </supplementary-material>
    ...
</sec>
<sec sec-type="supplementary-material" xml:lang="pt">
    <title xml:lang="pt">Title in portuguese</title>
    <supplementary-material id="scode1" content-type="source-code">
         <label xml:lang="en">Label in english 2</label>
         <caption>
              <title xml:lang="en">Title in english.</title>
         </caption>
        <media mime-subtype="zip" mimetype="application" xlink:href="elife-31549-code1-v1.zip"/>
    </supplementary-material>
    ...
</sec>

substance / texture

Supplementary files #1290