element <enumeration> (global)

Namespace:	http://www.xml-cml.org/schema/cml2/react
Type:	anonymous complexType
Content:	complex, 3 attributes, 1 element
Defined:	globally in cmlreact.xsd; see XML source
Includes:	definition of 1 element
Used:	at 1 location

XML Representation Summary

<enumeration

default	=	xsd:string
dictRef	=	xsd:string
value	=	xsd:string

Content:

annotation?

</enumeration>

Content model elements (1):

annotation

Included in content model of elements (1):

entry

Known Usage Locations

Within anonymous complexTypes of elements (1):
entry [ref]

Annotation

<h:div class="summary">An enumeration of value.</h:div> <h:div class="description">An enumeration of string values. Used where a dictionary entry constrains the possible values in a document instance. The dataTypes (if any) must all be identical and are defined by the dataType of the containing element.</h:div> <h:div class="example" href="enumeration1.xml"/>

XML Source (see within schema source)

<xsd:element id="el.enumeration" name="enumeration">

<xsd:annotation>

<xsd:documentation>

<h:div class="summary">An enumeration of value.</h:div>

<h:div class="description">

An enumeration of string values. Used where a dictionary entry constrains the possible values in a document instance. The dataTypes (if any) must all be identical and are defined by the dataType of the containing element.

</h:div>

<h:div class="example" href="enumeration1.xml"/>

</xsd:documentation>

</xsd:annotation>

<xsd:complexType>

<xsd:sequence>

<xsd:element minOccurs="0" ref="annotation"/>

</xsd:sequence>

<xsd:attributeGroup ref="value"/>

<xsd:attributeGroup ref="dictRef"/>

<xsd:attributeGroup ref="default"/>

</xsd:complexType>

</xsd:element>

Attribute Detail (all declarations; 3/3)

default

Type:	xsd:string, predefined
Use:	optional
Defined:	locally within default attributeGroup

<h:div class="summary">default value in an enumeration.</h:div> <h:div class="description">A non-whitespace string (value is irrelevant) indicates that the content of this enumeration is the default value (usually of a scalar). It is an error to have more than one default. If the scalar in an instance document has no value (i.e. is empty or contains only whitespace) its value is given by the default. If the scalar in the instance is empty and no enumerations have a default attribute, an application may throw an error.</h:div>

XML Source (see within schema source)

<xsd:attribute id="att.default" name="default" type="xsd:string">

<xsd:annotation>

<xsd:documentation>

<h:div class="summary">default value in an enumeration.</h:div>

<h:div class="description">

A non-whitespace string (value is irrelevant) indicates that the content of this enumeration is the default value (usually of a scalar). It is an error to have more than one default. If the scalar in an instance document has no value (i.e. is empty or contains only whitespace) its value is given by the default. If the scalar in the instance is empty and no enumerations have a default attribute, an application may throw an error.

</h:div>

</xsd:documentation>

</xsd:annotation>

</xsd:attribute>

dictRef

Type:	namespaceRefType
Use:	optional
Defined:	locally within dictRef attributeGroup

<h:div class="summary">A reference to a dictionary entry.</h:div> <h:div class="description">Elements in data instances such as _scalar_ may have a <h:tt>dictRef</h:tt> attribute to point to an entry in a dictionary. To avoid excessive use of (mutable) filenames and URIs we recommend a namespace prefix, mapped to a namespace URI in the normal manner. In this case, of course, the namespace URI must point to a real XML document containing _entry_ elements and validated against STMML Schema. <h:p>Where there is concern about the dictionary becoming separated from the document the dictionary entries can be physically included as part of the data instance and the normal XPointer addressing mechanism can be used.</h:p> <h:p>This attribute can also be used on _dictionary_ elements to define the namespace prefix</h:p> </h:div> <h:div class="example" href="dictRefGroup1.xml"/>

XML Source (see within schema source)

<xsd:attribute id="att.dictRef" name="dictRef" type="namespaceRefType">

<xsd:annotation>

<xsd:documentation>

<h:div class="summary">A reference to a dictionary entry.</h:div>

<h:div class="description">

Elements in data instances such as _scalar_ may have a

<h:tt>dictRef</h:tt>

attribute to point to an entry in a dictionary. To avoid excessive use of (mutable) filenames and URIs we recommend a namespace prefix, mapped to a namespace URI in the normal manner. In this case, of course, the namespace URI must point to a real XML document containing _entry_ elements and validated against STMML Schema.

<h:p>

Where there is concern about the dictionary becoming separated from the document the dictionary entries can be physically included as part of the data instance and the normal XPointer addressing mechanism can be used.

</h:p>

<h:p>

This attribute can also be used on _dictionary_ elements to define the namespace prefix

</h:p>

</h:div>

<h:div class="example" href="dictRefGroup1.xml"/>

</xsd:documentation>

</xsd:annotation>

</xsd:attribute>

value

Type:	xsd:string, predefined
Use:	optional
Defined:	locally within value attributeGroup

<h:div class="summary">Value of a scalar object.</h:div> <h:div class="description">The value must be consistent with the dataType of the object.</h:div>

XML Source (see within schema source)

<xsd:attribute id="att.value" name="value" type="xsd:string">

<xsd:annotation>

<xsd:documentation>

<h:div class="summary">Value of a scalar object.</h:div>

<h:div class="description">

The value must be consistent with the dataType of the object.

</h:div>

</xsd:documentation>

</xsd:annotation>

</xsd:attribute>

Content Element Detail (all declarations; 1/1)

annotation

Type:	anonymous complexType, mixed content
Defined:	by reference within (this) enumeration element

XML Source (see within schema source)

<xsd:element minOccurs="0" ref="annotation"/>

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/