Changes between Version 1 and Version 2 of CMDI 1.2/Cues/Localised documentation/Summary


Ignore:
Timestamp:
03/10/14 11:43:41 (10 years ago)
Author:
teckart
Comment:

Adding information for proposal "Component documentation"

Legend:

Unmodified
Added
Removed
Modified

  • CMDI 1.2/Cues/Localised documentation/Summary

    v1 v2  
    11This page is a subpage of [[CMDI 1.2]]
    22
    3 = Localised Documentation in CMDI 1.2: Executive summary =
     3= Localised Documentation and Documentation for Components in CMDI 1.2: Executive summary =
    44
    5 This page provides an executive summary of the issue and proposed solution fully described in [[CMDI 1.2/Cues/Localised documentation]].
     5This 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]].
    66
    77== Issue description ==
    88
    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.
     9In 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.
    1010
    1111== Description of proposed solution ==
    1212
    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.
     13The 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).
    1414
    1515=== Schema changes ===
    … …  
    2424=== XSD changes ===
    2525
    26 The following changes to the CMDI XML Schema accommodates documentation for CMD_Components, CMD_Elements and Attributes:
     26The changes to the General Component Schema reflect in the CMDI XML Schema as follows:
    2727
    2828* element ''xs:documentation'' in ''xs:annotation'' for ''xs:element'' and ''xs:attribute''
    … …  
    3636
    3737=== 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.
     38* Component Registry must support (multiple and multilingual) specification of documentation for components, elements and attributes (for new '''and''' existing components and profiles).
     39* Metadata editors may provide (localised) documentation if available. Arbil, as the most generic editor, should be prioritized.