Specify how the documentation of local elements (and their diagrams) must be stored.
NOTE: This parameter is enabled only when the parameter
"Generate Details | XSD Components | Elements | Local Elements | Unify By Type" is unselected (false ).
|
true
,
all documentation files for local elements will be stored in the subdirectory structure reproducing their parent components
(in which they are defined).
Namely, for a local element 'localElementName'
defined in a parent component,
its documentation file will be stored as follows:
Parent Component | Element Documentation File |
global complex type'typeName' |
.../schemas/schemaName_xsd/complexTypes/typeName/localElementName.html |
global element group'groupName' |
.../schemas/schemaName_xsd/groups/groupName/localElementName.html |
global element'elementName' |
.../schemas/schemaName_xsd/elements/elementName/localElementName.html |
another local element'elementName' |
.../schemas/schemaName_xsd/.../elementName/localElementName.html
At that, the subdirectory structure of the parent element will be reproduced at any depth according to the rules above. |
The component diagrams are stored in the same directory along with the component documentation files
under the same names however with different extension (corresponding the image format), e.g.:
|
false
, all element documentation files
are stored in the same directory:
.../schemas/schemaName_xsd/elements/
.../schemas/schemaName_xsd/elements/elementName_3.html
However, if you don't need this, the produced HTML documentation files will be more compact (as all links to local element docs will be shorter).
Note:
This parameter can be used only when the unification of local elements by type is disabled (see "Generate Details | XSD Components | Elements | Local Elements | Unify By Type" parameter).When the unification by type is enabled, several local elements defined in different locations may get documented in the same documentation file. This breaks the whole idea of storing element docs according their definition locations! In that case, this parameter is disabled and
false
.