element <import>
Namespace:
Type:
Content:
complex, 5 elements
Defined:
locally within Model complexType in vo-dml.xsd; see XML source
XML Representation Summary
<import>
   
Content: 
name, identifier?, version?, url, documentationURL
</import>
Content model elements (5):
Included in content model of elements (1):
Definition Locations
Annotation
Annotation 1 [src]:
An 'import' element indicates a dependency on an external, predefined VO-DML data model. Types from that model may be used for referencing, extension and assignment to attributes. Types from the external model MUST NOT be used for composition relationships. 'identification' relations to elements from that model may be used to indicate some kind of equivalence between elements in the current model and the external elements.
Annotation 2 [src]:
TBD We might require that every data model MUST include a version of the IVOA data model to gain access to the standard primitive types and some other types. We may require that that standard model should be included *completely*, i.e. including all its type definitions explicitly. This would be similar to treating it as a UML Profile, rather than an import. This would mean that the most common type assignments for attributes can be checked within the model and not require importing the remote model during validation.
XML Source (see within schema source)
<xsd:element maxOccurs="unbounded" minOccurs="0" name="import" type="ModelImport">
<xsd:annotation>
<xsd:documentation>
An 'import' element indicates a dependency on an external, predefined VO-DML data model.
Types from that model may be used for referencing, extension and assignment to
attributes.
Types from the external model MUST NOT be used for
composition relationships.
'identification' relations to elements from that model may be used to indicate some kind of
equivalence between
elements in the current model and the external elements.
</xsd:documentation>
<xsd:documentation>
TBD We might require that every data model MUST include a version of the IVOA data model
to gain access to the standard
primitive types and some other types.
We may require that that standard model should be included *completely*,
i.e. including all its type definitions explicitly.
This would be similar to treating it as a UML Profile, rather than an import.
This would mean that the most common type assignments for attributes
can be checked within the model and not require
importing the remote model during validation.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
Content Element Detail (all declarations; 5)
documentationURL
Type:
xsd:anyURI, simple content
Defined:
locally within ModelImport complexType
URL where a documentation HTML file for the remote model can be downloaded. This SHOULD be a document that contains anchors for each element thta has as name attribute the vodml-id of that element. I.e. it is assumed that the vodml-id-s of the imported types can be added onto this documentationURL (should end with a #?) so that a direct link to the documentation for a referenced data model element can be found.
XML Source (see within schema source)
<xsd:element minOccurs="1" name="documentationURL" type="xsd:anyURI">
<xsd:annotation>
<xsd:documentation>
URL where a documentation HTML file for the remote model can be downloaded.
This SHOULD be a document that contains anchors for each element thta has as name attribute the vodml-id of that element.
I.e. it is assumed that the
vodml-id-s of the imported types can be added onto this documentationURL
(should end with a #?) so that a direct link to the documentation for a referenced data model element can be found.
</xsd:documentation>
</xsd:annotation>
</xsd:element>

identifier
Type:
xsd:string, simple content
Defined:
locally within ModelImport complexType
A string holding the identifier by which the imported model is registered in an IVOA compatible registry. Must be the same value as the 'identifier' of the imported model.
XML Source (see within schema source)
<xsd:element maxOccurs="1" minOccurs="0" name="identifier" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
A string holding the identifier by which the imported model is registered in an
IVOA compatible registry. Must be the same value as the 'identifier' of the imported model.
</xsd:documentation>
</xsd:annotation>
</xsd:element>

name
Type:
ModelName, simple content
Defined:
locally within ModelImport complexType
Name by which imported model is used in the current model and its documentation. This name MUST be the same as the 'name' of the model definition in that remote document. For all utypes pointing to elements in the imported model MUST use this name as prefix.
XML Source (see within schema source)
<xsd:element minOccurs="1" name="name" type="ModelName">
<xsd:annotation>
<xsd:documentation>
Name by which imported model is used in the current model and its documentation.
This name MUST be the same as the 'name' of the model definition in that remote document.
For all utypes pointing to elements in the imported model MUST use this name as prefix.
</xsd:documentation>
</xsd:annotation>
</xsd:element>

url
Type:
xsd:anyURI, simple content
Defined:
locally within ModelImport complexType
URL from which the VO-DML model document can be downloaded. Note, could likely be done through a registry once ivoId is known. TBD SHOULD this be a generic URI, or can we insits on URL?
XML Source (see within schema source)
<xsd:element minOccurs="1" name="url" type="xsd:anyURI">
<xsd:annotation>
<xsd:documentation>
URL from which the VO-DML model document can be downloaded.
Note, could likely be done through a registry once ivoId is known.
TBD SHOULD this be a generic URI, or can we insits on URL?
</xsd:documentation>
</xsd:annotation>
</xsd:element>

version
Type:
xsd:string, simple content
Defined:
locally within ModelImport complexType
Version of the imported model.
XML Source (see within schema source)
<xsd:element minOccurs="0" name="version" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
Version of the imported model.
</xsd:documentation>
</xsd:annotation>
</xsd: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/