This page is a subpage of CMDI 1.2

Localised Documentation and Documentation for Components in CMDI 1.2: Executive summary

This page provides an executive summary of the issue and proposed solution fully described in CMDI 1.2/Cues/Localised documentation and CMDI 1.2/Cues/Component documentation.

Issue description

In CMDI 1.1 documentation is only allowed on elements and has no language property. Furthermore the current solution only supports one instance per element; hence, there is no way to provide documentation in multiple languages. To allow documentation for CMDI components and attributes and providing support for localised applications, there should also be documentation for components and attributes that may provide the specification of the language property.

Description of proposed solution

The current Documentation attribute will be refactored into a new child element Documentation (with xml:lang attribute) for attributes, elements or components. In the XSD this will be transformed into an xs:annotation element (by extension of the comp2schema stylesheet).

Schema changes

The following changes to the General Component Schema accommodates documentation for CMD_Components, CMD_Elements and Attributes:

• New element Documentation (maxOccurs="unbounded") in CMD_Component, CMD_Element and Attribute

Attribute for Documentation

• @xml:lang (optional: Language of the provided documentation in this element)

XSD changes

The changes to the General Component Schema reflect in the CMDI XML Schema as follows:

• element xs:documentation in xs:annotation for xs:element and xs:attribute

Attribute for xs:documentation

• @xml:lang (optional: Language of the provided documentation in this element)

Instance changes

There will be no changes to CMDI instances.

Impact on tools

• Component Registry must support (multiple and multilingual) specification of documentation for components, elements and attributes (for new and existing components and profiles).
• Metadata editors may provide (localised) documentation if available. Arbil, as the most generic editor, should be prioritized.