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.

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

4.1 draft for release candidate 1 #31

Merged
merged 7 commits into from
Feb 23, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -58,3 +58,4 @@ target/
.project
/.pydevproject
/.settings/
.vscode/settings.json
12 changes: 6 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
OpenAIRE Guidelines for Literature Repository Managers based on Dublin Core and DataCite Metadata Kernel
========================================================================================================
OpenAIRE Guidelines for institutional and thematic Repository Managers based on Dublin Core and DataCite Metadata Kernel
========================================================================================================================

Release 4.0
~~~~~~~~~~~
Release 4.1-rc
~~~~~~~~~~~~~~

.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1299203.svg
:target: https://doi.org/10.5281/zenodo.1299203
:alt: v.4.0 DOI
:alt: v.4.1 DOI

.. image:: https://readthedocs.org/projects/openaire-guidelines-for-literature-repository-managers/badge/?version=latest
:target: https://readthedocs.org/projects/openaire-guidelines-for-literature-repository-managers/?badge=v4.0.0
:target: https://readthedocs.org/projects/openaire-guidelines-for-literature-repository-managers/?badge=v4.1.0
:alt: Documentation Status

Status
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/_static/default.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.wy-nav-content {
max-width: none;
}
4 changes: 4 additions & 0 deletions docs/_templates/layout.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{% extends "!layout.html" %}
{% block extrahead %}
<link href="{{ pathto("_static/default.css", True) }}" rel="stylesheet" type="text/css">
{% endblock %}
37 changes: 21 additions & 16 deletions docs/application_profile.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Application Profile Overview
============================

The properties of the Application Profile for OpenAIRE Literature Repository Guidelines are listed in this section.
The properties of the Application Profile for OpenAIRE institutional and thematic Repository Guidelines are listed in this section.
The following requirement levels for the metadata properties are used:

Mandatory (M)
Expand All @@ -25,35 +25,40 @@ This documentation uses the following namespace abbreviations:
* ``datacite``: http://datacite.org/schema/kernel-4
* ``oaire``: http://namespace.openaire.eu/schema/oaire/

======================================== ============================= ========================================================================================
OpenAIRE-Field Metadata Element Refinement by Vocabulary
======================================== ============================= ========================================================================================
======================================== ============================= ================================================================================ ==============
OpenAIRE-Field Metadata Element Refinement by Vocabulary FAIR
======================================== ============================= ================================================================================ ==============
:ref:`dci:title` datacite:title :ref:`title type <vocab:titletype_titletype>`
:ref:`dci:creator` datacite:creator :ref:`name type <vocab:nametype_nametype>`
:ref:`dci:contributor` datacite:contributor | :ref:`name type <vocab:nametype_nametype>`
| :ref:`contributor type <vocab:contributortype_contributortype>`
:ref:`aire:fundingReference` oaire:fundingReference :ref:`funderIdentifier type <vocab:funderIdentifiertype_identifiertype>`
:ref:`dci:alternativeIdentifier` datacite:alternateIdentifier :ref:`alternateIdentifier type <vocab:alternateIdentifiertype_identifiertype>`
:ref:`dci:relatedIdentifier` datacite:relatedIdentifier | :ref:`relatedIdentifier type <vocab:relatedIdentifiertype_identifiertype>`
| :ref:`relation type <vocab:relationtype_relationtype>`
| :ref:`resourcetype general <vocab:resourcetypegeneral_resourcetypegeneral>`
:ref:`dci:relatedIdentifier` datacite:relatedIdentifier | :ref:`relatedIdentifier type <vocab:relatedIdentifiertype_identifiertype>` | RDA-I3-01M
| :ref:`relation type <vocab:relationtype_relationtype>` | RDA-I3-02M
| :ref:`resourcetype general <vocab:resourcetypegeneral_resourcetypegeneral>` | RDA-I3-03M
| RDA-I3-04M
:ref:`dci:dateEmbargo` datacite:date :ref:`date type <vocab:datetype_datetype>`
:ref:`dc:language` dc:language `IETF BCP 47`_, `ISO 639-3`_
:ref:`dc:publisher` dc:publisher
:ref:`dci:datePublication` datacite:date :ref:`date type <vocab:datetype_datetype>`
:ref:`aire:resourceType` oaire:resourceType `COAR Resource Type Vocabulary`_
:ref:`dc:description` dc:description
:ref:`dc:format` dc:format
:ref:`dci:identifier` datacite:identifier :ref:`identifier type <vocab:identifiertype_identifiertype>`
:ref:`dci:accessrights` datacite:rights `COAR Access Right Vocabulary`_
:ref:`dc:format` dc:format RDA-I1-01D
:ref:`dci:identifier` datacite:identifier :ref:`identifier type <vocab:identifiertype_identifiertype>` | RDA-F1-01M
| RDA-F1-02M
| RDA-A1.1-01D
:ref:`dci:accessrights` datacite:rights `COAR Access Right Vocabulary`_ RDA-A1-01M
:ref:`dc:source` dc:source
:ref:`dci:subject` datacite:subject
:ref:`aire:licenseCondition` oaire:licenseCondition
:ref:`dci:subject` datacite:subject RDA-I1-01M
:ref:`aire:licenseCondition` oaire:licenseCondition | RDA-R1.1-01M
| RDA-R1.1-02M
| RDA-R1.1-03M
:ref:`dc:coverage` dc:coverage
:ref:`dci:size` datacite:size
:ref:`dci:geolocation` datacite:geoLocation
:ref:`aire:version` oaire:version `COAR Version Vocabulary`_
:ref:`aire:file` oaire:file `COAR Access Right Vocabulary`_
:ref:`aire:file` oaire:file `COAR Access Right Vocabulary`_ RDA-F3-01M
:ref:`aire:citationTitle` oaire:citationTitle
:ref:`aire:citationVolume` oaire:citationVolume
:ref:`aire:citationIssue` oaire:citationIssue
Expand All @@ -63,7 +68,7 @@ OpenAIRE-Field Metadata Element Refinemen
:ref:`aire:citationConferencePlace` oaire:citationConferencePlace
:ref:`aire:citationConferenceDate` oaire:citationConferenceDate
:ref:`dct:audience` dcterms:audience
======================================== ============================= ========================================================================================
======================================== ============================= ================================================================================ ==============

The application profile is implemented in XML Schema.
`The files <https://github.com/openaire/guidelines-literature-repositories/tree/master/schemas>`_
Expand All @@ -74,12 +79,12 @@ In the XML metadata documents the schema must be declared as follows:
.. code-block:: xml
:linenos:

<resource xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
<oaire:resource xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:dc="http://purl.org/dc/elements/1.1/"
xmlns:dcterms="http://purl.org/dc/terms/"
xmlns:datacite="http://datacite.org/schema/kernel-4"
xmlns="http://namespace.openaire.eu/schema/oaire/"
xmlns:oaire="http://namespace.openaire.eu/schema/oaire/"
xsi:schemaLocation="http://namespace.openaire.eu/schema/oaire/ https://www.openaire.eu/schema/repo-lit/4.0/openaire.xsd">

.. _COAR Resource Type Vocabulary: http://vocabularies.coar-repositories.org/documentation/resource_types/
Expand Down
10 changes: 5 additions & 5 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -57,17 +57,17 @@
master_doc = 'index'

# General information about the project.
project = u'OpenAIRE Guidelines for Literature Repository Managers'
copyright = u'2018, OpenAIRE. This work is licensed under Creative Commons Attribution 4.0 International'
project = u'OpenAIRE Guidelines for institutional and thematic Repository Managers'
copyright = u'2021, OpenAIRE. This work is licensed under Creative Commons Attribution 4.0 International'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '4.0'
version = '4.1'
# The full version, including alpha/beta/rc tags.
release = '4.0.1-SNAPSHOT'
release = '4.1-SNAPSHOT'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down Expand Up @@ -230,7 +230,7 @@ def setup(app):
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'OpenAIREGuidelines.tex', u'OpenAIRE Interoperability Guidelines for Literature Repository Managers',
(master_doc, 'OpenAIREGuidelines.tex', u'OpenAIRE Interoperability Guidelines for institutional & thematic Repository Managers',
u'OpenAIRE Guidelines Team', 'manual', True),
]

Expand Down
1 change: 0 additions & 1 deletion docs/contribute.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ How to contribute

Your feedback, esp. as a repository manager, is important for us. You can provide us feedback using the following channels:

* by adding a comment to our v4 feedback document (no account needed) at: https://docs.google.com/document/d/1aFWrkBO_f_GTWWTAfco4uoUphEbtOOdJVD_2ohYw7Ek/edit
* by creating an issue in our guidelines github repository (you need to have a github account): https://github.com/openaire/guidelines-literature-repositories/issues
* by making annotations on the guidelines pages (you need to have an account for https://web.hypothes.is): just highlight some text and you can annotate the document
* by sending an e-mail to: [email protected]
28 changes: 28 additions & 0 deletions docs/fair_enabled.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
.. _fair_enabled:

FAIR enabled
============

The OpenAIRE and DRIVER guidelines, at the beginning of their time in `2006 <https://www.openaire.eu/history>`_, had already put the focus on elements that can be found today in the FAIR principles.
Community-based refinement and enhancement of the guidelines over time to include elements with their descriptions that are consistent with motivation of FAIR.
The following section describe the FAIRification process of the OpenAIRE Guidelines for institutional & thematic Repository Manager.

.. _fair_overview:

Overview
~~~~~~~~

The FAIR maturity model: specification and guidelines of the `Research Data Alliance (RDA) <https://www.rd-alliance.org>`_ (DOI: `10.15497/rda00045 <https://doi.org/10.15497/rda00045>`_)
has the aim to specify the objective indicators for the FAIR assessment. The guidelines are intended to assist evaluators to implement the indicators in the evaluation approach or tool
they manage.

The evaluation level analyse is done thru the RDA provided sheet at https://www.rd-alliance.org/system/files/FAIR_evaluation_levels_v0.01.xlsx .
The result of this evaluation shows the figure below.


.. image:: _static/FAIR-Indicator_InstThemRepoGuidelines.png
:width: 800px
:align: center
:alt: analyzed FAIR Indicator for the OpenAIRE Guidelines for instiutional and thematic repository managers


4 changes: 2 additions & 2 deletions docs/field_creator.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _dci:creator:

Creator (M)
===========
Creator (MA)
============

``datacite:creator``

Expand Down
2 changes: 1 addition & 1 deletion docs/field_filelocation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,6 @@ Example
.. code-block:: xml
:linenos:

<oaire:file accessRightsURI="http://purl.org/coar/access_right/c_abf2" mimeType="application/pdf" objectType="fulltext">http://link-to-the-fulltext.org</oaire:file>
<oaire:file accessRightsURI="http://purl.org/coar/access_right/c_abf2" mimeType="application/pdf" objectType="fulltext" version="4.0.1">http://link-to-the-fulltext.org</oaire:file>

.. _COAR Access Right Vocabulary: http://vocabularies.coar-repositories.org/documentation/access_rights/
31 changes: 29 additions & 2 deletions docs/field_projectid.rst
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Title of the project, award or grant (occurrence: 0-1).
Example
~~~~~~~

An example utilizing all fields:
Examples utilizing all fields:

.. code-block:: xml
:linenos:
Expand All @@ -90,4 +90,31 @@ An example utilizing all fields:
</oaire:fundingReference>
</oaire:fundingReferences>

.. _Crossref Funder Registry: https://www.crossref.org/services/funder-registry/

.. code-block:: xml
:linenos:

<oaire:fundingReferences>
<oaire:fundingReference>
<oaire:funderName>Deutsche Forschungsgemeinschaft</oaire:funderName>
<oaire:funderIdentifier funderIdentifierType="Crossref Funder ID"> http://dx.doi.org/10.13039/501100001659</oaire:funderIdentifier>
<oaire:fundingStream>Transregios</oaire:fundingStream>
<oaire:awardNumber awardURI="https://gepris.dfg.de/gepris/projekt/276833197">276833197</oaire:awardNumber>
<oaire:awardTitle>Quantitative Quality Assessment of Computational Photography</oaire:awardTitle>
</oaire:fundingReference>
</oaire:fundingReferences>

.. code-block:: xml
:linenos:

<oaire:fundingReferences>
<oaire:fundingReference>
<oaire:funderName>SNSF</oaire:funderName>
<oaire:funderIdentifier funderIdentifierType="ISNI">http://www.isni.org/isni/0000000106723101</oaire:funderIdentifier>
<oaire:fundingStream>International short research visits</oaire:fundingStream>
<oaire:awardNumber awardURI="http://p3.snf.ch/project-151094">151094</oaire:awardNumber>
<oaire:awardTitle>Amygdala fMRI and social cognition in patients with unilateral MTLE and Urbach-Wiethe disease</oaire:awardTitle>
</oaire:fundingReference>
</oaire:fundingReferences>

.. _Crossref Funder Registry: https://www.crossref.org/services/funder-registry/
23 changes: 22 additions & 1 deletion docs/field_resourceidentifier.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,11 @@ The ideal use of this element is to use a direct link or a link to a jump-off pa

Smart practice:

* use a stable URL
* use a stable, sustainable URL

**Remarks**

* adapted from `DataCite MetadataKernel`_ v4.1

**Do Not Confuse With**

Expand All @@ -51,6 +55,20 @@ The type of the Identifier (occurrences: 1).
.. note::
Unlike DataCite, OpenAIRE allows for DOIs and other types of identifiers.



`FAIR enabled <fair_enabled.html>`_
~~~~~~~~~~~~

============= =========== ===================================================
Indicator Priority Description
============= =========== ===================================================
RDA-F1-01M essential Metadata is identified by a persistent identifier
RDA-F1-02M essential Metadata is identified by a global unique id
RDA-A1.1-01D important Data is accessible through a free access protocol
============= =========== ===================================================


Example
~~~~~~~

Expand All @@ -60,3 +78,6 @@ In this example the handle redirects to the jump-off page. A jump-off page is a
:linenos:

<datacite:identifier identifierType="Handle">http://hdl.handle.net/1234/5628</datacite:identifier>


.. _DataCite MetadataKernel: http://schema.datacite.org/meta/kernel-4.1/
4 changes: 2 additions & 2 deletions docs/field_size.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@ Example
.. code-block:: xml
:linenos:

<datacite.sizes>
<datacite:sizes>
<datacite:size>15 pages</datacite:size>
<datacite:size>6 MB</datacite:size>
</datacite.sizes>
</datacite:sizes>

.. _DataCite MetadataKernel: http://schema.datacite.org/meta/kernel-4.1/
9 changes: 5 additions & 4 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
################################################################
OpenAIRE Guidelines for Literature Repository Managers v4
################################################################
#########################################################################
OpenAIRE Guidelines for institutional and thematic Repository Managers v4
#########################################################################

These guidelines describe the application profile v4 for Literature Repository managers to be compatible with OpenAIRE.
These guidelines describe the application profile v4 for institutional and thematic Repository managers to be compatible with OpenAIRE.

.. toctree::
:maxdepth: 1

introduction
use_of_oai_pmh
application_profile
fair_enabled

.. include:: contribute.rst
Loading