Skip to content

Commit

Permalink
additional work
Browse files Browse the repository at this point in the history
  • Loading branch information
jsstevenson committed Jul 30, 2024
1 parent 73d65db commit 78ff5fa
Show file tree
Hide file tree
Showing 9 changed files with 132 additions and 49 deletions.
11 changes: 11 additions & 0 deletions _includes/citation_toc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
[OBO Citation and Attribution Policy](/citation/Citation.html)

- [Referring to a single term](/citation/Citation.html#single-term)
- [Referring to an ontology](/citation/Citation.html#refer-ontology)
- [Citing an ontology](/citation/Citation.html#cite-ontology)

[OBO Foundry Publications](/citation/RelatedPublications.html)
- [Citing the OBO Foundry](/citation/RelatedPublications.html#citing)
- [Other OBO Foundry Publications](/citation/RelatedPublications.html#other)

[OBO Foundry Ontology Publications](/citation/KnownPublications.html)
7 changes: 3 additions & 4 deletions _includes/header.html
Original file line number Diff line number Diff line change
Expand Up @@ -113,10 +113,9 @@
Citation
</a>
<ul class="dropdown-menu" aria-labelledby="navbarCitationDropdown">
<li><a class="dropdown-item" href="/docs/Citation.html">Cite Ontologies</a></li>
<li><a class="dropdown-item" href="/registry/publications.html">Cite the OBO Foundry</a></li>
<li><a class="dropdown-item" href="/registry/publications.html">Publications Related to the OBO
Foundry</a></li>
<li><a class="dropdown-item" href="/citation/Citation.html">Cite Ontologies</a></li>
<li><a class="dropdown-item" href="/citation/RelatedPublications.html">OBO Foundry Publications</a></li>
<li><a class="dropdown-item" href="/citation/KnownPublications.html">Known OBO Foundry Ontology Publications</a></li>
</ul>
</li>

Expand Down
52 changes: 52 additions & 0 deletions _layouts/citation.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
layout: default
---
<div class="content">
<div>
<div class="page-header">
<h1>{{ page.title }}</h1>
</div>
</div>

<div class="col-md-12">
<div class="row">
<div class="col-md-3">
{% capture my_include %}{% include citation_toc.md %}{% endcapture %} {{
my_include | markdownify }} {% if page.id %}
<div class="btn-group" role="group" aria-label="Source">
<a
href="https://github.com/OBOFoundry/OBOFoundry.github.io/blob/master/citation/{{page.id}}.md"
>
<button
type="button"
data-toggle="tooltip"
title="See FAQ entry: How is metadata stored?"
html="true"
class="btn btn-outline-primary"
>
View
</button>
</a>
<a
href="https://github.com/OBOFoundry/OBOFoundry.github.io/edit/master/citation/{{page.id}}.md"
>
<button
type="button"
data-toggle="tooltip"
title="See FAQ entry: How I do edit my metadata?"
html="true"
class="btn btn-outline-primary"
>
Edit
</button>
</a>
<!-- <button type="button" class="btn btn-outline-primary">Help</button> -->
</div>
{% endif %}
</div>

<div class="col-md-9">{{ content }}</div>
</div>
</div>
</div>

2 changes: 1 addition & 1 deletion _layouts/ontology_detail.html
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ <h1>
</div>
</div>

{% if page.publications %}
{% if page.publications and page.publications.size > 0 %}
<div class="card" style="margin-bottom: 1.5em;" id="publications">
<div class="card-header">
Publications
Expand Down
9 changes: 9 additions & 0 deletions assets/css/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,12 @@ Slightly darken failing ontologies
.dash-status {
margin-bottom: 3px;
}

/*
Custom blockquote formatting
*/
.citation-blockquote {
padding: 5px;
margin-left: 20px;
margin-bottom: 16px;
}
33 changes: 23 additions & 10 deletions docs/Citation.md → citation/Citation.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,59 @@
---
layout: doc
layout: citation
title: OBO Citation and Attribution Policy
---

Open Biological and Biomedical Ontologies are used in a diversity of ways. The following guidelines are intended to promote proper attribution of the ontology creators and contributors, and to promote reproducibility in informatics applications.

## Referring to a single term
<h2 id="single-term">Referring to a single term</h2>

When referring to a single ontology term, use the full [Internationalized Resource Identifier (IRI)](http://tools.ietf.org/html/rfc3987), for example:

> http://purl.obolibrary.org/obo/UBERON_0000948
<div class="citation-blockquote">
http://purl.obolibrary.org/obo/UBERON_0000948
</div>

You can use a shorter [Compact URI (CURIE)](https://www.w3.org/TR/curie/) by defining a prefix that abbreviates the first part of the IRI. For example, the prefix "UBERON" can abbreviate "http://purl.obolibrary.org/obo/UBERON_", then "http://purl.obolibrary.org/obo/UBERON_0000948" can be shortened to "[UBERON:0000948](http://purl.obolibrary.org/obo/UBERON_0000948)". A footnote like this one should be included with the first use of the prefix:

> [UBERON:0000948](http://purl.obolibrary.org/obo/UBERON_0000948) is a Compact URI (CURIE). Here and subsequently the prefix "UBERON" expands to "http://purl.obolibrary.org/obo/UBERON_". The full identifier for the term is then <http://purl.obolibrary.org/obo/UBERON_0000948>. Browsing to this address gives further information about the term.
<div class="citation-blockquote">
<a href="http://purl.obolibrary.org/obo/UBERON_0000948">UBERON:0000948</a> is a Compact URI (CURIE). Here and subsequently the prefix "UBERON" expands to "http://purl.obolibrary.org/obo/UBERON_". The full identifier for the term is then <a href="http://purl.obolibrary.org/obo/UBERON_0000948">http://purl.obolibrary.org/obo/UBERON_0000948</a>. Browsing to this address gives further information about the term.
</div>

In situations that allow the use of hyperlinks, every CURIE should be a hyperlink with its full IRI as its target, as in these examples.

We also recommend including the primary label of the term in quotation marks before the IRI or CURIE:

> 'heart' ([UBERON:0000948](http://purl.obolibrary.org/obo/UBERON_0000948))
<div class="citation-blockquote">
'heart' (<a href="http://purl.obolibrary.org/obo/UBERON_0000948">UBERON:0000948</a>)
</div>

## Referring to an ontology
<h2 id="refer-ontology">Referring to an ontology</h2>

To facilitate reproducibility, be specific about the version of the ontology that you are referring to by using an ontology version IRI that contains the release date:

> http://purl.obolibrary.org/obo/uberon/releases/2016-01-26/uberon.owl
<div class="citation-blockquote">
http://purl.obolibrary.org/obo/uberon/releases/2016-01-26/uberon.owl
</div>

The ontology version IRI is indicated by the [owl:versionIRI](https://www.w3.org/2002/07/owl#versionIRI) property.

When referring to an ontology in general (not a specific version) you can use its ontology IRI:

> http://purl.obolibrary.org/obo/uberon.owl
<div class="citation-blockquote">
http://purl.obolibrary.org/obo/uberon.owl
</div>

The ontology IRI or ontology version IRI should be accompanied by a citation of the ontology, in any context where citations are appropriate.

## Citing an ontology
<h2 id="cite-ontology">Citing an ontology</h2>

Some ontologies recommend citation of specific publications. Please see their respective homepages for this information. For example, [Uberon]({{ "ontology/uberon.html#publications" | prepend: site.baseurl }}) lists two publications under "Publications."

In addition to the recommended publication, you should also cite the ontology using its IRI and the [new data citation extension to JATS](https://peerj.com/articles/cs-1/). When no specific publication is recommended, you must cite the ontology by its IRI. Here is an example citation:

> Mungall, C., Haendel, M., Dahdul, W., Ibrahim, N., Segerdell, E., Blackburn, D., Comte, A., Niknejad, A., and Decechi, A. (2016), Uberon Ontology, http://purl.obolibrary.org/obo/uberon/releases/2016-01-26/uberon.owl
<div class="citation-blockquote">
Mungall, C., Haendel, M., Dahdul, W., Ibrahim, N., Segerdell, E., Blackburn, D., Comte, A., Niknejad, A., and Decechi, A. (2016), Uberon Ontology, http://purl.obolibrary.org/obo/uberon/releases/2016-01-26/uberon.owl
</div>

Our ontology files list authors using the [dc:creator](http://purl.org/dc/elements/1.1/creator) property. The order of authors is not important, but you can use the primary contact for the ontology listed on the [OBO site](http://obofoundry.org) as the first author. Note that this does not necessarily include all those who have contributed directly to the ontology, via its issue tracker or on its mailing lists, for example. However, these can be readily retrieved if the proper IRI is referenced in the citation.

18 changes: 18 additions & 0 deletions citation/KnownPublications.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
layout: citation
title: Known Ontology Project Publications
---

This list is generated automatically from OBO Foundry ontology metadata. It is not intended to be authoritative or exhaustive.
<div>
{% for ontology in site.ontologies %}
{% if ontology.publications and ontology.publications.size > 0 %}
<h5>{{ ontology.title }} ({{ ontology.id }})</h5>
<ul>
{% for publication in ontology.publications %}
<li><a href="{{ publication.id }}" target="_blank" rel="noopener">{{ publication.title }}</a></li>
{% endfor %}
</ul>
{% endif %}
{% endfor %}
</div>
15 changes: 15 additions & 0 deletions citation/RelatedPublications.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
layout: citation
title: Publications Related to the OBO Foundry
---
<h2 id="citing">Citing the OBO Foundry</h2>

To reference the OBO Foundry generally, please cite:

Rebecca Jackson, Nicolas Matentzoglu, James A Overton, Randi Vita, James P Balhoff, Pier Luigi Buttigieg, Seth Carbon, Melanie Courtot, Alexander D Diehl, Damion M Dooley, William D Duncan, Nomi L Harris, Melissa A Haendel, Suzanna E Lewis, Darren A Natale, David Osumi-Sutherland, Alan Ruttenberg, Lynn M Schriml, Barry Smith, Christian J Stoeckert Jr., Nicole A Vasilevsky, Ramona L Walls, Jie Zheng, Christopher J Mungall, Bjoern Peters, **[OBO Foundry in 2021: operationalizing open data principles to evaluate ontologies](https://academic.oup.com/database/article/doi/10.1093/database/baab069/6410158)**, Database, Volume 2021, 2021, baab069, https://doi.org/10.1093/database/baab069

<h2 id="other">Other papers about the OBO Foundry</h2>

Barry Smith, Michael Ashburner, Cornelius Rosse, Jonathan Bard, William Bug, Werner Ceusters, Louis J Goldberg, Karen Eilbeck, Amelia Ireland, Christopher J Mungall, The OBI Consortium, Neocles Leontis, Philippe Rocca-Serra, Alan Ruttenberg, Susanna-Assunta Sansone, Richard H Scheuermann, Nigam Shah, Patricia L Whetzel, and Suzanna Lewis, **[The OBO Foundry: coordinated evolution of ontologies to support biomedical data integration](http://www.nature.com/nbt/journal/v25/n11/abs/nbt1346.html)**, Nature Biotechnology, Volume 25, 2007, https://doi.org/10.1038/nbt1346

[Google Scholar list of papers citing The OBO Foundry](https://scholar.google.ca/scholar?cites=13806088078865650870&as_sdt=2005&sciodt=0,5&hl=en)
34 changes: 0 additions & 34 deletions registry/publications.md

This file was deleted.

0 comments on commit 78ff5fa

Please sign in to comment.