<h:div class="summary">Documentation in the annotation of an entry.</h:div> <h:div class="description"> <h:p>A container similar to <h:tt>documentation</h:tt>in XML Schema. This is NOT part of the textual content of an entry but is designed to support the transformation of dictionary entrys into schemas for validation. This is experimental and should only be used for dictionaries, units, etc. One approach is to convert these into XML Schemas when the <h:tt>documentation</h:tt>and <h:tt>appinfo</h:tt>children will emerge in their correct position in the derived schema.</h:p> <h:p>Do NOT confuse documentation with the description or the definition which are part of the content of the dictionary</h:p> <h:p>If will probably only be used when there is significant appinfo in the entry or where the entry defines an XSD-like datatype of an element in the doc.</h:p> </h:div> <h:div class="example" href="documentation1.xml"/> |
QName | Type | Fixed | Default | Use | Inheritable | Annotation | |
---|---|---|---|---|---|---|---|
id | idType | optional |
|
||||
title | xsd:string | optional |
|
||||
Wildcard: ANY attribute from ANY namespace OTHER than 'http://www.xml-cml.org/schema' |
<xsd:element name="documentation" id="el.documentation" substitutionGroup="anyCml"> <xsd:annotation> <xsd:documentation> <h:div class="summary">Documentation in the annotation of an entry.</h:div> <h:div class="description"> <h:p>A container similar to <h:tt>documentation</h:tt>in XML Schema. This is NOT part of the textual content of an entry but is designed to support the transformation of dictionary entrys into schemas for validation. This is experimental and should only be used for dictionaries, units, etc. One approach is to convert these into XML Schemas when the <h:tt>documentation</h:tt>and <h:tt>appinfo</h:tt>children will emerge in their correct position in the derived schema.</h:p> <h:p>Do NOT confuse documentation with the description or the definition which are part of the content of the dictionary</h:p> <h:p>If will probably only be used when there is significant appinfo in the entry or where the entry defines an XSD-like datatype of an element in the doc.</h:p> </h:div> <h:div class="example" href="documentation1.xml"/> </xsd:documentation> </xsd:annotation> <xsd:complexType> <xsd:choice minOccurs="0" maxOccurs="unbounded"> <xsd:element ref="anyCml"/> <xsd:any namespace="##other" processContents="lax"/> <xsd:any namespace="##local" processContents="lax"/> </xsd:choice> <xsd:attributeGroup ref="id"/> <xsd:attributeGroup ref="title"/> <xsd:anyAttribute namespace="##other" processContents="lax"/> </xsd:complexType> </xsd:element> |