Skip to content

Commit 72b25ec

Browse files
committed
Implement author roles for JATS
1 parent 180d2b5 commit 72b25ec

File tree

3 files changed

+432
-0
lines changed

3 files changed

+432
-0
lines changed

data/templates/article.jats_publishing

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,22 @@ $elseif(author.name)$
109109
$else$
110110
<string-name>$author$</string-name>
111111
$endif$
112+
$if(author.roles)$
113+
$for(author.roles)$
114+
$if(it.credit-id)$
115+
<role vocab="credit"
116+
vocab-identifier="https://credit.niso.org/"
117+
vocab-term-identifier="https://credit.niso.org/contributor-roles/$it.credit-id$/"
118+
vocab-term="$it.credit-name$"
119+
$if(it.degree)$degree-contribution="$it.degree$"$endif$
120+
>
121+
$if(it.name)$$it.name$$else$$it.credit-name$$endif$
122+
</role>
123+
$else$
124+
<role>$it.name$</role>
125+
$endif$
126+
$endfor$
127+
$endif$
112128
$if(author.email)$
113129
<email>$author.email$</email>
114130
$endif$

doc/jats.md

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,84 @@ Metadata Values
6161
set it used, as affiliation links are not allowed in that
6262
schema.
6363

64+
`roles`
65+
: a list of dictionaries describing the author's role(s).
66+
Each role is added as an [`<role>`] element to
67+
the author's [`<contrib>`] element. The following examples
68+
illustrate:
69+
70+
An ad-hoc role:
71+
72+
```yaml
73+
roles:
74+
- name: Dolphin Catcher
75+
```
76+
77+
A role specified with CRediT. Note that if you
78+
use `credit-id`, you also have to use `credit-name`:
79+
80+
```yaml
81+
roles:
82+
- credit-id: writing-review-editing
83+
credit-name: Writing – review & editing
84+
```
85+
86+
A role specified with CRediT, including an
87+
optional degree of contribution. Note that
88+
specifying the degree only is allowed when
89+
using CRediT roles and not ad-hoc roles.
90+
91+
```yaml
92+
roles:
93+
- credit-id: writing-review-editing
94+
credit-name: Writing – review & editing
95+
degree: Lead
96+
```
97+
98+
A role specified with CRediT with a label override,
99+
useful for internationalization:
100+
101+
```yaml
102+
roles:
103+
- credit-id: writing-review-editing
104+
credit-name: Writing – review & editing
105+
name: Escrita – revisão e edição
106+
```
107+
108+
The `id` in the `credit` dictionary
109+
must be one the 14 identifiers from the
110+
Contribution Role Taxonomy (CRediT):
111+
112+
1. `conceptualization`
113+
2. `data-curation`
114+
3. `formal-analysis`
115+
4. `funding-acquisition`
116+
5. `investigation`
117+
6. `methodology`
118+
7. `project-administration`
119+
8. `resources`
120+
9. `software`
121+
10. `supervision`
122+
11. `validation`
123+
12. `visualization`
124+
13. `writing-original-draft`
125+
14. `writing-review-editing`
126+
127+
It's not clear from the JATS documentation if the `name`
128+
key in the `credit` dictionary should always adopt the primary
129+
English labels from the vocabulary, or if it's also able to
130+
accept internationalized versions. It's best to be safe and
131+
use the English labels here, then use the override for
132+
internationalization.
133+
134+
Optionally, the `degree` key in the `credit` dictionary
135+
can be used to specify the degree of contribution which
136+
can take one of three values:
137+
138+
1. `Lead`
139+
2. `Equal`
140+
3. `Supporting`
141+
64142
`equal-contrib`
65143
: boolean attribute used to mark authors who contributed
66144
equally to the work. The
@@ -475,3 +553,4 @@ Required metadata values:
475553
[`<institution-wrap>`]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/element/institution-wrap.html
476554
[`<institution>`]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/element/institution.html
477555
[`<pub-date>`]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/element/pub-date.html
556+
[`<role>`]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/element/role.html

0 commit comments

Comments
 (0)