FlexDoc/XML - XSDDoc - Parameter Tree

About XSDDoc parameters

Root parameter group

Parameter Name / Type / Description
Documentation Profile docProfile : enum {"compact", "detailed", "all"}

This parameter allows you to select a predefined documentation profile.

Each documentation profile represents a certain documentation structure and content. Some of them may be more suitable for your needs or used as a starting point for further customization.

XSDDoc template set exposes ca. 500 parameters. There are so many of them, because every feature found in the documentation that can vary anyhow is controlled by some parameter. Those parameters allow you to customize the documentation structure and content in a very wide range of possibilities. However, that requires you to browse the template parameter tree, to understand what each parameter means and specify some of them accordingly.

The «Documentation Profile» parameter is intended to help you with that. It is used to calculate the default values of lots of other parameters, which allows you to switch at once the whole bunch of settings determined by a particular documentation profile.

Note that it will work only for those parameters specified to use their default values (the check-box in the «Default» column must be selected for them). If you have already changed some of the parameters manually, they won't be affected.

So, after changing the «Documentation Profile» parameter, you will be asked if all other switch parameters (i.e. those with boolean and enum type) must be reset to their default values. That will ensure that the new documentation profile actually takes effect.

If you refuse that, you can do it later via the local menu invoked over «Documentation Profile» parameter by selecting one of the items:

  • Reset All Switches
  • Reset All Affected
Possible Choices: "compact"
Everything about your XML schemas will be documented, however in the most minimal form.

The following types of main documentation pages/blocks are generated:

# Documentation Page/Block Framed HTML Single-File
1 Title Page ✔
2 Table Of Contents ✔
3 Overview Summary ✔ ✔
4 Component Documentation ✔ ✔
5 Namespace Overview

including XSD component summaries

✔ ✔
6 Schema Overview

including full XML source

✔ ✔
7 XML Namespace Bindings ✔ ✔
8 Search ✔

Notes:

  • XML source is reproduced in the documentation only once for each entire XSD file. See also the parameter:
    Details | Schema | XML Source
  • The summaries of all XSD components are generated only once in the Namespace Overview pages/blocks. No component summary is generated separately for each XML schema.
    Content Model Tables will be included only in the case of Framed HTML. See the parameter:
    Details | Fragments | Component Summary | Content Model Table
  • All XSD components are fully documented as follows:

    • Only top-level (global) XML schema components will be documented separately with Component Documentation pages/blocks.

      The global documenting of local elements is suppressed. See also the parameter group:

      Generate Details | Components | Elements | Local Elements
    • All local elements and attributes will be documented in the Table Representations of Content Model of those components where a particular local element/attribute is declared or used.
    • Additionally, local elements with anonymous types will be documented locally (in the Component Documentation of their parent components) also with the Table Representation of their Content Model.
      A rare possibility of local elements with anonymous complex types defined within other local elements is also taken into account. Such nested-nested local elements are documented recursively along with their parents, which is controlled by the parameter:
      Details | Component | Content Element Details | Recursive
      See also parameters:

    • The same is for local attributes with anonymous types. They will be documented in more detail in the Attribute Details section of the Component Documentation of their parent components. See also the parameter:
      Details | Component | Attribute Details | Include | Local
    • The content model defined by an XSD component will be documented with:

      In the case of XSD elements, such representations will be generated only for elements with anonymous types. If the element type is a named (global) one, the element's content model representation is essentially the same as for its type. So, you can look at it by the type link.
    • The simple content derivation details will be disabled. All these parameters will be set to none:

    • XML source of separate XSD components will not be reproduced. All these parameters will be set to false:

"detailed"
This kind of documentation is focused more on complex XML schemas and may be suitable for most schema design patterns.

All documentation main pages/blocks are generated:

# Documentation Page/Block Framed HTML Single-File
1 Title Page ✔
2 Table Of Contents ✔
3 Overview Summary ✔ ✔
4 All Component Summary ✔ ✔
5 Component Documentation ✔ ✔
6 Namespace Overview ✔ ✔
7 Schema Overview

including full XML source

✔ ✔
8 XML Namespace Bindings ✔ ✔
9 Search ✔

Notes:

  • XML source is reproduced in the documentation only once for each entire XSD file. See also the parameters:
    Details | Schema | XML Source
  • The summaries of XSD components are generated:

    • All together
    • For each namespace
    • For XML schema
  • All XSD components are fully documented as follows:

    • All top-level (global) XML schema components will be documented separately with Component Documentation pages/blocks.
    • All local elements are documented globally (with a separate page/block referenced from all navigation lists). See also the parameter group:
      Generate Details | Components | Elements | Local Elements
    • The content model defined by an XSD component will be documented with:

      If so many ways are too much for you, you can disable what you don't need by unselecting corresponding parameters. See details by the links above.
    • Additionally, local attributes with anonymous types will be documented in more detail in the Attribute Details section of the Component Documentation of their parent components. See also the parameter:
      Details | Component | Attribute Details | Include | Local
    • The simple content derivation details will be enabled.
"all features"
All implemented features are enabled.

All local elements are documented globally and without unifying by type.

Each local element on a separate Component Documentation pages/block referenced from all navigation lists. The corresponding HTML/diagram files will be stored according the parent components.

The parameters that control this will be set as follows:

Generate Details | Components | Elements | Local Elements = "all"
Such documentation may be redundant for you.