The following is a list of custom annotations that are used in XML Schema descriptions for version 1.0 of the Cloud Servers API. Each annotation is defined as a single XML element in the http://docs.rackspacecloud.com/xsd-ext/v1.0 namespace. These elements can be added as annotations via the appinfo schema tag.
Annotations allow useful meta-data to be associated with the schema types. For example, a root element of a particular type can be associated with a sample document that illustrates its usage. Annotations also provide hints when converting schema into presentation markups such as XHTML, Docbook, and Open Document Format.
Aside from custom elements, schema types in the Cloud Servers API are also annotated with documentation tags. These tags always contain text in XHTML 1.1 block elements.
Get access to the xml: attribute groups for xml:lang needed by the Documentation type.
This is a meta-annotation, it is only used only when defining another annotation and provides information about the annotation.
Used to embed a fragment of code in the documentation text.
Defines a text based title for the current schema document. The title is used when converting the schema to presentation markup.
This tag is a template tag. It places content as is in a document when converting the schema to some presentation type. The presentation type is specified with the type attribute. The contents of head should be well-formed XML. This places content in the document header (think html:head) when converting the schema to presentation markup. See the header tag to place content at the top of the body content.
This tag is a template tag. It places content as is in a document when converting the schema to some presentation type. The presentation type is specified with the type attribute. The contents of header should be well-formed XML. This places content on the top of the presentation markup -- for XHTML this places content right after the html:body tag. See the head tag to place content in the document header.
This tag is a template tag. It places content as is in a document when converting the schema to some presentation type. The presentation type is specified with the type attribute. The contents of footer should be well-formed XML. This places content on the bottom of the presentation markup -- for XHTML this places content before closing the html:body tag. See the header tag to place content in the beginning of the document.
Samples provides a means of displaying several versions of the same code sample. We can do this to display the same sample in various formats: XML, JSON. Each sample can contain an optional description and a code element.
The link annotation establishes one or more relationships from a particular Schema document to another file. This is useful for establishing links between pages when converting to a presentation markup.
In this example, we note that the schema file is indexed by file index.xsd. Also, there is an alternative version of this file (schema.rnc) in RelaxNG Compact Syntax.
Here we denote a reverse link. We are saying this file serves as an index to file schema.xsd.
This type provides information about a custom annotation.
Used to capture documentation usually as XHTML.
A template places content as is in a document when converting the schema to some presentation type. The presentation type is specified with the type attribute.
Language defines the type of content in the template. It should be a mime-type. XHTML is assumed if type is not specified.
Used to provide example instances of schema elements.
An optional description or summary of the example.
The example code.
A descriptive title for the sample, the type attribute may be used as a title if this attribute is not specified.
A collection of samples.
An optional description or summary of the example.
A list of samples to display.
Source code that may be provided inline or that may be referenced via an href attribute.
This provides a link to the source code. If both the in-line text and the href parameter are specified, in-line text will be ignored.
A mime type describing the source code.
Used to establish relationships between documents.
When linking to an XML document, denotes the QName of the element to link to. This is usually used when linking with foreign schema elements.
A mime type describing the type of link.
The relationships from the current document to the document pointed to by the href attribute.
The relationships from the document pointed to by the href attribute to the current document.
A list of document relationships separated by whitespace.
A document relationship used in link elements. In order to remain flexible, this is not a finite enumeration. In practice, however, only three relationships are currently supported: alternate, index, and schema. The alternate forward relationship denotes that the linked document can be used as an alternative to the current document. The index forward relationship that the link document is an index to the current document. Finally, the schema relationship denotes that a schema element from the link document is used in the current document.
A list of annotation types separated by whitespace.
This enumeration describes where a custom annotation can be applied.
The annotation can be applied to the schema tag.
The annotation can be applied to the element tag.
The annotation can be embedded in the documentation tag of any schema element.
The annotation can be applied to any element in the XML Schema namespace.