7. Reference manual : document model

7.1. SchemaDoc elements
7.2. DocBook elements
7.3. Schema elements

In order to coordinate a set of documentation and its associated set of schemas, SchemaDoc uses a group of elements that links the DocBook namespace and the XML Schema namespace. These elements are declared either as block components (for example, sd:elemDocRef) or as inline references (for example, sd:elemRef).

Attribute sd:defaultNs

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

Description

This mechanism is used in order to solve namespaces naming used by the documented DTDs while referencing. The idea is to enable different mechanisms.

All xxxRef elements have at least two attributes: linkend and sd:defaultNs. linkend may contain a local name (myObject) or a prefixed name (test:myObject); this is the first mechanism. As an alternative, if a sole local name is provided, sd:defaultNs can be used in conjunction. Then, as a generalisation, if sd:defaultNs attribute is not provided, all processes should look on the stack of open elements in order to find a default namespace. At least, the one defined at article level will be found.

Element sd:schemaDef

— Container for all schema files used within the documentation

Description

This element is called within article at the end, in order to make the integration of all defined Schemas within the documentation. Prior to make the integration, it requires namespace prefix declarations, using the nsDecl element.

As a restriction, and for the purpose to ease namespace resolution in Schema object called from the documentation, all namespace prefixes needs to be declared. There is one nsDecl declaration by namespace prefix used and if different prefixes are used for the same namespace, all of them need to be declared. At least, there is for now a need for one declaration: the default namespace used by the Schema in reference.

defaultNsnsDeclmapN10FDD

Block components are present in documentation as para. They are containers for documentation of an object. For the moment, block components can only document a global element, in the XML Schema meaning. This restriction may be removed later, on a per need basis.

The provision for these kind of blocks includes the following declarations.

Element glossentry

Description

This element enables it, providing a term to be defined (glossterm) plus its formal definition (glossdef) with a provision of different kind of blocks for the definition wording. The information is supposed to be concise and will be also provided as a glossary in the different outputs. As a replacement of the definition, there may be a glosssee element forwarding to a yet existing definition.

glosstermacronymabbrevndxterm.classindextermrevhistoryglossseeglossdefmapN11224

Complex type sd:documentedObjectsHavingAttributes

— Model for content documentation of all xs objects that does have attributes

Description

This type is an extension of the preceding sd:documentedObjects enabling to have specific documentation sets on xs:attribute or xs:attributeGroup straight within the element. This documentation will be fully formatted later, as a special object. Mainly, the content has, in first, a sd:objAttributeDoc element.

defaultNsshowObjGraphicalsoDocumentsobjAttributeDocdivcomponent.mixlist.classitemizedlistorderedlistvariablelistadmon.classcautionimportantnotetipwarningSCHEMADOC.admon.classattributeDocRefdocumentedObjectselemDocRefdocumentedObjectsHavingAttributesattributeGroupDocRefdocumentedObjectscomplexTypeDocRefdocumentedObjectsHavingAttributesgroupDocRefdocumentedObjectssimpleTypeDocRefdocumentedObjectstoBeSolvedglossentrylinespecific.classliterallayoutprogramlistingpara.classparainformal.classmediaobjectgraphicformal.classequationexamplefigureinformalfiguretabletbl.table.mdlinformaltableinformal.tbl.table.mdlmapN11451