element <documentation> (global)
Namespace:
http://www.xml-cml.org/schema/cml2/react
Type:
anonymous complexType
Content:
mixed (allows character data), 2 attributes, elem. wildcard
Defined:
globally in cmlreact.xsd; see XML source
Includes:
definition of elem. wildcard
Used:
at 1 location
XML Representation Summary
<documentation
   
id
 = 
 xsd:string
title
 = 
 xsd:string
    >
   
Content: 
 {text} ? {any}*
</documentation>
Included in content model of elements (1):
annotation
Known Usage Locations
Annotation
<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 document.</h:p> </h:div> <h:div class="example" href="documentation1.xml"/>
XML Source (see within schema source)
<xsd:element id="el.documentation" name="documentation">
<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 document.
</h:p>
</h:div>
<h:div class="example" href="documentation1.xml"/>
</xsd:documentation>
</xsd:annotation>
<xsd:complexType mixed="true">
<xsd:sequence maxOccurs="unbounded" minOccurs="0">
<xsd:any processContents="lax"/>
</xsd:sequence>
<xsd:attributeGroup ref="id"/>
<xsd:attributeGroup ref="title"/>
</xsd:complexType>
</xsd:element>
Attribute Detail (all declarations; 2/2)
id
Type:
idType
Use:
optional
Defined:
locally within id attributeGroup
<h:div class="summary">An attribute providing a unique ID for an element.</h:div> <h:div class="description"/>
XML Source (see within schema source)
<xsd:attribute id="att.id" name="id" type="idType">
<xsd:annotation>
<xsd:documentation>
<h:div class="summary">
An attribute providing a unique ID for an element.
</h:div>
<h:div class="description"/>
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
title
Type:
xsd:string, predefined
Use:
optional
Defined:
locally within title attributeGroup
<h:div class="summary">A title on an element.</h:div> <h:div class="description">No controlled value.</h:div> <h:div class="example" href="title1.xml"/>
XML Source (see within schema source)
<xsd:attribute id="att.title" name="title" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
<h:div class="summary">A title on an element.</h:div>
<h:div class="description">No controlled value.</h:div>
<h:div class="example" href="title1.xml"/>
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
Content Element Detail (all declarations; 1/1)
{any element with any namespace}
Defined:
within (this) documentation element
XML Source (see within schema source)
<xsd:any processContents="lax"/>
This XML schema documentation has been generated with DocFlex/XML RE 1.8.5 using DocFlex/XML XSDDoc 2.5.0 template set.
DocFlex/XML RE is a reduced edition of DocFlex/XML, which is a tool for programming and running highly sophisticated documentation and reports generators by the data obtained from any kind of XML files. The actual doc-generators are implemented in the form of special templates that are designed visually using a high-quality Template Designer GUI basing on the XML schema (or DTD) files describing the data source XML.
DocFlex/XML XSDDoc is a commercial template application of DocFlex/XML that implements a high-quality XML Schema documentation generator with simultaneous support of framed multi-file HTML, single-file HTML and RTF output formats. (More formats are planned in the future).
A commercial license for "DocFlex/XML XSDDoc" will allow you:
  • To configure the generated documentation so much as you want. Thanks to our template technology, it was possible to support > 400 template parameters, which work the same as "options" of ordinary doc-generators. The parameters are organized in nested groups, which form a parameter tree. Most of them have their default values calculated dynamically from a few primary parameters. So, you'll never need to specify all of them. That will give you swift and effective control over the generated content!
  • To use certain features disabled in the free mode (such as the full documenting of substitution groups).
  • To select only the initial, imported, included, redefined XML schemas to be documented or only those directly specified by name.
  • To include only XML schema components specified by name.
  • To document local element components both globally and locally (similar to attributes).
  • To allow/suppress unification of local elements by type.
  • To enable/disable reproducing of namespace prefixes.
  • To use PlainDoc.tpl main template to generate all the XML schema documentation in a signle-file form as both HTML and incredible quality RTF output.
  • To format your annotations with XHTML tags and reproduce that formatting both in HTML and RTF output.
  • To insert images in your annotations using XHTML <img> tags (supported both in HTML and RTF output).
  • To remove this very advertisement text!
Once having only such a license, you will be able to run the fully-featured XML schema documentation generator both with DocFlex/XML (Full Edition) and with DocFlex/XML RE, which is a reduced free edition containing only the template interpretor / output generator. No other licenses will be required!
But this is not all. In addition to it, a commercial license for "DocFlex/XML SDK" will allow you to modify the XSDDoc templates themselves as much as you want. You will be able to achieve whatever was impossible to do with the template parameters only. And, of course, you could develop any template applications by your own!
Please note that by purchasing a license for this software, you not only acquire a useful tool, you will also make an important investment in its future development, the results of which you could enjoy later by yourself. Every single your purchase matters and makes a difference for us!
To purchase a license, please follow this link: http://www.filigris.com/shop/