XML Schema Documentation

Table of Contents

top

Schema Document Properties

Target Namespace http://softwarespecies.com/Personalizer/Schema/PrimeII
Version 1.1
Language en
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.
Schema Composition
  • This schema imports schema(s) from the following namespace(s):
    • http://softwarespecies.com/Personalizer/Schema/Commons (at common.xsd)
    • http://softwarespecies.com/Personalizer/Schema/Instance (at types.xsd)
    • http://softwarespecies.com/Personalizer/Schema/LibraryOfActions (at libactions.xsd)
    • http://softwarespecies.com/Personalizer/Schema/LibraryOfOptions (at liboptions.xsd)
    • http://softwarespecies.com/Personalizer/Schema/LibraryOfOptionTypes (at liboptypes.xsd)
Documentation Game-wise Tuning XML Schema for FingerTips Personalizer Framework. Copyright 2001-2006 Software Species [http://personalizer.softwarespecies.com].

Declared Namespaces

Prefix Namespace
Default namespace http://softwarespecies.com/Personalizer/Schema/PrimeII
xml http://www.w3.org/XML/1998/namespace
xsd http://www.w3.org/2001/XMLSchema
this http://softwarespecies.com/Personalizer/Schema/PrimeII
c http://softwarespecies.com/Personalizer/Schema/Commons
inst http://softwarespecies.com/Personalizer/Schema/Instance
loa http://softwarespecies.com/Personalizer/Schema/LibraryOfActions
loo http://softwarespecies.com/Personalizer/Schema/LibraryOfOptions
loot http://softwarespecies.com/Personalizer/Schema/LibraryOfOptionTypes
Schema Component Representation
<xsd:schema xml:lang="en" targetNamespace="http://softwarespecies.com/Personalizer/Schema/PrimeII" elementFormDefault="qualified" version="1.1">
<xsd:import namespace="http://softwarespecies.com/Personalizer/Schema/Commons" schemaLocation="common.xsd"/>
<xsd:import namespace="http://softwarespecies.com/Personalizer/Schema/Instance" schemaLocation="types.xsd"/>
<xsd:import namespace="http://softwarespecies.com/Personalizer/Schema/LibraryOfActions" schemaLocation="libactions.xsd"/>
<xsd:import namespace="http://softwarespecies.com/Personalizer/Schema/LibraryOfOptions" schemaLocation="liboptions.xsd"/>
<xsd:import namespace="http://softwarespecies.com/Personalizer/Schema/LibraryOfOptionTypes" schemaLocation="liboptypes.xsd"/>
...
</xsd:schema>
top

Global Declarations

Element: custom-library-items

Name custom-library-items
Type Locally-defined complex type
Nillable no
Abstract no
XML Instance Representation
<custom-library-items>
<!--
Key Constraint - TypeIdentifier
Selector - this:type
Field(s) - @name
-->
<!--
Key Reference Constraint - TypeIdentifierReference
Selector - this:option
Field(s) - @custom-type
Refers to - TypeIdentifier
-->

Start Choice [0..*]
<action> loa:ActionDefinition </action> [1]
<option> CustomizedOptionDefinition </option> [1]
<type> loot:TypeDefinition </type> [1]
End Choice
</custom-library-items>
Schema Component Representation
<xsd:element name="custom-library-items">
<xsd:complexType>
<xsd:choice minOccurs="0" maxOccurs="unbounded">
<xsd:element name="action" type=" loa:ActionDefinition "/>
<xsd:element name="option" type=" CustomizedOptionDefinition "/>
<xsd:element name="type" type=" loot:TypeDefinition "/>
</xsd:choice>
</xsd:complexType>
<xsd:key name="TypeIdentifier">
<xsd:selector xpath="this:type"/>
<xsd:field xpath="@name"/>
</xsd:key>
<xsd:keyref name="TypeIdentifierReference" refer=" TypeIdentifier ">
<xsd:selector xpath="this:option"/>
<xsd:field xpath="@custom-type"/>
</xsd:keyref>
</xsd:element>
top

Element: support-action

Name support-action
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Identifies a single action supported by the game. Optionally includes a regex pattern restricting action arguments, a custom description, the supported action types, and default controls.
XML Instance Representation
<support-action
name=" xsd:string [1] ?">
<default-control
type=" ActionExecutionModeType [0..1] ?"/> [0..*] ?
<custom-caption> xsd:string </custom-caption> [0..1] ?
<custom-description> xsd:string </custom-description> [0..1] ?
</support-action>
Schema Component Representation
<xsd:element name="support-action">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="default-control" minOccurs="0" maxOccurs="unbounded">
<xsd:complexType mixed="true">
<xsd:attribute name="type" type=" ActionExecutionModeType " use="optional"/>
</xsd:complexType>
</xsd:element>
<xsd:element name="custom-caption" type=" xsd:string " minOccurs="0"/>
<xsd:element name="custom-description" type=" xsd:string " minOccurs="0"/>
</xsd:sequence>
<xsd:attribute name="name" type=" xsd:string " use="required"/>
</xsd:complexType>
</xsd:element>
top

Element: support-option

Name support-option
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Identifies a single option supported by the game. Optionally includes a default value, a filter of valid values, a rounding grade, and a custom description.
XML Instance Representation
<support-option
name=" xsd:string [1] ?">
<default> xsd:string </default> [0..1] ?
<acceptable-values> xsd:string </acceptable-values> [0..1] ?
<grade> Cardinality </grade> [0..1] ?
<custom-caption> xsd:string </custom-caption> [0..1] ?
<custom-description> xsd:string </custom-description> [0..1] ?
</support-option>
Schema Component Representation
<xsd:element name="support-option">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="default" type=" xsd:string " minOccurs="0"/>
<xsd:element name="acceptable-values" type=" xsd:string " minOccurs="0"/>
<xsd:element name="grade" type=" Cardinality " minOccurs="0"/>
<xsd:element name="custom-caption" type=" xsd:string " minOccurs="0"/>
<xsd:element name="custom-description" type=" xsd:string " minOccurs="0"/>
</xsd:sequence>
<xsd:attribute name="name" type=" xsd:string " use="required"/>
</xsd:complexType>
</xsd:element>
top

Element: tuning

Name tuning
Type Locally-defined complex type
Nillable no
Abstract no
XML Instance Representation
<tuning>
<title> xsd:string </title> [1] ?
<origin> xsd:string </origin> [1] ?
<support-action> ... </support-action> [0..*]
<support-option> ... </support-option> [0..*]
<custom-library-items> ... </custom-library-items> [0..1]
</tuning>
Schema Component Representation
<xsd:element name="tuning">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="title" type=" xsd:string " minOccurs="1" maxOccurs="1"/>
<xsd:element name="origin" type=" xsd:string " minOccurs="1" maxOccurs="1"/>
<xsd:element ref=" support-action " minOccurs="0" maxOccurs="unbounded"/>
<xsd:element ref=" support-option " minOccurs="0" maxOccurs="unbounded"/>
<xsd:element ref=" custom-library-items " minOccurs="0" maxOccurs="1"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
top

Global Definitions

Complex Type: CustomizedOptionDefinition

Super-types: None
Sub-types: None
Name CustomizedOptionDefinition
Abstract no
XML Instance Representation
<...
class=" c:OptionClass [1] ?"
name=" xsd:string [1] ?"
type=" inst:OptionType [0..1] ?"
custom-type=" xsd:string [0..1] ?">
<desc> xsd:string </desc> [1..*] ?
<relation> c:RelationType </relation> [0..*]
</...>
Schema Component Representation
<xsd:complexType name="CustomizedOptionDefinition">
<xsd:sequence>
<xsd:element name="desc" type=" xsd:string " maxOccurs="unbounded"/>
<xsd:element name="relation" type=" c:RelationType " minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
<xsd:attribute name="class" type=" c:OptionClass " use="required"/>
<xsd:attribute name="name" type=" xsd:string " use="required"/>
<xsd:attribute name="type" type=" inst:OptionType " use="optional"/>
<xsd:attribute name="custom-type" type=" xsd:string " use="optional"/>
</xsd:complexType>
top

Simple Type: ActionExecutionModeType

Super-types: xsd:string < ActionExecutionModeType (by restriction)
Sub-types: None
Name ActionExecutionModeType
Content
  • Base XSD Type: string
  • value comes from list: {'Single'|'Toggle'|'Continuous'}
Documentation Lists available styles of action execution.
Schema Component Representation
<xsd:simpleType name="ActionExecutionModeType">
<xsd:restriction base=" xsd:string ">
<xsd:enumeration value="Single"/>
<xsd:enumeration value="Toggle"/>
<xsd:enumeration value="Continuous"/>
</xsd:restriction>
</xsd:simpleType>
top

Simple Type: Cardinality

Super-types: xsd:positiveInteger < Cardinality (by restriction)
Sub-types: None
Name Cardinality
Content
  • Base XSD Type: positiveInteger
  • 2 <= value <= 50
Schema Component Representation
<xsd:simpleType name="Cardinality">
<xsd:restriction base=" xsd:positiveInteger ">
<xsd:minInclusive value="2"/>
<xsd:maxInclusive value="50"/>
</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
<complexType name="AusAddress">
<complexContent>
<extension base=" Address ">
<sequence>
<element name="state" type=" AusStates "/>
<element name="postcode">
<simpleType>
<restriction base=" string ">
<pattern value="[1-9][0-9]{3}"/>
</restriction>
</simpleType>
</element>
</sequence>
<attribute name="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

Generated by xs3p. Last modified: