michael commented 5 years ago

Description

A complete feature proposal for editing authors and contributors (reviewer, editor, translator, ...) including affiliations.

User stories

User stories provided in separate tickets:

Email address #1260
Author names #1252
Author IDS #1253
Corresponding author status #1254
Present addresses #1255
Deceased status #1259
Author affiliations #1256
Author footnotes #1258
Non-author contributor roles #1263
Non-author contributor affiliations #1262

Proposal

Authors

Email

Optional email field can be filled out per contributor
Warning should be displayed if email is provided but corresponding author is not checked (Erudit requires that)

Corresponding author

Optional field (checkbox) to mark an author a corresponding author
Warning should be displayed if field is checked but no email is provided

Author affiliations

dedicated section for author affiliations (Insert > Author affiliation)
can be assigned to one or more authors (select affiliation via author card)

Deceased status

realised as an optional checkbox per author

Author footnotes

realised as typed notes
notes can be created and assigned a type (note, conflict of interest, present address, equally contributed)

Present addresses

See author footnotes.

Equally contributed

See author footnotes.

when equally contributed note is assigned, the equal-contrib attribute is set additionally in the stored XML

Author IDs

ability to add one or more author ids (ORCID, isni, researchid, scopus)
ability to set optional authenticated checkbox

Contributor roles

Special dictionary is used with roles for authors (CRediT taxonomy)

Non-author contributors

Like authors but with less details, and different roles (reviewer, editor, translator, ...)

Non-author contributor roles

Separate dictionary is used for non-author roles (Editor, Reviewer, Translator)

Non-author contributor affiliations

dedicated section for contributor affiliations (Insert > Contributor affiliation)

Roles

We want to define one or more dictionaries to be used to populate the contributor roles field. They will look like this:

Roles according to CRediT Taxonomy:

Name	Vocab	Vocab-ID	Vocab-Term	Vocab-Term-ID
Data Collection	credit	http://dictionary.casrai.org/Contributor_Roles	Investigation	Investigation

Roles for non-author contributors:

Name	Vocab	Vocab-ID	Vocab-Term	Vocab-Term-ID
Translator
Reviewing Editor
Senior Editor
Reviewer

Names

These are the fields available for describing a person (either author or non-author contributor)

surname
given names
prefix
suffix
alias

Melissa37 commented 5 years ago

@michael Thanks for doing this, but we need to wait for @NickDuf to think about this and think about designs.

Some of the interpretations are wrong, eg:

When email provided author is automatically marked as a corresponding author in stored XML

This does not meet the need of non-eLife users.

Deceased - realised as an optional checkbox per author

We need to work out how to add it if not present and it should not be part of the main area as it is so rare.

ORCID: if authenticated flag is set field is greyed out and not editable (only reset possible loosing the authenticated flag and letting production staff enter another orcid, which would need another verification round (to be done in integration platform)

Needs more thought on this to realize all possibilities.

Also, in Milestone 2 we will be delivering you some more Author-related metadata so we should wait for them before putting together the complete spec. Sorry!