complexType "Edition"
Namespace:
http://www.ivoa.net/xml/DocRegExt/v1
Content:
complex, 1 attribute, 11 elements
Defined:
globally in DocRegExt.xsd; see XML source
Includes:
definitions of 2 elements
Used:
never
XML Representation Summary
<...
    standardID
 = 
 xs:anyURI
    >
   
Content: 
 validationLevel*, description?, interface*, languageCode, locTitle?
</...>
Content Model Elements (5):
description (type xs:string),
interface (type vr:Interface),
languageCode (type xs:token),
locTitle (type xs:token),
validationLevel (type vr:Validation)
Annotation
Annotation 1 [src]:
An “edition” (typically: translation) of the document.
Annotation 2 [src]:
Although for a while, multiple editions of the document in one language may be given (corresponding perhaps to two “major” versions), in general, only the latest version of the document per language should be given. At least one vr:WebBrowser-typed interface with role="rendered" must be present. The access URL of the interface points to a rendered version of the edition (preferably in PDF, but HTML is acceptable, too). Editors are strongly encourated to also provide an interface with role="source", the accessURL of which should point to an editable version of the document, a version controlled repository, or the like.
Type Definition Detail
Type Derivation Tree
vr:Capability (extension)
  Edition
XML Source (see within schema source)
<xs:complexType name="Edition">
<xs:annotation>
<xs:documentation>
An &#8220;edition&#8221; (typically: translation) of the document.
</xs:documentation>
<xs:documentation>
Although for a while, multiple editions of the document in one language
may be given (corresponding perhaps to two &#8220;major&#8221; versions), in
general, only the latest version of the document per language should be
given.

At least one vr:WebBrowser-typed interface with
role="rendered" must be present. The access URL of the interface
points to a rendered version of the edition (preferably in PDF,
but HTML is acceptable, too).

Editors are strongly encourated to also provide an
interface with role="source", the accessURL of which should point
to an editable version of the document, a version controlled
repository, or the like.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="vr:Capability">
<xs:sequence>
<xs:element maxOccurs="1" minOccurs="1" name="languageCode" type="xs:token">
<xs:annotation>
<xs:documentation>
The language this document is (mainly) written in,
as an RFC 3066 language code.
</xs:documentation>
<xs:documentation>
The country codes must be given in all lowercase. This
results in strings like en-us, de-de, or es-mx.

This language is also the language for locTitle,
irrespective or that element's xml:lang setting.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="1" minOccurs="0" name="locTitle" type="xs:token">
<xs:annotation>
<xs:documentation>
The translated document's title in the language specified
by the language sibling.
</xs:documentation>
<xs:documentation>
It is recommended to set this element's xml:lang element
to the same value as the language sibling. The reason
xml:lang is not used in the first place is that with an
extra element, enforcing that the content language is
given is more straightforward.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
Attribute Detail (all declarations; 1)
standardID
Type:
xs:anyURI
Use:
optional
Defined:
locally within vr:Capability complexType
Annotation 1 [src]:
A URI identifier for a standard service.
Annotation 2 [src]:
This provides a unique way to refer to a service specification standard, such as a Simple Image Access service. The use of an IVOA identifier here implies that a VOResource description of the standard is registered and accessible.
XML Source (see within schema source)
<xs:attribute name="standardID" type="xs:anyURI">
<xs:annotation>
<xs:documentation>
A URI identifier for a standard service.
</xs:documentation>
<xs:documentation>
This provides a unique way to refer to a service
specification standard, such as a Simple Image Access service.
The use of an IVOA identifier here implies that a
VOResource description of the standard is registered and
accessible.
</xs:documentation>
</xs:annotation>
</xs:attribute>
Content Element Detail (all declarations; 11)
description
Type:
xs:string, simple content
Defined:
locally within vr:Capability complexType
Annotation 1 [src]:
A human-readable description of what this capability provides as part of the over-all service
Annotation 2 [src]:
Use of this optional element is especially encouraged when this capability is non-standard and is one of several capabilities listed.
XML Source (see within schema source)
<xs:element minOccurs="0" name="description" type="xs:string">
<xs:annotation>
<xs:documentation>
A human-readable description of what this capability
provides as part of the over-all service
</xs:documentation>
<xs:documentation>
Use of this optional element is especially encouraged when
this capability is non-standard and is one of several
capabilities listed.
</xs:documentation>
</xs:annotation>
</xs:element>
description
Type:
xs:string, simple content
Defined:
locally within vr:Capability complexType
Annotation 1 [src]:
A human-readable description of what this capability provides as part of the over-all service
Annotation 2 [src]:
Use of this optional element is especially encouraged when this capability is non-standard and is one of several capabilities listed.
XML Source (see within schema source)
<xs:element minOccurs="0" name="description" type="xs:string">
<xs:annotation>
<xs:documentation>
A human-readable description of what this capability
provides as part of the over-all service
</xs:documentation>
<xs:documentation>
Use of this optional element is especially encouraged when
this capability is non-standard and is one of several
capabilities listed.
</xs:documentation>
</xs:annotation>
</xs:element>
description
Type:
xs:string, simple content
Defined:
locally within vr:Capability complexType
Annotation 1 [src]:
A human-readable description of what this capability provides as part of the over-all service
Annotation 2 [src]:
Use of this optional element is especially encouraged when this capability is non-standard and is one of several capabilities listed.
XML Source (see within schema source)
<xs:element minOccurs="0" name="description" type="xs:string">
<xs:annotation>
<xs:documentation>
A human-readable description of what this capability
provides as part of the over-all service
</xs:documentation>
<xs:documentation>
Use of this optional element is especially encouraged when
this capability is non-standard and is one of several
capabilities listed.
</xs:documentation>
</xs:annotation>
</xs:element>
interface
Type:
vr:Interface, complex content
Defined:
locally within vr:Capability complexType
Annotation 1 [src]:
a description of how to call the service to access this capability
Annotation 2 [src]:
Since the Interface type is abstract, one must describe the interface using a subclass of Interface, denoting it via xsi:type.
Annotation 3 [src]:
Multiple occurences can describe different interfaces to the logically same capability, i.e. data or functionality. That is, the inputs accepted and the output provides should be logically the same. For example, a WebBrowser interface given in addition to a WebService interface would simply provide an interactive, human-targeted interface to the underlying WebService interface.
XML Source (see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" name="interface" type="vr:Interface">
<xs:annotation>
<xs:documentation>
a description of how to call the service to access
this capability
</xs:documentation>
<xs:documentation>
Since the Interface type is abstract, one must describe
the interface using a subclass of Interface, denoting
it via xsi:type.
</xs:documentation>
<xs:documentation>
Multiple occurences can describe different interfaces to
the logically same capability, i.e. data or functionality.
That is, the inputs accepted and the output provides should
be logically the same. For example, a WebBrowser interface
given in addition to a WebService interface would simply
provide an interactive, human-targeted interface to the
underlying WebService interface.
</xs:documentation>
</xs:annotation>
</xs:element>
interface
Type:
vr:Interface, complex content
Defined:
locally within vr:Capability complexType
Annotation 1 [src]:
a description of how to call the service to access this capability
Annotation 2 [src]:
Since the Interface type is abstract, one must describe the interface using a subclass of Interface, denoting it via xsi:type.
Annotation 3 [src]:
Multiple occurences can describe different interfaces to the logically same capability, i.e. data or functionality. That is, the inputs accepted and the output provides should be logically the same. For example, a WebBrowser interface given in addition to a WebService interface would simply provide an interactive, human-targeted interface to the underlying WebService interface.
XML Source (see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" name="interface" type="vr:Interface">
<xs:annotation>
<xs:documentation>
a description of how to call the service to access
this capability
</xs:documentation>
<xs:documentation>
Since the Interface type is abstract, one must describe
the interface using a subclass of Interface, denoting
it via xsi:type.
</xs:documentation>
<xs:documentation>
Multiple occurences can describe different interfaces to
the logically same capability, i.e. data or functionality.
That is, the inputs accepted and the output provides should
be logically the same. For example, a WebBrowser interface
given in addition to a WebService interface would simply
provide an interactive, human-targeted interface to the
underlying WebService interface.
</xs:documentation>
</xs:annotation>
</xs:element>
interface
Type:
vr:Interface, complex content
Defined:
locally within vr:Capability complexType
Annotation 1 [src]:
a description of how to call the service to access this capability
Annotation 2 [src]:
Since the Interface type is abstract, one must describe the interface using a subclass of Interface, denoting it via xsi:type.
Annotation 3 [src]:
Multiple occurences can describe different interfaces to the logically same capability, i.e. data or functionality. That is, the inputs accepted and the output provides should be logically the same. For example, a WebBrowser interface given in addition to a WebService interface would simply provide an interactive, human-targeted interface to the underlying WebService interface.
XML Source (see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" name="interface" type="vr:Interface">
<xs:annotation>
<xs:documentation>
a description of how to call the service to access
this capability
</xs:documentation>
<xs:documentation>
Since the Interface type is abstract, one must describe
the interface using a subclass of Interface, denoting
it via xsi:type.
</xs:documentation>
<xs:documentation>
Multiple occurences can describe different interfaces to
the logically same capability, i.e. data or functionality.
That is, the inputs accepted and the output provides should
be logically the same. For example, a WebBrowser interface
given in addition to a WebService interface would simply
provide an interactive, human-targeted interface to the
underlying WebService interface.
</xs:documentation>
</xs:annotation>
</xs:element>
languageCode
Type:
xs:token, simple content
Defined:
locally within (this) Edition complexType
Annotation 1 [src]:
The language this document is (mainly) written in, as an RFC 3066 language code.
Annotation 2 [src]:
The country codes must be given in all lowercase. This results in strings like en-us, de-de, or es-mx. This language is also the language for locTitle, irrespective or that element's xml:lang setting.
XML Source (see within schema source)
<xs:element maxOccurs="1" minOccurs="1" name="languageCode" type="xs:token">
<xs:annotation>
<xs:documentation>
The language this document is (mainly) written in,
as an RFC 3066 language code.
</xs:documentation>
<xs:documentation>
The country codes must be given in all lowercase. This
results in strings like en-us, de-de, or es-mx.

This language is also the language for locTitle,
irrespective or that element's xml:lang setting.
</xs:documentation>
</xs:annotation>
</xs:element>
locTitle
Type:
xs:token, simple content
Defined:
locally within (this) Edition complexType
Annotation 1 [src]:
The translated document's title in the language specified by the language sibling.
Annotation 2 [src]:
It is recommended to set this element's xml:lang element to the same value as the language sibling. The reason xml:lang is not used in the first place is that with an extra element, enforcing that the content language is given is more straightforward.
XML Source (see within schema source)
<xs:element maxOccurs="1" minOccurs="0" name="locTitle" type="xs:token">
<xs:annotation>
<xs:documentation>
The translated document's title in the language specified
by the language sibling.
</xs:documentation>
<xs:documentation>
It is recommended to set this element's xml:lang element
to the same value as the language sibling. The reason
xml:lang is not used in the first place is that with an
extra element, enforcing that the content language is
given is more straightforward.
</xs:documentation>
</xs:annotation>
</xs:element>
validationLevel
Type:
vr:Validation, simple content
Defined:
locally within vr:Capability complexType
Annotation 1 [src]:
A numeric grade describing the quality of the capability description and interface, when applicable, to be used to indicate the confidence an end-user can put in the resource as part of a VO application or research study.
Annotation 2 [src]:
See vr:ValidationLevel for an explanation of the allowed levels.
XML Source (see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" name="validationLevel" type="vr:Validation">
<xs:annotation>
<xs:documentation>
A numeric grade describing the quality of the
capability description and interface, when applicable,
to be used to indicate the confidence an end-user
can put in the resource as part of a VO application
or research study.
</xs:documentation>
<xs:documentation>
See vr:ValidationLevel for an explanation of the
allowed levels.
</xs:documentation>
</xs:annotation>
</xs:element>
validationLevel
Type:
vr:Validation, simple content
Defined:
locally within vr:Capability complexType
Annotation 1 [src]:
A numeric grade describing the quality of the capability description and interface, when applicable, to be used to indicate the confidence an end-user can put in the resource as part of a VO application or research study.
Annotation 2 [src]:
See vr:ValidationLevel for an explanation of the allowed levels.
XML Source (see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" name="validationLevel" type="vr:Validation">
<xs:annotation>
<xs:documentation>
A numeric grade describing the quality of the
capability description and interface, when applicable,
to be used to indicate the confidence an end-user
can put in the resource as part of a VO application
or research study.
</xs:documentation>
<xs:documentation>
See vr:ValidationLevel for an explanation of the
allowed levels.
</xs:documentation>
</xs:annotation>
</xs:element>
validationLevel
Type:
vr:Validation, simple content
Defined:
locally within vr:Capability complexType
Annotation 1 [src]:
A numeric grade describing the quality of the capability description and interface, when applicable, to be used to indicate the confidence an end-user can put in the resource as part of a VO application or research study.
Annotation 2 [src]:
See vr:ValidationLevel for an explanation of the allowed levels.
XML Source (see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" name="validationLevel" type="vr:Validation">
<xs:annotation>
<xs:documentation>
A numeric grade describing the quality of the
capability description and interface, when applicable,
to be used to indicate the confidence an end-user
can put in the resource as part of a VO application
or research study.
</xs:documentation>
<xs:documentation>
See vr:ValidationLevel for an explanation of the
allowed levels.
</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/