XML Schema Documentation

Table of Contents

top

Schema Document Properties

Target Namespace urn:devhelp
Element and Attribute Namespaces
  • Global element and attribute declarations belong to this schema's target namespace.
  • By default, local element declarations belong to this schema's target namespace.
  • By default, local attribute declarations have no namespace.
Documentation Devhelp2 files are use in the 'devhelp' documentation browser.

Declared Namespaces

Prefix Namespace
Default namespace urn:devhelp
xml http://www.w3.org/XML/1998/namespace
xsd http://www.w3.org/2001/XMLSchema
Schema Component Representation
<xsd:schema targetNamespace="urn:devhelp" elementFormDefault="qualified">
...
</xsd:schema>
top

Global Declarations

Attribute: author

Name author
Type xsd:string
Documentation Author of the document. Multiple authors are separated by ','.
XML Instance Representation
author="xsd:string"
Schema Component Representation
<xsd:attribute name="author" type="xsd:string"/>
top

Attribute: deprecated

Name deprecated
Type xsd:boolean
Documentation Marks the keyword as deprecated.
XML Instance Representation
deprecated="xsd:boolean"
Schema Component Representation
<xsd:attribute name="deprecated" type="xsd:boolean"/>
top

Attribute: language

Name language
Type language-type
Documentation Programing language this manual refers to.
XML Instance Representation
language="language-type"
Schema Component Representation
<xsd:attribute name="language" type="language-type"/>
top

Attribute: link

Name link
Type xsd:string
Documentation Entry point to the manual. Can be given as a relative path to the location of the devhelp2 file..
XML Instance Representation
Schema Component Representation
top

Attribute: name

Name name
Type xsd:string
Documentation Short name of the manual.
XML Instance Representation
name="xsd:string"
Schema Component Representation
<xsd:attribute name="name" type="xsd:string"/>
top

Attribute: since

Name since
Type xsd:string
Documentation Version since that the keyword is part of the API.
XML Instance Representation
since="xsd:string"
Schema Component Representation
<xsd:attribute name="since" type="xsd:string"/>
top

Attribute: title

Name title
Type xsd:string
Documentation Title of the reference manual.
XML Instance Representation
title="xsd:string"
Schema Component Representation
<xsd:attribute name="title" type="xsd:string"/>
top

Attribute: type

Name type
Type keyword-type
Documentation Type of the keyword.
XML Instance Representation
type="keyword-type"
Schema Component Representation
<xsd:attribute name="type" type="keyword-type"/>
top

Attribute: version

Name version
Type xsd:integer
Documentation Version of the devhelp xml specification (2).
XML Instance Representation
version="xsd:integer"
Schema Component Representation
<xsd:attribute name="version" type="xsd:integer"/>
top

Element: book

Name book
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Toplevel element of a devhelp book. A devhelp book list the structure of a developer manual together with development related metadata.
XML Instance Representation
<book
title="[1]"
link="[1]"
author="[1]"
name="[1]"
version="[1]"
language="[0..1]">
<chapters> ... </chapters> [1]
<functions> ... </functions> [1]
</book>
Schema Component Representation
<xsd:element name="book">
<xsd:complexType>
<xsd:sequence>
<xsd:element ref="chapters" minOccurs="1" maxOccurs="1"/>
<xsd:element ref="functions" minOccurs="1" maxOccurs="1"/>
</xsd:sequence>
<xsd:attribute ref="title" use="required"/>
<xsd:attribute ref="link" use="required"/>
<xsd:attribute ref="author" use="required"/>
<xsd:attribute ref="name" use="required"/>
<xsd:attribute ref="version" use="required"/>
<xsd:attribute ref="language"/>
</xsd:complexType>
</xsd:element>
top

Element: chapters

Name chapters
Type Locally-defined complex type
Nillable no
Abstract no
Documentation The chapters tag encloses the structure of the reference manual. Each sub unit is represented by a sub tag.
XML Instance Representation
<chapters>
<sub> ... </sub> [0..*]
</chapters>
Schema Component Representation
<xsd:element name="chapters">
<xsd:complexType>
<xsd:sequence>
<xsd:element ref="sub" minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
top

Element: functions

Name functions
Type Locally-defined complex type
Nillable no
Abstract no
XML Instance Representation
<functions>
<keyword> ... </keyword> [0..*]
</functions>
Schema Component Representation
<xsd:element name="functions">
<xsd:complexType>
<xsd:sequence>
<xsd:element ref="keyword" minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:complexType>
<xsd:documentation>
The functions tag encloses all api symbols of the reference manual. Each sub unit is represented by a keyword tag.
</xsd:documentation>
</xsd:element>
top

Element: keyword

Name keyword
Type Locally-defined complex type
Nillable no
Abstract no
XML Instance Representation
<keyword
type="[1]"
name="[1]"
link="[1]"
since="[0..1]"
deprecated="[0..1]"/>
Schema Component Representation
<xsd:element name="keyword">
<xsd:complexType>
<xsd:attribute ref="type" use="required"/>
<xsd:attribute ref="name" use="required"/>
<xsd:attribute ref="link" use="required"/>
<xsd:attribute ref="since"/>
<xsd:attribute ref="deprecated"/>
</xsd:complexType>
<xsd:documentation>
The keyword tag points to the documentation of a api symbol.
</xsd:documentation>
</xsd:element>
top

Element: sub

Name sub
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Sub tags for the hierachy of the chapters and parts.
XML Instance Representation
<sub
name="[1]"
link="[1]">
<sub> ... </sub> [0..*]
</sub>
Schema Component Representation
<xsd:element name="sub">
<xsd:complexType>
<xsd:sequence>
<xsd:element ref="sub" minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
<xsd:attribute ref="name" use="required"/>
<xsd:attribute ref="link" use="required"/>
</xsd:complexType>
</xsd:element>
top

Global Definitions

Simple Type: keyword-type

Super-types: xsd:string < keyword-type (by restriction)
Sub-types: None
Name keyword-type
Content
  • Base XSD Type: string
  • value comes from list: {'constant'|'enum'|'function'|'macro'|'property'|'signal'|'struct'|'typedef'|'union'|'variable'}
Documentation Known keyword types.
Schema Component Representation
<xsd:simpleType name="keyword-type">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="constant"/>
<xsd:enumeration value="enum"/>
<xsd:enumeration value="function"/>
<xsd:enumeration value="macro"/>
<xsd:enumeration value="property"/>
<xsd:enumeration value="signal"/>
<xsd:enumeration value="struct"/>
<xsd:enumeration value="typedef"/>
<xsd:enumeration value="union"/>
<xsd:enumeration value="variable"/>
</xsd:restriction>
</xsd:simpleType>
top

Simple Type: language-type

Super-types: xsd:string < language-type (by restriction)
Sub-types: None
Name language-type
Content
  • Base XSD Type: string
  • value comes from list: {'c'|'c++'|'c#'|'java'|'javascript'|'perl'|'python'|'vala'}
Documentation Known programing languages.
Schema Component Representation
<xsd:simpleType name="language-type">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="c"/>
<xsd:enumeration value="c++"/>
<xsd:enumeration value="c#"/>
<xsd:enumeration value="java"/>
<xsd:enumeration value="javascript"/>
<xsd:enumeration value="perl"/>
<xsd:enumeration value="python"/>
<xsd:enumeration value="vala"/>
</xsd:restriction>
</xsd:simpleType>
top

Legend

Complex Type:

Schema Component Type

AusAddress

Schema Component Name
Super-types: Address < AusAddress (by extension)
Sub-types:
  • QLDAddress (by restriction)
If this schema component is a type definition, its type hierarchy is shown in a gray-bordered box.
Name AusAddress
Abstract no
The table above displays the properties of this schema component.
XML Instance Representation
<... country="Australia">
<unitNo> string </unitNo> [0..1]
<houseNo> string </houseNo> [1]
<street> string </street> [1]
Start Choice[1]
<city> string </city> [1]
<town> string </town> [1]
End Choice
<state> AusStates </state> [1]
<postcode> string <<pattern = [1-9][0-9]{3}>> </postcode> [1]?
</...>

The XML Instance Representation table above shows the schema component's content as an XML instance.

Schema Component Representation
<complexTypename="AusAddress">
<complexContent>
<extensionbase="Address">
<sequence>
<elementname="state" type="AusStates"/>
<elementname="postcode">
<simpleType>
<restrictionbase="string">
<patternvalue="[1-9][0-9]{3}"/>
</restriction>
</simpleType>
</element>
</sequence>
<attributename="country" type="string" fixed="Australia"/>
</extension>
</complexContent>
</complexType>
The Schema Component Representation table above displays the underlying XML representation of the schema component. (Annotations are not shown.)
top

Glossary

Abstract (Applies to complex type definitions and element declarations). An abstract element or complex type cannot used to validate an element instance. If there is a reference to an abstract element, only element declarations that can substitute the abstract element can be used to validate the instance. For references to abstract type definitions, only derived types can be used.

All Model Group Child elements can be provided in any order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-all.

Choice Model Group Only one from the list of child elements and model groups can be provided in instances. See: http://www.w3.org/TR/xmlschema-1/#element-choice.

Collapse Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32). Then, collapse contiguous sequences of space characters into single space character, and remove leading and trailing space characters.

Disallowed Substitutions (Applies to element declarations). If substitution is specified, then substitution group members cannot be used in place of the given element declaration to validate element instances. If derivation methods, e.g. extension, restriction, are specified, then the given element declaration will not validate element instances that have types derived from the element declaration's type using the specified derivation methods. Normally, element instances can override their declaration's type by specifying an xsi:type attribute.

Key Constraint Like Uniqueness Constraint, but additionally requires that the specified value(s) must be provided. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Key Reference Constraint Ensures that the specified value(s) must match value(s) from a Key Constraint or Uniqueness Constraint. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Model Group Groups together element content, specifying the order in which the element content can occur and the number of times the group of element content may be repeated. See: http://www.w3.org/TR/xmlschema-1/#Model_Groups.

Nillable (Applies to element declarations). If an element declaration is nillable, instances can use the xsi:nil attribute. The xsi:nil attribute is the boolean attribute, nil, from the http://www.w3.org/2001/XMLSchema-instance namespace. If an element instance has an xsi:nil attribute set to true, it can be left empty, even though its element declaration may have required content.

Notation A notation is used to identify the format of a piece of data. Values of elements and attributes that are of type, NOTATION, must come from the names of declared notations. See: http://www.w3.org/TR/xmlschema-1/#cNotation_Declarations.

Preserve Whitespace Policy Preserve whitespaces exactly as they appear in instances.

Prohibited Derivations (Applies to type definitions). Derivation methods that cannot be used to create sub-types from a given type definition.

Prohibited Substitutions (Applies to complex type definitions). Prevents sub-types that have been derived using the specified derivation methods from validating element instances in place of the given type definition.

Replace Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32).

Sequence Model Group Child elements and model groups must be provided in the specified order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-sequence.

Substitution Group Elements that are members of a substitution group can be used wherever the head element of the substitution group is referenced.

Substitution Group Exclusions (Applies to element declarations). Prohibits element declarations from nominating themselves as being able to substitute a given element declaration, if they have types that are derived from the original element's type using the specified derivation methods.

Target Namespace The target namespace identifies the namespace that components in this schema belongs to. If no target namespace is provided, then the schema components do not belong to any namespace.

Uniqueness Constraint Ensures uniqueness of an element/attribute value, or a combination of values, within a specified scope. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

top