5 description

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

Requirement: recommended

Occurrence: 0-n

Example JSON

{
  "description": [
    {
      "text": "KELPWATCH tracks the recovery of giant kelp forests at twelve reference sites along the Great Southern Reef, combining diver surveys with fixed underwater imagery to measure canopy extent and species assemblage change following marine heatwaves.",
      "type": {
        "id": "https://vocabulary.raid.org/description.type.schema/318",
        "schemaUri": "https://vocabulary.raid.org/description.type.schema/320"
      },
      "language": {
        "id": "eng",
        "schemaUri": "https://www.iso.org/standard/74575.html"
      }
    },
    {
      "text": "Quarterly diver transects paired with time-lapse imagery, analysed against sea surface temperature records.",
      "type": {
        "id": "https://vocabulary.raid.org/description.type.schema/8",
        "schemaUri": "https://vocabulary.raid.org/description.type.schema/320"
      },
      "language": {
        "id": "eng",
        "schemaUri": "https://www.iso.org/standard/74575.html"
      }
    }
  ]
}

5.1 description.text

Definition: a project description that may include any additional information not captured by other metadata properties

Requirement: mandatory for each description supplied

Occurrence: 1

Allowed values: free text

Constraints: maximum 1000 characters

Note: Descriptions are intended to be flexible, and projects can use them liberally to capture information about the project that is not recorded elsewhere in the RAiD.

5.2 description.type

Definition: a metadata schema sub-block declaring the type of description

Requirement: mandatory for each description supplied

Occurrence: 1

Example JSON

{
  "type": {
    "id": "https://vocabulary.raid.org/description.type.schema/318",
    "schemaUri": "https://vocabulary.raid.org/description.type.schema/320"
  }
}

5.2.1 description.type.id

Definition: the type of description

Requirement: mandatory for each description.type supplied

Occurrence: 1

Allowed values: closed controlled list derived from description.type.schemaUri, published at https://vocabulary.raid.org/description.type.id/scheme

  • https://vocabulary.raid.org/description.type.schema/318 (Primary, i.e., a preferred full description or abstract)

  • https://vocabulary.raid.org/description.type.schema/319 (Alternative, i.e., an additional or supplementary full description or abstract)

  • https://vocabulary.raid.org/description.type.schema/3 (Brief, i.e., a shortened version of the primary description)

  • https://vocabulary.raid.org/description.type.schema/9 (Significance statement)

  • https://vocabulary.raid.org/description.type.schema/8 (Methods)

  • https://vocabulary.raid.org/description.type.schema/7 (Objectives)

  • https://vocabulary.raid.org/description.type.schema/392 (Acknowledgements, i.e., for recognition of people not listed as Contributors or organisations not listed as Organisations)

  • https://vocabulary.raid.org/description.type.schema/6 (Other, i.e., any other descriptive information such as a note)

Default: description.type.id for first-entered description (only) defaults to ‘Primary’

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

5.2.2 description.type.schemaUri

Definition: the URI of the description type schema

Requirement: mandatory for each description.type supplied

Occurrence: 1

Allowed values: closed controlled list defined at https://vocabulary.raid.org/description.type.schemaUri/scheme

  • https://vocabulary.raid.org/description.type.schema/320

Default: https://vocabulary.raid.org/description.type.schema/320, the only value in this closed controlled list

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’.

5.3 description.language

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

Requirement: recommended

Occurrence: 0-1

Example JSON

{
  "language": {
    "id": "eng",
    "schemaUri": "https://www.iso.org/standard/74575.html"
  }
}

5.3.1 description.language.id

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

Requirement: mandatory for each description.language supplied

Occurrence: 1

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

Example(s): eng

Note: Individual codes are not listed here, unlike other closed lists in this schema, because ISO 639:2023 (Set 3) contains several thousand language codes. Browse the full list at https://iso639-3.sil.org/code_tables/639/data.

5.3.2 description.language.schemaUri

Definition: the URI of the language identifier schema

Requirement: mandatory for each description.language supplied

Occurrence: 1

Allowed values: closed controlled list of allowed language schemas defined at https://vocabulary.raid.org/description.language.schemaUri/240

  • https://www.iso.org/standard/74575.html (ISO 639:2023 Code for individual languages and language groups (Set 3))

Default: https://www.iso.org/standard/74575.html, the only value in this closed controlled list

Constraints: currently limited to ISO 639:2023 (Set 3)