This page is a subpage of CMDI 1.2

Localised Documentation 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.

Issue description

In CMDI 1.1 documentation on elements has no language property and there can be only one instance per element; hence, there is no way to provide documentation in multiple languages. For localised applications, there should be an option so that the application can show documentation in the preferred language if available.

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.

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 following changes to the CMDI XML Schema accommodates documentation for CMD_Components, CMD_Elements and Attributes:

• 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.
• Metadata editors may provide localised documentation if available. Arbil, as the most generic editor - should be prioritized.