element <param>
Namespace:
{global namespace}
Type:
vs:InputParam
Content:
complex, 2 attributes, attr. wildcard, 11 elements
Defined:
locally at 2 locations in VODataService-v1.1.xsd
XML Representation Summary
<param
    std
 = 
 xs:boolean : "true"
    use
 = 
 ("required" | "optional" | "ignored") : "optional"
    {any attribute with non-schema namespace}
    >
   
Content: 
 name?, description?, unit?, ucd?, utype?, dataType?
</param>
Content model elements (6):
dataType (type vs:SimpleDataType),
description (type xs:token),
name (type xs:token),
ucd (type xs:token),
unit (type xs:token),
utype (type xs:token)
Definition Locations
Annotations (1) (by all definition locations)
Locations:
within vs:ParamHTTP complexType [def], within vs:ParamHTTP complexType [def]
Annotation:
a description of a input parameter that can be provided as a name=value argument to the service.
Attribute Detail (all declarations; 3)
std
Type:
xs:boolean
Use:
optional
Default:
"true"
Defined:
locally within vs:InputParam complexType
If true, the meaning and behavior of this parameter is reserved and defined by a standard interface. If false, it represents an implementation-specific parameter that effectively extends the behavior of the service or application.
XML Source (see within schema source)
<xs:attribute default="true" name="std" type="xs:boolean">
<xs:annotation>
<xs:documentation>
If true, the meaning and behavior of this parameter is
reserved and defined by a standard interface. If
false, it represents an implementation-specific
parameter that effectively extends the behavior of the
service or application.
</xs:documentation>
</xs:annotation>
</xs:attribute>
use
Type:
vs:ParamUse
Use:
optional
Default:
"optional"
Defined:
locally within vs:InputParam complexType
Annotation 1 [src]:
An indication of whether this parameter is required to be provided for the application or service to work properly.
Annotation 2 [src]:
Allowed values are "required" and "optional".
XML Source (see within schema source)
<xs:attribute default="optional" name="use" type="vs:ParamUse">
<xs:annotation>
<xs:documentation>
An indication of whether this parameter is
required to be provided for the application
or service to work properly.
</xs:documentation>
<xs:documentation>
Allowed values are "required" and "optional".
</xs:documentation>
</xs:annotation>
</xs:attribute>
{any attribute with non-schema namespace}
Defined:
within vs:BaseParam complexType
XML Source (see within schema source)
<xs:anyAttribute namespace="##other"/>
Content Element Detail (all declarations; 11)
dataType
Type:
vs:SimpleDataType, simple content
Defined:
locally within vs:InputParam complexType
a type of data contained in the column
XML Source (see within schema source)
<xs:element minOccurs="0" name="dataType" type="vs:SimpleDataType">
<xs:annotation>
<xs:documentation>
a type of data contained in the column
</xs:documentation>
</xs:annotation>
</xs:element>
description
Type:
xs:token, simple content
Defined:
locally within vs:BaseParam complexType
a free-text description of the column's contents
XML Source (see within schema source)
<xs:element minOccurs="0" name="description" type="xs:token">
<xs:annotation>
<xs:documentation>
a free-text description of the column's contents
</xs:documentation>
</xs:annotation>
</xs:element>
description
Type:
xs:token, simple content
Defined:
locally within vs:BaseParam complexType
a free-text description of the column's contents
XML Source (see within schema source)
<xs:element minOccurs="0" name="description" type="xs:token">
<xs:annotation>
<xs:documentation>
a free-text description of the column's contents
</xs:documentation>
</xs:annotation>
</xs:element>
name
Type:
xs:token, simple content
Defined:
locally within vs:BaseParam complexType
the name of the column
XML Source (see within schema source)
<xs:element minOccurs="0" name="name" type="xs:token">
<xs:annotation>
<xs:documentation>
the name of the column
</xs:documentation>
</xs:annotation>
</xs:element>
name
Type:
xs:token, simple content
Defined:
locally within vs:BaseParam complexType
the name of the column
XML Source (see within schema source)
<xs:element minOccurs="0" name="name" type="xs:token">
<xs:annotation>
<xs:documentation>
the name of the column
</xs:documentation>
</xs:annotation>
</xs:element>
ucd
Type:
xs:token, simple content
Defined:
locally within vs:BaseParam complexType
Annotation 1 [src]:
the name of a unified content descriptor that describes the scientific content of the parameter.
Annotation 2 [src]:
There are no requirements for compliance with any particular UCD standard. The format of the UCD can be used to distinguish between UCD1, UCD1+, and SIA-UCD. See http://www.ivoa.net/Documents/latest/UCDlist.html for the latest IVOA standard set.
XML Source (see within schema source)
<xs:element minOccurs="0" name="ucd" type="xs:token">
<xs:annotation>
<xs:documentation>
the name of a unified content descriptor that
describes the scientific content of the parameter.
</xs:documentation>
<xs:documentation>
There are no requirements for compliance with any
particular UCD standard. The format of the UCD can
be used to distinguish between UCD1, UCD1+, and
SIA-UCD. See
http://www.ivoa.net/Documents/latest/UCDlist.html
for the latest IVOA standard set.
</xs:documentation>
</xs:annotation>
</xs:element>
ucd
Type:
xs:token, simple content
Defined:
locally within vs:BaseParam complexType
Annotation 1 [src]:
the name of a unified content descriptor that describes the scientific content of the parameter.
Annotation 2 [src]:
There are no requirements for compliance with any particular UCD standard. The format of the UCD can be used to distinguish between UCD1, UCD1+, and SIA-UCD. See http://www.ivoa.net/Documents/latest/UCDlist.html for the latest IVOA standard set.
XML Source (see within schema source)
<xs:element minOccurs="0" name="ucd" type="xs:token">
<xs:annotation>
<xs:documentation>
the name of a unified content descriptor that
describes the scientific content of the parameter.
</xs:documentation>
<xs:documentation>
There are no requirements for compliance with any
particular UCD standard. The format of the UCD can
be used to distinguish between UCD1, UCD1+, and
SIA-UCD. See
http://www.ivoa.net/Documents/latest/UCDlist.html
for the latest IVOA standard set.
</xs:documentation>
</xs:annotation>
</xs:element>
unit
Type:
xs:token, simple content
Defined:
locally within vs:BaseParam complexType
the unit associated with all values in the column
XML Source (see within schema source)
<xs:element minOccurs="0" name="unit" type="xs:token">
<xs:annotation>
<xs:documentation>
the unit associated with all values in the column
</xs:documentation>
</xs:annotation>
</xs:element>
unit
Type:
xs:token, simple content
Defined:
locally within vs:BaseParam complexType
the unit associated with all values in the column
XML Source (see within schema source)
<xs:element minOccurs="0" name="unit" type="xs:token">
<xs:annotation>
<xs:documentation>
the unit associated with all values in the column
</xs:documentation>
</xs:annotation>
</xs:element>
utype
Type:
xs:token, simple content
Defined:
locally within vs:BaseParam complexType
Annotation 1 [src]:
an identifier for a concept in a data model that the data in this schema represent.
Annotation 2 [src]:
The format defined in the VOTable standard is highly recommended.
XML Source (see within schema source)
<xs:element minOccurs="0" name="utype" type="xs:token">
<xs:annotation>
<xs:documentation>
an identifier for a concept in a data model that
the data in this schema represent.
</xs:documentation>
<xs:documentation>
The format defined in the VOTable standard is highly
recommended.
</xs:documentation>
</xs:annotation>
</xs:element>
utype
Type:
xs:token, simple content
Defined:
locally within vs:BaseParam complexType
Annotation 1 [src]:
an identifier for a concept in a data model that the data in this schema represent.
Annotation 2 [src]:
The format defined in the VOTable standard is highly recommended.
XML Source (see within schema source)
<xs:element minOccurs="0" name="utype" type="xs:token">
<xs:annotation>
<xs:documentation>
an identifier for a concept in a data model that
the data in this schema represent.
</xs:documentation>
<xs:documentation>
The format defined in the VOTable standard is highly
recommended.
</xs:documentation>
</xs:annotation>
</xs:element>
This XML schema documentation has been generated with DocFlex/XML RE 1.8.0 using DocFlex/XML XSDDoc 2.2.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-end 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 more than 300 template parameters (working the same as "options" of an ordinary doc-gen), which will give you an unprecedented control over the generated content!
  • To use certain features disabled in the free mode (such as the full documenting of substitution groups).
  • To enable/disable documenting of the initial, imported, included and redefined XML schemas selectively.
  • To document local element components both globally and locally (similar to attributes).
  • To enable/disable reproducing of namespace prefixes.
  • 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 use PlainDoc.tpl main template to generate all the XML schema documentation in the form of a single HTML file.
  • To use the same template to generate the incredible quality RTF documentation.
  • To document only selected XML schema components specified by name.
  • 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 SDK 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: 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 result of which you could enjoy later by yourself. Every single your purchase matters and makes a difference for us!
To buy a license, please follow this link: http://www.filigris.com/shop/