diff --git a/docs/cris_v1_1/index.rst b/docs/cris_v1_1/index.rst new file mode 100644 index 0000000..a4d79fc --- /dev/null +++ b/docs/cris_v1_1/index.rst @@ -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/ . diff --git a/docs/index.rst b/docs/index.rst index fd81d89..f28bfff 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -16,8 +16,10 @@ OpenAIRE Guidelines have been released for publication repositories, data archiv literature/index data/index OpenAIRE Guidelines for CRIS Managers - Deprecated OpenAIRE Guidelines for Software Repository Managers - Deprecated OpenAIRE Guidelines for Other Research Products + Deprecated OpenAIRE Guidelines for Software Repository Managers +# + Deprecated OpenAIRE Guidelines for Other Research Products +# .. toctree:: :maxdepth: 1 @@ -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 (Deprecated) - - OpenAIRE Guidelines for Other Research Products (Deprecated) + - OpenAIRE Guidelines for Software Repository Managers (Deprecated) + - OpenAIRE Guidelines for Other Research Products (Deprecated) - Driver guidelines @@ -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: diff --git a/docs/literature/application_profile.rst b/docs/literature/application_profile.rst index 9372597..f0e29d2 100644 --- a/docs/literature/application_profile.rst +++ b/docs/literature/application_profile.rst @@ -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 -======================================== ============== ========================================= + + diff --git a/docs/literature/field_accesslevel.rst b/docs/literature/field_accesslevel.rst index d97b87a..e9551b8 100644 --- a/docs/literature/field_accesslevel.rst +++ b/docs/literature/field_accesslevel.rst @@ -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 `_ . The values are: @@ -21,8 +13,8 @@ Use terms from the `info:eu-repo-Access-Terms vocabulary /`` where ```` must be one of the following: * ``ark`` – Archival Resource Key @@ -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: diff --git a/docs/literature/field_contributor.rst b/docs/literature/field_contributor.rst index 308d551..ff26dbf 100644 --- a/docs/literature/field_contributor.rst +++ b/docs/literature/field_contributor.rst @@ -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: diff --git a/docs/literature/field_creator.rst b/docs/literature/field_creator.rst index 2e5fbb7..02c1c09 100644 --- a/docs/literature/field_creator.rst +++ b/docs/literature/field_creator.rst @@ -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 @@ -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: diff --git a/docs/literature/field_description.rst b/docs/literature/field_description.rst index eb4c042..0463142 100644 --- a/docs/literature/field_description.rst +++ b/docs/literature/field_description.rst @@ -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: diff --git a/docs/literature/field_embargoenddate.rst b/docs/literature/field_embargoenddate.rst index 32f318a..dd1a24e 100644 --- a/docs/literature/field_embargoenddate.rst +++ b/docs/literature/field_embargoenddate.rst @@ -1,35 +1,54 @@ -.. _dc:date_embargo: +.. _dci:date_embargo: -Embargo End Date (MA) -^^^^^^^^^^^^^^^^^^^^^ +7. Embargo Period Date (M) +========================== -DC Field -~~~~~~~~ -``dc:date`` -Usage -~~~~~ -*Mandatory when applicable* +DCMI Definition +~~~~~~~~~~~~~~~ +A date associated with an event in the life cycle of the resource. Typically, Date will be associated with the creation or availability of the resource. Recommended best practice for encoding the date value is defined in a profile of ISO 8601 [W3CDTF] and follows the ``YYYY-MM-DD`` format. Usage Instruction ~~~~~~~~~~~~~~~~~ -When :ref:`dc:rights_accesslevel` is set to +The date should be formatted according to the W3C encoding rules for dates and times: + +**Complete date:** + +``YYYY-MM-DD`` (e.g. 1997-07-16) + +where: + +* ``YYYY`` [four-digit year] is ''mandatory'' +* ``MM`` [two-digit month (01=January, etc.)] is ''optional'' +* ``DD`` [two-digit day of month (01 through 31)] is ''optional'' + +**One date field – Date of Publication:** + +Often repository systems have more then one date fields that serve different purposes. Date of creation, publication, modified, promotion, etc. Unqualified DC is unable to express all these dates, and for the end-user perspective it is confusing to receive more dates from the service provider. The service provider should make a choice what date- field to pick. Preferably in the end-users perspective the most logical and meaningful date will be the date of publication. To reduce the ambiguity of having a number of date fields without qualifiers, we recommend to reduce the number of fields and present the most meaningful date to the service provider. In most cases this is the date of the publication. In other cases this is the date of promotion of a PhD degree. + +**No date of publication available:** + +If no date of publication is available, use any other date available. It is better to use one date than no date at all. + +**Datestamp additions:** -* ``info:eu-repo/semantics/embargoedAccess`` +Additions like “Zulu time” should NOT be part of the metadata. -the end date of the embargo period must be provided. The corresponding term is defined by +**Fuzzy dates:** -* ``info:eu-repo/date/embargoEnd/`` +For fuzzy dates use a logical year that most represents that period, e.g. ``1650`` instead of ``17th century``. -Encoding of this date should be in the form ``YYYY-MM-DD`` conforming to ISO 8601. +To express more about that temporal period, one can use the ``dc:coverage`` field. A temporal period can be expressed in a standard way when precisely defined (see :ref:`dc:coverage`) or when “fuzzy” or uncertain by free text expressions. A service provider is able to sort dates based on date standards like W3CDTF. Since there is no standard for fuzzy dates for terms like “Renaissance” or “17th Century”, they will simply not appear on date-based query results. Since ~~~~~ -OpenAIRE Guidelines v1 +DRIVER Guidelines v2 Example ~~~~~~~ .. code-block:: xml :linenos: - info:eu-repo/date/embargoEnd/2015-12-31 + 2000-12-25 + 1978-02 + 1650 diff --git a/docs/literature/field_format.rst b/docs/literature/field_format.rst index 6896fbb..2d087a3 100644 --- a/docs/literature/field_format.rst +++ b/docs/literature/field_format.rst @@ -1,23 +1,14 @@ .. _dc:format: -Format (R) -^^^^^^^^^^ +13. Format (R) +============== -DC Field -~~~~~~~~ -``dc:format`` - -Usage -~~~~~ -*Recommended* - -DCMI Definition -~~~~~~~~~~~~~~~ +**DCMI Definition** The physical or digital manifestation of the resource. Typically, Format may include the media-type or dimensions of the resource. Format may be used to determine the software, hardware or other equipment needed to display or operate the resource. Examples of dimensions include size and duration. Recommended best practice is to select a value from a controlled vocabulary (for example, the list of Internet Media Types [MIME] defining computer media formats). -Usage Instruction -~~~~~~~~~~~~~~~~~ +**Usage Instruction** + Based on best practice, the IANA registered list of Internet Media Types (MIME types) is used to select a term from. For the full list see http://www.iana.org/assignments/media-types If one specific resource (an instance of scientific output) has more than one physical formats (e.g. postscript and pdf) stored as different object files, all formats are mentioned in the DC element format, for example: @@ -26,19 +17,19 @@ If one specific resource (an instance of scientific output) has more than one ph * ``application/postscript`` * ``application/vnd.oasis.opendocument.text`` -Do Not Confuse With -~~~~~~~~~~~~~~~~~~~ +**Do Not Confuse With** + * :ref:`dc:type` * :ref:`dc:identifier` DC element ``format`` describes the media type of this resource. DC element ``type`` describes the kind of academic output the resource is a representation of. ``dc:identifier`` is used to represent manifestations of digital resources. -Since -~~~~~ +**Since** + DRIVER Guidelines v2 -Example -~~~~~~~ +**Example** + .. code-block:: xml :linenos: diff --git a/docs/literature/field_language.rst b/docs/literature/field_language.rst index 478ccbd..2ac15f4 100644 --- a/docs/literature/field_language.rst +++ b/docs/literature/field_language.rst @@ -1,23 +1,18 @@ .. _dc:language: -Language (R) -^^^^^^^^^^^^ +8. Language (R) +=============== -DC Field -~~~~~~~~ -``dc:language`` +**DC Field** -Usage -~~~~~ +``dc:language`` -*Recommended* +**DCMI Definition** -DCMI Definition -~~~~~~~~~~~~~~~ A language of the intellectual content of the resource. -Usage Instruction -~~~~~~~~~~~~~~~~~ +**Usage Instruction** + A specific resource (an instance of scientific output) is either written in one human language or more. In these cases all used languages are used in the DC element ``language``. If a specific resource (an instance of scientific output) is written in one human language and is translated into other human languages, each translation does have its own record.. Recommended: ISO 639-x, where x can be 1,2 or 3. Best Practice: we use ISO 639-3 and by doing so we follow: http://www.sil.org/iso639-3/ @@ -26,17 +21,15 @@ If necessary, repeat this element to indicate multiple languages. If ISO 639-2 and 639-1 are sufficient for the contents of a repository they can be used alternatively. Since there is a unique mapping this can be done during an aggregation process. -Do Not Confuse With -~~~~~~~~~~~~~~~~~~~ -* Country codes (ISO 3166-1) +IETF BCP 47 + +**Since** -Since -~~~~~ DRIVER Guidelines v2 -Example -~~~~~~~ +**Example** + .. code-block:: xml :linenos: diff --git a/docs/literature/field_projectid.rst b/docs/literature/field_projectid.rst index 4c55ba7..ee63a0a 100644 --- a/docs/literature/field_projectid.rst +++ b/docs/literature/field_projectid.rst @@ -1,28 +1,41 @@ -.. _dc:relation_projectid: +.. _dci:fundingReference: -Project Identifier (MA) -^^^^^^^^^^^^^^^^^^^^^^^ +4. FundingReference (MA) +======================== -DC Field -~~~~~~~~ -``dc:relation`` +4.1 funderName +-------------- -Usage -~~~~~ -*Mandatory when applicable* +Name of the funding provider. -Usage Instruction -~~~~~~~~~~~~~~~~~ +4.2 funderIdentifier +-------------------- + +4.2.1 funderIdentifiertype +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +4.3 awardNumber +--------------- + +4.3.1 awardURI +^^^^^^^^^^^^^^ + +4.4 awardTitle +-------------- + +**Usage Instruction** .. include:: ../common/projectid.rst -Since -~~~~~ +**Since** + OpenAIRE Guidelines v1 +**Modified** + +OpenAIRE Guidelines v4 -Example -~~~~~~~ +**Example** An example that uses all six areas and covers an example of the funding programme ''Horizon Europe'', as label-term **HE**: diff --git a/docs/literature/field_publicationdate.rst b/docs/literature/field_publicationdate.rst index f6b9d57..08df1d4 100644 --- a/docs/literature/field_publicationdate.rst +++ b/docs/literature/field_publicationdate.rst @@ -1,22 +1,14 @@ .. _dc:date: -Publication Date (M) -^^^^^^^^^^^^^^^^^^^^ +10. Publication Date (M) +======================== -DC Field -~~~~~~~~ -``dc:date`` +**DCMI Definition** -Usage -~~~~~ -*Mandatory* - -DCMI Definition -~~~~~~~~~~~~~~~ A date associated with an event in the life cycle of the resource. Typically, Date will be associated with the creation or availability of the resource. Recommended best practice for encoding the date value is defined in a profile of ISO 8601 [W3CDTF] and follows the ``YYYY-MM-DD`` format. -Usage Instruction -~~~~~~~~~~~~~~~~~ +**Usage Instruction** + The date should be formatted according to the W3C encoding rules for dates and times: **Complete date:** @@ -47,12 +39,12 @@ For fuzzy dates use a logical year that most represents that period, e.g. ``1650 To express more about that temporal period, one can use the ``dc:coverage`` field. A temporal period can be expressed in a standard way when precisely defined (see :ref:`dc:coverage`) or when “fuzzy” or uncertain by free text expressions. A service provider is able to sort dates based on date standards like W3CDTF. Since there is no standard for fuzzy dates for terms like “Renaissance” or “17th Century”, they will simply not appear on date-based query results. -Since -~~~~~ +**Since** + DRIVER Guidelines v2 -Example -~~~~~~~ +**Example** + .. code-block:: xml :linenos: diff --git a/docs/literature/field_publicationreference.rst b/docs/literature/field_publicationreference.rst index 3a569f8..29d1bb0 100644 --- a/docs/literature/field_publicationreference.rst +++ b/docs/literature/field_publicationreference.rst @@ -1,18 +1,28 @@ -.. _dc:relation_publicationreference: +.. _dci:relatedIdentifier: -Publication Reference (R) -^^^^^^^^^^^^^^^^^^^^^^^^^ +6. RelatedIdentifier (MA) +========================= -DC Field -~~~~~~~~ -``dc:relation`` +6.1 relatedIdentifier (M) +------------------------- -Usage -~~~~~ -*Recommended* +6.1.1 relatedIdentifierType (M) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +6.1.2 relationType (M) +^^^^^^^^^^^^^^^^^^^^^^ + +6.1.3 relatedMetadataScheme (O) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +6.1.4 schemeURI (O) +^^^^^^^^^^^^^^^^^^^ + +6.1.5 schemeType (O) +^^^^^^^^^^^^^^^^^^^^ + +**Usage Instruction** -Usage Instruction -~~~~~~~~~~~~~~~~~ Encode links to publications referenced by this publication. The syntax is: ``info:eu-repo/semantics/reference//`` where ```` must be one of the following: * ``ark`` – Archival Resource Key @@ -27,12 +37,12 @@ Encode links to publications referenced by this publication. The syntax is: ``in * ``urn`` – Uniform Resource Name * ``wos`` – Web of Science accession number -Since -~~~~~ +**Since** + OpenAIRE Guidelines v3 -Example -~~~~~~~ +**Example** + .. code-block:: xml :linenos: diff --git a/docs/literature/field_publicationtype.rst b/docs/literature/field_publicationtype.rst index 9d832f6..c72b270 100644 --- a/docs/literature/field_publicationtype.rst +++ b/docs/literature/field_publicationtype.rst @@ -1,25 +1,21 @@ .. _dc:type: -Publication Type (M) -^^^^^^^^^^^^^^^^^^^^ +11. Publication Type (M) +======================== -DC Field -~~~~~~~~ -``dc:type`` +**Usage** -Usage -~~~~~ Publication type is used for the following purposes: * **Mandatory (M)**: Publication type (controlled): to indicate the type of publication based on the `info:eu-repo-publication-type-terms `_ vocabulary. * **Optional (O)**: Publication type (free): to indicate the type of publication based on a local repository vocabulary. -DCMI Definition -~~~~~~~~~~~~~~~ +**DCMI Definition** + The type of scientific output the resource is a manifestation of. In the DC element type the kind of dissemination, or the intellectual and/or content type of the resource is described. It is used to explain to the user what kind of resource he is looking at. Is it a book or an article. Was it written for internal or external use, etc. -Usage Instruction -~~~~~~~~~~~~~~~~~ +**Usage Instruction** + **Publication types (controlled):** The first occurrence of the DC Element ``type`` is mandatory and should be used for the type indication of the scientific output based on the ``info:eu-repo`` publication type vocabulary: @@ -45,20 +41,18 @@ The first occurrence of the DC Element ``type`` is mandatory and should be used The second occurrence of the DC Element ``type`` is optional and should be used for the subtype indication of the scientific output. -Do Not Confuse With -~~~~~~~~~~~~~~~~~~~ +**Do Not Confuse With** * :ref:`dc:format` DC element `type` describes the kind of academic output the resource is a representation of. DC element ‘format’ describes the media type of this resource. -Since -~~~~~ +**Since** DRIVER Guidelines v2 -Example -~~~~~~~ +**Example** + .. code-block:: xml :linenos: diff --git a/docs/literature/field_publisher.rst b/docs/literature/field_publisher.rst index 261c003..f438c8d 100644 --- a/docs/literature/field_publisher.rst +++ b/docs/literature/field_publisher.rst @@ -1,42 +1,33 @@ .. _dc:publisher: -Publisher (MA) -^^^^^^^^^^^^^^ +9. Publisher (MA) +================= -DC Field -~~~~~~~~ -``dc:publisher`` +**DCMI Definition** -Usage -~~~~~ -*Mandatory when applicable* - -DCMI Definition -~~~~~~~~~~~~~~~ An entity responsible for making the resource available. Examples of a Publisher include a person, an organization, or a service. Typically, the name of a Publisher should be used to indicate the entity. -Usage Instruction -~~~~~~~~~~~~~~~~~ +**Usage Instruction** + The (commercial or non-commercial) publisher of the resource; not the (sub)institution the author is affiliated with. Publisher is used only in the bibliographic / functional sense, not an organisational one. Use only the full name of the given (commercial) publisher, not the name of an organization or institute that is otherwise [in a broader sense] associated with the creator. With university publications place the name of the faculty and/or research group or research school after the name of the university. In the case of organizations where there is clearly a hierarchy present, list the parts of the hierarchy from largest to smallest, separated by full stops. If it is not clear whether there is a hierarchy present, or unclear which is the larger or smaller portion of the body, give the name as it appears in the eprint. The use of publisher names from authority lists constructed according to local or national thesaurus files is optional. -Do Not Confuse With -~~~~~~~~~~~~~~~~~~~ -* :ref:`dc:contributor` -* :ref:`dc:creator` +**Do Not Confuse With** + +* :ref:`dci:contributor` +* :ref:`dci:creator` In most cases the publisher and the creator are not the same. -Since -~~~~~ +**Since** DRIVER Guidelines v2 -Example -~~~~~~~ +**Example** + .. code-block:: xml :linenos: diff --git a/docs/literature/field_resourceidentifier.rst b/docs/literature/field_resourceidentifier.rst index bf07c7f..d907779 100644 --- a/docs/literature/field_resourceidentifier.rst +++ b/docs/literature/field_resourceidentifier.rst @@ -1,23 +1,15 @@ .. _dc:identifier: -Resource Identifier (M) -^^^^^^^^^^^^^^^^^^^^^^^ +14 Resource Identifier (M) +========================== -DC Field -~~~~~~~~ -``dc:identifier`` -Usage -~~~~~ -*Mandatory* - -DCMI Definition -~~~~~~~~~~~~~~~ +**DCMI Definition** An unambiguous reference to the resource within a given context. -Usage Instruction -~~~~~~~~~~~~~~~~~ +**Usage Instruction** + Recommended best practice is to identify the resource by means of a string or number conforming to a formal identification system. Example formal identification systems include the Uniform Resource Identifier (URI), the Uniform Resource Locator (URL), the Digital Object Identifier (DOI), and the ``URN:NBN``. The ideal use of this element is to use a direct link or a link to a jump-off page (persistent URL) from ``dc:identifier`` in the metadata record to the digital resource or a jump-off page. @@ -31,17 +23,16 @@ Smart practice: * place the “most appropriate” identifier in the form of a URL at the top of the list of Identifiers. In almost all cases this is the one that will be used by a service provider to let an end-user refer to. This can be a link to a jump-off page or a direct link to the file. Also this can be a direct URL, or a redirection URL, like PURL, HANDLE or other international resolution mechanisms. -Do Not Confuse With -~~~~~~~~~~~~~~~~~~~ +**Do Not Confuse With** + * :ref:`dc:relation` (Use ``dc:relation`` to refer from one version of the resource to another.) * :ref:`dc:source` (Use ``dc:source`` for bibliographic citation of the originating resource.) -Since -~~~~~ +**Since** + DRIVER Guidelines v2 -Example -~~~~~~~ +**Example** In this example the identifiers are sorted so that URLs are given first. The first URL will be considered as “most appropriate” and will be used in e.g. OpenAIRE to let an end-user redirect to. In this case the handle redirects to the jump-off page. A jump-off page is a good way to refer to. The end-user has the opportunity to see more information about the object(s) he has found, see the context and enjoy the other services a local repository has to offer: diff --git a/docs/literature/field_source.rst b/docs/literature/field_source.rst index 75a64b9..c0479ab 100644 --- a/docs/literature/field_source.rst +++ b/docs/literature/field_source.rst @@ -1,40 +1,32 @@ .. _dc:source: -Source (R) -^^^^^^^^^^ +16. Source (R) +============== -DC Field -~~~~~~~~ -``dc:source`` -Usage -~~~~~ -*Recommended* - -DCMI Definition -~~~~~~~~~~~~~~~ +**DCMI Definition** A reference to a resource from which the present resource is derived. -Usage Instruction -~~~~~~~~~~~~~~~~~ +**Usage Instruction** + The present resource may be derived from the Source resource in whole or in part. Recommended best practice is to reference the resource by means of a string or number conforming to a formal identification system. Best practice: Use only when the described resource is the result of digitization of non-digital originals. Otherwise, use Relation. Optionally metadata about the current location and call number of the digitized publication can be added. Use: Guidelines for Encoding Bibliographic Citation Information in Dublin Core Metadata (http://dublincore.org/documents/dc-citation-guidelines/). -Do Not Confuse With -~~~~~~~~~~~~~~~~~~~ +**Do Not Confuse With** + * :ref:`dc:relation` * :ref:`dc:identifier` -Since -~~~~~ +**Since** + DRIVER Guidelines v2 -Example -~~~~~~~ +**Example** + .. code-block:: xml :linenos: diff --git a/docs/literature/field_subject.rst b/docs/literature/field_subject.rst index 2093ee2..4425895 100644 --- a/docs/literature/field_subject.rst +++ b/docs/literature/field_subject.rst @@ -1,18 +1,11 @@ .. _dc:subject: -Subject (MA) -^^^^^^^^^^^^ +17. Subject (MA) +================ -DC Field -~~~~~~~~ -``dc:subject`` -Usage -~~~~~ -*Mandatory when applicable (MA)* +**Usage Instruction** -Usage Instruction -~~~~~~~~~~~~~~~~~ In the DC subject element two kinds of values are possible: encode either a keyword or a classification. When both are available use separate occurrences of this element. Use the first occurrence of the DC element ``subject`` for a human readable keyword. @@ -35,17 +28,16 @@ It is recommended to use an URI when using classification schemes or controlled If no specific classification scheme is used we recommend the Dewey Decimal Classification (DDC). More information about the DDC and the DDC Summaries can be found at https://www.oclc.org/en/dewey/resources.html . Please note that OCLC owns all copyright rights in the Dewey Decimal Classification system. Dewey, Dewey Decimal Classification, DDC, OCLC and WebDewey are registered trademarks of OCLC. -Do Not Confuse With -~~~~~~~~~~~~~~~~~~~ +**Do Not Confuse With** * :ref:`dc:type` -Since -~~~~~ +**Since** + DRIVER Guidelines v2 -Example -~~~~~~~ +**Example** + .. code-block:: xml :linenos: diff --git a/docs/literature/field_title.rst b/docs/literature/field_title.rst index a41bd43..88fa51d 100644 --- a/docs/literature/field_title.rst +++ b/docs/literature/field_title.rst @@ -1,23 +1,24 @@ .. _dc:title: -Title (M) ---------- +1. Title (M) +============ -DC Field -~~~~~~~~ -``dc:title`` +A name given to the resource. -Usage -~~~~~ -*Mandatory (M)* +.. _dc:title_lang: + +1.1 lang (O) +^^^^^^^^^^^^ + +The language of the title (occurences: 0-n) + +**Usage Instruction** -Usage Instruction -~~~~~~~~~~~~~~~~~ Preserve the original wording, order and spelling of the resource title. Only capitalize proper nouns. Punctuation need not reflect the usage of the original. Subtitles should be separated from the title by a colon. This instruction would result in Title:Subtitle (i.e. no space). If necessary, repeat this element for multiple titles. -Example -~~~~~~~ +**Example** + .. code-block:: xml :linenos: - Main title:Subtitle + Main title:Subtitle diff --git a/docs/literature/introduction.rst b/docs/literature/introduction.rst index 56d99d7..aa338b4 100644 --- a/docs/literature/introduction.rst +++ b/docs/literature/introduction.rst @@ -5,7 +5,7 @@ Introduction Aim ^^^ -The OpenAIRE Guidelines for Literature Repository Managers 3.0 provide +The OpenAIRE Guidelines for Literature Repository Managers 4.0 provide orientation for repository managers to define and implement their local data management policies according to the requirements of the OpenAIRE - Open Access Infrastructure for Research in Europe. @@ -29,7 +29,7 @@ discoverability and utilizing value-added services provided by the OpenAIRE port According to the ongoing expansion and anticipating the merger of the DRIVER Guidelines into the context of OpenAIRE Guidelines, detailed content from the DRIVER Guidelines 2.0 was adapted and added into this version of the Guidelines. -The OpenAIRE Guidelines for Literature Repository Managers 3.0 are now only a +The OpenAIRE Guidelines for Literature Repository Managers 4.0 are part of a set of OpenAIRE Guidelines that also includes the OpenAIRE Guidelines for Data Archive Managers and the OpenAIRE CERIF-XML profile. diff --git a/docs/literature_v4/index.rst b/docs/literature_v4/index.rst new file mode 100644 index 0000000..f242625 --- /dev/null +++ b/docs/literature_v4/index.rst @@ -0,0 +1,7 @@ +.. _literature_v4: + +OpenAIRE Guidelines for Literature Repository Managers v4 +=============================================================== + +The OpenAIRE Guidelines for Literature Repository Managers v4 are drafted for consultation and community feedback at http://openaire-guidelines-for-literature-repository-managers.readthedocs.io/en/latest/ . + diff --git a/docs/orp/index.rst b/docs/orp/index.rst new file mode 100644 index 0000000..91ef91b --- /dev/null +++ b/docs/orp/index.rst @@ -0,0 +1,7 @@ +.. _orp: + +Draft OpenAIRE Guidelines for Other Research Products +===================================================== + +The OpenAIRE Guidelines for Other Research Products Repository Managers are drafted for consultation and community feedback at https://guidelines-other-products.readthedocs.io/en/latest/ . + diff --git a/docs/software/index.rst b/docs/software/index.rst new file mode 100644 index 0000000..59c4521 --- /dev/null +++ b/docs/software/index.rst @@ -0,0 +1,7 @@ +.. _software: + +Draft OpenAIRE Guidelines for Software Repository Managers +========================================================== + +The OpenAIRE Guidelines for Software Repository Managers are drafted for consultation and community feedback at http://software-guidelines.readthedocs.io/en/latest/index.html . +