Publication dates

[fred-atherden]

The dates for an article's publication events, covering preprints, accepted manuscript publication/ePub ahead of print, version of record publication, updated version publication etc.

User Stories

Author

• [x] As an author, I want to be able to see any publication dates added to my article so that I can check they are correct.
• [ ] As an author, I want to be able to see the history of publication events associated with my article so that I have this information for reference.
• [ ] As an author I want to be able to see if the details of a preprint publication have been added to my article so that I can check it has been linked to the correct one.

Production staff

• [ ] As production staff I want to add one or more new publication dates to an article so that I can include this metadata before publishing the article.
• [x] As production staff, I want to be able to edit a publication date so that I can update it if required.
• [ ] As production staff, I want to be able to remove a publication date so that I can correct errors.
• [ ] As production staff, I want to be able to indicate the type for a date so that I can distinguish different stages of publication.
• [ ] As production staff I want to be able to add a new publication event to an article so that I can ensure the most recent published version of an article references all previous versions of the article.
• [ ] As a production staff I want to be able to edit the details of previous publication events so I can correct any errors.
• [ ] As production staff I want to be able to add a textual description to a publication event so that I can inform a reader of the article why this version was published.

But what if . . . ?

• Ideally the previous publication event dates should be automatically updated in the tool by checking against the publisher database so we can ensure these details are correct and human error is avoided. However, the textual description required will need to be added by staff, but a warning if text is missing would be ideal.

Considerations

• We will need a date-picker on all date fields for ease of use (https://github.com/substance/texture/issues/980).
• Some publishers will need two or more to capture different stages of publication (e.g. epub and then print). These are distinguished using different type and format attributes.
• eLife is going to adopt a JATS4R recommendation to use the pub-history element to capture the history of publication events (preprint, publication of accepted article, version of record publication, update versions etc). This will exist in addition to one or two pub-dates, which will be used to capture the original publication date of the article (the first time it was published online) and the publication date for the current version of the article.
• The original publication date will be fixed across all versions of the article from the first one onwards. The version publication date will be updated each time a new version of the article is published. When this happens, the previous version publication date will be moved to the publication event history (the original publication date will be repeated, i.e. will live in both places once a subsequent version is published).
• When a new version of the article is issued, an explanation for why will be added as a description next to the previous version's pub date in publication event history.
• The events in the publication history as recommended by JATS4R will have an @event-type from a JATS4R defined list:
  • authors-original
  • submitted-manuscript-under-review
  • accepted-manuscript
  • proof
  • version-of-record
  • corrected-version-of-record
  • enhanced-version-of-record
  • pre-print (Added by JATS4R)

(These are based on Journal Article Versions guidelines:

• AO = Author’s Original
• SMUR = Submitted Manuscript Under Review
• AM = Accepted Manuscript
• P = Proof
• VoR = Version of Record
• CVoR = Corrected Version of Record
• EVoR = Enhanced Version of Record)

XML requirements

eLife captures publication date in two ways, both as a direct child of article-meta. The first is using <pub-date publication-format="appropriate-value" date-type="pub">

<pub-date publication-format="electronic" date-type="pub">
          <day>09</day>
          <month>04</month>
          <year>2019</year>
</pub-date>

eLife doesn't, but some publishers also use season inside pub-date, such as:

<pub-date publication-format="print" date-type="pub">
          <season>April</season>
          <year>2019</year>
</pub-date>

or

<pub-date publication-format="print" date-type="pub">
          <season>April</season>
          <day>09</day>
          <month>04</month>
          <year>2019</year>
</pub-date>

In addition to this, SciELO and Erudit use <pub-date date-type="collection">. eLife uses this as well but it is no longer a requirement for PMC and so we can remove it from our XML.

<pub-date date-type="collection">
          <year>2019</year>
</pub-date>

Different @pub-type values may be used - for example:

<pub-date pub-type="ppub">
          <month>1</month>
          <year>2014</year>
</pub-date>
<pub-date pub-type="epub-original">
          <day>30</day>
          <month>1</month>
          <year>2014</year>
</pub-date>
<pub-date pub-type="epub">
          <day>31</day>
          <month>1</month>
          <year>2014</year>
</pub-date>

<pub-date publication-format="electronic" date-type="pub" iso-8601-date="2018-02-06">
          <day>06</day>
          <month>02</month>
          <year>2018</year>
</pub-date>
<pub-date pub-type="collection">
          <year>2018</year>
</pub-date>

All article publication history information is included in the pub-history element (which is included as a child of the article-meta). Each publication event is included in an event element which contains a description, event-desc, and a date.

<article-meta>
     ...
     <pub-history>
         <event event-type="pre-print">
             <event-desc> This article was originally published as a <ext-link ext-link-type="uri"  xlink:href="https://doi.org/10.1101/118356">preprint</ext-link> on bioRxiv.</event-desc>
             <article-id pub-id-type="doi" assigning-authority="crossref">https://doi.org/10.1101/118356</article-id>
             <date iso-8601-date="2017-03-24">
                 <day>24</day>
                 <month>03</month>
                 <year>2017</year>
             </date>
         </event>
<event event-type="accepted-manuscript">
             <event-desc> This article was published as an <ext-link ext-link-type="uri"  xlink:href="https://elifesciences.org/articles/46313v1">accepted manuscript</ext-link> previously.</event-desc>
             <date iso-8601-date="2019-06-21">
                 <day>21</day>
                 <month>06</month>
                 <year>2019</year>
             </date>
         </event>
<event event-type="version-of-record">
             <event-desc> This article was published previously at <ext-link ext-link-type="uri"  xlink:href="https://elifesciences.org/articles/46313v2"> but has been updated to correct an error that was introduced in the proofing process which resulted in the mix up of the images for Figure 3's supplements.</event-desc>
             <date iso-8601-date="2019-07-08">
                 <day>08</day>
                 <month>07</month>
                 <year>2019</year>
             </date>
         </event>
     </pub-history>
     ...
</article-meta>

N.B. - this tagging is only available in JATS archive DTD V1.2 (the inclusion of <event> in <history>).

Example of pub-history and pub-date change in one article

Accepted Manuscript Publication (PoA)

<article-meta>
    ...
    <pub-date date-type="publication" publication-format="electronic"><day>24</day><month>06</month><year>2019</year></pub-date>
    ...
    <pub-history>
        <event event-type="pre-print">
            <event-desc> This article was originally published as a <ext-link ext-link-type="uri"  xlink:href="https://doi.org/10.1101/118356">preprint</ext-link> on bioRxiv.</event-desc>
            <article-id pub-id-type="doi" assigning-authority="crossref">https://doi.org/10.1101/118356</article-id>
            <date iso-8601-date="2017-03-24">
                <day>24</day>
                <month>03</month>
                <year>2017</year>
            </date>
        </event>
    </pub-history>
    ...
</article-meta>

Version of Record (VoR)

<article-meta>
    ...
    <pub-date date-type="publication" publication-format="electronic"><day>24</day><month>06</month><year>2019</year></pub-date>
    <pub-date date-type="publication" publication-format="electronic"><day>08</day><month>07</month><year>2019</year></pub-date>
    ...
    <pub-history>
        <event event-type="pre-print">
            <event-desc> This article was originally published as a <ext-link ext-link-type="uri"  xlink:href="https://doi.org/10.1101/118356">preprint</ext-link> on bioRxiv.</event-desc>
            <article-id pub-id-type="doi" assigning-authority="crossref">https://doi.org/10.1101/118356</article-id>
            <date iso-8601-date="2017-03-24">
                <day>24</day>
                <month>03</month>
                <year>2017</year>
            </date>
        </event>
        <event event-type="accepted-manuscript">
            <event-desc> This article was published as an <ext-link ext-link-type="uri"  xlink:href="https://elifesciences.org/articles/46313v1">accepted manuscript</ext-link> previously.</event-desc>
            <date iso-8601-date="2019-06-24">
                <day>24</day>
                <month>06</month>
                <year>2019</year>
            </date>
        </event>
    </pub-history>
    ...
</article-meta>

New version VoR

<article-meta>
    ...
    <pub-date date-type="publication" publication-format="electronic"><day>24</day><month>06</month><year>2019</year></pub-date>
    <pub-date date-type="publication" publication-format="electronic"><day>16</day><month>07</month><year>2019</year></pub-date>
    ...
    <pub-history>
        <event event-type="pre-print">
            <event-desc> This article was originally published as a <ext-link ext-link-type="uri"  xlink:href="https://doi.org/10.1101/118356">preprint</ext-link> on bioRxiv.</event-desc>
            <article-id pub-id-type="doi" assigning-authority="crossref">https://doi.org/10.1101/118356</article-id>
            <date iso-8601-date="2017-03-24">
                <day>24</day>
                <month>03</month>
                <year>2017</year>
            </date>
        </event>
        <event event-type="accepted-manuscript">
            <event-desc> This article was published as an <ext-link ext-link-type="uri"  xlink:href="https://elifesciences.org/articles/46313v1">accepted manuscript</ext-link> previously.</event-desc>
            <date iso-8601-date="2019-06-24">
                <day>24</day>
                <month>06</month>
                <year>2019</year>
            </date>
        </event>
        <event event-type="version-of-record">
            <event-desc>This article published previously at <ext-link ext-link-type="uri"  xlink:href="https://elifesciences.org/articles/46313v1"> contained an error that was introduced in the proofing process which resulted in the mix up of the images for Figure 3's supplements.</event-desc>
            <date iso-8601-date="2019-07-08">
                <day>08</day>
                <month>07</month>
                <year>2019</year>
            </date>
        </event>
    </pub-history>
    ...
</article-meta>

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

[NickDuf]

Dates are available in Texture but are insufficient to answer eLifes user stories

[fred-atherden]

@Melissa37 should the article-id contain the full doi.org type URL? Or should it contain the PID itself, i.e. <article-id pub-id-type="doi" assigning-authority="crossref">10.1101/118356</article-id> instead of <article-id pub-id-type="doi" assigning-authority="crossref">https://doi.org/10.1101/118356</article-id>?

[Melissa37]

@FAtherden-eLife can we pend this one? The JATS4R rec is out of date as new tagging was added to the DTD as a result of this rec but the JATS4R working group has not re-done the work to account for that. It's old, so there might be renewed interest and ideas

[fred-atherden]

@Melissa37 OK thanks - would it be worth @NickDuf, holding off on related design work then?

[Melissa37]

Yes deffo - this is not needed for Insights

Cheers

Melissa Harrison Head of Production Operations

Tel: +44 1223 855340

http://elifesciences.org

On Mon, Feb 17, 2020 at 3:25 PM FAtherden-eLife notifications@github.com wrote:

@Melissa37 https://github.com/Melissa37 OK thanks - would it be worth @NickDuf https://github.com/NickDuf, holding off on related design work then?

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/libero/editor/issues/47?email_source=notifications&email_token=ABOFQJFVAOCPVUBCOAGP7MLRDKT6DA5CNFSM4INUCXYKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEL6ZM5Y#issuecomment-587044471, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABOFQJE3V437TX3PGF6YDQDRDKT6DANCNFSM4INUCXYA .

-- eLife Sciences Publications, Ltd is a limited liability non-profit non-stock corporation incorporated in the State of Delaware, USA, with company number 5030732, and is registered in the UK with company number FC030576 and branch number BR015634 at the address Westbrook Centre, Milton Road, Cambridge, CB4 1YG.