# XML Schema Documentation

Printer-friendly Version
XML Instance Representation:
[ Expand All | Collapse All ]
Schema Component Representation:
[ Expand All | Collapse All ]

## Table of Contents

- Schema Document Properties
- Global Declarations
  - Element: PortalBrowser
- Global Definitions
  - Complex Type: DefaultType
  - Complex Type: FlagsType
  - Complex Type: SectionType
  - Simple Type: boolType
  - Simple Type: ImageIDType
  - Simple Type: RequestMethodType

- Legend

- Glossary

top

## Schema Document Properties

Target Namespace | None
Element and Attribute Namespaces | Global element and attribute declarations belong to this schema's target namespace. By default, local element declarations have no namespace. By default, local attribute declarations have no namespace.

### Declared Namespaces

Prefix | Namespace
--- | ---
xml | http://www.w3.org/XML/1998/namespace
xs | http://www.w3.org/2001/XMLSchema

Schema Component Representation
<xs:schema>
...
</xs:schema>
top

## Global Declarations

### Element: PortalBrowser

Name | PortalBrowser
Type | Locally-defined complex type
Nillable | no
Abstract | no
Documentation | Содержит список порталов - минимум одна подсекция Portal.

XML Instance Representation
<PortalBrowser>
<Portal
name="xs:string [1] ?"
URL="xs:string [1] ?"
HubURL="xs:string [0..1] ?"
SearchURL="xs:string [0..1] ?"
XMLVersion="xs:unsignedByte [1] ?"
DefaultCharset="xs:string (value comes from list: {'utf8'|'ansi'}) [0..1]"
UpdateURL="xs:string [0..1] ?"> [1..*] ?
<Login
URL="xs:string [1] ?"
Command="xs:string [1] ?"
RequestMethod="RequestMethodType [0..1] ?"/> [0..1] ?
<Images
Large="xs:string [0..1] ?"
Small="xs:string [0..1] ?"
LargePng="xs:string [0..1] ?"
SmallPng="xs:string [0..1] ?"
SmallImageID="ImageIDType [0..1] ?"
LargeImageID="ImageIDType [0..1] ?"/> [0..1] ?
<Default> DefaultType </Default> [0..1]
<Flags> FlagsType </Flags> [0..1]
<Section> SectionType </Section> [1..*]
<UserData> [0..1] ?
Start All [1]
<Flags> FlagsType </Flags> [0..1]
<Login
user="xs:string [0..1] ?"
password="xs:string [0..1] ?"/> [0..1] ?
<Default> DefaultType </Default> [0..1]
End All
</UserData>
</Portal>
</PortalBrowser>
Schema Component Representation
<xs:element name="PortalBrowser">
<xs:complexType>
<xs:sequence>
<xs:element name="Portal" minOccurs="1" maxOccurs="unbounded">
<xs:complexType>
<xs:sequence>
<xs:element name="Login" minOccurs="0" maxOccurs="1">
<xs:complexType>
<xs:attribute name="URL" type="xs:string" use="required"/>
<xs:attribute name="Command" type="xs:string" use="required"/>
<xs:attribute name="RequestMethod" type="RequestMethodType" use="optional"/>
</xs:complexType>
</xs:element>
<xs:element name="Images" minOccurs="0" maxOccurs="1">
<xs:complexType>
<xs:attribute name="Large" type="xs:string" use="optional"/>
<xs:attribute name="Small" type="xs:string" use="optional"/>
<xs:attribute name="LargePng" type="xs:string" use="optional"/>
<xs:attribute name="SmallPng" type="xs:string" use="optional"/>
<xs:attribute name="SmallImageID" type="ImageIDType" use="optional"/>
<xs:attribute name="LargeImageID" type="ImageIDType" use="optional"/>
</xs:complexType>
</xs:element>
<xs:element name="Default" type="DefaultType" minOccurs="0" maxOccurs="1"/>
<xs:element name="Flags" type="FlagsType" minOccurs="0" maxOccurs="1"/>
<xs:element name="Section" type="SectionType" minOccurs="1" maxOccurs="unbounded"/>
<xs:element name="UserData" minOccurs="0" maxOccurs="1">
<xs:complexType>
<xs:all>
<xs:element name="Flags" type="FlagsType" minOccurs="0" maxOccurs="1"/>
<xs:element name="Login" minOccurs="0" maxOccurs="1">
<xs:complexType>
<xs:attribute name="user" type="xs:string" use="optional"/>
<xs:attribute name="password" type="xs:string" use="optional"/>
</xs:complexType>
</xs:element>
<xs:element name="Default" type="DefaultType" minOccurs="0" maxOccurs="1"/>
</xs:all>
</xs:complexType>
</xs:element>
</xs:sequence>
<xs:attribute name="name" type="xs:string" use="required"/>
<xs:attribute name="URL" type="xs:string" use="required"/>
<xs:attribute name="HubURL" type="xs:string" use="optional"/>
<xs:attribute name="SearchURL" type="xs:string" use="optional"/>
<xs:attribute name="XMLVersion" type="xs:unsignedByte" use="required"/>
<xs:attribute name="DefaultCharset" use="optional">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="utf8"/>
<xs:enumeration value="ansi"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="UpdateURL" type="xs:string" use="optional"/>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
top

## Global Definitions

### Complex Type: DefaultType

Super-types: | None
Sub-types: | None

Name | DefaultType
Abstract | no
Documentation | Описание значений по-умолчанию.

XML Instance Representation
<...
StartSection="xs:unsignedByte [0..1] ?"
SearchSection="xs:unsignedByte [0..1] ?"/>
Schema Component Representation
<xs:complexType name="DefaultType">
<xs:attribute name="StartSection" type="xs:unsignedByte" use="optional"/>
<xs:attribute name="SearchSection" type="xs:unsignedByte" use="optional"/>
</xs:complexType>
top

### Complex Type: FlagsType

Super-types: | None
Sub-types: | None

Name | FlagsType
Abstract | no
Documentation | Флаги применяемые к конкретному порталу.

XML Instance Representation
<...
DisableLoginDialog="boolType [0..1] ?"
DisableHubLogin="boolType [0..1] ?"
DisableAutoUpdate="boolType [0..1] ?"
AllowExternalLinks="boolType [0..1] ?"
DenyNewWnd="boolType [0..1] ?"
DenyExternalLinksNewWindow="boolType [0..1] ?"
AllLinksInNewWnd="boolType [0..1] ?"
HostToolbarIconFirst="boolType [0..1] ?"
HostToolbarIconNone="boolType [0..1] ?"
HostMenuNone="boolType [0..1] ?"
EnableScriptDebugging="boolType [0..1] ?"
DisableToolbarFollowURL="boolType [0..1] ?"
ShowRequestDumper="boolType [0..1] ?"
DisableToolbar="boolType [0..1] ?"/>
Schema Component Representation
<xs:complexType name="FlagsType">
<xs:attribute name="DisableLoginDialog" type="boolType" use="optional"/>
<xs:attribute name="DisableHubLogin" type="boolType" use="optional"/>
<xs:attribute name="DisableAutoUpdate" type="boolType" use="optional"/>
<xs:attribute name="AllowExternalLinks" type="boolType" use="optional"/>
<xs:attribute name="DenyNewWnd" type="boolType" use="optional"/>
<xs:attribute name="DenyExternalLinksNewWindow" type="boolType" use="optional"/>
<xs:attribute name="AllLinksInNewWnd" type="boolType" use="optional"/>
<xs:attribute name="HostToolbarIconFirst" type="boolType" use="optional"/>
<xs:attribute name="HostToolbarIconNone" type="boolType" use="optional"/>
<xs:attribute name="HostMenuNone" type="boolType" use="optional"/>
<xs:attribute name="EnableScriptDebugging" type="boolType" use="optional"/>
<xs:attribute name="DisableToolbarFollowURL" type="boolType" use="optional"/>
<xs:attribute name="ShowRequestDumper" type="boolType" use="optional"/>
<xs:attribute name="DisableToolbar" type="boolType" use="optional"/>
</xs:complexType>
top

### Complex Type: SectionType

Super-types: | None
Sub-types: | None

Name | SectionType
Abstract | no
Documentation | Описание раздела портала.

XML Instance Representation
<...
SearchName="xs:string [0..1] ?"
SearchURL="xs:string [0..1] ?"
LargeImageID="ImageIDType [0..1] ?"
URL="xs:string [0..1] ?"
AbsolutePath="boolType [0..1] ?"
name="xs:string [0..1] ?"
SearchCommand="xs:string [0..1] ?"
RequestMethod="RequestMethodType [0..1] ?">
<Section> SectionType </Section> [0..*]
</...>
Schema Component Representation
<xs:complexType name="SectionType">
<xs:sequence>
<xs:element name="Section" type="SectionType" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="SearchName" type="xs:string" use="optional"/>
<xs:attribute name="SearchURL" type="xs:string" use="optional"/>
<xs:attribute name="LargeImageID" type="ImageIDType" use="optional"/>
<xs:attribute name="URL" type="xs:string" use="optional"/>
<xs:attribute name="AbsolutePath" type="boolType" use="optional"/>
<xs:attribute name="name" type="xs:string" use="optional"/>
<xs:attribute name="SearchCommand" type="xs:string" use="optional"/>
<xs:attribute name="RequestMethod" type="RequestMethodType" use="optional"/>
</xs:complexType>
top

### Simple Type: boolType

Super-types: | xs:unsignedByte < boolType (by restriction)
Sub-types: | None

Name | boolType
Content | Base XSD Type: unsignedByte 0 <= value <= 1
Documentation | Тип "да/нет". Принимает значения 0 для "нет" и 1 для "да".

Schema Component Representation
<xs:simpleType name="boolType">
<xs:restriction base="xs:unsignedByte">
<xs:minInclusive value="0"/>
<xs:maxInclusive value="1"/>
</xs:restriction>
</xs:simpleType>
top

### Simple Type: ImageIDType

Super-types: | xs:string < ImageIDType (by restriction)
Sub-types: | None

Name | ImageIDType
Content | Base XSD Type: string pattern = Home|Search|([0-9])*
Documentation | Индекс иконки: номер иконки в bmp файле или ключевое слово "Home" или "Search". Если указан индекс - берется иконка из заданного файла иконок, если ключевое слово - то иконка берется из внутренних ресурсов, внешний файл в этом случае не используется.

Schema Component Representation
<xs:simpleType name="ImageIDType">
<xs:restriction base="xs:string">
<xs:pattern value="Home|Search|([0-9])*"/>
</xs:restriction>
</xs:simpleType>
top

### Simple Type: RequestMethodType

Super-types: | xs:string < RequestMethodType (by restriction)
Sub-types: | None

Name | RequestMethodType
Content | Base XSD Type: string value comes from list: {'POST'|'GET'}
Documentation | Тип http запроса.

Schema Component Representation
<xs:simpleType name="RequestMethodType">
<xs:restriction base="xs:string">
<xs:enumeration value="POST"/>
<xs:enumeration value="GET"/>
</xs:restriction>
</xs: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.

- The minimum and maximum occurrence of elements and attributes are provided in square brackets, e.g. [0..1].
- Model group information are shown in gray, e.g. Start Choice ... End Choice.
- For type derivations, the elements and attributes that have been added to or changed from the base type's content are shown in bold.
- If an element/attribute has a fixed value, the fixed value is shown in green, e.g. country="Australia".
- Otherwise, the type of the element/attribute is displayed.
  - If the element/attribute's type is in the schema, a link is provided to it.
  - For local simple type definitions, the constraints are displayed in angle brackets, e.g. <<pattern = [1-9][0-9]{3}>>.
- If a local element/attribute has documentation, it will be displayed in a window that pops up when the question mark inside the attribute or next to the element is clicked, e.g. <postcode>.

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