wiki:CMDI 1.2/Specification

Version 20 (modified by Twan Goosen, 9 years ago) (diff)

link to glossary document

NOTE: This page is currently under development and should be considered a draft. If you wish to contribute, please contact the authors.

Notes from a recent meeting concerning the CMDI specification can be found here

Component Metadata Infrastructure (CMDI) 1.2 [DRAFT]

  1. Component Metadata Infrastructure (CMDI) 1.2 [DRAFT]
    1. Introduction
      1. History
      2. Terminology
      3. Glossary
      4. Normative References
      5. Non-Normative References
      6. Typographic and XML Namespace conventions
  2. Structure of CMDI-files
    1. The header
    2. The resources section
      1. The Resource proxy list
      2. The Journal File Proxy List
      3. The Resource Relation List
    3. The Is-Part-of List
    4. The components
  3. The CMDI Component Specification Language
    1. CCSL header
    2. Component definition
    3. Element definition
    4. Cardinality of elements and components
    5. Describing multilingual content
    6. Attributes for elements and components
  4. Transformation of CCSL into a schema
    1. Interpretation of hierarchies of the CCSL
    2. Interpretation of the order or elements
    3. Interpretation of attributes
  5. Appendices
  6. Bibliography

Introduction

The goal of the Component Metadata Infrastructure (CMDI) specification...

TODO

History

TODO

Terminology

The key words MUST, MUST NOT, REQUIRED, SHALL, SHALL NOT, SHOULD, SHOULD NOT, RECOMMENDED, MAY, and OPTIONAL in this document are to be interpreted as described in RFC2119.

Glossary

Work in progress. Responsible for this section: Thorsten & Twan

Being prepared in ​Google Docs

Normative References

RFC2119
Key words for use in RFCs to Indicate Requirement Levels, IETF RFC 2119, March 1997,
​http://www.ietf.org/rfc/rfc2119.txt
XML-Namespaces
Namespaces in XML 1.0 (Third Edition), W3C, 8 December 2009,
​http://www.w3.org/TR/2009/REC-xml-names-20091208/

Non-Normative References

RFC3023
XML Media Types, IETF RFC 3023, January 2001,
​http://www.ietf.org/rfc/rfc3023.txt

Typographic and XML Namespace conventions

The following typographic conventions for XML fragments will be used throughout this specification:

  • <prefix:Element>
    An XML element with the Generic Identifier Element that is bound to an XML namespace denoted by the prefix prefix.
  • @attr
    An XML attribute with the name attr
  • string
    The literal string must be used either as element content or attribute value.

The following XML namespace names and prefixes are used throughout this specification. The column "Recommended Syntax" indicates which syntax variant SHOULD be used by the Endpoint to serialize the XML response.

Prefix Namespace Name Comment Recommended Syntax
cmd http://clarin.eu/cmd CMDI instance prefixed

TODO: update namespaces

Structure of CMDI-files

Responsible for this section: Oddrun

The header

State purpose of header List elements in a table, giving name, "definition", type, cardinality for each

The resources section

The Resource proxy list

State purpose of Resource Proxy list (and which files should be listed here) Specify in detail how resource proxies are represented:

  • all possible elements and attributes with definition, type, cardinality/obligation

The Journal File Proxy List

State purpose of Journal File Proxy list (and which files should be listed here) Specify in detail how resource proxies are represented:

  • all possible elements and attributes with definition, type, cardinality/obligation

The Resource Relation List

State purpose of Resource Relation List (representing binary relations between resource (proxies) and/or other resources Specify in detail how resource relation are represented:

  • all possible elements and attributes with definition, type, cardinality/obligation

The Is-Part-of List

State purpose of Is-Part-of List (representing external resources that the described resource is a part of) (NOTE: IsPartOfList? no longer in Resources section) Specify in detail how an Is-part-of relation is represented:

  • all possible elements and attributes with definition, type, cardinality/obligation

The components

Sate purpose of components section, and its dependency upon profile (as given in header: MdProfile?)

The CMDI Component Specification Language

Responsible for this section: Thomas

CCSL header

Component definition

Element definition

Cardinality of elements and components

Describing multilingual content

Attributes for elements and components

Transformation of CCSL into a schema

Responsible for this section: Twan

Interpretation of hierarchies of the CCSL

Interpretation of the order or elements

Interpretation of attributes

Appendices

Bibliography

IETF RFC 2045, Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies

IETF RFC 2046, Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types

IETF RFC 5646, Tags for Identifying Languages

ISO 639‐1, Codes for the representation of names of languages — Part 1: Alpha-2 code

ISO 639‐3, Codes for the representation of names of languages -- Part 3: Alpha-3 code for comprehensive coverage of languages

ISO 3166‐1, Codes for the representation of names of countries and their subdivisions — Part 1: Country codes

ISO 8601, Data elements and interchange formats — Information interchange — Representation of dates and times

ISO/IEC 10646‐1, Information technology — Universal Multiple-Octet Coded Character Set (UCS) — Part 1: Architecture and Basic Multilingual Plane XML Schema Part 2: Datatypes, Biron, P.V. and Malhotra, A. (eds.), W3C Recommendation 02 May 2001, available at <​http://www.w3.org/TR/xmlschema-2/>

Attachments (12)

Download all attachments as: .zip