Products         Downloads         Licensing         Shop         Customers         Support    

 DocFlex Technology
Overview
Features
Documentation
 DocFlex/XML
Overview
Features
Documentation
XSDDoc
Features
Organization
Examples
Templates
Subtemplates
Parameters
FAQ
WSDLDoc
Integrations
Bundles
 DocFlex/Javadoc
Overview
Documentation
Basic Templates
JavadocPro
Examples
Tutorials
 DocFlex/Together
Overview
Examples
Basic Templates
Documentation
Tutorials
 Try
Downloads
Registration
Trial License
 Use
Licensing
Shop
Support
 Company
News
Products
Customers
About Us
Imprint
Legal
Contact
Links
 

DocFlex/XML - XSDDoc - Parameters

About XSDDoc parameters

Parameter Tree


“Navigation” parameter group

This group of parameter controls the generation of the frameset and various navigation lists used in Framed HTML Documentation.

Parameter/Group

Name / Type / Description

Overview Frame

nav.overviewFrame : boolean

Specify whether to generate the Overview Frame, which contains the primary navigation lists (such as the lists of namespaces and XML schemas that have been documented).

This might be more important for big XML schema projects (with multiple schemas/namespaces). For a small XML schema or when you generate some specialized documentation, you may find that the Overview Frame is redundant.

Title

nav.overviewFrame.title : string

Specify the title to be placed at the top of the Overview Frame.

Note: The text specified with this parameter may contain HTML tags, which will be rendered with the corresponding formatting. Check also that “Render embedded HTML” option of the destination HTML output format is set for this! (It can be specified in the generator dialog.)

Default Value:

Copied from the value of Documentation Title parameter.
See Also Parameters:

List Frame

nav.listFrame : enum {"allcomps", "namespace", "schema"}

This parameter allows you to customize the initial content of the List Frame, which is used to display one of the second-level navigation pages associated with a particular selection in the Overview Frame.

Possible Choices:

"All Components"
Load the first the All Components page with the list of all global components and local elements defined throughout all XML schemas being documented.

Using the “Navigation | List Frame | All Components” parameters, you can customize precisely what is included in that list (as well as how it is sorted).

"Namespace"
This selection causes loading the first a Namespace Navigation Page with the list of all schemas and all components that target/belong to one of the documented namespaces.

There may be several such pages, a separate page for each namespace. The loaded will be loaded one, which has been generated the first. This is controlled by the “Generate Details | Sorting | Namespaces” parameter.

"Schema"
This selection causes loading the first a Schema Navigation Page with the list of the components defined in one of the documented XML schemas.

There may be several such pages, a separate page for each XML schema. The loaded will be one, which has been generated the first. This is controlled by the “Generate Details | Sorting | Schemas” parameter.

Note:
When the specified navigation page is not available (has not been generated), by default, the initially loaded document is chosen according to the following priority list:
  1. All Components
  2. Namespace
  3. Schema
Nested Parameters:
Control the generation and content of particular navigation pages loaded in the List Frame.

Table of Contents

nav.listFrame.toc : boolean

Specify whether to generate the Table of Contents box at the top of on each navigation page.

This box includes the links to all list groups, which allow you to quickly jump to any group, particularly when there are lots of items.

All Components

nav.listFrame.allcomps : boolean

Specify whether to generate the All Components navigation page.

Nested Parameters:

Control the generation of the page content (see below).

Link To

nav.listFrame.allcomps.linkTo : enum {"details", "xml_source"}

With this parameter you can choose the destination of the component hyperlinks.

Possible Choices:

"Component Details"
All component hyperlinks will go to the component details, which are the Component Documentation pages generated for each component.
"XML Source"
In this case, each component hyperlink will be directed to the definition of this component within the reproduced full XML schema source.

That effectively will allow you to use the component list as an index to your XML schema source.

Note that the full XML schema source is reproduced on the Schema Overview page.

Notes:
  • When a particular hyperlink destination corresponding to this parameter setting does not exist (has not been generated), an alternative destination will be tried (e.g. the component's XML source instead of the Component Documentation and vice-versa).
  • All pages loaded by the component hyperlinks will be targeted to the Detail Frame.

Sorting

nav.listFrame.allcomps.sorting : boolean

With this parameter you can specify the sorting order of components (within each component type group).

The exact meaning of this parameter is the same as of “Generate Details | Sorting | Components” parameter, from which it also inherits its default value.

Elements
Local Elements
Complex Types
Simple Types
Element Groups
Global Attributes
Attribute Groups

nav.listFrame.allcomps.elements : boolean
nav.listFrame.allcomps.element.local : enum {"all", "complexType", "none"}
nav.listFrame.allcomps.complexTypes : boolean
nav.listFrame.allcomps.simpleTypes : boolean
nav.listFrame.allcomps.groups : boolean
nav.listFrame.allcomps.attributes : boolean
nav.listFrame.allcomps.attributeGroups : boolean

Specify whether to include in the list the components of particular types.

Note:

The default values of these parameters are copied dynamically from the values of the respective parameters in “Generate Details” group (e.g. “Generate Details | Elements”).

Namespace

nav.listFrame.namespace : boolean

Specify whether to generate Namespace navigation pages.

Nested Parameters:

Control the generation of the page content (see below).

Link To

nav.listFrame.namespace.linkTo : enum {"details", "xml_source"}

With this parameter you can choose the destination of the component hyperlinks.

For details, see parameter: All Components | Link To

Sorting

nav.listFrame.namespace.sorting : boolean

With this parameter you can specify the sorting order of components (within each component type group).

The exact meaning of this parameter is the same as of “Generate Details | Sorting | Components” parameter, from which it also inherits its default value.

Schemas

nav.listFrame.namespace.schemas : boolean

Specify whether all documented XML schemas targeting the given namespace must be listed in the namespace navigation frame.

Elements
Local Elements
Complex Types
Simple Types
Element Groups
Global Attributes
Attribute Groups

nav.listFrame.namespace.elements : boolean
nav.listFrame.namespace.element.local : enum {"all", "complexType", "none"}
nav.listFrame.namespace.complexTypes : boolean
nav.listFrame.namespace.simpleTypes : boolean
nav.listFrame.namespace.groups : boolean
nav.listFrame.namespace.attributes : boolean
nav.listFrame.namespace.attributeGroups : boolean

Specify whether to include in the list the components of particular types.

Note:

The default values of these parameters are copied dynamically from the values of the respective parameters in “Generate Details” group (e.g. “Generate Details | Elements”).

Schema

nav.listFrame.schema : boolean

Specify whether to generate Schema navigation pages.

Nested Parameters:

Control the generation of the page content; similar to “All Components” parameter group.

Detail Frame

nav.detailFrame : enum {"overview", "allcomps", "namespace", "schema"}

This parameter allows you to customize the initial content of the Detail Frame, which is used to display the actual documentation content.

Possible Choices:

"Overview Summary"
Load the first the Overview Summary page.
"All Component Summary"
Load the first the All Component Summary page.
"Namespace Overview"
This selection will cause loading the first some of the Namespace Overview pages.

The documentation may contain several such pages -- a separate page for each namespace. Among them the one will be loaded which has been generated the first. This is controlled by the “Generate Details | Sorting | Namespaces” parameter.

"Schema Overview"
This selection will cause loading the first some of the Schema Overview pages.

The documentation may contain several such pages -- a separate page for each XML schema. Among such pages the one will be loaded which has been generated the first. This is controlled by the “Generate Details | Sorting | Schemas” parameter.

Note:
When the specified page is not available (has not been generated), by default, the initially loaded document is chosen according to the following priority list:
  1. Overview Summary
  2. All Component Summary
  3. Namespace Overview
  4. Schema Overview
  5. Component Documentation
  6. Namespace Bindings Report

Copyright© 2003-2014 Filigris Works, Leonid Rudy Softwareprodukte. All rights reserved.