Acknowledgements is the section in the article in which authors thank other people for help and support during their work, acknowledge funders, make various disclaimers, and dedicate the work in a plain text statement. Formal tagging for items such as acknowledge funders is covered elsewhere.
User stories
Author
As an author, I want to be able to add an acknowledgements section so that I can include acknowledgements to my manuscript.
As an author, I want to be able to edit an acknowledgements section for my manuscript so that I can correct errors and add any missing information.
As an author, I want to be able to add hyperlinks to an acknowledgements section so that I can link out to external resources.
As an author, I want to be able to add reference or asset citations to my acknowledgements so that I can cite other articles and assets in this context.
As an author, I want to be able to remove an acknowledgements section so that I can delete redundant information.
Erudit
As an production staff, I want to be able to add multiple acknowledgements sections so that I can manage translations of the acknowledgements.
But what if . . . ?
Consideration
Acknowledgements may contain multiple paragraphs.
The title of the acknowledgements may vary slightly between journals so can't be hard-coded.
eLife only allows one acknowledgements section; Érudit requires more to account for translations.
XML requirements
Acknowledgements are captured as ack elements, placed in the back. An article may contain numerous ack elements for different translations of the same content (the ack containing a language which differs to the main article should have an appropriate @xml:lang attribute):
<back>
<ack>
<title>Remerciement</title>
<p>Texte de remerciement.</p>
</ack>
<ack xml:lang="en">
<title>Acknowledgement</title>
<p>Ack text goes here.</p>
</ack>
</back>
eLife allows the following child elements:
title
p
Aside from xref, ext-link, and inline-formula (which are allowed as descendants of ack in eLife content), acknowledgements in eLife articles typically contain quite simple content (paragraphs with text which may have some formatting).
Description
Acknowledgements is the section in the article in which authors thank other people for help and support during their work, acknowledge funders, make various disclaimers, and dedicate the work in a plain text statement. Formal tagging for items such as acknowledge funders is covered elsewhere.
User stories
Author
Erudit
But what if . . . ?
Consideration
XML requirements
Acknowledgements are captured as
ack
elements, placed in theback
. An article may contain numerousack
elements for different translations of the same content (theack
containing a language which differs to the main article should have an appropriate@xml:lang
attribute):eLife allows the following child elements:
Aside from
xref
,ext-link
, andinline-formula
(which are allowed as descendants ofack
in eLife content), acknowledgements in eLife articles typically contain quite simple content (paragraphs with text which may have some formatting).Mock ups
Proposal