FlexDoc/Javadoc - JavadocClassic - Parameters

«Pagination» parameter group

This group of parameters is related specifically to printable documentation (e.g. in RTF format).

It is available only in SingleDoc.tpl main template.

Parameter	Name / Type / Description
Generate page columns	`page.columns : boolean` Specify whether to generate page number columns in summary tables. Page numbers substitute for hyperlinks in printed documentation and help to navigate it.
Start from new page	`page.start` This group of parameters specifies which documentation blocks should start from a new page. It has effect only when you generate RTF documentation.
Table Of Contents	`page.start.toc : boolean` Specify if the Table Of Contents should start from a new page. See Also Parameters: Generate \| Table Of Contents Pagination \| Orientation \| Table Of Contents
Overview	`page.start.overview : boolean` Specify if the documentation Overview should start from a new page. See Also Parameters: Generate \| Overview Pagination \| Orientation \| Overview
Module Summary	`page.start.overview.modules : boolean` Specify if the module summary should start from a new page. See Also Parameter: Generate \| Overview \| Module Summary
Package Summary	`page.start.overview.packages : boolean` Specify if the package summary (or All Package Summary) should start from a new page. See Also Parameters: Generate \| Overview \| Package Summary Generate \| Overview \| All Package Summary
Classes Summary	`page.start.overview.classes : boolean` Specify if the All Class Summary should start from a new page. See Also Parameter: Generate \| Overview \| All Classes Summary
Module	`page.start.module : boolean` Specify if each Module Documentation section (or module group) should start from a new page. See Also Parameters: Generate \| Grouping \| By Modules Generate \| Module Pagination \| Orientation \| Module
Package	`page.start.package : boolean` Specify if each Package Documentation section (or package group) should start from a new page. See Also Parameters: Generate \| Grouping \| By Packages Generate \| Package Pagination \| Orientation \| Package
Class	`page.start.class : boolean` Specify if each Class Documentation section should started from a new page. See Also Parameters: Generate \| Class Pagination \| Orientation \| Class
Orientation	`page.orientation` This parameter group allows you to set the page orientation selectively for specific sections of the generated printable (RTF) documentation. The page orientation for the whole document is specified in the main template's property: Formatting \| Page Settings \| Paper \| Orientation which can be overridden also during the generation, with the RTF Output Format option: Page Settings \| Orientation Using parameters in this group, you can generate a document with mixed page orientation. For instance, when some descriptions of particular components are expected to contain very wide tables so they would not fit on a page in portrait orientation and get cut.
Table Of Contents	`page.orientation.toc : enum {"default", "portrait", "landscape"}` Specify the page orientation of Table Of Contents section. Possible Choices: "Default" The page orientation is the one specified for the whole document. "Portrait" The page orientation is Portrait. "Landscape" The page orientation is Landscape. Note: The Portrait/Landscape setting will always override anything specified for the whole document. See Also Parameters: Generate \| Table Of Contents Pagination \| Start from new page \| Table Of Contents
Overview	`page.orientation.overview : enum {"default", "portrait", "landscape"}` Specify the page orientation of Overview section. Possible Choices: "Default" The page orientation is the one specified for the whole document. "Portrait" The page orientation is Portrait. "Landscape" The page orientation is Landscape. Note: The Portrait/Landscape setting will always override anything specified for the whole document. See Also Parameters: Generate \| Overview Pagination \| Start from new page \| Overview
Module	`page.orientation.module : enum {"default", "portrait", "landscape"}` Specify the page orientation of Module Documentation sections. Possible Choices: "Default" The page orientation is the one specified for the whole document. "Portrait" The page orientation is Portrait. "Landscape" The page orientation is Landscape. Notes: The Portrait/Landscape setting will always override the default page orientation specified for the whole document. The nested parameter allows you to apply the special page orientation only to particular Java modules. See Also Parameters: Generate \| Grouping \| By Modules Generate \| Module Pagination \| Start from new page \| Module
Names	`page.orientation.module.names : list of strings` This parameter allows you to specify particular Java modules, to which the special page orientation (set with the parameter above) will be applied. The modules are specified as the list of their qualified names separated with newlines or colons (`':'`), for example: `java.desktop:java.xml` The special page orientation will be applied only to those modules found in this list. When the list is empty (the parameter is not specified), the special page orientation will be applied to all modules.
Package	`page.orientation.package : enum {"default", "portrait", "landscape"}` Specify the page orientation of Package Documentation sections. Possible Choices: "Default" The page orientation is the one specified for the whole document. "Portrait" The page orientation is Portrait. "Landscape" The page orientation is Landscape. Notes: The Portrait/Landscape setting will always override the default page orientation specified for the whole document. The nested parameter allows you to apply the special page orientation only to particular Java packages. See Also Parameters: Generate \| Grouping \| By Packages Generate \| Package Pagination \| Start from new page \| Package
Names	`page.orientation.package.names : list of strings` This parameter allows you to specify particular Java packages, to which the special page orientation (set with the parameter above) will be applied. The packages are specified as the list of their qualified names separated with newlines or colons (`':'`), for example: `java.io;java.util:javax.swing.text` The special page orientation will be applied only to those packages found in this list. When the list is empty (the parameter is not specified), the special page orientation will be applied to all packages.
Class	`page.orientation.class : enum {"default", "portrait", "landscape"}` Specify the page orientation of Class Documentation sections. Possible Choices: "Default" The page orientation is the one specified for the whole document. "Portrait" The page orientation is Portrait. "Landscape" The page orientation is Landscape. Notes: The Portrait/Landscape setting will always override the default page orientation specified for the whole document. The nested parameter allows you to apply the special page orientation only to particular Java classes. See Also Parameters: Generate \| Class Pagination \| Start from new page \| Class
Names	`page.orientation.class.names : list of strings` This parameter allows you to specify particular Java classes, to which the special page orientation (set with the parameter above) will be applied. The classes are specified as the list of their qualified names separated with newlines or colons (`':'`), for example: `java.io.File:java.util.Random` The special page orientation will be applied only to those classes found in this list. When the list is empty (the parameter is not specified), the special page orientation will be applied to all classes.