| 1 | This page is a subpage of [[CMDI 1.2]] |
| 2 | |
| 3 | = Localised Documentation in CMDI 1.2: Executive summary = |
| 4 | |
| 5 | This page provides an executive summary of the issue and proposed solution fully described in [[CMDI 1.2/Cues/Localised documentation]]. |
| 6 | |
| 7 | == Issue description == |
| 8 | |
| 9 | 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. |
| 10 | |
| 11 | == Description of proposed solution == |
| 12 | |
| 13 | 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. |
| 14 | |
| 15 | === Schema changes === |
| 16 | |
| 17 | The following changes to the General Component Schema accommodates documentation for CMD_Components, CMD_Elements and Attributes: |
| 18 | |
| 19 | * New element ''Documentation'' (maxOccurs="unbounded") in CMD_Component, CMD_Element and Attribute |
| 20 | |
| 21 | Attribute for ''Documentation'' |
| 22 | * @xml:lang (optional: Language of the provided documentation in this element) |
| 23 | |
| 24 | === XSD changes === |
| 25 | |
| 26 | The following changes to the CMDI XML Schema accommodates documentation for CMD_Components, CMD_Elements and Attributes: |
| 27 | |
| 28 | * element ''xs:documentation'' in ''xs:annotation'' for ''xs:element'' and ''xs:attribute'' |
| 29 | |
| 30 | Attribute for ''xs:documentation'' |
| 31 | * @xml:lang (optional: Language of the provided documentation in this element) |
| 32 | |
| 33 | === Instance changes === |
| 34 | |
| 35 | There will be no changes to CMDI instances. |
| 36 | |
| 37 | === Impact on tools === |
| 38 | * Component Registry must support (multiple and multilingual) specification of documentation for components, elements and attributes. |
| 39 | * Metadata editors may provide localised documentation if available. Arbil, as the most generic editor - should be prioritized. |