Info Node: (texinfo)HTML Customization Variables
texinfo: HTML Customization Variables
Customization Variables 
Other Customization Variables 
Customization Variables and Options 
Back to Software Index
22.5.3 HTML Customization Variables
-----------------------------------
This table gives the customization variables which apply to HTML output
only. A few other customization variable apply to both HTML and other
output formats; those are given in the next section.
'AVOID_MENU_REDUNDANCY'
For HTML. If set, and the menu entry and menu description are the
same, then do not print the menu description; default false.
'AFTER_BODY_OPEN'
For HTML. If set, the corresponding text will appear at the
beginning of each HTML file; default unset.
'AFTER_ABOUT'
For HTML, when an About-element is output. If set, the
corresponding text will appear at the end of the About element;
default unset.
'AFTER_OVERVIEW'
'AFTER_TOC_LINES'
For HTML. If set, the corresponding text is output after the short
table of contents for 'AFTER_OVERVIEW' and after the table of
contents for 'AFTER_TOC_LINES'; otherwise, a default string is
used. At the time of writing, a '</div>' element is closed.
In general, you should set 'BEFORE_OVERVIEW' if 'AFTER_OVERVIEW' is
set, and you should set 'BEFORE_TOC_LINES' if 'AFTER_TOC_LINES' is
set.
'BASEFILENAME_LENGTH'
For HTML. The maximum length of the base filenames; default 245.
Changing this would make cross-manual references to such long node
names invalid (Note: HTML Xref Link Basics).
'BEFORE_OVERVIEW'
'BEFORE_TOC_LINES'
For HTML. If set, the corresponding text is output before the
short table of contents for 'BEFORE_OVERVIEW' and before the table
of contents for 'BEFORE_TOC_LINES', otherwise a default string is
used. At the time of writing, a '<div ...>' element is opened.
In general you should set 'AFTER_OVERVIEW' if 'BEFORE_OVERVIEW' is
set, and you should set 'AFTER_TOC_LINES' if 'BEFORE_TOC_LINES' is
set.
'BIG_RULE'
For HTML. Rule used after and before the top element and before
special elements, but not for footers and headers; default '<hr>'.
'BODYTEXT'
For HTML, the text appearing in '<body>'. By default, set
automatically, taking into account the document language (Note:
@documentlanguage).
'CASE_INSENSITIVE_FILENAMES'
For HTML. Construct output file names as if the filesystem were
case insensitive (Note: HTML Splitting); default false.
'CHAPTER_HEADER_LEVEL'
For HTML. Header formatting level used for chapter level
sectioning commands; default '2'.
'CHECK_HTMLXREF'
For HTML. Check that manuals which are the target of external
cross references (Note: Four and Five Arguments) are present in
'htmlxref.cnf' (Note: HTML Xref Configuration); default false.
'COMPLEX_FORMAT_IN_TABLE'
For HTML. If set, use tables for indentation of complex formats;
default false.
'CSS_LINES'
For HTML. CSS output, automatically determined by default (Note:
HTML CSS).
'DATE_IN_HEADER'
For HTML. Put the document generation date in the header; off by
default.
'DEF_TABLE'
For HTML. If set, a '<table>' construction for '@deffn' and
similar @-commands is used (looking more like the TeX output),
instead of definition lists; default false.
'DEFAULT_RULE'
For HTML. Rule used between element, except before and after the
top element, and before special elements, and for footers and
headers; default '<hr>'.
'DO_ABOUT'
For HTML. If set to 0 never do an About special element; if set to
1 always do an About special element; default 0.
'EXTERNAL_DIR'
For HTML. Base directory for external manuals; default none. It
is better to use the general external cross reference mechanism
(Note: HTML Xref Configuration) than this variable.
'EXTRA_HEAD'
For HTML. Additional text appearing within '<head>'; default
unset.
'FOOTNOTE_END_HEADER_LEVEL'
For HTML. Header formatting level used for the footnotes header
with the 'end' footnotestyle; default '4'. Note: Footnote
Styles.
'FOOTNOTE_SEPARATE_HEADER_LEVEL'
For HTML. Header formatting level used for the footnotes header
with the 'separate' footnotestyle; default '4'. Note: Footnote
Styles.
'FRAMES'
For HTML. If set, a file describing the frame layout is generated,
together with a file with the short table of contents; default
false.
'FRAMESET_DOCTYPE'
For HTML. Same as DOCTYPE, but for the file containing the frame
description.
'HEADER_IN_TABLE'
For HTML. Use tables for header formatting rather than a simple
'<div>' element; default false.
'ICONS'
For HTML. Use icons for the navigation panel; default false.
'IMAGE_LINK_PREFIX'
For HTML. If set, the associated value is prepended to the image
file links; default unset.
'INLINE_CSS_STYLE'
For HTML. Put CSS directly in HTML elements rather than at the
beginning of the output; default false.
'KEEP_TOP_EXTERNAL_REF'
For HTML. If set, do not ignore 'Top' as the first argument for an
external ref to a manual, as is done by default. Note: Top Node
Naming.
'L2H'
For HTML. If set, 'latex2html' is used to convert '@math' and
'@tex' sections; default false. Best used with '--iftex'.
'L2H_CLEAN'
(Relevant only if 'L2H' is set.) If set, the intermediate files
generated in relation with 'latex2html' are removed; default true.
'L2H_FILE'
(Relevant only if 'L2H' is set.) If set, the given file is used as
'latex2html''s init file; default unset.
'L2H_HTML_VERSION'
(Relevant only if 'L2H' is set.) The HTML version used in the
'latex2html' call; default unset.
'L2H_L2H'
(Relevant only if 'L2H' is set.) The program invoked as
'latex2html'; default is 'latex2html'.
'L2H_SKIP'
(Relevant only if 'L2H' is set.) If set to a true value, the
actual call to 'latex2html' is skipped; previously generated
content is reused instead. If set to 0, the cache is not used at
all. If set to 'undef', the cache is used for as many TeX
fragments as possible and for any remaining the command is run.
The default is 'undef'.
'L2H_TMP'
(Relevant only if 'L2H' is set.) Set the directory used for
temporary files. None of the file name components in this
directory name may start with '.'; otherwise, 'latex2html' will
fail (because of 'dvips'). The default is the empty string, which
means the current directory.
'MAX_HEADER_LEVEL'
For HTML. Maximum header formatting level used (higher header
formatting level numbers correspond to lower sectioning levels);
default '4'.
'MENU_SYMBOL'
For HTML. Symbol used in front of menu entries when node names are
used for menu entries formatting; default '•'.
'MONOLITHIC'
For HTML. Output only one file including the table of contents.
Set by default, but only relevant when the output is not split.
'NO_CSS'
For HTML. Do not use CSS; default false. Note: HTML CSS.
'NODE_FILE_EXTENSION'
For HTML. Extension for node files if 'NODE_FILENAMES' is set;
default 'html'.
'PRE_ABOUT'
For HTML, when an About element is output. If set to a text
string, this text will appear at the beginning of the About
element. If set to a reference on a subroutine, the result of the
subroutine call will appear at the beginning of the About element.
If not set (the default), default text is used.
'PRE_BODY_CLOSE'
For HTML. If set, the given text will appear at the footer of each
HTML file; default unset.
'PROGRAM_NAME_IN_FOOTER'
For HTML. If set, output the program name and miscellaneous
related information in the page footers; default false.
'SHORTEXTN'
For HTML. If set, use '.htm' as extension; default false.
'SHOW_TITLE'
For HTML. If set, output the title at the beginning of the
document; default true.
'SIMPLE_MENU'
For HTML. If set, use a simple preformatted style for the menu,
instead of breaking down the different parts of the menu; default
false. Note: Menu Parts.
'TOC_LINKS'
For HTML. If set, links from headings to toc entries are created;
default false.
'TOP_FILE'
This file name may be used for the top-level file. The extension
is set appropriately, if necessary. This is used to override the
default, and is, in general, only taken into account when output is
split, and for HTML.
'TOP_NODE_FILE'
For HTML. File name used for the Top node, if 'NODE_FILENAMES' is
set; default is 'index'.
'TOP_NODE_FILE_TARGET'
For HTML. File name used for the Top node in cross references;
default is 'index'.
'TOP_NODE_UP_URL'
For HTML. The url used for the Up pointer of the Top node; default
'undef', meaning no link is generated.
'USE_ACCESSKEY'
For HTML. Use 'accesskey' in cross references; default true.
'USE_ISO'
For HTML. Use entities for doubled single-quote characters (Note:
Inserting Quotation Marks), and '---' and '--' (Note:
Conventions); default true.
'USE_LINKS'
For HTML. Generate '<link>' elements in the HTML '<head>' output;
default true.
'USE_REL_REV'
For HTML. Use 'rel' in cross references; default true.
'VERTICAL_HEAD_NAVIGATION'
For HTML. If set, a vertical navigation panel is used; default
false.
'WORDS_IN_PAGE'
For HTML, with output split at nodes. Specifies the approximate
minimum page length at which a navigation panel is placed at the
bottom of a page. To avoid ever having the navigation buttons at
the bottom of a page, set this to a sufficiently large number. The
default is 300.
'XREF_USE_FLOAT_LABEL'
For HTML. If set, for the float name in cross references, use the
float label instead of the type followed by the float number (Note:
@float). The default is off.
'XREF_USE_NODE_NAME_ARG'
For HTML. Only relevant for cross reference commands with no cross
reference name (second argument). If set to 1, use the node name
(first) argument in cross reference @-commands for the text
displayed as the hyperlink. If set to 0, use the node name if
'USE_NODES' is set, otherwise the section name. If set to 'undef',
use the first argument in preformatted environments, otherwise use
the node name or section name depending on 'USE_NODES'. The
default is 'undef'.
automatically generated by info2www version 1.2