Table 1.
Software Citation Use Cases–Software Citation with registered DOI & Software Citation with URL (not persistent).
| Use Case Name, Description | Desired Outcome for JATS XML version 1.3 | Desired Outcome for Crossref Metadata depository schema 5.3.1 | Notes |
|---|---|---|---|
|
Use case A Software Citation with registered DOI A registered DOI has the desired metadata to support this citation and allows for content negotiation |
<ref id=“bib11”> <element-citation publication-type=“software”> <person-group person-group-type=“author”> <name> <surname> Wang</surname> <given-names> Yafei </given-names> </name>…</person-group> <year iso-8601-date=“2022”> 2022 </year> <part-title> pc4covid19/pharmacodynamics2GUI: Version 2.0</part-title> <source> zenodo </source> <pub-id pub-id-type=“doi”> 10.5281/zenodo.3967327 </pub-id> </element-citation> </ref> |
Tags: //citation/unstructured_citation AND //citation/doi e.g. <citation key=“XXX”> <unstructured_citation>Wang Yafei, …, 2022, pc4covid19//pharmacodynamics2GUI: Version 2.0, zenodo, 10.5281/zenodo.3967327</unstructured_citation> <doi> 10.5281/zenodo.3967327</doi> </citation> |
Pro: Crossref can update Event Data. At this time software is not included in Scholix. |
|
Use Case B Software Citation with URL (not persistent) e.g., GitHub, GitLab, BitBucket, The community accepted location for the software does not use persistent identifiers. A URL is provided instead. No DOI registration services are available. |
<ref id=“bib3”> <element-citation publication-type=“software”> <person-group person-group-type=“author”> <name> <surname> Kotila </surname> <given-names> M </given-names> </name>…</person-group> <year iso-8601-date=“2019”>2019</year> <part-title>Numerical computing is fun</part-title> <source>GitHub</source> <ext-link ext-link-type=“uri” xlinkhref=“https://github.com/eka-foundation/numerical-computing-is-fun”>https://github.com/eka-foundation/numerical-computing-is-fun</ext-link> </element-citation> </ref> |
Tags: //citation/unstructured_citation e.g. <citation key=“XXX”> <unstructured_citation> Kotila M, …, 2019, Numerical computing is fun, GitHub, https://github.com/eka-foundation/numerical-computing-is-fun” >https://github.com/eka-foundation/numerical-computing-is-fun </unstructured_citation> </citation> |
Con: Software is not in a trusted preservation repository. The URL is subject to link rot and it is not FAIR. |