FlexDoc/Javadoc - JavadocClassic - Templates

Cross-Reference Page Subtemplates

Generate pages of framed HTML documentation that help to quickly find the necessary information. Some of these templates are used also to generate sections of other documents.

package-summary.tpl

This template is used in two places:

To generate the package summary included in the general Overview produced by overview.tpl template.
To generate “All Packages” page (allpackages-index.html file), which is loaded when clicking on «All Packages» item in the navigation bar in framed HTML documentation.

On the following screenshot you can see a sample “All Packages” page generated by this template (click to see the real HTML):

Related Parameters:

Template Location:

{flexdoc-javadoc}/templates/classic/lib/package/package-summary.tpl

Called From:

FramedDoc.tpl, overview.tpl

Calls:

navbar.tpl, navbar-bottom.tpl, summary.tpl, demo-incomplete.tpl

class-summary.tpl

This template is used in three places:

To generate class summaries in the Overview and Package pages/sections.
To generate “All Classes” page (allclasses-index.html file), which is loaded when clicking on «All Classes» item in the navigation bar in framed HTML documentation.

Here is the template's screenshot:

On the following screenshot you can see a sample “All Classes” page generated by this template (click to see the real HTML):

Template Location:

{flexdoc-javadoc}/templates/classic/lib/class/class-summary.tpl

Related Parameters:

Called From:

FramedDoc.tpl, overview.tpl, package.tpl

Calls:

navbar.tpl, navbar-bottom.tpl, className.tpl, classLinkTitle.tpl, typeArguments.tpl, summary.tpl, demo-incomplete.tpl

package-use.tpl

This template generates a “Use” page for each documented package. The page provides the list of packages and classes that reference any classes in the given package.

The next screenshots show an HTML page generated by this template (click to see the real HTML):

Template Location:

{flexdoc-javadoc}/templates/classic/lib/package/package-use.tpl

Controlled By Parameter:

Generate | Cross-Reference Pages | Use (Package/Class)

Called From:

FramedDoc.tpl

Calls:

navbar.tpl, navbar-bottom.tpl, classLinkTitle.tpl, summary.tpl, demo-incomplete.tpl

class-use.tpl

This template generates a “Use” page for each documented class. The page provides the list of packages, classes and members that reference the given class.

The next screenshots show an HTML page generated by this template (click to see the real HTML):

Template Location:

{flexdoc-javadoc}/templates/classic/lib/class/class-use.tpl

Controlled By Parameter:

Generate | Cross-Reference Pages | Use (Package/Class)

Called From:

FramedDoc.tpl

Calls:

navbar.tpl, navbar-bottom.tpl, classLinkTitle.tpl, type.tpl, typeArguments.tpl, summary.tpl, demo-incomplete.tpl

class-tree.tpl

This template generates class/interface hierarchy pages (all 'overview-tree.html' and 'package-tree.html' files). These are the pages you reach using the «Tree» button in the navigation bar.

The next screenshots show an HTML page generated by this template (click to see the real HTML):

Template Location:

{flexdoc-javadoc}/templates/classic/lib/class/class-tree.tpl

Controlled By Parameter:

Generate | Cross-Reference Pages | Tree (Class Hierarchy)

Called From:

FramedDoc.tpl

Calls:

navbar.tpl, navbar-bottom.tpl, classLinkTitle.tpl, demo-incomplete.tpl

deprecated-list.tpl

This template generates the deprecated API page ('deprecated-list.html' file), which contains the list of deprecated APIs, and the «Deprecated» link in the navigation bar to that page.

The next screenshots show an HTML page generated by this template (click to see the real HTML):

Template Location:

{flexdoc-javadoc}/templates/classic/lib/deprecated-list.tpl

Controlled By Parameter:

Generate | Cross-Reference Pages | Deprecated List

Called From:

FramedDoc.tpl

Calls:

navbar.tpl, navbar-bottom.tpl, classLinkTitle.tpl, demo-incomplete.tpl

index-all.tpl

This template generates a single index page ('index-all.html' file).

It is used when no splitting of the index into multiple files has been specified (the parameter “Generate | Cross-Reference Pages | Index | Split” is false).

Here is the template's screenshot:

It is a simple template. Actually it does little more but calls the index-letter.tpl template to generate the index section for each particular letter.

Template Location:

{flexdoc-javadoc}/templates/classic/lib/index-all.tpl

Controlled By Parameter Group:

Generate | Cross-Reference Pages | Index

Called From:

FramedDoc.tpl

Calls:

navbar.tpl, navbar-bottom.tpl, index-letter.tpl demo-incomplete.tpl

index-letter.tpl

This template generates for a particular letter either a section of the whole index file (i.e. 'index-all.html' generated by index-all.tpl) or a corresponding separate index page ('index-files/index-n.html' file).

In which mode the template is run depends on the setting of the “Generate | Cross-Reference Pages | Index | Split” parameter. The letter, for which the particular index section/page will be generated, is passed to the template via the context element.

The following screenshots show an HTML page generated by this template (click to see the real HTML):

Template Location:

{flexdoc-javadoc}/templates/classic/lib/index-letter.tpl

Controlled By Parameter Group:

Generate | Cross-Reference Pages | Index

Called From:

FramedDoc.tpl, index-all.tpl

Calls:

navbar.tpl, navbar-bottom.tpl, classLinkTitle.tpl, type.tpl, typeArguments.tpl, text.tpl, summary.tpl, demo-incomplete.tpl

serialized-form.tpl

This template generates the serialized form page ('serialized-form.html' file), which provides information about serializable and externalizable classes.