FlexDoc/XML - XSDDoc - Templates

Subtemplates

The actual documentation content is generated by subtemplates, which are called both from the main templates and from each other. All subtemplates are found in {XSDDoc}/lib directory and its subdirectories.

Subtemplates are normal FlexDoc/XML templates. However, they are typically not designed to run directly from the generator as the main templates – that will cause an error or produce meaningless output.

Below is the summary of all subtemplates by directories:
Directory/Template Description
[lib] general-purpose subtemplates
about.tpl Adds the «About» section at the bottom of each separate output document.
Called From:
nav-bottom.tpl, SingleDoc.tpl
Related Parameter:
Show | About (footer)
init.tpl This template produces no output. Instead, it is called only once from either FramedDoc.tpl or SingleDoc.tpl main templates before any other processing starts. The template's job is to load all XML schema files to be processed/documented (including those references from them directly or indirectly) and to create all necessary element maps, which are essentially hash-maps. Element maps allow you to resolve very complicated queries. They are used in almost everywhere in XSDDoc template set (including even in init.tpl itself) and are critical for working of everything.
Called From:
FramedDoc.tpl, SingleDoc.tpl
nav-bar.tpl Generates the navigation bar.

Called From:

nav-bottom.tpl, nav-top.tpl
Related Parameter:
Navigation | Detail Frame | Navigation Bar
nav-bottom.tpl Generates the bottom of each detail page of framed HTML documentation, which may include:
  • Navigation bar
  • Bottom Text
  • About section
Calls:
about.tpl, nav-bar.tpl
Called From:
all-components.tpl, attributeGroup.tpl, complexType.tpl, element.tpl, globalAttribute.tpl, group.tpl, namespace.tpl, overview.tpl, schema-source.tpl, schema.tpl, search.tpl, simpleType.tpl, xmlns-bindings.tpl
Related Parameters:
nav-top.tpl Generates the top of each detail page of framed HTML documentation, which may include:
  • Detail Header
  • Navigation bar
Calls:
nav-bar.tpl
Called From:
all-components.tpl, attributeGroup.tpl, complexType.tpl, element.tpl, globalAttribute.tpl, group.tpl, namespace.tpl, overview.tpl, schema-source.tpl, schema.tpl, search.tpl, simpleType.tpl, xmlns-bindings.tpl
Related Parameters:
overview-frame.tpl Generates the HTML document loaded in the Overview Frame, which contains the primary navigation lists (such as the lists of namespaces and XML schemas that have been documented).

Calls:

schemaLinkTitle.tpl
Called From:
FramedDoc.tpl
Related Parameter:
Navigation | Overview Frame
overview.tpl Generates the «Overview Summary» documentation page/block.

Calls:

all-components.tpl, HTMLHeadSetup.tpl, namespaceSummary.tpl, nav-bottom.tpl, nav-top.tpl, schemaSummary.tpl, text.tpl, xhtmlHeadContent.tpl
Called From:
FramedDoc.tpl, SingleDoc.tpl
Related Parameters:
title-page.tpl Generates the Title Page in single-file documentation.

Called From:

SingleDoc.tpl
Related Parameter:
TOC.tpl Generates the Table Of Contents in single-file documentation.

Calls:

componentName.tpl, schemaLinkTitle.tpl
Called From:
SingleDoc.tpl
Related Parameter:
[lib/attribute] subtemplates related to documenting attribute components (those specified in XML schema with <xs:attribute> elements)
attributes.tpl Generates the «Global Attributes» section of single-file documentation.

Calls:

globalAttribute.tpl
Called From:
namespace.tpl
Related Parameter:
Generate Details | Components | Global Attributes
contentAttributes.tpl Generates «Attribute Detail» section of the Component Documentation, which provides the most detailed information about each attribute (and attribute wildcard) found in the XSD component's content model.

Calls:

annotation.tpl, componentLinkTitle.tpl, componentName.tpl, facet.tpl, nodeSource.tpl, simpleContentDerivation.tpl, simpleContentRep.tpl, sourceNote.tpl, typeDerivationSummary.tpl, typeDerivationTree.tpl, wildcard.tpl
Called From:
attributeGroup.tpl, complexType.tpl, element.tpl
Related Parameters:
Details | Component | Attribute Detail
globalAttribute.tpl Generates «Component Documentation» pages/blocks for global attributes.

Calls:

annotation.tpl, componentName.tpl, elementList.tpl, elementNameExt.tpl, facet.tpl, globalAttributeProfile.tpl, HTMLHeadSetup.tpl, nav-bottom.tpl, nav-top.tpl, nodeSource.tpl, simpleContentDerivation.tpl, sourceNote.tpl, typeDerivationTree.tpl, xmlRep.tpl
Called From:
attributes.tpl, FramedDoc.tpl
Related Parameters:
globalAttributeProfile.tpl Generates «Component Profile» section for global attributes

Calls:

componentLinkTitle.tpl, schemaName.tpl, typeDerivationSummary.tpl
Called From:
globalAttribute.tpl, globalAttributeSummary.tpl
Related Parameters:
globalAttributeSummary.tpl Generates «Global Attribute Summary» sections.

Calls:

annotationText.tpl, componentName.tpl, globalAttributeProfile.tpl
Called From:
all-components.tpl, namespace.tpl, schema.tpl
Related Parameters:
[lib/component] subtemplates involved in documenting of all types of components
all-components-frame.tpl Generates «All Components» navigation page loaded in the List Frame.

Calls:

componentName.tpl, elementListNote.tpl
Called From:
FramedDoc.tpl
Related Parameter:
Navigation | List Frame | All Components
all-components.tpl Generates «All Component Summary» page/block.

Calls:

attributeGroupSummary.tpl, complexTypeSummary.tpl, elementSummary.tpl, globalAttributeSummary.tpl, groupSummary.tpl, HTMLHeadSetup.tpl, nav-bottom.tpl, nav-top.tpl, simpleTypeSummary.tpl
Called From:
FramedDoc.tpl, overview.tpl, SingleDoc.tpl
Related Parameter:
componentLinkTitle.tpl Generates the text specified as title (tooltip) of component hyperlink. This provides addition information about the component, which can be easily seen by moving the mouse cursor over the component name.

Calls:

componentName.tpl
Called From:
complexContentModel.tpl, componentName.tpl, contentAttributes.tpl, contentElementList.tpl, contentElements.tpl, diagram.tpl, elementNameExt.tpl, elementProfile.tpl, globalAttributeProfile.tpl, simpleContentDerivation.tpl, simpleContentRep.tpl, substitutionGroupInfo.tpl, tableRep.tpl, typeDerivationSummary.tpl, typeDerivationTree.tpl, typeRefs.tpl, typeRelatedComps.tpl, xmlRep.tpl
Related Parameter:
Show | Link Titles (Tooltips)
componentName.tpl Generates the full name of a component, under which it appears in various lists and references. This includes:
  • The name specified for that component in the XML schema
  • The namespace prefix representing the component's namespace and most relevant to the given documentation location
  • The hyperlink to the documentation location most detaily describing that component
  • Any extension of the component name with its own hylerlinks (see “Adding extensions to local element names” and “Documenting of redefinitions”)

Calls:

componentLinkTitle.tpl, elementNameExt.tpl
Called From:
all-components-frame.tpl, attributeGroup.tpl, attributeGroupSummary.tpl, complexTypeSummary.tpl, componentLinkTitle.tpl, contentAttributes.tpl, contentElements.tpl, element.tpl, elementList.tpl, elementProfile.tpl, elements.tpl, elementSummary.tpl, FramedDoc.tpl, globalAttribute.tpl, globalAttributeSummary.tpl, group.tpl, groupSummary.tpl, namespace-frame.tpl, schema-frame.tpl, search-indexes.tpl, simpleTypeSummary.tpl, tableRep.tpl, TOC.tpl, typeRefs.tpl, typeRelatedComps.tpl
Related Parameter:
[lib/content] Subtemplates that generate various information and representations of the XML element content described by a given XSD component
complexContentModel.tpl Generates «Content Element Model» sections within XML Representation Summary

Calls:

componentLinkTitle.tpl, wildcard.tpl
Called From:
xmlRep.tpl
contentType.tpl Generates a short description of the content represented by an element or complexType component, e.g.: simple, complex, mixed, empty

Called From:

contentElements.tpl, elementProfile.tpl, typeProfile.tpl
Related Parameters:
facet.tpl Generates «Facet Documentation» section.

Calls:

annotation.tpl
Called From:
complexType.tpl, contentAttributes.tpl, contentElements.tpl, element.tpl, globalAttribute.tpl, simpleContentDerivation.tpl, simpleType.tpl
Related Parameters:
simpleContentDerivation.tpl Generates a section that shows how a simple content was derived, like on the following screenshot:

Calls:
annotation.tpl, componentLinkTitle.tpl, facet.tpl
Called From:
complexType.tpl, contentAttributes.tpl, contentElements.tpl, element.tpl, globalAttribute.tpl, simpleType.tpl
Related Parameters:
simpleContentRep.tpl Generates a short representation of simple content, like the following:
list of (xs:anyURI | ("##targetNamespace" | "##local"))
Calls:
componentLinkTitle.tpl
Called From:
contentAttributes.tpl, contentElements.tpl, tableRep.tpl, xmlRep.tpl
Related Parameters:
tableRep.tpl Generates the Table Representation of component content model.

Calls:

annotationText.tpl, componentLinkTitle.tpl, componentName.tpl, simpleContentRep.tpl, typeDerivationSummary.tpl, wildcard.tpl
Called From:
attributeGroup.tpl, attributeGroupSummary.tpl, complexType.tpl, complexTypeSummary.tpl, contentElements.tpl, element.tpl, elementSummary.tpl, group.tpl, groupSummary.tpl
Related Parameters:
wildcard.tpl Generates a textual representation of an element/attribute wildcard (specified in XML schema with <xs:any> and <xs:anyAttribute> elements). That is used in Called From:
attributeGroupProfile.tpl, complexContentModel.tpl, contentAttributes.tpl, contentElementList.tpl, contentElements.tpl, diagram.tpl, elementProfile.tpl, groupProfile.tpl, tableRep.tpl, typeProfile.tpl, xmlRep.tpl
xmlRep.tpl Generates the XML Representation Summary

Calls:

complexContentModel.tpl, componentLinkTitle.tpl, simpleContentRep.tpl, wildcard.tpl
Called From:
attributeGroup.tpl, complexType.tpl, contentElements.tpl, element.tpl, globalAttribute.tpl, group.tpl, simpleType.tpl
Related Parameters:
[lib/description] Subtemplates that convert the text data found in the source XML files into the descriptions placed in the documentation.
annotation.tpl Generates all «Description» sections whose content comes from the <xs:annotation> elements found in XML schema. That includes the processing of any XHTML markup specified within XML schema annotations.

Calls:

documentSource.tpl, text.tpl
Called From:
attributeGroup.tpl, complexType.tpl, contentAttributes.tpl, contentElements.tpl, element.tpl, facet.tpl, globalAttribute.tpl, group.tpl, schema.tpl, simpleContentDerivation.tpl, simpleType.tpl
Related Parameters:
annotationText.tpl Generates the description text equally obtained from <xs:annotation> elements, however, used only in various summary tables depending on particular template parameters:
  • Only the first sentence may be retrieved and displayed from the whole text
  • The XHTML markup specified in XSD annotation may be rendered, however, in a flattened form with all HTML block-tags and images removed.
Calls:
text.tpl, textFS.tpl
Called From:
attributeGroupSummary.tpl, complexTypeSummary.tpl, DiagramKit.tpl, elementSummary.tpl, globalAttributeSummary.tpl, groupSummary.tpl, schemaSummary.tpl, simpleTypeSummary.tpl, tableRep.tpl
Related Parameters:
text.tpl Renders the text data specifed in the raw XML source into the full description placed in the generated documentation. That includes also the processing of any XHTML markup specified along with the text. The images specified in the XML source with <img> elements are equally copied/inserted into the output documentation.

Called From:

annotation.tpl, annotationText.tpl, overview.tpl
Related Parameters:
textFS.tpl This template does the same as text.tpl. However, its output is more suitable for extracting the first sentence (to be placed in summary table). For instance, when the processing of XHTML markup is enabled, all images are removed and spaces collapsed (particularly within <pre> tags).

Called From:

annotationText.tpl
xhtmlHeadContent.tpl When a description comes from an XHTML file, that file may contain both embedded CSS stylesheet and references to external CSS files. That everything should be copied into the generated HTML documentation along with the output file, where that description is inserted. That's what this template does.

Called From:

overview.tpl, SingleDoc.tpl,
Related Parameters:
Literal Input | General Description | File
[lib/diagramming] subtemplates related to the generation of diagrams
diagram.tpl Generates «Component Diagram» sections

Calls:

componentLinkTitle.tpl, typeDerivationSummary.tpl, wildcard.tpl
Called From:
attributeGroup.tpl, complexType.tpl, element.tpl, group.tpl
Related Parameters: See Also:
FlexDoc/XML | Features | Insertion of images | Element Images
DiagramKit.tpl DiagramKit service template.
DiagramKit is a diagramming engine that generates graphical diagrams of XML schema components. Those diagrams are integrated into the output documentation by the diagram.tpl template.

However, DiagramKit does not parse XML schema files on its own. Rather, it must be provided with the structured data about the XSD component via a special API exposed to templates via special FlexQuery functions and properties.

That's what this template does. It loads the DiagramKit with all the data necessary to generate diagrams.

Calls:
annotationText.tpl
Called From:
FramedDoc.tpl, SingleDoc.tpl
Related Parameters:
DiagramKit
[lib/element] subtemplates related to documenting element components (those specified in XML schema with <xs:element> elements)
contentElementList.tpl Generates the «List of Content Elements» section of Component Documentation

Calls:

componentLinkTitle.tpl, elementNameExt.tpl, wildcard.tpl
Called From:
element.tpl, group.tpl, typeRelatedComps.tpl
Related Parameters:
Details | Component | Related Components | Content Elements
contentElements.tpl Generates «Content Element Detail» section of Component Documentation, which provides the most detailed information about each child element (and element wildcard) found in the XSD component's content model.

Calls:

annotation.tpl, componentLinkTitle.tpl, componentName.tpl, contentElements.tpl, contentType.tpl, elementBlockAttrInfo.tpl, elementFinalAttrInfo.tpl, elementList.tpl, facet.tpl, nodeSource.tpl, simpleContentDerivation.tpl, simpleContentRep.tpl, sourceNote.tpl, substitutionGroupInfo.tpl, tableRep.tpl, typeDerivationSummary.tpl, typeDerivationTree.tpl, wildcard.tpl, xmlRep.tpl
Called From:
complexType.tpl, contentElements.tpl, element.tpl, group.tpl,
Related Parameters:
Details | Component | Content Element Detail
element.tpl Generates «Component Documentation» pages/blocks for elements.

Calls:

annotation.tpl, componentName.tpl, contentAttributes.tpl, contentElementList.tpl, contentElements.tpl, diagram.tpl, elementList.tpl, elementNameExt.tpl, elementProfile.tpl, facet.tpl, HTMLHeadSetup.tpl, nav-bottom.tpl, nav-top.tpl, nodeSource.tpl, simpleContentDerivation.tpl, sourceNote.tpl, tableRep.tpl, typeDerivationTree.tpl, xmlRep.tpl
Called From:
elements.tpl, SingleDoc.tpl
Related Parameters:
elementBlockAttrInfo.tpl Generates «Block» section in profiles of global elements, which comes from the value of 'block' attribute specified in <xs:element> elements.

Called From:

contentElements.tpl, elementProfile.tpl
Related Parameters:
elementFinalAttrInfo.tpl Generates «Final» section in profiles of global elements, which comes from the value of 'final' attribute specified in <xs:element> elements.

Called From:

contentElements.tpl, elementProfile.tpl
Related Parameters:
elementList.tpl Generates a list of some element components (typically related to an XSD component being documented) in various styles (flow, one column, two columns, optimal).

Calls:

componentName.tpl, elementNameExt.tpl
Called From:
contentElements.tpl, element.tpl, globalAttribute.tpl
Related Parameters:
elementListNote.tpl Generates a subheading of element lists or summaries, which explains the scope of listed elements (e.g. «global + local with complex types» or «local elements unified by type»)

Called From:

all-components-frame.tpl, elements.tpl, elementSummary.tpl, namespace-frame.tpl, schema-frame.tpl
Related Parameter:
Generate Details | Components | Elements | Local Elements
elementNameExt.tpl Generates the extensions of names of some local elements (with its own hylerlinks).

Calls:

componentLinkTitle.tpl
Called From:
attributeGroup.tpl, componentName.tpl, contentElementList.tpl, element.tpl, elementList.tpl, FramedDoc.tpl, globalAttribute.tpl, group.tpl, search-indexes.tpl, SingleDoc.tpl, typeRefs.tpl, typeRelatedComps.tpl
Related Parameter:
Show | Element Name Extensions
See Also:
Adding extensions to local element names
elementProfile.tpl Generates «Component Profile» section for element components.

Calls:

componentLinkTitle.tpl, componentName.tpl, contentType.tpl, elementBlockAttrInfo.tpl, elementFinalAttrInfo.tpl, schemaName.tpl, substitutionGroupInfo.tpl, typeDerivationSummary.tpl, wildcard.tpl
Called From:
element.tpl, elementSummary.tpl
Related Parameters:
elements.tpl Generates the «Elements» section of single-file documentation.

Calls:

element.tpl
Called From:
namespace.tpl
Related Parameter:
Generate Details | Components | Elements
elementSummary.tpl Generates «Element Summary» sections.

Calls:

annotationText.tpl, componentName.tpl, elementListNote.tpl, elementProfile.tpl, tableRep.tpl
Called From:
all-components.tpl, namespace.tpl, schema.tpl
Related Parameters:
substitutionGroupInfo.tpl Generates «Subst.Gr» section in profiles of global elements, which shows the summary info about the involvement of the element in substitution groups:
  • The list of substitution groups, which this element is affiliated to.
  • The number of known elements (or the name of the element if it is only one) which may substitute for this element.
That information comes from the value of 'substitutionGroup' attribute specified in <xs:element> elements.

Calls:

componentLinkTitle.tpl
Called From:
contentElements.tpl, elementProfile.tpl
Related Parameters: See Also:
Documenting of substitution groups
[lib/groups] subtemplates related to documenting global element/attribute group components (those specified in XML schema with <xs:group>/<xs:attributeGroup> elements)
attributeGroup.tpl Generates «Component Documentation» pages/blocks for attribute groups.

Calls:

annotation.tpl, attributeGroupProfile.tpl, componentName.tpl, contentAttributes.tpl, diagram.tpl, elementNameExt.tpl, HTMLHeadSetup.tpl, nav-bottom.tpl, nav-top.tpl, nodeSource.tpl, sourceNote.tpl, tableRep.tpl, xmlRep.tpl
Called From:
attributeGroups.tpl, FramedDoc.tpl
Related Parameters:
attributeGroupProfile.tpl Generates «Component Profile» section for attribute groups

Calls:

schemaName.tpl, wildcard.tpl
Called From:
attributeGroup.tpl, attributeGroupSummary.tpl
Related Parameters:
attributeGroups.tpl Generates the «Attribute Groups» section of single-file documentation.

Calls:

attributeGroup.tpl
Called From:
namespace.tpl
Related Parameter:
Generate Details | Components | Attribute Groups
attributeGroupSummary.tpl Generates «Attribute Group Summary» sections.

Calls:

annotationText.tpl, attributeGroupProfile.tpl, componentName.tpl, tableRep.tpl
Called From:
all-components.tpl, namespace.tpl, schema.tpl
Related Parameters:
group.tpl Generates «Component Documentation» pages/blocks for element groups.

Calls:

annotation.tpl, componentName.tpl, contentElementList.tpl, contentElements.tpl, diagram.tpl, elementNameExt.tpl, groupProfile.tpl, HTMLHeadSetup.tpl, nav-bottom.tpl, nav-top.tpl, nodeSource.tpl, sourceNote.tpl, tableRep.tpl, xmlRep.tpl
Called From:
FramedDoc.tpl, groups.tpl
Related Parameters:
groupProfile.tpl Generates «Component Profile» section for element groups

Calls:

schemaName.tpl, wildcard.tpl
Called From:
group.tpl, groupSummary.tpl
Related Parameters:
groups.tpl Generates the «Element Groups» section of single-file documentation.

Calls:

group.tpl
Called From:
namespace.tpl
Related Parameter:
Generate Details | Components | Element Groups
groupSummary.tpl Generates «Element Group Summary» sections.

Calls:

annotationText.tpl, componentName.tpl, groupProfile.tpl, tableRep.tpl
Called From:
all-components.tpl, namespace.tpl, schema.tpl
Related Parameters:
[lib/images] contains icons used in XML schema documentation
[lib/namespace] subtemplates related to documenting namespaces
namespace-frame.tpl Generates Namespace Navigation Pages loaded in the List Frame.

Calls:

componentName.tpl, elementListNote.tpl, schemaName.tpl
Called From:
FramedDoc.tpl
Related Parameters:
Navigation | List Frame | Namespace
namespace.tpl Generates «Namespace Overview» page/block.

Calls:

attributeGroups.tpl, attributeGroupSummary.tpl, attributes.tpl, complexTypes.tpl, , elements.tpl, elementSummary.tpl, globalAttributeSummary.tpl, groups.tpl, groupSummary.tpl, HTMLHeadSetup.tpl, namespaceProfile.tpl, nav-bottom.tpl, nav-top.tpl, schemaSummary.tpl, simpleTypes.tpl, simpleTypeSummary.tpl
Called From:
FramedDoc.tpl, SingleDoc.tpl
Related Parameters:
namespaceProfile.tpl Generates «Namespace Profile» sections

Calls:

schemaName.tpl
Called From:
namespace.tpl, overview.tpl
Related Parameters:
namespaceSummary.tpl Generates «Namespace Summary» section.

Calls:

namespaceProfile.tpl
Called From:
overview.tpl
Related Parameter:
Details | Overview | Namespace Summary
[lib/schema] subtemplates related to documenting particular XML schema files (as a whole)
schema-frame.tpl Generates Schema Navigation Pages loaded in the List Frame.

Calls:

componentName.tpl, elementListNote.tpl, schemaName.tpl
Called From:
FramedDoc.tpl
Related Parameter:
Navigation | List Frame | Schema
schema-source.tpl Generates «Schema XML Source» pages/blocks

Calls:

documentSource.tpl, HTMLHeadSetup.tpl, nav-bottom.tpl, nav-top.tpl, sourceNote.tpl
Called From:
FramedDoc.tpl, schema.tpl
Related Parameters:
Details | Schema | XML Source
schema.tpl Generates «Schema Overview» pages/blocks

Calls:

annotation.tpl, attributeGroupSummary.tpl, complexTypeSummary.tpl, elementSummary.tpl, globalAttributeSummary.tpl, groupSummary.tpl, HTMLHeadSetup.tpl, nav-bottom.tpl, nav-top.tpl, schema-source.tpl, schemaProfile.tpl, simpleTypeSummary.tpl
Called From:
FramedDoc.tpl, SingleDoc.tpl
Related Parameters:
schemaLinkTitle.tpl Generates the text specified as title (tooltip) of XML schema hyperlink. This provides addition information about the schema, which can be easily seen by moving the mouse cursor over the schema link.

Called From:

overview-frame.tpl, schemaName.tpl, TOC.tpl
Related Parameters:
Show | Link Titles (Tooltips)
schemaName.tpl Generates XML schema name, under which that schema appears in various lists and references. This includes also the hyperlink to «Schema Overview».

Calls:

schemaLinkTitle.tpl
Called From:
attributeGroupProfile.tpl, elementProfile.tpl, globalAttributeProfile.tpl, groupProfile.tpl, namespace-frame.tpl, namespaceProfile.tpl, schema-frame.tpl, schemaProfile.tpl, schemaSummary.tpl, typeProfile.tpl
schemaProfile.tpl Generates «Schema Profile» sections

Calls:

schemaName.tpl
Called From:
schema.tpl, schemaSummary.tpl
Related Parameters:
schemaSummary.tpl Generates «Schema Summary» sections.

Calls:

annotationText.tpl, schemaName.tpl, schemaProfile.tpl
Called From:
namespace.tpl, overview.tpl
Related Parameters:
[lib/search] Subtemplates related to the dynamic search functionality.

Related Parameters:

Navigation | Search
category-index.tpl Generates a search index for a particular search category, which may be one of the following:
  • Elements – all global and local XSD element components
  • Attributes – all global and local XSD attribute components
  • Complex Types – global (named) XSD complex types
  • Simple Types – global (named) XSD simple types
  • Groups – global (named) XSD element groups
  • Attribute Groups – global (named) XSD attribute groups
Each search index is a JavaScript array, whose elements represent the index entries. An entry consists of
  • One or several keywords, by which the entry can be found
  • The target that identifies the location within the documentation linked to the entry
Ultimately, the target is translated into an ordinary local URL within the HTML documentation. However, since such URLs are rather long, in order to compactify the index, the URLs themselves are kept separately in the two-dimensional search targets array. In the index entry, the actual target is represented by two indexes in that array.
Called From:
search-indexes.tpl
Related Parameters:
HTMLHeadSetup.tpl Generates a fragment of the HTML header that calls all JavaScript and CSS files necessary for dynamic search functionality (the search-box), which typically looks as follows:
<link rel="stylesheet" type="text/css" href="search/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="search/search.css" title="Style">
<script type="text/javascript" src="search/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="search/jquery-ui.min.js"></script>
<script type="text/javascript" src="search/init.js"></script>
Called From:
all-components.tpl, attributeGroup.tpl, complexType.tpl, element.tpl, globalAttribute.tpl, group.tpl, namespace.tpl, overview.tpl, schema-source.tpl, schema.tpl, search.tpl, simpleType.tpl, xmlns-bindings.tpl
init_js.tpl Generated the init.js JavaScript file, whose job is to setup the search index. In particular, it loads all special JavaScripts that contain the index data: The init.js is called from every generated HTML document that displays the search-box.

Called From:

search.tpl
search-indexes.tpl Generated the search-indexes.js file that contains all search indexes.

Calls:

category-index.tpl, componentName.tpl, elementNameExt.tpl
Called From:
search.tpl
search-targets.tpl Generated the search-targets.js file that contains the JavaScript representation of the search-targets array.
That array encodes all local URLs of the documentation locations referenced by search index entries. The array is effectively two dimensional. The first dimension (the primary array) lists all HTML files containing the targets. And for each HTML file, the second-dimension array lists the anchors of all targets found in that file. Thereby, a pair of integers allow you to fully reconstruct the corresponding local URL.
Called From:
search.tpl
search.tpl Generates the Search Page and calls from itself all other subtemplates that generated the dynamic search JavaScript framework.

Calls:

HTMLHeadSetup.tpl, init_js.tpl, nav-bottom.tpl, nav-top.tpl, search-indexes.tpl, search-targets.tpl
Called From:
FramedDoc.tpl
[lib/search/scripts] Contains the static JavaScript/CSS files and icons used to power the dynamic search functionality. All of these files are copied by the search.tpl template into the [search] folder of the generated framed HTML documentation:
  • search.js – the JavaScript implementation of the dynamic search and the functioning of the search-box. This file is loaded dynamically by the init.js script.
  • search.css – styles the search-box
  • glass.png – the icon that highlights the search-box
  • x.png – the icon for the search-box reset button
In addition to that, the JQuery UI library files:
  • jquery-3.6.1.min.js
  • jquery-ui.min.js
  • jquery-ui.min.css
are equally copied into the documentation [search] folder from the FlexDoc/XML resources: {flexdoc-xml}/lib/resources/jquery/
[lib/type] subtemplates related to documenting global (named) simple/complex types (those specified in XML schema with <xs:simpleType>/<xs:complexType> elements)
complexType.tpl Generates «Component Documentation» pages/blocks for complex types.

Calls:

annotation.tpl, contentAttributes.tpl, contentElements.tpl, diagram.tpl, facet.tpl, HTMLHeadSetup.tpl, nav-bottom.tpl, nav-top.tpl, nodeSource.tpl, simpleContentDerivation.tpl, sourceNote.tpl, tableRep.tpl, typeDerivationTree.tpl, typeProfile.tpl, typeRefs.tpl, typeRelatedComps.tpl, xmlRep.tpl
Called From:
complexTypes.tpl, FramedDoc.tpl
Related Parameters:
complexTypes.tpl Generates the «Complex Types» section of single-file documentation.

Calls:

complexType.tpl
Called From:
namespace.tpl
Related Parameter:
Generate Details | Components | Complex Types
complexTypeSummary.tpl Generates «Complex Type Summary» sections.

Calls:

annotationText.tpl, componentName.tpl, tableRep.tpl, typeProfile.tpl
Called From:
all-components.tpl, namespace.tpl, schema.tpl
Related Parameters:
simpleType.tpl Generates «Component Documentation» pages/blocks for simple types.

Calls:

annotation.tpl, facet.tpl, HTMLHeadSetup.tpl, nav-bottom.tpl, nav-top.tpl, nodeSource.tpl, simpleContentDerivation.tpl, sourceNote.tpl, typeDerivationTree.tpl, typeProfile.tpl, typeRefs.tpl, typeRelatedComps.tpl, xmlRep.tpl
Called From:
FramedDoc.tpl, simpleTypes.tpl
Related Parameters:
simpleTypes.tpl Generates the «Simple Types» section of single-file documentation.

Calls:

simpleType.tpl
Called From:
namespace.tpl
Related Parameter:
Generate Details | Components | Simple Types
simpleTypeSummary.tpl Generates «Simple Type Summary» sections.

Calls:

annotationText.tpl, componentName.tpl, tableRep.tpl, typeProfile.tpl
Called From:
all-components.tpl, namespace.tpl, schema.tpl
Related Parameters:
typeBlockAttrInfo.tpl Generates «Block» section in profiles of complex types, which comes from the value of 'block' attribute specified in <xs:complexType> elements. Called From:
typeProfile.tpl
Related Parameters:
typeDerivationSummary.tpl Generates a summary of type derivation, which is added to the information about an anonymous type displayed in «Type» section of «Component Profile», like on this screenshot:

Calls:

componentLinkTitle.tpl
Called From:
contentAttributes.tpl, contentElements.tpl, diagram.tpl, elementProfile.tpl globalAttributeProfile.tpl, tableRep.tpl, typeProfile.tpl
Related Parameters:
typeDerivationTree.tpl Generates «Type Derivation Tree» section.

Type Derivation Tree graphically depicts how a given type was derived from all its know supertypes, which appear in the form of a tree (that shows also the method by which each intermediate type was produced from its parent type):

In case of derivation by union, the full supertype tree is too complicated, so it is reduced to a formula that shows only the ancestor types used directly in the declaration of the given type:

Calls:

componentLinkTitle.tpl
Called From:
complexType.tpl, contentAttributes.tpl, contentElements.tpl, element.tpl, globalAttribute.tpl, simpleType.tpl
Related Parameters:
typeFinalAttrInfo.tpl Generates «Final» section in profiles of simple/complex types, which comes from the value of 'final' attribute specified in <xs:simpleType> and <xs:complexType> elements.
Called From:
typeProfile.tpl
Related Parameters:
typeProfile.tpl Generates «Component Profile» section for simple/complex types

Calls:

contentType.tpl, schemaName.tpl, typeBlockAttrInfo.tpl, typeDerivationSummary.tpl, typeFinalAttrInfo.tpl, wildcard.tpl
Called From:
complexType.tpl, complexTypeSummary.tpl, simpleType.tpl, simpleTypeSummary.tpl
Related Parameters:
typeRefs.tpl Generates «Reference Locations» section for simple/complex types.

Calls:

componentLinkTitle.tpl, componentName.tpl, elementNameExt.tpl
Called From:
complexType.tpl, simpleType.tpl
Related Parameters:
Details | Component | Reference Locations
typeRelatedComps.tpl Generates the following sections of Component Documentation:
  • List of Direct Subtypes
  • List of Indirect Subtypes
  • List of All Based Elements
  • List of All Based Attributes
Calls:
componentLinkTitle.tpl, componentName.tpl, contentElementList.tpl, elementNameExt.tpl
Called From:
complexType.tpl, simpleType.tpl
Related Parameters:
[lib/xml] subtemplates related to documenting/reproducing XML source of XML schemas
documentSource.tpl Reproduces the XML source of the whole XML document.

Calls:

nodeSource.tpl
Called From:
annotation.tpl, schema-source.tpl
Related Parameters:
nodeSource.tpl Reproduces the XML source of a given XML document node (that is a fragment of the document's full XML source corresponding to the document's W3C DOM tree branch attached to the given node), including hyperlinks from certain attribute values to the corresponding documentation details. For example:

Called From:
attributeGroup.tpl, complexType.tpl, contentAttributes.tpl, contentElements.tpl, documentSource.tpl, element.tpl, globalAttribute.tpl, group.tpl, simpleType.tpl
Related Parameters:
sourceNote.tpl Generates some extra information about the reproduced XML source, which is displayed at the «XML Source» section heading, such as whether (and how many annotations) were removed from it and the link to the location of this fragment within the full document source, like the following:

(w/o annotations (3); see within schema source)

Called From:

attributeGroup.tpl, complexType.tpl, contentAttributes.tpl, contentElements.tpl, element.tpl, globalAttribute.tpl, group.tpl, schema-source.tpl, simpleType.tpl
xmlns-bindings.tpl Generates «XML Namespace Bindings» page/block.

Calls:

HTMLHeadSetup.tpl, nav-bottom.tpl, nav-top.tpl
Called From:
FramedDoc.tpl, SingleDoc.tpl
Related Parameters:
Generate Details | XML Namespace Bindings