Skip to content

Commit

Permalink
preparation of v4.0 draft
Browse files Browse the repository at this point in the history
  • Loading branch information
Jochen Schirrwagen committed Jan 24, 2017
1 parent 4810f16 commit 0f8facc
Show file tree
Hide file tree
Showing 18 changed files with 315 additions and 282 deletions.
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
54 changes: 54 additions & 0 deletions docs/literature/field_date.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
.. _dci:date:

7. Embargo Period Date (M)
==========================


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
~~~~~~~~~~~~~~~~~
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:**

Additions like “Zulu time” should NOT be part of the metadata.

**Fuzzy dates:**

For fuzzy dates use a logical year that most represents that period, e.g. ``1650`` instead of ``17th century``.

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
~~~~~
DRIVER Guidelines v2

Example
~~~~~~~
.. code-block:: xml
:linenos:
<dc:date>2000-12-25</dc:date>
<dc:date>1978-02</dc:date>
<dc:date>1650</dc:date>
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
31 changes: 11 additions & 20 deletions docs/literature/field_format.rst
Original file line number Diff line number Diff line change
@@ -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:
Expand All @@ -26,19 +17,19 @@ If one specific resource (an instance of scientific output) has more than one ph
* ``<dc:format>application/postscript</dc:format>``
* ``<dc:format>application/vnd.oasis.opendocument.text</dc:format>``

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:
Expand Down

0 comments on commit 0f8facc

Please sign in to comment.