This page is a subpage of CMDI 1.2

Documentation on components and attributes

An executive summary is available at CMDI 1.2/Cues/Localised documentation/Summary (Summarisation of this proposal and CMDI 1.2/Cues/Localised documentation)

The issue

In CMDI 1.1 there is no documentation property for CMDI Components and Attributes as there is for CMDI Elements (where the Documentation attribute in the spec gets transformed to an ann:documentation attribute in the schema). Even though components do have a 'description', this is clearly different from documentation (which would generally contain a usage description rather than a conceptual one) so this needs to be added.

Proposed solutions

Apply the same manner of specifying documentation for an element to components and attributes in the general component schema. Extend the comp2schema stylesheet to transform these in a similar way to make the documentation available in profile schemata.

Centre impact

• Metadata modelers will want to add documentation to their new or existing components and profiles
• Clients will need to be extended to read and display the documentation for components and attributes in addition to element

Implementation examples

See Localised documentation for an example that has (localised) documentation on all three levels.

Tickets

Tickets in the CMDI 1.2 milestone with the keyword componentdocumentation:

Ticket	Summary	Owner	Component	Priority	Status
No tickets found

Discussion

Discuss the topic in general below this point