JezK
Edit File: HTML-Customization-Variables.html
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <!-- Created by GNU Texinfo 6.8, https://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <!-- This manual is for GNU Texinfo (version 6.8, 8 June 2021), a documentation system that can produce both online information and a printed manual from a single source using semantic markup. Copyright (C) 1988, 1990-1993, 1995-1999, 2001-2021 Free Software Foundation, Inc. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License". --> <title>HTML Customization Variables (GNU Texinfo 6.8)</title> <meta name="description" content="HTML Customization Variables (GNU Texinfo 6.8)"> <meta name="keywords" content="HTML Customization Variables (GNU Texinfo 6.8)"> <meta name="resource-type" content="document"> <meta name="distribution" content="global"> <meta name="Generator" content="texi2any"> <meta name="viewport" content="width=device-width,initial-scale=1"> <link href="index.html" rel="start" title="Top"> <link href="Command-and-Variable-Index.html" rel="index" title="Command and Variable Index"> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> <link href="Customization-Variables.html" rel="up" title="Customization Variables"> <link href="MathJax-Customization-Variables.html" rel="next" title="MathJax Customization Variables"> <link href="Customization-Variables-and-Options.html" rel="prev" title="Customization Variables and Options"> <style type="text/css"> <!-- a.copiable-anchor {visibility: hidden; text-decoration: none; line-height: 0em} a.summary-letter {text-decoration: none} blockquote.indentedblock {margin-right: 0em} div.display {margin-left: 3.2em} div.example {margin-left: 3.2em} kbd {font-style: oblique} pre.display {font-family: inherit} pre.format {font-family: inherit} pre.menu-comment {font-family: serif} pre.menu-preformatted {font-family: serif} span.nolinebreak {white-space: nowrap} span.roman {font-family: initial; font-weight: normal} span.sansserif {font-family: sans-serif; font-weight: normal} span:hover a.copiable-anchor {visibility: visible} ul.no-bullet {list-style: none} --> </style> </head> <body lang="en"> <div class="subsection" id="HTML-Customization-Variables"> <div class="header"> <p> Next: <a href="MathJax-Customization-Variables.html" accesskey="n" rel="next">MathJax Customization Variables</a>, Previous: <a href="Customization-Variables-and-Options.html" accesskey="p" rel="prev">Customization Variables and Options</a>, Up: <a href="Customization-Variables.html" accesskey="u" rel="up">Customization Variables</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Command-and-Variable-Index.html" title="Index" rel="index">Index</a>]</p> </div> <hr> <span id="HTML-Customization-Variables-1"></span><h4 class="subsection">19.4.3 HTML Customization Variables</h4> <p>This table gives the customization variables which apply to HTML output only. A few other customization variables apply to both HTML and other output formats; see <a href="Other-Customization-Variables.html">Other Customization Variables</a>. </p> <dl compact="compact"> <dt id='index-AVOID_005fMENU_005fREDUNDANCY'><span><code>AVOID_MENU_REDUNDANCY</code><a href='#index-AVOID_005fMENU_005fREDUNDANCY' class='copiable-anchor'> ¶</a></span></dt> <dd><p>If set, and the menu entry and menu description are the same, then do not print the menu description; default false. </p> </dd> <dt id='index-AFTER_005fBODY_005fOPEN'><span><code>AFTER_BODY_OPEN</code><a href='#index-AFTER_005fBODY_005fOPEN' class='copiable-anchor'> ¶</a></span></dt> <dd><p>If set, the corresponding text will appear at the beginning of each HTML file; default unset. </p> </dd> <dt id='index-AFTER_005fABOUT'><span><code>AFTER_ABOUT</code><a href='#index-AFTER_005fABOUT' class='copiable-anchor'> ¶</a></span></dt> <dd><p>For HTML, when an About-element is output. If set, the corresponding text will appear at the end of the About element; default unset. </p> </dd> <dt id='index-AFTER_005fOVERVIEW'><span><code>AFTER_OVERVIEW</code><a href='#index-AFTER_005fOVERVIEW' class='copiable-anchor'> ¶</a></span></dt> <dt id='index-AFTER_005fTOC_005fLINES'><span><code>AFTER_TOC_LINES</code><a href='#index-AFTER_005fTOC_005fLINES' class='copiable-anchor'> ¶</a></span></dt> <dd><p>If set, the corresponding text is output after the short table of contents for <code>AFTER_OVERVIEW</code> and after the table of contents for <code>AFTER_TOC_LINES</code>; otherwise, a default string is used. At the time of writing, a <code></div></code> element is closed. </p> <p>In general, you should set <code>BEFORE_OVERVIEW</code> if <code>AFTER_OVERVIEW</code> is set, and you should set <code>BEFORE_TOC_LINES</code> if <code>AFTER_TOC_LINES</code> is set. </p> </dd> <dt id='index-BASEFILENAME_005fLENGTH'><span><code>BASEFILENAME_LENGTH</code><a href='#index-BASEFILENAME_005fLENGTH' class='copiable-anchor'> ¶</a></span></dt> <dd><p>The maximum length of a base file name; default 245. Changing this would make cross-manual references to such long node names invalid (see <a href="HTML-Xref-Link-Basics.html">HTML Cross-reference Link Basics</a>). </p> </dd> <dt id='index-BEFORE_005fOVERVIEW'><span><code>BEFORE_OVERVIEW</code><a href='#index-BEFORE_005fOVERVIEW' class='copiable-anchor'> ¶</a></span></dt> <dt id='index-BEFORE_005fTOC_005fLINES'><span><code>BEFORE_TOC_LINES</code><a href='#index-BEFORE_005fTOC_005fLINES' class='copiable-anchor'> ¶</a></span></dt> <dd><p>If set, the corresponding text is output before the short table of contents for <code>BEFORE_OVERVIEW</code> and before the table of contents for <code>BEFORE_TOC_LINES</code>, otherwise a default string is used. At the time of writing, a <code><div ...></code> element is opened. </p> <p>In general you should set <code>AFTER_OVERVIEW</code> if <code>BEFORE_OVERVIEW</code> is set, and you should set <code>AFTER_TOC_LINES</code> if <code>BEFORE_TOC_LINES</code> is set. </p> </dd> <dt id='index-BIG_005fRULE'><span><code>BIG_RULE</code><a href='#index-BIG_005fRULE' class='copiable-anchor'> ¶</a></span></dt> <dd><p>Rule used after and before the top element and before special elements, but not for footers and headers; default <code><hr></code>. </p> </dd> <dt id='index-BODYTEXT'><span><code>BODYTEXT</code><a href='#index-BODYTEXT' class='copiable-anchor'> ¶</a></span></dt> <dd><span id="index-_003cbody_003e-text_002c-customizing"></span> <span id="index-lang_002c-HTML-attribute"></span> <p>The text appearing in <code><body></code>. By default, sets the HTML <code>lang</code> attribute to the document language (see <a href="_0040documentlanguage.html"><code>@documentlanguage <var>ll</var>[_<var>cc</var>]</code>: Set the Document Language</a>). </p> </dd> <dt id='index-CASE_005fINSENSITIVE_005fFILENAMES'><span><code>CASE_INSENSITIVE_FILENAMES</code><a href='#index-CASE_005fINSENSITIVE_005fFILENAMES' class='copiable-anchor'> ¶</a></span></dt> <dd><p>Construct output file names as if the filesystem were case insensitive (see <a href="HTML-Splitting.html">HTML Splitting</a>); default false. </p> </dd> <dt id='index-CHAPTER_005fHEADER_005fLEVEL'><span><code>CHAPTER_HEADER_LEVEL</code><a href='#index-CHAPTER_005fHEADER_005fLEVEL' class='copiable-anchor'> ¶</a></span></dt> <dd><p>Header formatting level used for chapter level sectioning commands; default ‘<samp>2</samp>’. </p> </dd> <dt id='index-CHECK_005fHTMLXREF'><span><code>CHECK_HTMLXREF</code><a href='#index-CHECK_005fHTMLXREF' class='copiable-anchor'> ¶</a></span></dt> <dd><p>Check that manuals which are the target of external cross-references (see <a href="Four-and-Five-Arguments.html"><code>@xref</code> with Four and Five Arguments</a>) are present in <samp>htmlxref.cnf</samp> (see <a href="HTML-Xref-Configuration.html">HTML Cross-reference Configuration: <samp>htmlxref.cnf</samp></a>); default false. </p> </dd> <dt id='index-COMPLEX_005fFORMAT_005fIN_005fTABLE'><span><code>COMPLEX_FORMAT_IN_TABLE</code><a href='#index-COMPLEX_005fFORMAT_005fIN_005fTABLE' class='copiable-anchor'> ¶</a></span></dt> <dd><p>If set, use tables for indentation of complex formats; default false. </p> </dd> <dt id='index-CONTENTS_005fOUTPUT_005fLOCATION'><span><code>CONTENTS_OUTPUT_LOCATION</code><a href='#index-CONTENTS_005fOUTPUT_005fLOCATION' class='copiable-anchor'> ¶</a></span></dt> <dd><p>If set to ‘<samp>after_top</samp>’, output the contents at the end of the <code>@top</code> section. If set to ‘<samp>inline</samp>’, output the contents where the <code>@contents</code> and similar @-commands are located. If set to ‘<samp>separate_element</samp>’ output the contents in separate elements, either at the end of the document if not split, or in a separate file. If set to ‘<samp>after_title</samp>’ the tables of contents are output after the title; default ‘<samp>after_top</samp>’. </p> </dd> <dt id='index-COPIABLE_005fANCHORS'><span><code>COPIABLE_ANCHORS</code><a href='#index-COPIABLE_005fANCHORS' class='copiable-anchor'> ¶</a></span></dt> <dd><p>If set, output copiable anchors for the definition commands (see <a href="Definition-Commands.html">Definition Commands</a>) and table commands (see <a href="Two_002dcolumn-Tables.html">Making a Two-column Table</a>) where an index entry is defined. An anchor appears as a ‘¶’ sign that appears when you hover the mouse pointer over the heading text. </p> </dd> <dt id='index-CSS_005fLINES'><span><code>CSS_LINES</code><a href='#index-CSS_005fLINES' class='copiable-anchor'> ¶</a></span></dt> <dd><p>CSS output, automatically determined by default (see <a href="HTML-CSS.html">HTML CSS</a>). </p> </dd> <dt id='index-DATE_005fIN_005fHEADER'><span><code>DATE_IN_HEADER</code><a href='#index-DATE_005fIN_005fHEADER' class='copiable-anchor'> ¶</a></span></dt> <dd><p>Put the document generation date in the header; off by default. </p> </dd> <dt id='index-DEF_005fTABLE'><span><code>DEF_TABLE</code><a href='#index-DEF_005fTABLE' class='copiable-anchor'> ¶</a></span></dt> <dd><p>If set, a <code><table></code> construction for <code>@deffn</code> and similar @-commands is used (looking more like the TeX output), instead of definition lists; default false. </p> </dd> <dt id='index-DEFAULT_005fRULE'><span><code>DEFAULT_RULE</code><a href='#index-DEFAULT_005fRULE' class='copiable-anchor'> ¶</a></span></dt> <dd><p>Rule used between element, except before and after the top element, and before special elements, and for footers and headers; default <code><hr></code>. </p> </dd> <dt id='index-DO_005fABOUT'><span><code>DO_ABOUT</code><a href='#index-DO_005fABOUT' class='copiable-anchor'> ¶</a></span></dt> <dd><p>If set to 0 never do an About special element; if set to 1 always do an About special element; default 0. </p> </dd> <dt id='index-EXTERNAL_005fDIR'><span><code>EXTERNAL_DIR</code><a href='#index-EXTERNAL_005fDIR' class='copiable-anchor'> ¶</a></span></dt> <dd><p>Base directory for external manuals; default none. It is better to use the general external cross-reference mechanism (see <a href="HTML-Xref-Configuration.html">HTML Cross-reference Configuration: <samp>htmlxref.cnf</samp></a>) than this variable. </p> </dd> <dt id='index-EXTRA_005fHEAD'><span><code>EXTRA_HEAD</code><a href='#index-EXTRA_005fHEAD' class='copiable-anchor'> ¶</a></span></dt> <dd><p>Additional text appearing within <code><head></code>; default unset. </p> </dd> <dt id='index-FOOTNOTE_005fEND_005fHEADER_005fLEVEL'><span><code>FOOTNOTE_END_HEADER_LEVEL</code><a href='#index-FOOTNOTE_005fEND_005fHEADER_005fLEVEL' class='copiable-anchor'> ¶</a></span></dt> <dd><p>Header formatting level used for the footnotes header with the ‘end’ footnotestyle; default ‘<samp>4</samp>’. See <a href="Footnote-Styles.html">Footnote Styles</a>. </p> </dd> <dt id='index-FOOTNOTE_005fSEPARATE_005fHEADER_005fLEVEL'><span><code>FOOTNOTE_SEPARATE_HEADER_LEVEL</code><a href='#index-FOOTNOTE_005fSEPARATE_005fHEADER_005fLEVEL' class='copiable-anchor'> ¶</a></span></dt> <dd><p>Header formatting level used for the footnotes header with the ‘separate’ footnotestyle; default ‘<samp>4</samp>’. See <a href="Footnote-Styles.html">Footnote Styles</a>. </p> </dd> <dt id='index-FRAMES'><span><code>FRAMES</code><a href='#index-FRAMES' class='copiable-anchor'> ¶</a></span></dt> <dd><p>If set, a file describing the frame layout is generated, together with a file with the short table of contents; default false. </p> </dd> <dt id='index-FRAMESET_005fDOCTYPE'><span><code>FRAMESET_DOCTYPE</code><a href='#index-FRAMESET_005fDOCTYPE' class='copiable-anchor'> ¶</a></span></dt> <dd><p>Same as DOCTYPE, but for the file containing the frame description. </p> </dd> <dt id='index-HEADER_005fIN_005fTABLE'><span><code>HEADER_IN_TABLE</code><a href='#index-HEADER_005fIN_005fTABLE' class='copiable-anchor'> ¶</a></span></dt> <dd><p>Use tables for header formatting rather than a simple <code><div></code> element; default false. </p> </dd> <dt id='index-HTML_005fMATH'><span><code>HTML_MATH</code><a href='#index-HTML_005fMATH' class='copiable-anchor'> ¶</a></span></dt> <dd><p>Method to use to render <code>@math</code>. This can be unset, set to ‘<samp>mathjax</samp>’ (see <a href="MathJax-Customization-Variables.html">MathJax Customization Variables</a>), set to ‘<samp>l2h</samp>’, which has the same effect as setting <code>L2H</code> (see <a href="latex2html-Customization-Variables.html"><code>latex2html</code> Customization Variables</a>), or set to ‘<samp>t2h</samp>’, which uses <code>tex4ht</code>. </p> </dd> <dt id='index-ICONS'><span><code>ICONS</code><a href='#index-ICONS' class='copiable-anchor'> ¶</a></span></dt> <dd><p>Use icons for the navigation panel; default false. </p> </dd> <dt id='index-IMAGE_005fLINK_005fPREFIX'><span><code>IMAGE_LINK_PREFIX</code><a href='#index-IMAGE_005fLINK_005fPREFIX' class='copiable-anchor'> ¶</a></span></dt> <dd><p>If set, the associated value is prepended to the image file links; default unset. </p> </dd> <dt id='index-INDEX_005fENTRY_005fCOLON'><span><code>INDEX_ENTRY_COLON</code><a href='#index-INDEX_005fENTRY_005fCOLON' class='copiable-anchor'> ¶</a></span></dt> <dd><p>Symbol used between the index entry and the associated node or section; default ‘<samp>:</samp>’. </p> </dd> <dt id='index-INFO_005fJS_005fDIR'><span><code>INFO_JS_DIR</code><a href='#index-INFO_005fJS_005fDIR' class='copiable-anchor'> ¶</a></span></dt> <dd><p>(Experimental.) Add a JavaScript browsing interface to the manual. The value of the variable is the directory to place the code for this interface, so you would run the program as e.g. ‘<samp>texi2any --html -c INFO_JS_DIR=js <var>manual</var>.texi</samp>’ to place files in a ‘<samp>js</samp>’ directory under the output. This provides some of the functionality of the Info browsers in a web browser, such as keyboard navigation and index lookup. This only works with non-split HTML output. </p> <p>The interface should provide an acceptable fallback in functionality if JavaScript or web browser features are not available. However, please be cautious when using this option, in case you do make your documentation harder to access for some of your users. </p> </dd> <dt id='index-INLINE_005fCSS_005fSTYLE'><span><code>INLINE_CSS_STYLE</code><a href='#index-INLINE_005fCSS_005fSTYLE' class='copiable-anchor'> ¶</a></span></dt> <dd><p>Put CSS directly in HTML elements rather than at the beginning of the output; default false. </p> </dd> <dt id='index-JS_005fWEBLABELS'><span><code>JS_WEBLABELS</code><a href='#index-JS_005fWEBLABELS' class='copiable-anchor'> ¶</a></span></dt> <dt id='index-JS_005fWEBLABELS_005fFILE'><span><code>JS_WEBLABELS_FILE</code><a href='#index-JS_005fWEBLABELS_005fFILE' class='copiable-anchor'> ¶</a></span></dt> <dd><p>Specify how to use a <em>JavaScript license web labels</em> page to give licensing information and source code for any JavaScript used in the HTML files for the manual. (See <a href="https://www.gnu.org/licenses/javascript-labels.html">https://www.gnu.org/licenses/javascript-labels.html</a>). </p> <p>With the value ‘<samp>generate</samp>’ (the default), generate a labels page at <code>JS_WEBLABELS_FILE</code>, and link to it in the HTML output files. Only do this if actually referencing JavaScript files (either with <code>HTML_MATH</code> set to ‘<samp>mathjax</samp>’, or when using the experimental JS browsing interface when <code>INFO_JS_DIR</code> is set). With this setting, <code>JS_WEBLABELS_FILE</code> must be a relative file name. </p> <p>With the value ‘<samp>reference</samp>’, link to the labels file given by <code>JS_WEBLABELS_FILE</code> in the output, and do not generate a labels file. This setting is useful if you separately maintain a single labels file for a larger website that includes your manual. </p> <p>With ‘<samp>omit</samp>’, neither generate nor link to a labels file. </p> </dd> <dt id='index-KEEP_005fTOP_005fEXTERNAL_005fREF'><span><code>KEEP_TOP_EXTERNAL_REF</code><a href='#index-KEEP_005fTOP_005fEXTERNAL_005fREF' class='copiable-anchor'> ¶</a></span></dt> <dd><p>If set, do not ignore ‘<samp>Top</samp>’ as the first argument for an external ref to a manual, as is done by default. See <a href="Referring-to-a-Manual-as-a-Whole.html">Referring to a Manual as a Whole</a>. </p> </dd> <dt id='index-MAX_005fHEADER_005fLEVEL'><span><code>MAX_HEADER_LEVEL</code><a href='#index-MAX_005fHEADER_005fLEVEL' class='copiable-anchor'> ¶</a></span></dt> <dd><p>Maximum header formatting level used (higher header formatting level numbers correspond to lower sectioning levels); default ‘<samp>4</samp>’. </p> </dd> <dt id='index-MENU_005fENTRY_005fCOLON'><span><code>MENU_ENTRY_COLON</code><a href='#index-MENU_005fENTRY_005fCOLON' class='copiable-anchor'> ¶</a></span></dt> <dd><p>Symbol used between the menu entry and the description; default ‘<samp>:</samp>’. </p> </dd> <dt id='index-MENU_005fSYMBOL'><span><code>MENU_SYMBOL</code><a href='#index-MENU_005fSYMBOL' class='copiable-anchor'> ¶</a></span></dt> <dd><p>Symbol used in front of menu entries when node names are used for menu entries formatting; default ‘<samp>&bull;</samp>’. </p> </dd> <dt id='index-MONOLITHIC'><span><code>MONOLITHIC</code><a href='#index-MONOLITHIC' class='copiable-anchor'> ¶</a></span></dt> <dd><p>Output only one file including the table of contents. Set by default, but only relevant when the output is not split. </p> </dd> <dt id='index-NO_005fCSS'><span><code>NO_CSS</code><a href='#index-NO_005fCSS' class='copiable-anchor'> ¶</a></span></dt> <dd><p>Do not use CSS; default false. See <a href="HTML-CSS.html">HTML CSS</a>. </p> </dd> <dt id='index-PRE_005fABOUT'><span><code>PRE_ABOUT</code><a href='#index-PRE_005fABOUT' class='copiable-anchor'> ¶</a></span></dt> <dd><p>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. </p> </dd> <dt id='index-PRE_005fBODY_005fCLOSE'><span><code>PRE_BODY_CLOSE</code><a href='#index-PRE_005fBODY_005fCLOSE' class='copiable-anchor'> ¶</a></span></dt> <dd><p>If set, the given text will appear at the footer of each HTML file; default unset. </p> </dd> <dt id='index-PROGRAM_005fNAME_005fIN_005fFOOTER'><span><code>PROGRAM_NAME_IN_FOOTER</code><a href='#index-PROGRAM_005fNAME_005fIN_005fFOOTER' class='copiable-anchor'> ¶</a></span></dt> <dd><p>If set, output the program name and miscellaneous related information in the page footers; default false. </p> </dd> <dt id='index-SECTION_005fNAME_005fIN_005fTITLE'><span><code>SECTION_NAME_IN_TITLE</code><a href='#index-SECTION_005fNAME_005fIN_005fTITLE' class='copiable-anchor'> ¶</a></span></dt> <dd><p>If set, when output is split, use the argument of the chapter structuring command (e.g., <code>@chapter</code> or <code>@section</code>) in the <code><title></code> instead of the argument to <code>@node</code>. </p> </dd> <dt id='index-SHOW_005fTITLE'><span><code>SHOW_TITLE</code><a href='#index-SHOW_005fTITLE' class='copiable-anchor'> ¶</a></span></dt> <dd><p>If set, output the title at the beginning of the document; default true. </p> </dd> <dt id='index-SIMPLE_005fMENU'><span><code>SIMPLE_MENU</code><a href='#index-SIMPLE_005fMENU' class='copiable-anchor'> ¶</a></span></dt> <dd><p>If set, use a simple preformatted style for the menu, instead of breaking down the different parts of the menu; default false. See <a href="Menu-Parts.html">The Parts of a Menu</a>. </p> </dd> <dt id='index-TOC_005fLINKS'><span><code>TOC_LINKS</code><a href='#index-TOC_005fLINKS' class='copiable-anchor'> ¶</a></span></dt> <dd><p>If set, links from headings to toc entries are created; default false. </p> </dd> <dt id='index-TOP_005fFILE'><span><code>TOP_FILE</code><a href='#index-TOP_005fFILE' class='copiable-anchor'> ¶</a></span></dt> <dd><p>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. </p> </dd> <dt id='index-TOP_005fNODE_005fFILE_005fTARGET'><span><code>TOP_NODE_FILE_TARGET</code><a href='#index-TOP_005fNODE_005fFILE_005fTARGET' class='copiable-anchor'> ¶</a></span></dt> <dd><p>File name used for the Top node in cross-references; default is <code>index.html</code>. </p> </dd> <dt id='index-TOP_005fNODE_005fUP_005fURL'><span><code>TOP_NODE_UP_URL</code><a href='#index-TOP_005fNODE_005fUP_005fURL' class='copiable-anchor'> ¶</a></span></dt> <dd><p>A url used for Top node up references; the default is <code>undef</code>, in that case no Top node Up reference is generated. For more about the Top node pointers, see <a href="First-Node.html">The First Node</a>. For overriding the Up pointer name in case <code>TOP_NODE_UP_URL</code> is set and for other formats, see <code>TOP_NODE_UP</code> in <a href="Other-Customization-Variables.html">Other Customization Variables</a>. </p> </dd> <dt id='index-USE_005fACCESSKEY'><span><code>USE_ACCESSKEY</code><a href='#index-USE_005fACCESSKEY' class='copiable-anchor'> ¶</a></span></dt> <dd><span id="index-accesskey-2"></span> <p>Use <code>accesskey</code> in cross-references; default true. </p> </dd> <dt id='index-USE_005fISO'><span><code>USE_ISO</code><a href='#index-USE_005fISO' class='copiable-anchor'> ¶</a></span></dt> <dd><p>Use entities for doubled single-quote characters (see <a href="Inserting-Quotation-Marks.html">Inserting Quotation Marks</a>), and ‘<samp>---</samp>’ and ‘<samp>--</samp>’ (see <a href="Conventions.html">General Syntactic Conventions</a>); default true. </p> </dd> <dt id='index-USE_005fLINKS'><span><code>USE_LINKS</code><a href='#index-USE_005fLINKS' class='copiable-anchor'> ¶</a></span></dt> <dd><span id="index-_003clink_003e-HTML-tag_002c-in-_003chead_003e"></span> <span id="index-_003chead_003e-HTML-tag_002c-and-_003clink_003e"></span> <p>Generate <code><link></code> elements in the HTML <code><head></code> output; default true. </p> </dd> <dt id='index-USE_005fNODE_005fDIRECTIONS'><span><code>USE_NODE_DIRECTIONS</code><a href='#index-USE_005fNODE_005fDIRECTIONS' class='copiable-anchor'> ¶</a></span></dt> <dd><p>If true, use nodes to determine where next, up and prev link to in node headers. If false, use sections. If undefined, use <code>USE_NODES</code> value. Default is undefined. Note that this setting does not determine the link string only where the links points to, see <a href="Three-Arguments.html">xrefautomaticsectiontitle</a> for the link string customization. If nodes and sections are systematically associated, this customization has no practical effect. </p> </dd> <dt id='index-USE_005fREL_005fREV'><span><code>USE_REL_REV</code><a href='#index-USE_005fREL_005fREV' class='copiable-anchor'> ¶</a></span></dt> <dd><p>Use <code>rel</code> in cross-references; default true. </p> </dd> <dt id='index-VERTICAL_005fHEAD_005fNAVIGATION'><span><code>VERTICAL_HEAD_NAVIGATION</code><a href='#index-VERTICAL_005fHEAD_005fNAVIGATION' class='copiable-anchor'> ¶</a></span></dt> <dd><p>If set, a vertical navigation panel is used; default false. </p> </dd> <dt id='index-WORDS_005fIN_005fPAGE'><span><code>WORDS_IN_PAGE</code><a href='#index-WORDS_005fIN_005fPAGE' class='copiable-anchor'> ¶</a></span></dt> <dd><span id="index-Navigation-panel_002c-bottom-of-page"></span> <span id="index-Navigation-footer"></span> <p>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. </p> </dd> <dt id='index-XREF_005fUSE_005fFLOAT_005fLABEL'><span><code>XREF_USE_FLOAT_LABEL</code><a href='#index-XREF_005fUSE_005fFLOAT_005fLABEL' class='copiable-anchor'> ¶</a></span></dt> <dd><p>If set, for the float name in cross-references, use the float label instead of the type followed by the float number (see <a href="_0040float.html"><code>@float</code> [<var>type</var>][,<var>label</var>]: Floating Material</a>). The default is off. </p> </dd> <dt id='index-XREF_005fUSE_005fNODE_005fNAME_005fARG'><span><code>XREF_USE_NODE_NAME_ARG</code><a href='#index-XREF_005fUSE_005fNODE_005fNAME_005fARG' class='copiable-anchor'> ¶</a></span></dt> <dd><p>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 <code>USE_NODES</code> is set, otherwise the section name. If set to ‘<samp>undef</samp>’, use the first argument in preformatted environments, otherwise use the node name or section name depending on <code>USE_NODES</code>. The default is ‘<samp>undef</samp>’. </p> </dd> </dl> </div> <hr> <div class="header"> <p> Next: <a href="MathJax-Customization-Variables.html">MathJax Customization Variables</a>, Previous: <a href="Customization-Variables-and-Options.html">Customization Variables and Options</a>, Up: <a href="Customization-Variables.html">Customization Variables</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Command-and-Variable-Index.html" title="Index" rel="index">Index</a>]</p> </div> </body> </html>