Skip to content

Latest commit

 

History

History
54 lines (49 loc) · 1.72 KB

DATASET-TEMPLATES.md

File metadata and controls

54 lines (49 loc) · 1.72 KB
Raw

Dataset templates

Projects offer various template options to build a title or citation for a release. The templates can include lower case variables in curly brackets, e.g {editors} ({date}).

Variables

In general all dataset properties are allowed as variables:

  • key
  • sourceKey
  • private
  • type
  • origin
  • attempt # incremental int for imports & releases
  • imported
  • deleted
  • gbifKey
  • gbifPublisherKey
  • size
  • notes
  • doi
  • identifier
  • title
  • alias
  • description
  • issued
  • version
  • issn
  • contact
  • creator
  • editor
  • publisher
  • contributor
  • geographicScope
  • taxonomicScope
  • temporalScope
  • confidence
  • completeness
  • license
  • url
  • logo
  • source

In addition the current {date} is supported. All dates are formatted as ISO dates by default, but you can also give a custom date format to the template that follows after the variable and a comma inside the brackets, e.g. {created,YYYY} will render the date the dataset record was created in ChecklistBank as a 4 digit year. All patterns from the java DateTimeFormatter are supported.

Examples of classic COL templates

  • Release Title Template: Catalogue of Life - {date,MMMM yyyy}
  • Release Alias Template: COL{date,yy.M}
  • Release Citation Template: {editors} ({date,yyyy}). Species 2000 & ITIS Catalogue of Life, {date,ddd MMMM yyyy}. Digital resource at www.catalogueoflife.org. Species 2000: Naturalis, Leiden, the Netherlands. ISSN 2405-8858.
  • Release Source Citation Template: {editorsOrAuthors} ({project.issued,yyyy}). {alias}: {title} (version {version}). In: {project.title}