Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds a section to describe using shortDOI service #121

Merged
merged 4 commits into from
Jan 25, 2021
Merged

Adds a section to describe using shortDOI service #121

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0b24f0d
Adds a section to describe using shortDOI service
ashepherd Nov 5, 2020
0e092be
add missing word for reason about page weight
ashepherd Nov 5, 2020
b3d8389
Update Dataset.md
ashepherd Nov 5, 2020
56304e1
Merge branch 'develop' into feature-120-short-doi
mbjones Jan 22, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions guides/Dataset.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
- [Describing a Dataset](#describing-a-dataset)
- [Common Properties](#common-properties)
- [Identifier](#identifier)
- [How to reference Short DOIs](#how-to-reference-short-dois)
- [Variables](#variables)
- [Catalog](#catalog)
- [Metadata](#metadata)
Expand Down Expand Up @@ -282,6 +283,43 @@ NOTE: If you have a DOI, the citation text can be [automatically generated](http
}
</pre>

#### How to reference Short DOIs

[Short DOIs](http://shortdoi.org/) is a redirect service offered by the International DOI Foundation that provides a shorter version of an orginial DOI. For example, the original DOI `doi:10.5066/F7VX0DMQ` has a short DOI of `doi.org/csgf`. Short DOIs are resolvable using standard DOI URLS such as `http://doi.org/fg5v`. These short DOIs are treated identically to the original DOI. If you are using the short DOI service, we recommend publishing a short DOI URL using the `schema:sameAs` property of the `schema:Dataset`:

<pre>
{
"@context": {
"@vocab": "https://schema.org/"
},
"@type": "Dataset",
"name": "Removal of organic carbon by natural bacterioplankton communities as a function of pCO2 from laboratory experiments between 2012 and 2016",
"description": "This dataset includes results of laboratory experiments which measured dissolved organic carbon (DOC) usage by natural bacteria in seawater at different pCO2 levels. Included in this dataset are; bacterial abundance, total organic carbon (TOC), what DOC was added to the experiment, target pCO2 level. ",
"url": "https://www.sample-data-repository.org/dataset/472032",
"sameAs": [
"https://search.dataone.org/#view/https://www.sample-data-repository.org/dataset/472032",
<strong>"http://doi.org/fg5v"</strong>
],
"version": "2013-11-21",
"keywords": ["ocean acidification", "Dissolved Organic Carbon", "bacterioplankton respiration", "pCO2", "carbon dioxide", "oceans"],
"identifier":
{
"@id": "https://doi.org/10.5066/F7VX0DMQ",
"@type": "PropertyValue",
"propertyID": "https://registry.identifiers.org/registry/doi",
"value": "doi:10.5066/F7VX0DMQ",
"url": "https://doi.org/10.5066/F7VX0DMQ"
}
}
</pre>

`schema:sameAs` is used here for the following reasons:

1. It doesn't add too many more statements that might increase the page weight (which may impact major search engine crawlers stopping the crawl of schema.org markup).
2. Crawlers that follow the URL for the short DOI can retrieve structured metadata for the DOI itself:

`curl --location --request GET "http://doi.org/fg5v" --header "Accept: application/ld+json"`

Back to [top](#top)

### Variables
Expand Down