Skip to content
6 changes: 6 additions & 0 deletions docs/cris_v1_1/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. _cris_1_1:

Draft OpenAIRE Guidelines for CRIS Managers v1.1
================================================

The OpenAIRE Guidelines for CRIS Managers version 1.1 are drafted for consultation and community feedback at http://openaire-guidelines-for-cris-managers.readthedocs.io/en/latest/ .
21 changes: 17 additions & 4 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,10 @@ OpenAIRE Guidelines have been released for publication repositories, data archiv
literature/index
data/index
OpenAIRE Guidelines for CRIS Managers <https://openaire-guidelines-for-cris-managers.readthedocs.io/en/v1.2.0/>
Deprecated OpenAIRE Guidelines for Software Repository Managers <http://software-guidelines.readthedocs.io/en/latest/>
Deprecated OpenAIRE Guidelines for Other Research Products <https://guidelines-other-products.readthedocs.io/en/latest/>
Deprecated OpenAIRE Guidelines for Software Repository Managers
#<http://software-guidelines.readthedocs.io/en/latest/>
Deprecated OpenAIRE Guidelines for Other Research Products
#<https://guidelines-other-products.readthedocs.io/en/latest/>

.. toctree::
:maxdepth: 1
Expand All @@ -34,8 +36,8 @@ OpenAIRE Guidelines have been released for publication repositories, data archiv
These versions are no longer accepted according with the OpenAIRE acquisition policy:
- OpenAIRE Guidelines for Literature Repositories v2.0
- OpenAIRE Guidelines for Literature Repositories v1.0
- OpenAIRE Guidelines for Software Repository Managers <http://software-guidelines.readthedocs.io/en/latest/> (Deprecated)
- OpenAIRE Guidelines for Other Research Products <https://guidelines-other-products.readthedocs.io/en/latest/> (Deprecated)
- OpenAIRE Guidelines for Software Repository Managers (Deprecated)
- OpenAIRE Guidelines for Other Research Products (Deprecated)
- Driver guidelines


Expand All @@ -45,6 +47,17 @@ The guidelines specifically provide guidance on how to specify:
- Funding information
- Related publications, datasets, software etc..


.. toctree::
:maxdepth: 1
:caption: Guidelines Drafts

literature_v4/index
software/index
orp/index

Moving forward towards Open Science these guidelines are drafted for consultation and community feedback.

Participate
-----------
You are invited to participate by commenting or editing the content. See our guide for how to get started:
Expand Down
37 changes: 20 additions & 17 deletions docs/literature/application_profile.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,31 +4,34 @@ Application Profile Overview
This documentation uses the following namespace abbreviation:

* ``dc``: http://purl.org/dc/elements/1.1/
* ``datacite``: http://datacite.org/schema/kernel-4
* ``rdf`` : http://www.w3.org/1999/02/22-rdf-syntax-ns#
* ``aire``: http://openaire.eu/schema/v4

======================================== ============== =========================================
OpenAIRE-Field OAI-DC Element Refinement by vocabulary
OpenAIRE-Field OAI-DC Element Refinement by Vocabulary
======================================== ============== =========================================
:ref:`dc:title` dc:title
:ref:`dc:creator` dc:creator
:ref:`dc:relation_projectid` dc:relation ``info:eu-repo/grantAgreement/``
:ref:`dc:rights_accesslevel` dc:rights ``info:eu-repo/semantics/``
:ref:`dc:rights_licensecondition` dc:rights
:ref:`dc:date_embargo` dc:date ``info:eu-repo/date/embargoEnd/``
:ref:`dc:relation_alternativeidentfier` dc:relation ``info:eu-repo/semantics/altIdentifier/``
:ref:`dc:relation_publicationreference` dc:relation ``info:eu-repo/semantics/reference/``
:ref:`dc:relation_datasetreference` dc:relation ``info:eu-repo/semantics/dataset/``
:ref:`dc:subject` dc:subject
:ref:`dc:description` dc:description
:ref:`dci:creator` datacitec:creator
:ref:`dci:contributor` datacite:contributor DataCite contributor type
:ref:`dci:fundingReference` datacite:fundingReference DataCite funderIdentifier type
:ref:`dci:alternativeidentfier` datacite:alternateIdentifier
:ref:`dci:relatedIdentifier` datacite:relatedIdentifier DataCite relatedIdentifier type
:ref:`dci:date_embargo` datacite:date DataCite dateType
:ref:`dc:language` dc:language IETF BCP 47, ISO 639-1,2,3
:ref:`dc:publisher` dc:publisher
:ref:`dc:contributor` dc:contributor
:ref:`dc:date` dc:date
:ref:`dc:type` dc:type ``info:eu-repo/semantics/``
:ref:`dc:type_publicationversion` dc:type ``info:eu-repo/semantics/``
:ref:`dc:type` dc:type COAR Resource Type Vocabulary
:ref:`dc:description` dc:description
:ref:`dc:format` dc:format
:ref:`dc:identifier` dc:identfier
:ref:`dc:rights_accesslevel` dc:rights (COAR)
:ref:`dc:source` dc:source
:ref:`dc:language` dc:language
:ref:`dc:subject` dc:subject
:ref:`dc:rights_licensecondition` dc:rights
:ref:`dc:relation_datasetreference` dc:relation
:ref:`dc:type_publicationversion` dc:type
:ref:`dc:relation` dc:relation
:ref:`dc:coverage` dc:coverage
:ref:`dc:audience` dc:audience
======================================== ============== =========================================


18 changes: 5 additions & 13 deletions docs/literature/field_accesslevel.rst
Original file line number Diff line number Diff line change
@@ -1,18 +1,10 @@
.. _dc:rights_accesslevel:

Access Level (M)
^^^^^^^^^^^^^^^^
15 Access Level (M)
===================

DC Field
~~~~~~~~
``dc:rights``

Usage
~~~~~
*Mandatory*

Usage Instruction
~~~~~~~~~~~~~~~~~
**Usage Instruction**

Use terms from the `info:eu-repo-Access-Terms vocabulary <https://wiki.surfnet.nl/display/standards/info-eu-repo/#info-eu-repo-AccessRights>`_ . The values are:

Expand All @@ -21,8 +13,8 @@ Use terms from the `info:eu-repo-Access-Terms vocabulary <https://wiki.surfnet.n
* ``info:eu-repo/semantics/restrictedAccess``
* ``info:eu-repo/semantics/openAccess``

Example
~~~~~~~
**Example**

.. code-block:: xml
:linenos:

Expand Down
28 changes: 13 additions & 15 deletions docs/literature/field_alternativeidentifier.rst
Original file line number Diff line number Diff line change
@@ -1,18 +1,16 @@
.. _dc:relation_alternativeidentfier:
.. _dci:alternativeidentfier:

Alternative Identifier (R)
^^^^^^^^^^^^^^^^^^^^^^^^^^
5. AlternateIdentifier (R)
==========================

DC Field
~~~~~~~~
``dc:relation``
An identifier or identifiers other than the primary Identifier applied to the resource being registered. This may be any alphanumeric string which is unique within its domain of issue. May be used for local identifiers. AlternateIdentifier should be used for another identifier of the same instance (same location, same file).

Usage
~~~~~
*Recommended*
5.1 alternateIdentifierType (O)
-------------------------------


**Usage Instruction**

Usage Instruction
~~~~~~~~~~~~~~~~~
List alternative identifiers for this publication that are not the primary identifier (repository splash page), e.g., the DOI of publisher’s version, the PubMed/arXiv ID. The term is defined by ``info:eu-repo/semantics/altIdentifier/<scheme>/<identifier>`` where ``<scheme>`` must be one of the following:

* ``ark`` – Archival Resource Key
Expand All @@ -27,12 +25,12 @@ List alternative identifiers for this publication that are not the primary ident
* ``urn`` – Uniform Resource Name
* ``wos`` – Web of Science accession number

Since
~~~~~
**Since**

OpenAIRE Guidelines v3

Example
~~~~~~~
**Example**

.. code-block:: xml
:linenos:

Expand Down
57 changes: 38 additions & 19 deletions docs/literature/field_contributor.rst
Original file line number Diff line number Diff line change
@@ -1,43 +1,62 @@
.. _dc:contributor:
.. _dci:contributor:

Contributor (R)
3. Contributor (R)
==================

.. _dci:contributor_contributorName:

3.1 contributorName (M)
-----------------------

3.2 givenName (O)
-----------------

3.3 familyName (O)
------------------

3.4 nameIdentifier (R)
----------------------

3.4.1 nameIdentifierScheme
^^^^^^^^^^^^^^^^^^^^^^^^^^

3.4.2 schemeURI
^^^^^^^^^^^^^^^

DC Field
~~~~~~~~
``dc:contributor``
3.5 affiliation
---------------

3.6 contributorType
-------------------

attribute

Usage
~~~~~

*Recommended*
**DCMI Definition**

DCMI Definition
~~~~~~~~~~~~~~~
An entity responsible for making contributions to the content of the resource. Examples of a Contributor include a person, an organization, or a service. Typically, the name of a Contributor should be used to indicate the entity.

Usage Instruction
~~~~~~~~~~~~~~~~~
**Usage Instruction**

Examples of contributors are: a supervisor, editor, technician or data collector.

Personal names should be listed as: see instructions under Creator. A “promotor”, i.e. a professor supervising a student’s work for a doctor’s degree - is considered a contributor of a dissertation in his or her role as promotor/examiner. In less-rich Unqualified DC it is difficult to express all roles in different contexts. In the PhD thesis as a document, the key figures are the author and the supervisor. In the overall PhD process other roles are involved, such as committee members and the Master of Ceremonies, but in Unqualified these roles have to be sacrificed.

In the case of organizations : see instructions under Creator The inclusion of personal and corporate name headings from authority lists constructed according to local or national thesaurus files is optional.

Do Not Confuse With
~~~~~~~~~~~~~~~~~~~
**Do Not Confuse With**

* :ref:`dc:publisher`
* :ref:`dc:creator`
* :ref:`dci:creator`

The DC element ``contributor`` describes the scientist(s) that has/have made contributions to the given scientific output, not as a primary creator or (commercial) publisher.

Since
~~~~~
**Since**

DRIVER Guidelines v2

Example
~~~~~~~
**Example**

.. code-block:: xml
:linenos:

Expand Down
57 changes: 38 additions & 19 deletions docs/literature/field_creator.rst
Original file line number Diff line number Diff line change
@@ -1,18 +1,42 @@
.. _dc:creator:
.. _dci:creator:

Creator (M)
^^^^^^^^^^^
2. Creator (M)
==============

DC Field
~~~~~~~~
``dc:creator``
The authors of the publication in priority order. May be a corporate/institutional or personal name.

Usage
~~~~~
*Mandatory*
.. _dci:creator_creatorName:

2.1 creatorName (M)
-------------------

.. _dci:creator_nameIdentifier:

2.2 nameIdentifier (R)
----------------------

.. _dci:creator_nameIdentifier_nameIdentifierScheme:

2.2.1 nameIdentifierScheme (R)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

attribute

.. _dci:creator_nameIdentifier_schemeURI:

2.2.2 schemeURI (O)
^^^^^^^^^^^^^^^^^^^

.. _dci:creator_affiliation:


2.3 affiliation (O)
-------------------

some text

**Usage Instruction**

Usage Instruction
~~~~~~~~~~~~~~~~~
Examples of a Creator include a person, an organization, or a service. If necessary, repeat this element for multiple authors.

Use inverted name, so the syntax will be the following: “surname”, “initials” (“first name”) “prefix”. For example Jan Hubert de Smit becomes
Expand Down Expand Up @@ -56,18 +80,13 @@ It is recommended to encode thesauri with an URI, for service providers to recog
In cases of lesser responsibility, other than authorship, use ``dc:contributor``. If the nature of the responsibility is ambiguous, recommended best practice is to use ``dc:publisher`` for organizations, and ``dc:creator`` for individuals.


Do Not Confuse With
~~~~~~~~~~~~~~~~~~~
**Do Not Confuse With**

* :ref:`dc:contributor`
* :ref:`dc:publisher`

Since
~~~~~

DRIVER Guidelines v2
**Example**

Example
~~~~~~~
.. code-block:: xml
:linenos:

Expand Down
21 changes: 6 additions & 15 deletions docs/literature/field_description.rst
Original file line number Diff line number Diff line change
@@ -1,27 +1,18 @@
.. _dc:description:

Description (MA)
^^^^^^^^^^^^^^^^
12. Description (MA)
====================

DC Field
~~~~~~~~
``dc:description``
**Usage Instruction**

Usage
~~~~~
*Mandatory when applicable*

Usage Instruction
~~~~~~~~~~~~~~~~~
This element is used for a textual description of the content. When a resource consists of several separate physical object files, do not use ``dc:description`` to list the URLs of these files.

Since
~~~~~
**Since**

DRIVER Guidelines v2

Example
~~~~~~~
**Example**

.. code-block:: xml
:linenos:

Expand Down
Loading