Parameter |
Name / Type / Description |
Diagram
|
doc.comp.diagram : boolean
Specify whether to generate/include a graphical diagram representation of the XSD component.
Diagrams are generated by a special diagramming plugin.
Applies To:
- Elements
- Complex Types
- Element Groups
Nested Parameters:
-
Control how to direct hyperlinks from the diagram image.
|
Hyperlinks
|
doc.comp.diagram.links
This parameter group controls how the diagram hyperlinks will be generated.
The current implementation limits it to the following possibilities:
-
The depiction of a global attribute (specified by reference) can be hyperlinked either to
the attribute's global documentation or to its local documentation (found in «Attrbute Detail» section).
This is controlled by the “Global Attributes” parameter
of this group.
When neither local nor global documentation is found, the hyperlink will go to the location where
the global attribute is defined within the XML schema source.
-
The depiction of a local attribute or attribute prohibition can be hyperlinked only
to the corresponding local documentation in «Attrbute Detail» section.
When that documentation is not found, the hyperlink will go to the definition's location within the XML schema source.
-
The depiction of a global element (specified by reference) can be hyperlinked only to
the element's global documentation. If not found, the hyperlink will go to the location where
the global element is defined within the XML schema source.
-
The depiction of a local element can be hyperlinked either to the global documentation related
to this element component (see
“Generate Details | Elements | Local Elements”
parameter) or to its local documentation in «Content Element Detail»
section. This is controlled by the
“Local Elements” parameter in this group.
When neither local nor global documentation is found, the hyperlink will go to the definition's location
within the XML schema source.
|
Global Attributes
|
doc.comp.diagram.links.attribute.global : enum {"global", "local"}
Specify how to hyperlink the depiction of a global attribute:
- "global documentation"
-
The hyperlink will be generated to the attribute's global documentation (see
“Generate Details | Global Attributes”
parameter). If that documentation is not found, the hyperlink goes to the local documentation
of the attribute's reference definition in the «Attrbute Detail» section.
At last, if that is also not found, the hyperlink is directed to the definition of the global attribute
within the XML schema source.
- "local documentation"
-
In this case, the local documentation (found in «Attrbute Detail»
section) will be the first priority; then the attribute global documentation; at last,
the location within the XML schema source.
|
Local Elements
|
doc.comp.diagram.links.element.local : enum {"global", "local"}
Specify how to hyperlink the depiction of a local element:
- "global documentation"
-
The hyperlink will be generated to the global documentation related to this element component (see
“Generate Details | Elements | Local Elements”
parameter). If that documentation is not found, the hyperlink goes to the local documentation
(of the element's reference definition) in the «Content Element Detail»
section. At last, if that is also not found, the hyperlink will be directed to the definition of this element
within the XML schema source.
- "local documentation"
-
In this case, the local documentation (found in «Content Element Detail»
section) will be the first priority; then the element's global documentation; at last, the location within the XML schema source.
|