With this parameter you can specify at once the sorting order of components for a number of locations throughout the documentation. This includes:
In fact, that is controlled via other parameters:
FramedDoc.tpl
main template),
the sorting of component navigation lists.
Precisely, this is controlled via the following parameters (for which this parameter provides the default value):
SingleDoc.tpl
main template),
this parameter directly controls the ordering of component details
(called Component Documentation).
true
),
the components will be sorted alphabetically by their names (ignoring letter case).
The component name is assumed to be that under which the component appears (is referenced to) at the given documentation location. This is typically the component qualified name (which is the actual namespace prefix plus the component local name). That, however, can be changed using "Show | Namespace Prefixes" parameter.
Additionally, in the case of a local element, the component name may also include a special extension used to distinguish the equally named local elements. For more details about this, please see "Show | Element Name Extensions" parameter.
false
),
the components will not be sorted.
In that case they will follow in a certain "physical" order produced according to the following.
When the components come from different XML schemas, first, they will be grouped by their schemas. The ordering of those groups is determined by how the initial XML schemas (to be documented) have been specified as well as how these schemas import other XML schemas (see also "Generate Details | For schemas" parameter group for that matter).
Within a group belonging to the same XML schema, the components will follow in the same order as they are defined in that schema.
This gives you a possibility to specify a particular ordering of the components (e.g. elements) by yourself. Simply define the most important components (e.g. an XML document's root element) on the top of the XML schema. If you have several schemas to document, specify the most important of them the first. That will produce the component ordering as you wish (or something close to it).