Reference list

[fred-atherden]

The reference list for the article, encompassing all works cited in the article body and appendixes.

User Stories

Author

• [x] As an author, I want to be able to see the reference list(s) for my article so that I can check it ahead of publication.
• [ ] As an author, I want to be able to add a new reference list to my article so that I can start a new bibliography.
• [ ] As an author, I want to be able to add a new reference to the reference list so that I can include missing information.
• [ ] As an author, I want new references to automatically go into the correct point in a reference list so that reference list order is maintained.
• [ ] As an author, I want to be able to remove a reference so that I can delete information that is no longer required.
• [ ] As an author, I want to be alerted if I try to delete a reference that is still cited in the text so that I do not accidentally remove information that is still required.

Production staff

• [ ] As production staff, I need to be able to clearly identify references with missing DOIs so that I can add one if possible.
• [ ] As production staff, I want to be able to check references by type so that I can make sure that the information supplied is correct.

Éruidt

• [ ] As production staff, I want to be able to add a paragraph within the reference list so that I can append additional information for the reader.

But what if . . . ?

Considerations

• There are two major citation styles that will need to be supported in Texture: name/year (Smith et al., 2009) and number (usually denoted with a superscript numeral).
• Broadly speaking, the order of references in the reference list is alphabetical for name/year citation style and by order of citations in the text for number citation style.
• At eLife, specific rules are followed to handle the possible complexities of alphabetical ordering. They are that:
  • References should be arranged alphabetically by the value of the first name in the author list
  • If the first authors of two or more references have the same name, order is then determined by:
  • second author then date for references with two authors
  • date for references with three or more authors
• eLife will likely simplify these rules, but complexity in this is possible depending on journal style.
• A reference list might contain one or more paragraph of text to provide additional information (Example).
• Érudit supports multiple reference lists in order to provide translations in multi-lingual articles. This would mostly be a use case for multilingual articles where a ref-list is translated. An xml:lang attribute would be needed on each ref-list (otherwise we should not have to identify the language of a ref-list). Example.
• In other cases, there may be section-specific reference lists. For example, an appendix might have a dedicated reference list separate from that for the main body of the article.
• Érudit also require sub–reference lists (e.g. that a ref-list may contain a child or descendant ref-lists). This is typically used to group references according to the type of document cited (common in HSS content). For example, one ref-list for books, one for newspaper article, one for research-articles, one for archive documents, etc. Example
• Finally, Érudit require the ability to chose whether references are numbered or not - their articles can be either name/year or numbered style; they do not just support one style like eLife.

XML requirements

The reference list is captured as a ref-list, as a child of back. It has a title element.

<back>
    ...
    <ref-list>
        <title>References</title>
        <ref id="bib1">
            ...
        </ref>
        <ref id="bib2">
            ...
        </ref>
        ...
        <ref id="bib999">
            ...
        </ref>
    </ref-list>
</back>

Taken from: https://github.com/elifesciences/TextureRequirements/issues/69

[NickDuf]

Texture does support single reference lists. This feature does not completely meet eLife’s user stories