@@ -41,17 +41,78 @@ As part of the BioHackathon Europe 2023, we here report...
4141## Author information
4242
4343Information about the authors is given in the [ YAML] ( https://en.wikipedia.org/wiki/YAML ) format at the top of this template.
44- For authors you provide their names, their affiliations, and ideally their [ ORCID] ( https://orcid.org/ )
45- identifier. For affiliations, the [ Research Organization Registry] ( https://ror.org/ ) (ROR) identifier can be given.
46- For example, this is the author information for this template:
44+ For authors you provide their names, their affiliations. That is the minimum, but as BioHackrXiv is moving to a situation
45+ where more metadata is shared, and used by, for example, EuropePMC, adding additional information ie encouraged.
46+
47+ BioHackathons is about hacking together, and the minimal number of authors for reports is two. This makes a minimal example
48+ look like this:
49+
50+ ``` yaml
51+ authors :
52+ - name : First Author
53+ affiliation : 1
54+ - name : Last Author
55+ affiliation : 2
56+ affiliations :
57+ - name : First Affiliation
58+ index : 1
59+ - name : ELIXIR Europe
60+ index : 2
61+ ` ` `
62+
63+ ### Author identifiers
64+
65+ Ideally, authors provide their [ORCID](https://orcid.org/) identifier. For affiliations, It is added with the ` orcid:` field.
66+ So, and author record would look like this :
67+
68+ ` ` ` yaml
69+ authors:
70+ - name: First Author
71+ affiliation: 1
72+ orcid: 0000-0000-0000-0000
73+ ` ` `
74+
75+ # ## Research Organization Registry identifiers
76+
77+ Matching the author identifier, the affiliations can be further specified with the
78+ [Research Organization Registry](https://ror.org/) (ROR) identifier.
79+ For example, this is the affiliation identifier can be added with the `ror:` field :
80+
81+ ` ` ` yaml
82+ affiliations:
83+ - name: ELIXIR Europe
84+ ror: 044rwnt51
85+ index: 2
86+ ` ` `
87+
88+ # ## Contributor Role Taxonomy
89+
90+ A last feature since is minimal support for the Contributor Role Taxonomy (CRediT). You
91+ can specify the role of authors in writing the report with the `role:` field. However,
92+ the authors are responsible for selection the right terms from [CRediT](https://credit.niso.org/).
93+ An example looks like this :
4794
4895` ` ` yaml
4996authors:
5097 - name: First Author
5198 affiliation: 1
99+ orcid: 0000-0000-0000-0000
100+ role: Conceptualization, Writing – review & editing
101+ ` ` `
102+
103+ # ## A full examples
104+
105+ A full example then has this structure :
106+
107+ ` ` ` yaml
108+ authors:
109+ - name: First Author
110+ affiliation: 1
111+ role: Writing – original draft
52112 - name: Last Author
53113 orcid: 0000-0000-0000-0000
54114 affiliation: 2
115+ role: Conceptualization, Writing – review & editing
55116affiliations:
56117 - name: First Affiliation
57118 index: 1
0 commit comments