HTML Customization Variables (GNU Texinfo 6.7)

20.6.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; see Other Customization Variables.

AVOID_MENU_REDUNDANCY

If set, and the menu entry and menu description are the same, then do not print the menu description; default false.

AFTER_BODY_OPEN

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

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

The maximum length of the base filenames; default 245. Changing this would make cross-manual references to such long node names invalid (see HTML Xref Link Basics).

BEFORE_OVERVIEW

BEFORE_TOC_LINES

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

Rule used after and before the top element and before special elements, but not for footers and headers; default <hr>.

BODYTEXT

The text appearing in <body>. By default, sets the HTML lang attribute to the document language (see @documentlanguage).

CASE_INSENSITIVE_FILENAMES

Construct output file names as if the filesystem were case insensitive (see HTML Splitting); default false.

CHAPTER_HEADER_LEVEL

Header formatting level used for chapter level sectioning commands; default ‘2’.

CHECK_HTMLXREF

Check that manuals which are the target of external cross-references (see Four and Five Arguments) are present in htmlxref.cnf (see HTML Xref Configuration); default false.

COMPLEX_FORMAT_IN_TABLE

If set, use tables for indentation of complex formats; default false.

CSS_LINES

CSS output, automatically determined by default (see HTML CSS).

DATE_IN_HEADER

Put the document generation date in the header; off by default.

DEF_TABLE

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

Rule used between element, except before and after the top element, and before special elements, and for footers and headers; default <hr>.

DO_ABOUT

If set to 0 never do an About special element; if set to 1 always do an About special element; default 0.

EXTERNAL_DIR

Base directory for external manuals; default none. It is better to use the general external cross-reference mechanism (see HTML Xref Configuration) than this variable.

EXTRA_HEAD

Additional text appearing within <head>; default unset.

FOOTNOTE_END_HEADER_LEVEL

Header formatting level used for the footnotes header with the ‘end’ footnotestyle; default ‘4’. See Footnote Styles.

FOOTNOTE_SEPARATE_HEADER_LEVEL

Header formatting level used for the footnotes header with the ‘separate’ footnotestyle; default ‘4’. See Footnote Styles.

FRAMES

If set, a file describing the frame layout is generated, together with a file with the short table of contents; default false.

FRAMESET_DOCTYPE

Same as DOCTYPE, but for the file containing the frame description.

HEADER_IN_TABLE

Use tables for header formatting rather than a simple <div> element; default false.

ICONS

Use icons for the navigation panel; default false.

IMAGE_LINK_PREFIX

If set, the associated value is prepended to the image file links; default unset.

INLINE_CONTENTS

If set, output the contents where the @contents and similar @-commands are located; default true. This is ignored if @set*contentsaftertitlepage is set (see Contents).

INLINE_CSS_STYLE

Put CSS directly in HTML elements rather than at the beginning of the output; default false.

KEEP_TOP_EXTERNAL_REF

If set, do not ignore ‘Top’ as the first argument for an external ref to a manual, as is done by default. See Referring to a Manual as a Whole.

MAX_HEADER_LEVEL

Maximum header formatting level used (higher header formatting level numbers correspond to lower sectioning levels); default ‘4’.

MENU_SYMBOL

Symbol used in front of menu entries when node names are used for menu entries formatting; default ‘•’.

MONOLITHIC

Output only one file including the table of contents. Set by default, but only relevant when the output is not split.

NO_CSS

Do not use CSS; default false. See HTML CSS.

PRE_ABOUT

Used 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

If set, the given text will appear at the footer of each HTML file; default unset.

PROGRAM_NAME_IN_FOOTER

If set, output the program name and miscellaneous related information in the page footers; default false.

SECTION_NAME_IN_TITLE

If set, when output is split, use the argument of the chapter structuring command (e.g., @chapter or @section) in the <title> instead of the argument to @node.

SHOW_TITLE

If set, output the title at the beginning of the document; default true.

SIMPLE_MENU

If set, use a simple preformatted style for the menu, instead of breaking down the different parts of the menu; default false. See Menu Parts.

TOC_LINKS

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_TARGET

File name used for the Top node in cross-references; default is index.html.

TOP_NODE_UP_URL

A url used for Top node up references; the default is undef, in that case no Top node Up reference is generated. For more about the Top node pointers, see First Node. For overriding the Up pointer name in cas TOP_NODE_UP_URL is set and for other formats, see TOP_NODE_UP in Other Customization Variables.

USE_ACCESSKEY

Use accesskey in cross-references; default true.

USE_ISO

Use entities for doubled single-quote characters (see Inserting Quotation Marks), and ‘---’ and ‘--’ (see Conventions); default true.

USE_LINKS

Generate <link> elements in the HTML <head> output; default true.

USE_REL_REV

Use rel in cross-references; default true.

VERTICAL_HEAD_NAVIGATION

If set, a vertical navigation panel is used; default false.

WORDS_IN_PAGE

When output is split by 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

If set, for the float name in cross-references, use the float label instead of the type followed by the float number (see @float). The default is off.

XREF_USE_NODE_NAME_ARG

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’.