6.8 Customizing the page header
It is possible to add lines to the text within the <head>
HTML elements, by defining the variable
$EXTRA_HEAD.
Similarly it is possible to add text just after the <body>
element with the variable
$AFTER_BODY_OPEN.
These variables are empty by default.
The HTML encoding of the resulting document is defined by
$ENCODING_NAME. If the variable isn't defined,
the @documentencoding value is used, or the
$OUT_ENCODING value, if set. $ENCODING_NAME may
influence the value of $OUT_ENCODING, which corresponds with
the encoding used when writing to the resulting files.
See section Setting the encodings.
The description of the document may be specified in
$DOCUMENT_DESCRIPTION. If this variable is undef, the text
associated with @documentdescription is used, and if there isn't
such test a default description is constructed using the document title and
the name of the first section of the file.
The <body> element attributes may be set by defining the
variable
$BODYTEXT. If you want to define that variable
dynamically, you should use the init_out function reference
(see section Preparing the output).
The default functions call the function associated with
$print_head_navigation to format the navigation panel for the
page header. Thus you can control parts of the formatting by
redefining the function reference.
- Function Reference: print_head_navigation $filehandle \@buttons
$filehandle is the opened filehandle the function should write to.
\@buttons is an array reference which should hold the specification of
the buttons for the navigation panel.
If you want even more control, you can have full control over the page header
formatting by redefining three function references. The function associated
with
$print_page_head is called for all the pages, and after that,
the function associated with
$print_chapter_header is called
if the document is split at chapters, or the function associated with
$print_section_header is called if the document is split at sections.
- Function Reference: print_page_head $filehandle
$filehandle is the opened filehandle the function should write to.
This function should print the page head, including the <body>
element.
- Function Reference: print_chapter_header $filehandle
$filehandle is the opened filehandle the function should write to.
This function is called if the document is split at chapters, after
print_page_head.
- Function Reference: print_section_header $filehandle
$filehandle is the opened filehandle the function should write to.
This function is called if the document is split at sections, after
print_page_head.
Doku-Base
This document was created by Netzdino using texi2html.
|