element <action> (global)

Namespace:	http://www.xml-cml.org/schema/cml2/react
Type:	anonymous complexType
Content:	mixed (allows character data), 14 attributes, elem. wildcard
Defined:	globally in cmlreact.xsd; see XML source
Includes:	definition of elem. wildcard
Used:	never

XML Representation Summary

<action

convention	=	xsd:string
count	=	xsd:double
dictRef	=	xsd:string
duration	=	xsd:string
end	=	xsd:string
endCondition	=	xsd:string
id	=	xsd:string
order	=	("sequential" \| "parallel")
ref	=	xsd:string
start	=	xsd:string
startCondition	=	xsd:string
title	=	xsd:string
type	=	xsd:string
units	=	xsd:string

Content:

{text} ? {any}*

</action>

Annotation

<h:div class="summary">An action which might occur in scientific data or narrative.</h:div> <h:div class="description"> An action which might occur in scientific data or narrative. The definition is deliberately vague, intending to collect examples of possible usage. Thus an action could be addition of materials, measurement, application of heat or radiation. The content model is unrestricted. _action_ iself is normally a child of _actionList_. <h:p>The start, end and duration attributes should be interpreted as </h:p> <h:ul> <h:li>XSD dateTimes and XSD durations. This allows precise recording of time of day, etc, or duration after start of actionList. A <h:tt>convention="xsd"</h:tt> attribute should be used to enforce XSD.</h:li> <h:li>a numerical value, with a units attribute linked to a dictionary.</h:li> <h:li>a human-readable string (unlikely to be machine processable)</h:li> </h:ul> <h:p> <h:tt>startCondition</h:tt> and <h:tt>endCondition</h:tt> values are not constrained, which allows XSL-like <h:tt>test</h:tt> attribute values. The semantics of the conditions are yet to be defined and at present are simply human readable. </h:p> <h:p>The order of the <h:tt>action</h:tt> elements in the document may, but will not always, define the order that they actually occur in.</h:p> <h:p>A delay can be shown by an <h:tt>action</h:tt> with no content. Repeated actions or actionLists are indicated through the count attribute.</h:p> </h:div> <h:div class="example" href="action1.xml"/>

XML Source (see within schema source)

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

<xsd:annotation>

<xsd:documentation>

<h:div class="summary">

An action which might occur in scientific data or narrative.

</h:div>

<h:div class="description">

An action which might occur in scientific data or narrative. The definition is deliberately vague, intending to collect examples of possible usage. Thus an action could be addition of materials, measurement, application of heat or radiation. The content model is unrestricted. _action_ iself is normally a child of _actionList_.

<h:p>

The start, end and duration attributes should be interpreted as

</h:p>

<h:ul>

<h:li>

XSD dateTimes and XSD durations. This allows precise recording of time of day, etc, or duration after start of actionList. A

<h:tt>convention="xsd"</h:tt>

attribute should be used to enforce XSD.

</h:li>

<h:li>

a numerical value, with a units attribute linked to a dictionary.

</h:li>

<h:li>

a human-readable string (unlikely to be machine processable)

</h:li>

</h:ul>

<h:p>

<h:tt>startCondition</h:tt>

and

<h:tt>endCondition</h:tt>

values are not constrained, which allows XSL-like

<h:tt>test</h:tt>

attribute values. The semantics of the conditions are yet to be defined and at present are simply human readable.

</h:p>

<h:p>

The order of the

<h:tt>action</h:tt>

elements in the document may, but will not always, define
the order that they actually occur in.

</h:p>

<h:p>

A delay can be shown by an

<h:tt>action</h:tt>

with no content. Repeated actions or
actionLists are indicated through the count attribute.

</h:p>

</h:div>

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

</xsd:documentation>

</xsd:annotation>

<xsd:complexType mixed="true">

<xsd:sequence maxOccurs="unbounded" minOccurs="0">

<xsd:any processContents="lax"/>

</xsd:sequence>

<xsd:attributeGroup ref="title"/>

<xsd:attributeGroup ref="id"/>

<xsd:attributeGroup ref="convention"/>

<xsd:attributeGroup ref="dictRef"/>

<xsd:attributeGroup ref="units"/>

<xsd:attributeGroup ref="start"/>

<xsd:attributeGroup ref="startCondition"/>

<xsd:attributeGroup ref="duration"/>

<xsd:attributeGroup ref="end"/>

<xsd:attributeGroup ref="endCondition"/>

<xsd:attributeGroup ref="type"/>

<xsd:attributeGroup ref="actionOrder"/>

<xsd:attributeGroup ref="count">

<xsd:annotation>

<xsd:documentation>

<h:div class="specific">Number of times the action should be repeated.</h:div>

</xsd:documentation>

</xsd:annotation>

</xsd:attributeGroup>

<xsd:attributeGroup ref="ref"/>

</xsd:complexType>

</xsd:element>

Attribute Detail (all declarations; 14/14)

convention

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

<h:div class="summary">A reference to a convention.</h:div> <h:div class="description">There is no controlled vocabulary for conventions, but the author must ensure that the semantics are openly available and that there are mechanisms for implementation. The convention is inherited by all the subelements, so that a convention for <h:tt>molecule</h:tt> would by default extend to its <h:tt>bond</h:tt> and <h:tt>atom</h:tt> children. This can be overwritten if necessary by an explicit <h:tt>convention</h:tt>. <h:p>It may be useful to create conventions with namespaces (e.g. <h:tt>iupac:name</h:tt>). Use of <h:tt>convention</h:tt> will normally require non-STMML semantics, and should be used with caution. We would expect that conventions prefixed with "ISO" would be useful, such as ISO8601 for dateTimes.</h:p> <h:p>There is no default, but the conventions of STMML or the related language (e.g. CML) will be assumed.</h:p> </h:div> <h:div class="example" href="convGroup1.xml" id="ex"/>

XML Source (see within schema source)

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

<xsd:annotation>

<xsd:documentation>

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

<h:div class="description">

There is no controlled vocabulary for conventions, but the author must ensure that the semantics are openly available and that there are mechanisms for implementation. The convention is inherited by all the subelements,
so that a convention for

<h:tt>molecule</h:tt>

would by default extend to its

<h:tt>bond</h:tt>

and

<h:tt>atom</h:tt>

children. This can be overwritten
if necessary by an explicit

<h:tt>convention</h:tt>

<h:p>

It may be useful to create conventions with namespaces (e.g.

<h:tt>iupac:name</h:tt>

).
Use of

<h:tt>convention</h:tt>

will normally require non-STMML semantics, and should be used with
caution. We would expect that conventions prefixed with "ISO" would be useful,
such as ISO8601 for dateTimes.

</h:p>

<h:p>

There is no default, but the conventions of STMML or the related language (e.g. CML) will be assumed.

</h:p>

</h:div>

<h:div class="example" href="convGroup1.xml" id="ex"/>

</xsd:documentation>

</xsd:annotation>

</xsd:attribute>

count

Type:	positiveNumberType
Use:	optional
Defined:	locally within count attributeGroup

<h:div class="summary">The count of the object.</h:div> <h:div class="description">No fixed semantics or default, normally integral. It is presumed that the element can be multiplied by the count value.</h:div>

XML Source (see within schema source)

<xsd:attribute id="att.count" name="count" type="positiveNumberType">

<xsd:annotation>

<xsd:documentation>

<h:div class="summary">The count of the object.</h:div>

<h:div class="description">

No fixed semantics or default, normally integral. It is presumed that the element can be multiplied by the count value.

</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>

duration

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

<h:div class="summary">The duration of the action.</h:div> <h:div class="description">Semantics undefined.</h:div>

XML Source (see within schema source)

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

<xsd:annotation>

<xsd:documentation>

<h:div class="summary">The duration of the action.</h:div>

<h:div class="description">Semantics undefined.</h:div>

</xsd:documentation>

</xsd:annotation>

</xsd:attribute>

end

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

<h:div class="summary">The end time.</h:div> <h:div class="description">The start time in any allowable XSD representation of date, time or dateTime. This will normally be a clock time or date.</h:div>

XML Source (see within schema source)

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

<xsd:annotation>

<xsd:documentation>

<h:div class="summary">The end time.</h:div>

<h:div class="description">

The start time in any allowable XSD representation of date, time or dateTime. This will normally be a clock time or date.

</h:div>

</xsd:documentation>

</xsd:annotation>

</xsd:attribute>

endCondition

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

<h:div class="summary">The end condition.</h:div> <h:div class="description"> <h:p>At present a human-readable string describing some condition when the ac tion should end. As XML develops it may be possible to add machine-processable semantics in this field.</h:p> </h:div>

XML Source (see within schema source)

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

<xsd:annotation>

<xsd:documentation>

<h:div class="summary">The end condition.</h:div>

<h:div class="description">

<h:p>

At present a human-readable string describing some condition when the
ac tion should end. As XML develops it may be possible to add machine-processable
semantics in this field.

</h:p>

</h:div>

</xsd:documentation>

</xsd:annotation>

</xsd:attribute>

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>

order

Type:	anonymous simpleType (restriction of xsd:string)
Use:	optional
Defined:	locally within actionOrder attributeGroup

<h:div class="summary">Describes whether child elements are sequential or parallel.</h:div> <h:div class="description">There is no default.</h:div>

Anonymous simpleType

Derivation:

restriction of xsd:string

XML Source (see within schema source)

<xsd:attribute id="att.actionOrder" name="order">

<xsd:annotation>

<xsd:documentation>

<h:div class="summary">

Describes whether child elements are sequential or parallel.

</h:div>

<h:div class="description">There is no default.</h:div>

</xsd:documentation>

</xsd:annotation>

<xsd:simpleType>

<xsd:restriction base="xsd:string">

<xsd:enumeration value="sequential"/>

<xsd:enumeration value="parallel"/>

</xsd:restriction>

</xsd:simpleType>

</xsd:attribute>

ref

Type:	refType
Use:	optional
Defined:	locally within ref attributeGroup

<h:div class="summary">A reference to an element of given type.</h:div> <h:div class="description"> <h:tt>ref</h:tt> modifies an element into a reference to an existing element of that type within the document. This is similar to a pointer and it can be thought of a strongly typed hyperlink. It may also be used for "subclassing" or "overriding" elements.<br/> When referring to an element most of the "data" such as attribute values and element content will be on the full instantiated element. Therefore ref (and possibly id) will normally be the only attributes on the pointing element. However there may be some attributes (title, count, etc.) which have useful semantics, but these are element-specific</h:div> <h:div class="example" href="refGroup1.xml"/>

XML Source (see within schema source)

<xsd:attribute id="att.ref" name="ref" type="refType">

<xsd:annotation>

<xsd:documentation>

<h:div class="summary">A reference to an element of given type.</h:div>

<h:div class="description">

<h:tt>ref</h:tt>

modifies an element into a reference to an existing element of that type within the document. This is similar to a pointer and it can be thought of a strongly typed hyperlink. It may also be used for "subclassing" or "overriding" elements.

When referring to an element most of the "data" such as attribute values and element content will be on the full instantiated element. Therefore ref (and possibly id) will normally be the only attributes on the pointing element. However there may be some attributes (title, count, etc.) which have useful semantics, but these are element-specific

</h:div>

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

</xsd:documentation>

</xsd:annotation>

</xsd:attribute>

start

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

<h:div class="summary">The start time.</h:div> <h:div class="description">The start time in any allowable XSD representation of date, time or dateTime. This will normally be a clock time or date.</h:div>

XML Source (see within schema source)

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

<xsd:annotation>

<xsd:documentation>

<h:div class="summary">The start time.</h:div>

<h:div class="description">

The start time in any allowable XSD representation of date, time or dateTime. This will normally be a clock time or date.

</h:div>

</xsd:documentation>

</xsd:annotation>

</xsd:attribute>

startCondition

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

<h:div class="summary">The start condition.</h:div> <h:div class="description">This can describe the condition(s) that has to be met before an action can begin, such as in a recipe. Semantics are unexplored but could be used to control robotic operations.</h:div>

XML Source (see within schema source)

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

<xsd:annotation>

<xsd:documentation>

<h:div class="summary">The start condition.</h:div>

<h:div class="description">

This can describe the condition(s) that has to be met before an action can begin, such as in a recipe. Semantics are unexplored but could be used to control robotic operations.

</h:div>

</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>

type

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

<h:div class="summary">Type of the object.</h:div> <h:div class="description">A qualifier which may affect the semantics of the object.</h:div>

XML Source (see within schema source)

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

<xsd:annotation>

<xsd:documentation>

<h:div class="summary">Type of the object.</h:div>

<h:div class="description">

A qualifier which may affect the semantics of the object.

</h:div>

</xsd:documentation>

</xsd:annotation>

</xsd:attribute>

units

Type:	unitsType
Use:	optional
Defined:	locally within units attributeGroup

<h:div class="summary">Scientific units on an element.</h:div> <h:div class="description">These must be taken from a dictionary of units. There should be some mechanism for validating the type of the units against the possible values of the element.</h:div>

XML Source (see within schema source)

<xsd:attribute id="att.units" name="units" type="unitsType">

<xsd:annotation>

<xsd:documentation>

<h:div class="summary">Scientific units on an element.</h:div>

<h:div class="description">

These must be taken from a dictionary of units. There should be some mechanism for validating the type of the units against the possible values of the element.

</h:div>

</xsd:documentation>

</xsd:annotation>

</xsd:attribute>

Content Element Detail (all declarations; 1/1)

{any element with any namespace}

Defined:

within (this) action 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/