http://www.tireme.fr/XMLSchema/documentation/V1/
Contents
Block documentation components
Inline documentation references
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.
sdManage.attribute —
<xs:attributeGroup name="sdManage.attribute"><xs:attribute default="false" ref="manage"> </xs:attribute></xs:attributeGroup>
sdUseNamespace.attribute —
<xs:attributeGroup name="sdUseNamespace.attribute"><xs:attribute default="false" ref="useNamespace"> </xs:attribute></xs:attributeGroup>
sdLang.attribute —
<xs:attributeGroup name="sdLang.attribute"><xs:attribute ref="language" use="required"> </xs:attribute></xs:attributeGroup>
defaultNs — Defines a default namespace reference for all links declaration used by sd elements.
language — Language used for writing the documentation. Enable to generate different output
publicName — Public name of the model that will later been used within catalogs
doc-loc —
<xs:attributeGroup name="doc-loc"><xs:attribute ref="dtdLocation" use="optional"> </xs:attribute><xs:attribute ref="publicName"> </xs:attribute></xs:attributeGroup>
docManage — Used at schema level, indicate if the output processes must use this schema information while creating outputs
schemaDef — Container for all schema files used within the documentation
<xs:element name="schemaDef"><xs:complexType mixed="false"></xs:element><xs:sequence><xs:choice maxOccurs="unbounded" minOccurs="0"><xs:element ref="nsDecl"> </xs:element></xs:choice><xs:choice maxOccurs="unbounded"></xs:sequence><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:attribute ref="defaultNs"> </xs:attribute></xs:complexType>
nsDecl — Definition namespace/prefix association
linkendAsCharReq —
showObjGraphic — When documentation is displayed, do we show the associated graphic
schemaObjectsDocumented —
<xs:group name="schemaObjectsDocumented"><xs:choice></xs:group><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>
documentedObjCommonAttr —
| Name | Type | Use | Default val. | Facets |
| defaultNs | ||||
| (Group) linkendAsCharReq | ||||
| showObjGraphic | ||||
<xs:attributeGroup name="documentedObjCommonAttr"><xs:attributeGroup ref="linkendAsCharReq"> </xs:attributeGroup><xs:attribute ref="defaultNs"> </xs:attribute><xs:attribute ref="showObjGraphic"> </xs:attribute></xs:attributeGroup>
objAttributeDoc — Enable to document attributes of a specific container
<xs:element name="objAttributeDoc"><xs:complexType mixed="false"></xs:element><xs:choice maxOccurs="unbounded"></xs:complexType><xs:element ref="localAttributeDoc"> </xs:element><xs:element ref="localAttributeGroupDoc"> </xs:element></xs:choice>
simpleTypeDocRef — Element for creating documentation of a simple type
groupDocRef — Element for creating documentation of a group
elemDocRef — Element for creating documentation of an element
complexTypeDocRef — Element for creating documentation of a complex type
attributeDocRef — Element for creating documentation of an attribute
attributeGroupDocRef — Element for creating documentation of an attribute group
toBeSolved — Enable to communicate between people of a same project
| Name | Type | Use | Default val. | Facets |
| priority | normal | Enumerated values: normal | high | low |
<xs:element name="toBeSolved"><xs:complexType mixed="true"></xs:element><xs:group maxOccurs="unbounded" minOccurs="0" ref="para.char.mix"> </xs:group><xs:attribute default="normal" name="priority"></xs:complexType><xs:simpleType></xs:attribute><xs:restriction base="xs:token"></xs:simpleType><xs:enumeration value="normal"/><xs:enumeration value="high"/><xs:enumeration value="low"/></xs:restriction>
simpleTypeRef — Referencing a simple type
globalObjType —
| Name | Type | Use | Default val. | Facets |
| globalObjType | element | Enumerated values: element | complexType | attributeGroup |
<xs:attributeGroup name="globalObjType"><xs:attribute default="element" name="globalObjType"></xs:attributeGroup><xs:simpleType></xs:attribute><xs:restriction base="xs:NMTOKEN"></xs:simpleType><xs:enumeration value="element"/><xs:enumeration value="complexType"/><xs:enumeration value="attributeGroup"/></xs:restriction>
localAttributeRef — Referencing an attribute local to a global object
| Name | Type | Use | Default val. | Facets |
| defaultNs | ||||
| (Group) globalObjType | ||||
| (Group) linkendAsCharReq | ||||
| path | xs:string | required | ||
<xs:element name="localAttributeRef"><xs:complexType mixed="false"></xs:element><xs:attributeGroup ref="linkendAsCharReq"> </xs:attributeGroup><xs:attribute ref="defaultNs"> </xs:attribute><xs:attribute name="path" type="xs:string" use="required"/><xs:attributeGroup ref="globalObjType"> </xs:attributeGroup></xs:complexType>
localElemRef — Referencing an element local to a global object
| Name | Type | Use | Default val. | Facets |
| defaultNs | ||||
| (Group) globalObjType | ||||
| (Group) linkendAsCharReq | ||||
| path | xs:string | required | ||
| schemaId | ||||
<xs:element name="localElemRef"><xs:complexType mixed="false"></xs:element><xs:attributeGroup ref="linkendAsCharReq"> </xs:attributeGroup><xs:attribute ref="schemaId"> </xs:attribute><xs:attribute name="path" type="xs:string" use="required"/><xs:attribute ref="defaultNs"> </xs:attribute><xs:attributeGroup ref="globalObjType"> </xs:attributeGroup></xs:complexType>
attributeGroupRef — Referencing an attribute group
attributeRef — Referencing an attribute
elemRef — Referencing an element
groupRef — Referencing a group
complexTypeRef — Referencing a complex type
alsoDocuments — defines all objects also documented by its container
| Name | Type | Use | Default val. | Facets |
| isRelevantToViewIt | Enumerated values: true | false | onlyGraphic |
<xs:element name="alsoDocuments"><xs:complexType mixed="false"></xs:element><xs:choice maxOccurs="unbounded"><xs:element ref="attributeGroupRef"> </xs:element><xs:element ref="attributeRef"> </xs:element><xs:element ref="complexTypeRef"> </xs:element><xs:element ref="elemRef"> </xs:element><xs:element ref="groupRef"> </xs:element><xs:element ref="simpleTypeRef"> </xs:element></xs:choice><xs:attribute name="isRelevantToViewIt"></xs:complexType><xs:simpleType></xs:attribute><xs:restriction base="xs:token"></xs:simpleType><xs:enumeration value="true"/><xs:enumeration value="false"/><xs:enumeration value="onlyGraphic"/></xs:restriction>
localAttributeDocType —
<xs:complexType mixed="false" name="localAttributeDocType"><xs:sequence><xs:group maxOccurs="unbounded" minOccurs="0" ref="divcomponent.mix"> </xs:group></xs:sequence><xs:attributeGroup ref="linkendreq"> </xs:attributeGroup></xs:complexType>
localAttributeGroupDoc — locally documented attribute group