Skip to content

Commit b00a93d

Browse files
committed
Add attribution section to CWL best practices
1 parent 3a98b5d commit b00a93d

File tree

1 file changed

+27
-5
lines changed

1 file changed

+27
-5
lines changed

src/main/resources/templates/about.html

Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ <h1>About</h1>
4444
understanding and discovery as well as encouraging best practices when writing workflows and their
4545
tooling.</p>
4646

47-
<p>Cite as: <code><a href="https://doi.org/10.5281/zenodo.823534">10.5281/zenodo.823534</a></code></p>
47+
<p>Cite as: <code><a href="https://doi.org/10.7490/f1000research.1114375.1">10.7490/f1000research.1114375.1</a></code></p>
4848

4949
<p>A <a href="https://doi.org/10.5281/zenodo.823535">Technical Report for this project can be viewed here</a>.</p>
5050

@@ -133,16 +133,38 @@ <h2>Use of Subworkflows</h2>
133133
<p class="use">Subworkflows are simplified in the visualisations and are linked as a different workflow in the
134134
<code>Step</code> tables on each workflow page</p>
135135

136+
<h2>Attribution</h2>
137+
<p class="recommendation">Include attribution information in your workflow and tool descriptions</p>
138+
<p class="recommendation_more">
139+
For example, to attribute a person as the creator of a workflow or tool with name, email and
140+
ORCID information, include the following statements at the top level:<br />
141+
<pre>
142+
$namespaces: { s: "http://schema.org/" }
143+
s:creator:
144+
- class: s:Person
145+
s:name: Mark Robinson
146+
s:email: mailto:[email protected]
147+
s:sameAs:
148+
- id: http://orcid.org/0000-0002-8184-7507
149+
</pre>
150+
</p>
151+
<p class="why">Attribution information allows your workflows and tooling to be used by others while
152+
recognising your contributions. The inclusion of an <a href="https://orcid.org/">ORCID</a> allows you to
153+
be uniquely identified from other researchers</p>
154+
<p class="use">CWLViewer parses attribution information for inclusion in the Research Object Manifest from
155+
both the Git commit logs and from the CWL descriptions themselves when expressed in the
156+
<a href="http://schema.org/creator">http://schema.org/creator</a> format as above</p>
157+
136158
<h2>Licensing</h2>
137159
<p class="recommendation">Include a <a href="https://opensource.org/licenses">OSI approved open source license</a>
138160
in your workflow and tool descriptions</p>
139161
<p class="recommendation_more">
140162
For example, the following two statements at the top level of a workflow or tool description licenses it
141163
under the <a href="https://www.apache.org/licenses/LICENSE-2.0">Apache V2.0 License</a>:<br />
142-
<code>
143-
$namespaces: { s: "http://schema.org/" }<br />
144-
s:license: "https://www.apache.org/licenses/LICENSE-2.0"
145-
</code>
164+
<pre>
165+
$namespaces: { s: "http://schema.org/" }
166+
s:license: "https://www.apache.org/licenses/LICENSE-2.0"
167+
</pre>
146168
</p>
147169
<p class="why">A permissive open source license allows others to remix and use your tooling and workflows
148170
to prevent the community from repeating development effort, allowing everyone to benefit</p>

0 commit comments

Comments
 (0)