II. http://www.tireme.fr/XMLSchema/documentation/V1/ContainedObjects

Attribute group sdManage.attribute —
Attribute group sdUseNamespace.attribute —
Attribute useNamespace —
Attribute group sdLang.attribute —
Attribute group namespaceAttr —
Attribute sd:defaultNs — Defines a default namespace reference for all links declaration used by sd elements.
Attribute manage — Does program will manage the model ?
Attribute isTopLevelRoot — Is it a schema root for xs2dtd
Attribute language — Language used for writing the documentation. Enable to generate different output
Attribute dtdLocation —
Attribute publicName — Public name of the model that will later been used within catalogs
Attribute group sd:doc-loc —
Attribute docManage — Used at schema level, indicate if the output processes must use this schema information while creating outputs
Element sd:schemaDef — Container for all schema files used within the documentation
Element nsDecl — Definition namespace/prefix association
Attribute group sd:linkendreq —
Attribute group sd:linkendAsCharReq —
Attribute schemaId —
Attribute showObjGraphic — When documentation is displayed, do we show the associated graphic
Group schemaObjectsDocumented —
Attribute group documentedObjCommonAttr —
Element sd:objAttributeDoc — Enable to document attributes of a specific container
Element sd:simpleTypeDocRef — Element for creating documentation of a simple type
Element sd:groupDocRef — Element for creating documentation of a group
Element sd:elemDocRef — Element for creating documentation of an element
Element sd:complexTypeDocRef — Element for creating documentation of a complex type
Element sd:attributeDocRef — Element for creating documentation of an attribute
Element sd:attributeGroupDocRef — Element for creating documentation of an attribute group
Element sd:toBeSolved — Enable to communicate between people of a same project
Element glossRef — Reference to glossary
Element decisionRef — Reference to definition
Element sd:simpleTypeRef — Referencing a simple type
Attribute group sd:globalObjType —
Element sd:localAttributeRef — Referencing an attribute local to a global object
Element sd:localElemRef — Referencing an element local to a global object
Element sd:attributeGroupRef — Referencing an attribute group
Element sd:attributeRef — Referencing an attribute
Element sd:elemRef — Referencing an element
Element sd:groupRef — Referencing a group
Element sd:complexTypeRef — Referencing a complex type
Element schemaRef — Referencing a schema
Element sd:alsoDocuments — defines all objects also documented by its container
Complex type localAttributeDocType —
Element localAttributeDoc — locally documented attribute
Element localAttributeGroupDoc — locally documented attribute group

Defines namespace

http://www.tireme.fr/XMLSchema/documentation/V1/

Contents

Objects specific to SchemaDoc

Reused declarations

Schema container

Referencing mechanism

Reused objects

Block documentation components

Other bloc elements

Inline documentation references

include: redefinableSchemaDocObjects.xsd

import: docbookWrapper.xsd (http://www.oasis-open.org/docbook/xmlschema/4.1.2)

Objects specific to SchemaDoc

This model defines all objects specific to the SchemaDoc namespace and that are reused either in the DocBook model or in the XML Schema one.

Reused declarations

Attribute group sdManage.attribute

sdManage.attribute —

Used in:

Attribute groups: SCHEMADOC.article.attributes

Attributes and attr. groups

Name	Type	Use	Default val.	Facets
manage

Source

<xs:attributeGroup name="sdManage.attribute">  <xs:attribute default="false" ref="manage">  </xs:attribute>
</xs:attributeGroup>

Attribute group sdUseNamespace.attribute

sdUseNamespace.attribute —

Used in:

Attribute groups: SCHEMADOC.article.attributes

Attributes and attr. groups

Name	Type	Use	Default val.	Facets
useNamespace

Source

<xs:attributeGroup name="sdUseNamespace.attribute">  <xs:attribute default="false" ref="useNamespace">  </xs:attribute>
</xs:attributeGroup>

Attribute useNamespace

useNamespace —

Used in:

Attribute groups: sdUseNamespace.attribute

Source


<xs:attribute name="useNamespace">
  <xs:simpleType>
    <xs:restriction base="xs:token">
      <xs:enumeration value="true"/>
      <xs:enumeration value="false"/>
    </xs:restriction>
  </xs:simpleType>
</xs:attribute>

Attribute group sdLang.attribute

sdLang.attribute —

Used in:

Attribute groups: SCHEMADOC.article.attributes

Attributes and attr. groups

Name	Type	Use	Default val.	Facets
language

Source

<xs:attributeGroup name="sdLang.attribute">  <xs:attribute ref="language" use="required">  </xs:attribute>
</xs:attributeGroup>

Attribute group namespaceAttr

namespaceAttr —

Used in:

Attribute groups: SCHEMADOC.specificAttributesForDBHierarchy

Source


<xs:attributeGroup name="namespaceAttr"></xs:attributeGroup>

Attribute sd:defaultNs

defaultNs — Defines a default namespace reference for all links declaration used by sd elements.

Used in:

Elements: localAttributeRef - localElemRef - schemaDef
Complex types: simpleObjRefType
Attribute groups: SCHEMADOC.specificAttributesForDBHierarchy - documentedObjCommonAttr

Source


<xs:attribute name="defaultNs" type="xs:token"></xs:attribute>

Attribute manage

manage — Does program will manage the model ?

Used in:

Complex types: schema
Attribute groups: sdManage.attribute

Source


<xs:attribute name="manage" type="xs:boolean"></xs:attribute>

Attribute isTopLevelRoot

isTopLevelRoot — Is it a schema root for xs2dtd

Used in:

Complex types: schema

Source


<xs:attribute name="isTopLevelRoot" type="xs:boolean"></xs:attribute>

Attribute language

language — Language used for writing the documentation. Enable to generate different output

Used in:

Attribute groups: sdLang.attribute

Source


<xs:attribute name="language">
  <xs:simpleType>
    <xs:restriction base="xs:language">
      <xs:enumeration value="fr"/>
      <xs:enumeration value="en"/>
    </xs:restriction>
  </xs:simpleType>
</xs:attribute>

Attribute dtdLocation

dtdLocation —

Used in:

Attribute groups: doc-loc

Source


<xs:attribute name="dtdLocation" type="xs:string"></xs:attribute>

Attribute publicName

publicName — Public name of the model that will later been used within catalogs

Used in:

Complex types: schema
Attribute groups: doc-loc

Source


<xs:attribute name="publicName" type="xs:string"></xs:attribute>

Attribute group sd:doc-loc

doc-loc —

Used in:

Complex types: include - import - redefine

Attributes and attr. groups

Name	Type	Use	Default val.	Facets
dtdLocation
publicName

Source

<xs:attributeGroup name="doc-loc">  <xs:attribute ref="dtdLocation" use="optional">  </xs:attribute>
  <xs:attribute ref="publicName">  </xs:attribute>
</xs:attributeGroup>

Attribute docManage

docManage — Used at schema level, indicate if the output processes must use this schema information while creating outputs

Source


<xs:attribute default="false" name="docManage" type="xs:boolean"/>

Schema container

Element sd:schemaDef

schemaDef — Container for all schema files used within the documentation

Used in:

Complex types: SCHEMADOC.article

Attributes and attr. groups

Name	Type	Use	Default val.	Facets
defaultNs

Source

<xs:element name="schemaDef">  <xs:complexType mixed="false">    <xs:sequence>      <xs:choice maxOccurs="unbounded" minOccurs="0">        <xs:element ref="nsDecl">        </xs:element>
      </xs:choice>
      <xs:choice maxOccurs="unbounded">
        <xs:any maxOccurs="1" minOccurs="1" namespace="http://www.w3.org/2001/XInclude" processContents="lax"/>
        <xs:any maxOccurs="1" minOccurs="1" namespace="http://www.w3.org/2001/XMLSchema" processContents="lax"/>
      </xs:choice>
    </xs:sequence>
    <xs:attribute ref="defaultNs">    </xs:attribute>
  </xs:complexType>
</xs:element>

Element nsDecl

nsDecl — Definition namespace/prefix association

Used in:

Elements: schemaDef

Attributes and attr. groups

Name	Type	Use	Default val.	Facets
nsName	xs:string	required
nsPrefix	xs:string	required

Source


<xs:element name="nsDecl">
  <xs:complexType mixed="false">
    <xs:attribute name="nsPrefix" type="xs:string" use="required"/>
    <xs:attribute name="nsName" type="xs:string" use="required"/>
  </xs:complexType>
</xs:element>

Referencing mechanism

Attribute group sd:linkendreq

linkendreq —

Used in:

Complex types: localAttributeDocType

Attributes and attr. groups

Name	Type	Use	Default val.	Facets
linkend	xs:token	required

Source


<xs:attributeGroup name="linkendreq">
  <xs:attribute name="linkend" type="xs:token" use="required"/>
</xs:attributeGroup>

Attribute group sd:linkendAsCharReq

linkendAsCharReq —

Used in:

Elements: localAttributeRef - localElemRef
Complex types: simpleObjRefType
Attribute groups: documentedObjCommonAttr

Attributes and attr. groups

Name	Type	Use	Default val.	Facets
linkend	xs:token	required
schemaId	xs:token	optional

Source


<xs:attributeGroup name="linkendAsCharReq">
  <xs:attribute name="linkend" type="xs:token" use="required"/>
  <xs:attribute name="schemaId" type="xs:token" use="optional"/>
</xs:attributeGroup>

Attribute schemaId

schemaId —

Used in:

Elements: localElemRef

Source


<xs:attribute name="schemaId" type="xs:token"></xs:attribute>

Attribute showObjGraphic

showObjGraphic — When documentation is displayed, do we show the associated graphic

Used in:

Attribute groups: documentedObjCommonAttr

Source


<xs:attribute default="true" name="showObjGraphic" type="xs:boolean"></xs:attribute>

Reused objects

Block documentation components

Group schemaObjectsDocumented

schemaObjectsDocumented —

Source

<xs:group name="schemaObjectsDocumented">  <xs:choice>    <xs:element ref="attributeDocRef">    </xs:element>
    <xs:element ref="attributeGroupDocRef">    </xs:element>
    <xs:element ref="complexTypeDocRef">    </xs:element>
    <xs:element ref="elemDocRef">    </xs:element>
    <xs:element ref="groupDocRef">    </xs:element>
    <xs:element ref="simpleTypeDocRef">    </xs:element>
  </xs:choice>
</xs:group>

Attribute group documentedObjCommonAttr

documentedObjCommonAttr —

Used in:

Complex types: documentedObjects - documentedObjectsHavingAttributes

Attributes and attr. groups

Name	Type	Use	Default val.	Facets
defaultNs
(Group) linkendAsCharReq
showObjGraphic

Source

<xs:attributeGroup name="documentedObjCommonAttr">  <xs:attributeGroup ref="linkendAsCharReq">  </xs:attributeGroup>
  <xs:attribute ref="defaultNs">  </xs:attribute>
  <xs:attribute ref="showObjGraphic">  </xs:attribute>
</xs:attributeGroup>

Element sd:objAttributeDoc

objAttributeDoc — Enable to document attributes of a specific container

Used in:

Complex types: documentedObjectsHavingAttributes

Source

<xs:element name="objAttributeDoc">  <xs:complexType mixed="false">    <xs:choice maxOccurs="unbounded">      <xs:element ref="localAttributeDoc">      </xs:element>
      <xs:element ref="localAttributeGroupDoc">      </xs:element>
    </xs:choice>
  </xs:complexType>
</xs:element>

Element sd:simpleTypeDocRef

simpleTypeDocRef — Element for creating documentation of a simple type

Type: documentedObjects

Used in:

Groups: SCHEMADOC.admon.class - schemaObjectsDocumented

Source


<xs:element name="simpleTypeDocRef" type="documentedObjects"></xs:element>

Element sd:groupDocRef

groupDocRef — Element for creating documentation of a group

Type: documentedObjects

Used in:

Groups: SCHEMADOC.admon.class - schemaObjectsDocumented

Source


<xs:element name="groupDocRef" type="documentedObjects"></xs:element>

Element sd:elemDocRef

elemDocRef — Element for creating documentation of an element

Type: documentedObjectsHavingAttributes

Used in:

Groups: SCHEMADOC.admon.class - schemaObjectsDocumented

Source


<xs:element name="elemDocRef" type="documentedObjectsHavingAttributes"></xs:element>

Element sd:complexTypeDocRef

complexTypeDocRef — Element for creating documentation of a complex type