4 description

Definition: a metadata schema block containing the description of the RAiD and associated properties

Requirement: recommended

Occurrence: 0-n

Example JSON

4.1 description.text

Definition: a project description that may include any additional information that does not fit in the other categories

Requirement: mandatory for each description supplied

Occurrence: 0-1

Allowed values: free text

Constraints: maximum 1000 characters

. 4.2-description.type:

4.2 description.type

Definition: a metadata schema block declaring the type of description

Requirement: mandatory for each description supplied

Occurrence: 1

Example JSON

4.2.1 description.type.id

Definition: the type of description.

Requirement: mandatory for each description.type supplied

Occurrence: 0-1

Allowed values: closed controlled list derived from description.type.schemaUri

  • Primary (preferred full description or abstract)

  • Alternative (additional full description or abstract)

  • Brief

  • Significance Statement

  • Methods

  • Objectives

  • Other (any other descriptive information, e.g. a note or similar)

Default: ‘Primary’

Constraints: if a description is provided, one (and only one) primary description is mandatory

Note: controlled list adapted from Vocabularies for Registry Schema 1.6.5 ‘Description Type’ and DataCite Metadata Schema 4.4 Appendix 1 Table 10 ‘Description of descriptiontype’.

4.2.2 description.type.schemaUri

Definition: the URI of the description type schema

Requirement: mandatory for each description.type.id supplied

Occurrence: 0-1

Allowed values: closed controlled list

  • [URI of RAiD vocab on RVA (to be created)]

4.3 description.language

Definition: a metadata schema block declaring the language of the description text

Requirement: recommended

Occurrence: 0-1

Example JSON

4.3.1 description.language.id

Definition: the language used for the description text identified by a code or other identifier

Requirement: recommended

Occurrence: 0-1

Allowed values: closed controlled list derived from titles.language.schemaUri

Example: eng (ISO 639-3 three-letter code)

4.3.2 description.language.schemaUri

Definition: the URI of the language identifier schema

Requirement: mandatory for each description.language.id supplied

Occurrence: 0-1

Allowed values: closed controlled list of allowed language schemas

  • https://www.iso.org/standard/39534.html

Note: Currently limited to ISO 639-3 three-letter code.