FlexDoc/XML - XSDDoc - Parameter Tree

Specify whether to generate hyperlink titles.

In HTML, hyperlink titles are specified using title attribute, like this:

<a ... title="link tooltip text"> ... </a>

Related Templates:

componentLinkTitle.tpl, schemaLinkTitle.tpl

Specify whether the component link title (tooltip) will include the name of the component. This will look as on the screenshot:

When a hyperlink appears on a schema component name, it would be helpful to use the link tooltip to quickly see what a namespace this component belongs to.

This might be particularly useful when the XML schemas you document define many components with equal local names, however, in different namespaces and no prefixes are defined for those namespaces at that.

Specify whether to show in the component link title (tooltip) some information about the component's definition/declaration location.

Specify whether to show in the component link title (tooltip) the information about the parent component, in which the given local element or attribute is declared, as shown on the following screenshot:

Specify whether the component link title (tooltip) will include the name of the XML schema file, where the component is defined.

For global components, that will add a text like this:

defined in XMLSchema.xsd

Specify whether to show the location of schema source files (or URLs)

schemaProfile.tpl

Specify whether to display the schema location as relative pathname.

When this parameter is selected (true) and the schema file resides on the local system, the file pathname will be converted to a relative one against the documentation destination directory.

Specify whether to generate a hyperlink to the schema file.

When this parameter is selected (true), the schema location text will be hyperlinked to the actual schema file.

When the displayed schema location is a relative pathname, the hyperlink is generated relatively to the location of the given document file. Otherwise, the hyperlink is generated to an absolute URL either on the local system or remote one.

Specify whether to add namespace prefixes to any XML names appearing in the generated documentation.

Example:

Suppose you generate documentation for two XML schemas: schema1 and schema2.

The schema1 is targeted to the namespace associated with 'namespace_uri_1' URI, which is bound to 'myns' prefix. This schema defines some MyType type component.

The schema2 is targeted to a different namespace, however, it also uses MyType, which it imports from the schema1. To reference to that type, the schema2 binds the 'namespace_uri_1' to the prefix 'ns1', so MyType looks in it as:

ns1:MyType

In the parts of the documentation related to schema1 you will see:

myns:MyType

ns1:MyType

Specify whether to generate extensions of local element names.

The extended name of a local element is made of its normal name extended with some short info about the possible element use, type or its definition location. For example:

configuration (in plugin in plugins in reporting)
xs:complexType (type xs:localComplexType)
xs:attribute (defined in group xs:attrDecls)

The name extension is needed to distinguish that element in the documentation from other local elements that share the same XML name.

Name extensions may be not necessary for local element with unique names. For instance, some XML schemas are designed (or generated) so that almost all element components are defined locally, except only the root element. At that, all element names may be unique. So, the name extensions are not really needed and will only overload the documentation.

Possible Choices:

"always"

Generate name extensions for all local elements.

Generate name extension only for local elements with non-unique names (i.e. whose XML names are shared by any other element components).

Do not generate the name extensions.

Adding extensions to local element names

elementNameExt.tpl

Specify how the name extension is generated.

The extensions of local element names are generated according to several rules applied in a certain priority. This parameter allows you to change that priority.

"use"

The extension text provides a hint, how the given element may be used:

• If the element is included in the content model of only one other element, that will be shown in the extension, e.g.:

  configuration (in plugin in plugins in reporting)

• If this is unification of local elements by type, that type will be shown in the extension

  plugin (type Plugin)

The extension text indicates where the element is defined, e.g.:

configuration (defined in complexType ReportPlugin)

If a local element is defined within another element, that will correspond to both the definition location and use, e.g.:

plugin (in plugins defined in complexType Reporting)

If this parameter is selected (true), the name extension text will be generated as concise as possible, with some auxiliary words omitted.

For example, with this parameter:

• Unselected (false)

  plugin (in plugins defined in complexType Reporting)

• Selected (true)

  plugin (in plugins defined in Reporting)

Specify whether to generate the About section added at the bottom of each generated document.

This section shows certain information about FlexDoc/XML software and XSDDoc template set.

Literal Input | Bottom Text

about.tpl