PDFDoclet allows to create a bookmark outline which makes it easier to access
the various parts of the document. The default bookmark outline structure for
an API for which an overview and appendices were specified is this:
+ Title Page
+ All Classes
Within each package entry, the structure always looks like this:
+ Package name
+ Class name
It is possible, however, to change the bookmark structure in various ways, as
explained in the following sections.
The following list shows the configuration properties which can be used to
override the default bookmark labels.
The last two properties are mutual exclusive. The last one ("
is used only in conjunction with the
parameter (see next section).
PDFDoclet supports the
parameter which allows to group certain
packages together. See Sun's javadoc for a detailled explanation of this parameter.
The packages not included in any of the groups are all under a bookmark with the
default label "Other Packages". To override this label, set this property:
As the example example1.pdf
shows, it is possible to create custom entries in
the bookmark outline. This can be achieved with a special kind of HTML anchor
<a name="pdfbookmark" label="Text Label"></a>
Due to some mysterious behaviour of the HTML parser, it's better to create a
separate opening and closing tag, as shown in this example. Usually it also works
if the HTML tag is closed directly, XML-style, but in certain situations, following
HTML tags may be turned into links (although they shouldn't). This may be fixed in
a future release. For the time being, it is recommended to use this notation.