FlexDoc/XML - XSDDoc - Parameter Tree

Specify whether to generate the Overview Frame, which contains primary navigation lists (such as the lists of namespaces and XML schemas that have been documented). This might be more important for large XML schema projects (with multiple schemas/namespaces).

That may be more important for large 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 redundant.

Nested Parameters:

Control the Overview Frame content

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

The text specified with this parameter may contain HTML tags, which will be rendered with the corresponding formatting. See also: Using HTML markup in annotations

Provided by the parameter: Literal Input | Header Text

Specify whether to show the Overview item.

The item is linked to the Overview Summary page targeted to the Detail Frame.

Default Value:

Provided by the parameter: Generate Details | Overview

Specify whether to show the All Components item.

The item is linked to the All Components Navigation List targeted to the List Frame.

Default Value:

Derived from the values of the parameters:

• Generate Details | All Components
• Navigation | List Frame | All Components

Specify whether to show the Namespace Bindings item.

The item is linked to the XML Namespace Bindings page targeted to Detail Frame.

Default Value:

Provided by the parameter: Generate Details | XML Namespace Bindings

Specify whether to show the Search item.

The item is linked to the Search page targeted to Detail Frame.

Default Value:

Derived from the values of the parameters:

• Navigation | Search
• Navigation | Detail Frame | Navigation Bar

Specify whether to show the list of namespaces.

Each list item is linked to the corresponding Namespace Navigation List targeted to the List Frame.

Default Value:

Derived from the values of the parameters:

• Generate Details | Namespace
• Navigation | List Frame | Namespace

Specify whether to show the list of XML Schemas.

Each list item is linked to the corresponding Schema Navigation List targeted to the List Frame.

Default Value:

Derived from the values of the parameters:

• Generate Details | Schema
• Navigation | List Frame | 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. This includes:

• The list of all components
• The list of all schemas/components that target/belong to a particular namespace
• The list of components defined in a particular XML schema

"All Components"

Load the first the All Components Page.

This page lists all global components and local elements defined throughout all XML schemas being documented.

You can customize precisely what is included in that list (as well as how it is sorted) using the parameters: Navigation | List Frame | All Components

This selection causes a Namespace Navigation Page generated for one of the documented namespaces to be loaded the first.

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

The generation of Namespace Navigation pages is controlled by the parameter group: Navigation | List Frame | Namespace

This selection causes a Schema Navigation Page generated for one of the documented XML schemas to be loaded the first.

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 parameter: Generate Details | Sorting | Schemas

The generation of the Schema Navigation pages is controlled by the parameter group: Navigation | List Frame | Schema

When the specified component list (HTML 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

Control the generation and content of particular navigation lists loaded in the List Frame.

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.

This parameter specifies whether to generate the All Components navigation page.

This page lists all global components and local elements defined throughout all XML schemas being documented.

The component list is broken into separate groups according to component types (e.g. elements, complexTypes etc). Using corresponding nested parameters, you can specify the components of which types should be included in the list.

The sorting order of components within a type group is controlled by the "Sorting" nested parameter.

Default Value:

Copied from the value of the parameter:

• Generate Details | All Components

However, it will be also true when both parameters are false:

• Generate Details | Namespace
• Generate Details | Schema

all-components-frame.tpl

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

Possible Choices:

"Component Details"

All component hyperlinks will go to the component details, which are the Component Documentation pages generated for each component.

The generation of the Component Documentation is controlled by:

• The parameter group: Generate Details | Components
• The parameter group: Details | Component

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 either on the Schema Overview page or on a separate page. That is controlled by the parameter group: Details | Schema | XML Source

• 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 (see also the parameter group: Navigation | Detail Frame).

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 the parameter

Generate Details | Sorting | Components

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

Default Value:

Provided by the respective parameters in the group: Generate Details | Components

Specify whether to generate the navigation lists for namespaces.

Default Value:

Provided by the parameter: Generate Details | Namespace

Specify the list content

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

For details, see parameter: All Components | Link To

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 the parameter

Generate Details | Sorting | Components

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

Provided by the parameter: Generate Details | Schema

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

Default Value:

Provided by the respective parameters in the group: Generate Details | Components

Specify whether to generate the navigation lists for XML schemas.

Default Value:

Provided by the parameter: Generate Details | Schema

Specify the list content

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

Possible Choices:

"Overview"

First, load the Overview Summary page.

The generation of this page is controlled by parameters:

• Generate Details | Overview
• Details | Overview

Start with the All Component Summary page.

The generation of this page is controlled by parameters:

• Generate Details | All Components
• Details | All Components

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 that was generated the first. This is controlled by the parameter:

Generate Details | Sorting | Namespaces

The generation of Namespace Overview pages is controlled by parameters:

• Generate Details | Namespace
• Details | Namespace

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 that was generated the first. This is controlled by the parameter:

Generate Details | Sorting | Schemas

The generation of Schema Overview pages is controlled by parameters:

• Generate Details | Schema
• Details | Schema

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

Specify what is initially loaded into the Detail Frame, as well as other navigation features added to detail pages.

Specify whether to add the Detail Header to each detail page, as shown on this screenshot:

• Custom Logotype. Its presence is controlled by the nested parameter:

  Navigation | Detail Frame | Header | Logotype

  where you can read how to change it.
• Header Title, which is specified with the parameter:

  Literal Input | Header Title

• Header Text, which is specified with the parameter:

  Literal Input | Header Text

nav-top.tpl

Specify whether to display the custom Logotype on the left of the Detail Header (see on the screenshot above).

The logotype image is loaded from the file:

{flexdoc-xml}/XSDDoc/templates/lib/images/logo.png

Specify whether to add the Navigation Bar to each detail page (see on the screenshot above).

The Navigation Bar contains links to some important pages as well as the dynamic Search-Box. It is displayed both at the top at bottom of each detail page.

Navigation | Search

nav-bar.tpl, nav-top.tpl, nav-bottom.tpl

Specify whether to generate the dynamic search functionality as shown on the following screenshot (click to view in full size):

• The interactive search-box embedded in the navigation bar.
• Search indices
• Search Help page that both explains the search queries and shows some search index statistics.
• Javascript files implementing the dynamic search functionality.
  The dynamic search-box is implemented using JQuery UI. So, jQuery library files are also copied into the generated documentation.

The schema components are index by their names, which may include namespace prefixes, e.g.:

xs:schema

or

xsd:schema

The prefix helps to distinguish which namespace the component belongs to. That may be important when several XML schemas targeting different namespaces are documented together. The presence of namespace prefixes in the component names does not impair the dynamic search.

Whether the namespace prefixes is added to the component name is controlled by the parameter: Show | Namespace Prefixes

Specify which XML schema components are indexed.

search.tpl

Specify whether to index element components (both global and local ones).

Default Value:

By default, this parameter is true when there are documented elements anywhere. That is, either of the following parameters is selected:

• Generate Details | Components | Elements
• Details | Component |
  • Content Model | Table Representation | Content Elements
  • Content Element Detail

Specify whether to index attribute components (both global and local ones).

Default Value:

By default, this parameter is true when there are documented attributes. That is, either of the following parameters is selected:

• Generate Details | Components | Global Attributes
• Details | Component |
  • Content Model | Table Representation | Attributes
  • Attribute Detail

Specify whether to index global (named) components of particular types.

Default Value:

Provided by the respective parameters in the group: Generate Details | Components