# Exemple de documentation automatique

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
  - Attribute: annee
  - Attribute: date
  - Attribute: href
  - Attribute: ISBN
  - Attribute: lang
  - Attribute: pages
  - Element: article
  - Element: auteur
  - Element: biblio
  - Element: description
  - Element: editeur
  - Element: lien
  - Element: livre
  - Element: revue
  - Element: titre
- Global Definitions
  - Simple Type: isbnType
  - Simple Type: pagesType

- 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.
Documentation | Schéma de définition d'une bibliographie.

### 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

### Attribute: annee

Name | annee
Type | xs:gYear

XML Instance Representation
annee=" xs:gYear"

Schema Component Representation
<xs:attribute name="annee" type=" xs:gYear "/>

top

### Attribute: date

Name | date
Type | xs:date

XML Instance Representation
date=" xs:date"

Schema Component Representation
<xs:attribute name="date" type=" xs:date "/>

top

### Attribute: href

Name | href
Type | xs:anyURI

XML Instance Representation
href=" xs:anyURI"

Schema Component Representation
<xs:attribute name="href" type=" xs:anyURI "/>

top

### Attribute: ISBN

Name | ISBN
Type | isbnType

XML Instance Representation
ISBN=" isbnType "

Schema Component Representation
<xs:attribute name="ISBN" type=" isbnType "/>

top

### Attribute: lang

Name | lang
Type | xs:language

XML Instance Representation
lang=" xs:language"

Schema Component Representation
<xs:attribute name="lang" type=" xs:language "/>

top

### Attribute: pages

Name | pages
Type | pagesType

XML Instance Representation
pages=" pagesType "

Schema Component Representation
<xs:attribute name="pages" type=" pagesType "/>

top

### Element: article

Name | article
Type | Locally-defined complex type
Nillable | no
Abstract | no
Documentation | Référence vers un article de journal, de revue...

XML Instance Representation
<article pages="[1]" lang="anySimpleType [0..1]"> <titre> ... </titre> [1] <auteur> ... </auteur> [1] <revue> ... </revue> [1] <description> ... </description> [0..1] </article>

Schema Component Representation
<xs:element name="article"> <xs:complexType> <xs:sequence> <xs:element ref=" titre "/> <xs:element ref=" auteur "/> <xs:element ref=" revue "/> <xs:element ref=" description " minOccurs="0" maxOccurs="1"/> </xs:sequence> <xs:attribute ref=" pages " use="required"/> <xs:attribute name="lang" default="fr"/> </xs:complexType> </xs:element>

top

### Element: auteur

Name | auteur
Type | xs:string
Nillable | no
Abstract | no

XML Instance Representation
<auteur> xs:string </auteur>

Schema Component Representation
<xs:element name="auteur" type=" xs:string "/>

top

### Element: biblio

Name | biblio
Type | Locally-defined complex type
Nillable | no
Abstract | no
Documentation | Elément racine

XML Instance Representation
<biblio> Start Choice [0..*] <livre> ... </livre> [1] <article> ... </article> [1] <lien> ... </lien> [1] End Choice </biblio>

Schema Component Representation
<xs:element name="biblio"> <xs:complexType> <xs:choice minOccurs="0" maxOccurs="unbounded"> <xs:element ref=" livre "/> <xs:element ref=" article "/> <xs:element ref=" lien "/> </xs:choice> </xs:complexType> </xs:element>

top

### Element: description

Name | description
Type | xs:string
Nillable | no
Abstract | no

XML Instance Representation
<description> xs:string </description>

Schema Component Representation
<xs:element name="description" type=" xs:string "/>

top

### Element: editeur

Name | editeur
Type | xs:string
Nillable | no
Abstract | no

XML Instance Representation
<editeur> xs:string </editeur>

Schema Component Representation
<xs:element name="editeur" type=" xs:string "/>

top

### Element: lien

Name | lien
Type | Locally-defined complex type
Nillable | no
Abstract | no
Documentation | Référence vers un site Web

XML Instance Representation
<lien lang="[0..1]" href="[1]" date="[0..1]"> <titre> ... </titre> [1] <auteur> ... </auteur> [0..1] <description> ... </description> [0..1] </lien>

Schema Component Representation
<xs:element name="lien"> <xs:complexType> <xs:sequence> <xs:element ref=" titre "/> <xs:element ref=" auteur " minOccurs="0" maxOccurs="1"/> <xs:element ref=" description " minOccurs="0" maxOccurs="1"/> </xs:sequence> <xs:attribute ref=" lang " default="fr"/> <xs:attribute ref=" href " use="required"/> <xs:attribute ref=" date " use="optional"/> </xs:complexType> </xs:element>

top

### Element: livre

Name | livre
Type | Locally-defined complex type
Nillable | no
Abstract | no
Documentation | Permet de déclarer les références d'un livre.

XML Instance Representation
<livre annee="anySimpleType [0..1] ?" ISBN="anySimpleType [0..1]" lang="anySimpleType [0..1]" pages="[0..1]"> <titre> ... </titre> [1] <auteur> ... </auteur> [1] <editeur> ... </editeur> [1] <description> ... </description> [0..1] </livre>

Schema Component Representation
<xs:element name="livre"> <xs:complexType> <xs:sequence> <xs:element ref=" titre "/> <xs:element ref=" auteur "/> <xs:element ref=" editeur "/> <xs:element ref=" description " minOccurs="0" maxOccurs="1"/> </xs:sequence> <xs:attribute name="annee" use="optional"/> <xs:attribute name="ISBN" use="optional"/> <xs:attribute name="lang" default="fr"/> <xs:attribute ref=" pages " use="optional"/> </xs:complexType> </xs:element>

top

### Element: revue

Name | revue
Type | xs:string
Nillable | no
Abstract | no

XML Instance Representation
<revue> xs:string </revue>

Schema Component Representation
<xs:element name="revue" type=" xs:string "/>

top

### Element: titre

Name | titre
Type | xs:string
Nillable | no
Abstract | no

XML Instance Representation
<titre> xs:string </titre>

Schema Component Representation
<xs:element name="titre" type=" xs:string "/>

top

## Global Definitions

### Simple Type: isbnType

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

Name | isbnType
Content | Built-in XSD Type: string pattern = [0-9]{10}

Schema Component Representation
<xs:simpleType name="isbnType"> <xs:restriction base=" xs:string "> <xs:pattern value="[0-9]{10}"/> </xs:restriction> </xs:simpleType>

top

### Simple Type: pagesType

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

Name | pagesType
Content | Built-in XSD Type: string pattern = [0-9]+[ à ][0-9]+

Schema Component Representation
<xs:simpleType name="pagesType"> <xs:restriction base=" xs:string "> <xs:pattern value="[0-9]+[ à ][0-9]+"/> </xs:restriction> </xs:simpleType>

top

## Legend

Complex Type: | AusAddress
Schema Component Type | 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

Generated by xs3p. Last modified: