Reporting standards contain any details of a specific standard that the data being reported meets, usually in the form of a checklist.
User Stories
Author
As an author, I want to be able to see any reporting standard files associated with my article so that I can make sure none are missing.
As an author, I want to be able to download any reporting standard files associated with my articles so that I can check the files themselves are correct.
As an author, I want to be able to update a reporting standard file so that I can fix errors in the file originally supplied.
As an author, I want to be able to edit the title and caption of a reporting standard file, so that I can correct any errors.
As an author, I want to be able to add reference or asset citations to my reporting standard file title and legend so that I can cite other articles and assets in this context.
As an author, I want to be able to adjust the type and placement of reporting standard files so that I can ensure that they display correctly within the manuscript. [E.g. change a reporting standard file to a supplementary file]
Production staff
As production staff, I want to be able to add reporting standard files so that I can include any missing assets.
As production staff, I want to be able to remove reporting standard files, so that I eliminate anything that has been incorrectly supplied.
As production staff, I want to know why an author has changed a reporting standard file so that I am aware of the reason for the change.
As production staff, I want to provide an explanation for why I am replacing a reporting standard file so that I can record the reason for the change.
But what if . . . ?
Considerations
The eLife labelling scheme for these files is
Reporting standard 1
Reporting standard 2
Labels will vary from publisher to publisher.
This is a variant of a supplementary file (outlined in this ticket), with a different labelling convention.
XML requirements
supplementary material with a specific label.
Captured as a supplementary-material in a back/sec[@sec-type="supplementary-material"] element. These have a child label whose value is 'Reporting Standards X.'.
<back>
...
<sec sec-type="supplementary-material">
<title>Additional files</title>
<supplementary-material id="supp5">
<label>Reporting Standards 1.</label>
<caption>
<title>CONSORT extension for Pilot and Feasibility Trials Checklist.</title>
</caption>
<media mime-subtype="docx" mimetype="application" xlink:href="elife-31549-repstand1-v1.docx"/>
</supplementary-material>
</sec>
...
<back>
Reporting standards contain any details of a specific standard that the data being reported meets, usually in the form of a checklist.
User Stories
Author
Production staff
But what if . . . ?
Considerations
XML requirements
supplementary material with a specific label.
Captured as a
supplementary-material
in aback/sec[@sec-type="supplementary-material"]
element. These have a childlabel
whose value is 'Reporting Standards X.'.Taken from: https://github.com/elifesciences/TextureRequirements/issues/62