You are here

CMDI Best Practices Guide

The CMDI Best Practices guide contains a collection of general best practices regarding modelling and authoring CMDI metadata within CLARIN. It also featuers a a set of cross-cutting descriptions of common approaches and problems.

The editors of the CMDI Best Practices guide aim to regularly publish new versions of the guide. You can download the current version of the guide or have a look at previous versions. Some parts of the document are currently work in progress and/or not yet included in the published versions. Draft versions and ongoing work on the guide is publicly available through the draft version repository.

The guide is distributed under a Creative Commons Attribution-ShareAlike licence (CC-BY-SA 4.0). You are welcome to send your feedback to cmdi@clarin.eu.

For an introduction to the guide and some background information, see our CLARIN Annual Conference 2017 presentation (video and slides).

Also a draft implementation of Schematron rules for the more technical best practices are available for trial. These can be run with version 1.1 (or higher) of SchemAnon, but also via general XML tools like oXygen.

Example: check all the CMD records (which use the file extension .cmdi) in my-cmdi-directory

java -jar SchemAnon.jar \
  https://raw.githubusercontent.com/clarin-eric/cmdi-toolkit/develop/src/main/resources/toolkit/sch/cmd-record-best-practices.sch
  ./my-cmdi-directory cmdi

Example: check the profile with id clarin.eu:cr1:p_1505397653795

wget -O profile.xml https://catalog.clarin.eu/ds/ComponentRegistry/rest/registry/1.x/profiles/clarin.eu:cr1:p_1505397653795/xml
java -jar SchemAnon.jar \
  https://raw.githubusercontent.com/clarin-eric/cmdi-toolkit/develop/src/main/resources/toolkit/sch/cmd-component-best-practices.sch \
  profile.xml