FlexDoc/Javadoc - JavadocClassic - Templates

Support File Subtemplates

Generate files that help to navigate the framed HTML documentation and connect to it.

help-doc.tpl

This template generates the Help page ('help-doc.html' file). This is the page you reach using the «Help» button in the navigation bar.

Here is a sample help page generated by this template (click on the screenshot to see the real HTML):

Template Location:

{flexdoc-javadoc}/templates/classic/lib/help-doc.tpl
Controlled By Parameter:
Generate | Help

Called From:

FramedDoc.tpl

Calls:

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

overview-frame.tpl

This template generates the primary navigation page, which includes the lists all packages and other primary links. It is used in the upper-left "Overview" frame.

Sample output (click on the screenshot to see HTML):

Template Location:

{flexdoc-javadoc}/templates/classic/lib/overview-frame.tpl

Called From:

FramedDoc.tpl

allclasses-frame.tpl

This template generates a navigation page with the list of all documented classes. It is loaded in the lower-left "List" frame.

Sample output (click on the screenshot to see HTML):

Template Location:

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

Called From:

FramedDoc.tpl

Calls:

classLinkTitle.tpl

module-frame.tpl

This template generates a separate navigation page for each documented module, which is loaded into the lower-left "List" frame on clicking on the corresponding module in the "Overview" frame.

The page contains the link to the corresponding Module Documentation page and the list of all documented packages in that module along with the links to the corresponding navigation pages for each package that are loaded in the same frame window.

Sample output (click on to see the HTML):

Template Location:

{flexdoc-javadoc}/templates/classic/lib/module/module-frame.tpl

Called From:

FramedDoc.tpl

package-frame.tpl

This template generates a separate navigation page for each documented package, which is loaded into the lower-left "List" frame on clicking on the corresponding package in the "Overview" frame.

The page contains the link to the corresponding Package Documentation page and the list of all documented classes in that package along with the links to the corresponding class details. The classes are grouped by their functional roles (such as interfaces, ordinary classes, exceptions etc.)

Sample output (click on to see the HTML):

Template Location:

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

Called From:

FramedDoc.tpl

Calls:

classLinkTitle.tpl

element-list.tpl

This template generates an element-list file, which is a plain-text file that lists the names of all documented modules/packages (or those containing the documented classes). It is used by Javadoc to generate hyperlinks from another Java API documentation to this one, whose location is specified with -link or -linkoffline options on the Javadoc command line.

The element-list file generated by this template allows linking any other Java API documentation (including the one generated by the Standard Doclet) to the framed HTML documentation produced with FramedDoc.tpl template.

The opposite is possible as well, as FlexDoc Doclet also supports -link and -linkoffline options.

Here is the template's screenshot:

The element-list.tpl template is called from the FramedDoc.tpl main template, where the corresponding Call Template section it is specified to produce a plain-text file – not an HTML file as all other subtemplates.

On the following screenshot you can see a element-list file produced by this template (it is included in the framed HTML demo documentation):

In case of non-modular Java project, element-list.tpl template generates the package-list file, which lists only packages

Template Location:

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

Called From:

FramedDoc.tpl