RFC D03: Dataset v2 - Documentation Section

[susheel]

RFC D04: Dataset v2 - Documentation Section

Summary & Motivation:

This RFC introduces a new documentation object property that will be used to replace the description, media and group properties of the Dataset metadata specification.

Authors:

• A. Milward (MetadataWorks)
• D. Milward (MetadataWorks)
• S. Varma (HDR UK)

Detailed List Of Changes:

This RFC is limited to the creation of a new documentation object property based on a new definition called documentation which is listed below:

New Definitions:

• description:
  • New string format limited to (5,3000) characters
• documentation:
  • description: Dataset Description
  • isPartOf: Dataset Group
  • associatedMedia: Associated Media

Required Properties:

• documentation:
  • New documentation property that uses the new documentation definition which includes description, isPartOf, associatedMedia properties

Breaking Changes:

• description:
  • Moved string with char limit (2,3000) into the new documentation object definition which includes a description string with char limit (2,3000)
• group:
  • Renamed to isPartOf
  • Moved string into the new documentation object definition which includes a isPartOf string
• media:
  • Renamed to associatedMedia
  • Moved URI array into the new documentation object definition which includes a associatedMedia property which is an array of URIs

Unresolved Questions:

• description:
  • Should this be a required field? I have added it as such.
• isPartOf:
  • Should this be char limited? Suggest (2,80)?
  • Should this be a required field? I have added it as such.
  • Should this be an array? The datasets could be part of multiple groups?
• additionalDocumentation:
  • Should we place a character limit on this field? Suggest (5,3000)