| <!DOCTYPE html> |
| <html> |
| <!-- Created by Texinfo 6.8dev+dev, http://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.8dev, 23 February 2022), |
| 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-2022 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.8dev)</title> |
| |
| <meta name="description" content="HTML Customization Variables (GNU Texinfo 6.8dev)"> |
| <meta name="keywords" content="HTML Customization Variables (GNU Texinfo 6.8dev)"> |
| <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-link {visibility: hidden; text-decoration: none; line-height: 0em} |
| span.r {font-family: initial; font-weight: normal} |
| span:hover a.copiable-link {visibility: visible} |
| --> |
| </style> |
| |
| |
| </head> |
| |
| <body lang="en"> |
| <div class="subsection-level-extent" id="HTML-Customization-Variables"> |
| <div class="nav-panel"> |
| <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> |
| <h4 class="subsection" id="HTML-Customization-Variables-1">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 class="ref" href="Other-Customization-Variables.html">Other Customization Variables</a>. |
| </p> |
| <dl class="vtable"> |
| <dt id='index-AVOID_005fMENU_005fREDUNDANCY'><span><code class="code">AVOID_MENU_REDUNDANCY</code><a class="copiable-link" href='#index-AVOID_005fMENU_005fREDUNDANCY'> ¶</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 class="code">AFTER_BODY_OPEN</code><a class="copiable-link" href='#index-AFTER_005fBODY_005fOPEN'> ¶</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_005fSHORT_005fTOC_005fLINES'><span><code class="code">AFTER_SHORT_TOC_LINES</code><a class="copiable-link" href='#index-AFTER_005fSHORT_005fTOC_005fLINES'> ¶</a></span></dt> |
| <dt id='index-AFTER_005fTOC_005fLINES'><span><code class="code">AFTER_TOC_LINES</code><a class="copiable-link" href='#index-AFTER_005fTOC_005fLINES'> ¶</a></span></dt> |
| <dd><p>If set, the corresponding text is output after the short |
| table of contents for <code class="code">AFTER_SHORT_TOC_LINES</code> and after the table of |
| contents for <code class="code">AFTER_TOC_LINES</code>; otherwise, a default string is |
| used. At the time of writing, a <code class="code"></div></code> element is closed. |
| </p> |
| <p>In general, you should set <code class="code">BEFORE_SHORT_TOC_LINES</code> if |
| <code class="code">AFTER_SHORT_TOC_LINES</code> is set, and you should set |
| <code class="code">BEFORE_TOC_LINES</code> if <code class="code">AFTER_TOC_LINES</code> is set. |
| </p> |
| </dd> |
| <dt id='index-BASEFILENAME_005fLENGTH'><span><code class="code">BASEFILENAME_LENGTH</code><a class="copiable-link" href='#index-BASEFILENAME_005fLENGTH'> ¶</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 class="pxref" href="HTML-Xref-Link-Basics.html">HTML Cross-reference Link Basics</a>). |
| </p> |
| </dd> |
| <dt id='index-BEFORE_005fSHORT_005fTOC_005fLINES'><span><code class="code">BEFORE_SHORT_TOC_LINES</code><a class="copiable-link" href='#index-BEFORE_005fSHORT_005fTOC_005fLINES'> ¶</a></span></dt> |
| <dt id='index-BEFORE_005fTOC_005fLINES'><span><code class="code">BEFORE_TOC_LINES</code><a class="copiable-link" href='#index-BEFORE_005fTOC_005fLINES'> ¶</a></span></dt> |
| <dd><p>If set, the corresponding text is output before the short |
| table of contents for <code class="code">BEFORE_SHORT_TOC_LINES</code> and before the table of |
| contents for <code class="code">BEFORE_TOC_LINES</code>, otherwise a default string is |
| used. At the time of writing, a <code class="code"><div ...></code> element is opened. |
| </p> |
| <p>In general you should set <code class="code">AFTER_SHORT_TOC_LINES</code> if |
| <code class="code">BEFORE_SHORT_TOC_LINES</code> is set, and you should set |
| <code class="code">AFTER_TOC_LINES</code> if <code class="code">BEFORE_TOC_LINES</code> is set. |
| </p> |
| |
| </dd> |
| <dt id='index-BIG_005fRULE'><span><code class="code">BIG_RULE</code><a class="copiable-link" href='#index-BIG_005fRULE'> ¶</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 class="code"><hr></code>. |
| </p> |
| </dd> |
| <dt id='index-BODYTEXT'><span><code class="code">BODYTEXT</code><a class="copiable-link" href='#index-BODYTEXT'> ¶</a></span></dt> |
| <dd><a class="index-entry-id" id="index-_003cbody_003e-text_002c-customizing"></a> |
| <a class="index-entry-id" id="index-lang_002c-HTML-attribute"></a> |
| <p>The text appearing in <code class="code"><body></code>. By default, sets the |
| HTML <code class="code">lang</code> attribute to the document language |
| (see <a class="pxref" href="_0040documentlanguage.html"><code class="code">@documentlanguage <var class="var">ll</var>[_<var class="var">cc</var>]</code>: Set the Document Language</a>). |
| </p> |
| </dd> |
| <dt id='index-CASE_005fINSENSITIVE_005fFILENAMES'><span><code class="code">CASE_INSENSITIVE_FILENAMES</code><a class="copiable-link" href='#index-CASE_005fINSENSITIVE_005fFILENAMES'> ¶</a></span></dt> |
| <dd><p>Construct output file names as if the filesystem were case |
| insensitive (see <a class="pxref" href="HTML-Splitting.html">HTML Splitting</a>); default false. |
| </p> |
| </dd> |
| <dt id='index-CHAPTER_005fHEADER_005fLEVEL'><span><code class="code">CHAPTER_HEADER_LEVEL</code><a class="copiable-link" href='#index-CHAPTER_005fHEADER_005fLEVEL'> ¶</a></span></dt> |
| <dd><p>Header formatting level used for chapter level sectioning |
| commands; default ‘<samp class="samp">2</samp>’. |
| </p> |
| </dd> |
| <dt id='index-CHECK_005fHTMLXREF'><span><code class="code">CHECK_HTMLXREF</code><a class="copiable-link" href='#index-CHECK_005fHTMLXREF'> ¶</a></span></dt> |
| <dd><p>Check that manuals which are the target of external |
| cross-references (see <a class="pxref" href="Four-and-Five-Arguments.html"><code class="code">@xref</code> with Four and Five Arguments</a>) are present in |
| <samp class="file">htmlxref.cnf</samp> (see <a class="pxref" href="HTML-Xref-Configuration.html">HTML Cross-reference Configuration: <samp class="file">htmlxref.cnf</samp></a>); default false. |
| </p> |
| </dd> |
| <dt id='index-COMPLEX_005fFORMAT_005fIN_005fTABLE'><span><code class="code">COMPLEX_FORMAT_IN_TABLE</code><a class="copiable-link" href='#index-COMPLEX_005fFORMAT_005fIN_005fTABLE'> ¶</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 class="code">CONTENTS_OUTPUT_LOCATION</code><a class="copiable-link" href='#index-CONTENTS_005fOUTPUT_005fLOCATION'> ¶</a></span></dt> |
| <dd><p>If set to ‘<samp class="samp">after_top</samp>’, output the contents at the end of the <code class="code">@top</code> |
| section. If set to ‘<samp class="samp">inline</samp>’, output the contents where the |
| <code class="code">@contents</code> and similar @-commands are located. If set to |
| ‘<samp class="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 class="samp">after_title</samp>’ the tables of contents are output after the title; default |
| ‘<samp class="samp">after_top</samp>’. |
| </p> |
| </dd> |
| <dt id='index-CONVERT_005fTEXINFO_005fMATH_005fTO_005fLATEX'><span><code class="code">CONVERT_TEXINFO_MATH_TO_LATEX</code><a class="copiable-link" href='#index-CONVERT_005fTEXINFO_005fMATH_005fTO_005fLATEX'> ¶</a></span></dt> |
| <dd><p>If set, convert <code class="code">@math</code> and <code class="code">@displaymath</code> to LaTeX. Default |
| <code class="code">undef</code>. If undefined, set if <code class="code">HTML_MATH</code> is set. |
| </p> |
| </dd> |
| <dt id='index-COPIABLE_005fLINKS'><span><code class="code">COPIABLE_LINKS</code><a class="copiable-link" href='#index-COPIABLE_005fLINKS'> ¶</a></span></dt> |
| <dd><p>If set, output copiable links for the definition commands |
| (see <a class="pxref" href="Definition-Commands.html">Definition Commands</a>) and table commands (see <a class="pxref" href="Two_002dcolumn-Tables.html">Making a Two-column Table</a>) where an index entry is defined. A link appears as a ‘¶’ |
| sign that appears when you hover the mouse pointer over the heading text. |
| </p> |
| </dd> |
| <dt id='index-DATE_005fIN_005fHEADER'><span><code class="code">DATE_IN_HEADER</code><a class="copiable-link" href='#index-DATE_005fIN_005fHEADER'> ¶</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 class="code">DEF_TABLE</code><a class="copiable-link" href='#index-DEF_005fTABLE'> ¶</a></span></dt> |
| <dd><p>If set, a <code class="code"><table></code> construction for <code class="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 class="code">DEFAULT_RULE</code><a class="copiable-link" href='#index-DEFAULT_005fRULE'> ¶</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 class="code"><hr></code>. |
| </p> |
| </dd> |
| <dt id='index-DO_005fABOUT'><span><code class="code">DO_ABOUT</code><a class="copiable-link" href='#index-DO_005fABOUT'> ¶</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_005fCROSSREF_005fSPLIT'><span><code class="code">EXTERNAL_CROSSREF_SPLIT</code><a class="copiable-link" href='#index-EXTERNAL_005fCROSSREF_005fSPLIT'> ¶</a></span></dt> |
| <dd><p>For cross-references to other manuals, this determines if the other |
| manual is considered to be split or monolithic. By default, it is set |
| based on the value of <code class="code">SPLIT</code>. See <a class="xref" href="HTML-Xref.html">HTML Cross-references</a>, and see <a class="pxref" href="HTML-Xref-Configuration.html">HTML Cross-reference Configuration: <samp class="file">htmlxref.cnf</samp></a>. |
| </p> |
| </dd> |
| <dt id='index-EXTERNAL_005fDIR'><span><code class="code">EXTERNAL_DIR</code><a class="copiable-link" href='#index-EXTERNAL_005fDIR'> ¶</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 class="pxref" href="HTML-Xref-Configuration.html">HTML Cross-reference Configuration: <samp class="file">htmlxref.cnf</samp></a>) than this variable. |
| </p> |
| </dd> |
| <dt id='index-EXTERNAL_005fCROSSREF_005fEXTENSION'><span><code class="code">EXTERNAL_CROSSREF_EXTENSION</code><a class="copiable-link" href='#index-EXTERNAL_005fCROSSREF_005fEXTENSION'> ¶</a></span></dt> |
| <dd><p>File extension for cross-references to other manuals. If unset, |
| based on <code class="code">EXTENSION</code>. |
| </p> |
| </dd> |
| <dt id='index-EXTRA_005fHEAD'><span><code class="code">EXTRA_HEAD</code><a class="copiable-link" href='#index-EXTRA_005fHEAD'> ¶</a></span></dt> |
| <dd><p>Additional text appearing within <code class="code"><head></code>; default unset. |
| </p> |
| </dd> |
| <dt id='index-FOOTNOTE_005fEND_005fHEADER_005fLEVEL'><span><code class="code">FOOTNOTE_END_HEADER_LEVEL</code><a class="copiable-link" href='#index-FOOTNOTE_005fEND_005fHEADER_005fLEVEL'> ¶</a></span></dt> |
| <dd><p>Header formatting level used for the footnotes header with |
| the ‘end’ footnotestyle; default ‘<samp class="samp">4</samp>’. See <a class="xref" href="Footnote-Styles.html">Footnote Styles</a>. |
| </p> |
| </dd> |
| <dt id='index-FOOTNOTE_005fSEPARATE_005fHEADER_005fLEVEL'><span><code class="code">FOOTNOTE_SEPARATE_HEADER_LEVEL</code><a class="copiable-link" href='#index-FOOTNOTE_005fSEPARATE_005fHEADER_005fLEVEL'> ¶</a></span></dt> |
| <dd><p>Header formatting level used for the footnotes header with |
| the ‘separate’ footnotestyle; default ‘<samp class="samp">4</samp>’. See <a class="xref" href="Footnote-Styles.html">Footnote Styles</a>. |
| </p> |
| </dd> |
| <dt id='index-FRAMES'><span><code class="code">FRAMES</code><a class="copiable-link" href='#index-FRAMES'> ¶</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 class="code">FRAMESET_DOCTYPE</code><a class="copiable-link" href='#index-FRAMESET_005fDOCTYPE'> ¶</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 class="code">HEADER_IN_TABLE</code><a class="copiable-link" href='#index-HEADER_005fIN_005fTABLE'> ¶</a></span></dt> |
| <dd><p>Use tables for header formatting rather than a simple |
| <code class="code"><div></code> element; default false. |
| </p> |
| </dd> |
| <dt id='index-HTML_005fMATH'><span><code class="code">HTML_MATH</code><a class="copiable-link" href='#index-HTML_005fMATH'> ¶</a></span></dt> |
| <dd><p>Method to use to render <code class="code">@math</code>. This can be unset, set to |
| ‘<samp class="samp">mathjax</samp>’ (see <a class="pxref" href="MathJax-Customization-Variables.html">MathJax Customization Variables</a>), |
| set to ‘<samp class="samp">l2h</samp>’, which uses <code class="command">latex2html</code> |
| (see <a class="pxref" href="latex2html-Customization-Variables.html"><code class="command">latex2html</code> Customization Variables</a>), or set to |
| ‘<samp class="samp">t2h</samp>’, which uses <code class="command">tex4ht</code>. |
| </p> |
| </dd> |
| <dt id='index-HTML_005fROOT_005fELEMENT_005fATTRIBUTES'><span><code class="code">HTML_ROOT_ELEMENT_ATTRIBUTES</code><a class="copiable-link" href='#index-HTML_005fROOT_005fELEMENT_005fATTRIBUTES'> ¶</a></span></dt> |
| <dd><p>Use that string for the <code class="code"><html></code> HTML document root element. |
| Default undefined. |
| </p> |
| </dd> |
| <dt id='index-ICONS'><span><code class="code">ICONS</code><a class="copiable-link" href='#index-ICONS'> ¶</a></span></dt> |
| <dd><p>Use icons for the navigation panel; default false. |
| </p> |
| </dd> |
| <dt id='index-IMAGE_005fLINK_005fPREFIX'><span><code class="code">IMAGE_LINK_PREFIX</code><a class="copiable-link" href='#index-IMAGE_005fLINK_005fPREFIX'> ¶</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 class="code">INDEX_ENTRY_COLON</code><a class="copiable-link" href='#index-INDEX_005fENTRY_005fCOLON'> ¶</a></span></dt> |
| <dd><p>Symbol used between the index entry and the associated node or section; |
| default ‘<samp class="samp">:</samp>’. |
| </p> |
| </dd> |
| <dt id='index-INFO_005fJS_005fDIR'><span><code class="code">INFO_JS_DIR</code><a class="copiable-link" href='#index-INFO_005fJS_005fDIR'> ¶</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 class="samp">texi2any --html |
| -c INFO_JS_DIR=js <var class="var">manual</var>.texi</samp>’ to place files in a ‘<samp class="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 class="code">INLINE_CSS_STYLE</code><a class="copiable-link" href='#index-INLINE_005fCSS_005fSTYLE'> ¶</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 class="code">JS_WEBLABELS</code><a class="copiable-link" href='#index-JS_005fWEBLABELS'> ¶</a></span></dt> |
| <dt id='index-JS_005fWEBLABELS_005fFILE'><span><code class="code">JS_WEBLABELS_FILE</code><a class="copiable-link" href='#index-JS_005fWEBLABELS_005fFILE'> ¶</a></span></dt> |
| <dd><p>Specify how to use a <em class="dfn">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 class="uref" href="https://www.gnu.org/licenses/javascript-labels.html">https://www.gnu.org/licenses/javascript-labels.html</a>). |
| </p> |
| <p>With the value ‘<samp class="samp">generate</samp>’ (the default), generate a labels page |
| at <code class="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 class="code">HTML_MATH</code> set to ‘<samp class="samp">mathjax</samp>’, or when using the experimental |
| JS browsing interface when <code class="code">INFO_JS_DIR</code> is set). With this |
| setting, <code class="code">JS_WEBLABELS_FILE</code> must be a relative file name. |
| </p> |
| <p>With the value ‘<samp class="samp">reference</samp>’, link to the labels |
| file given by <code class="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 class="samp">omit</samp>’, neither generate nor link to a labels file. |
| </p> |
| </dd> |
| <dt id='index-KEEP_005fTOP_005fEXTERNAL_005fREF'><span><code class="code">KEEP_TOP_EXTERNAL_REF</code><a class="copiable-link" href='#index-KEEP_005fTOP_005fEXTERNAL_005fREF'> ¶</a></span></dt> |
| <dd><p>If set, do not ignore ‘<samp class="samp">Top</samp>’ as the first |
| argument for an external ref to a manual, as is done by default. |
| See <a class="xref" 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 class="code">MAX_HEADER_LEVEL</code><a class="copiable-link" href='#index-MAX_005fHEADER_005fLEVEL'> ¶</a></span></dt> |
| <dd><p>Maximum header formatting level used (higher header |
| formatting level numbers correspond to lower sectioning levels); |
| default ‘<samp class="samp">4</samp>’. |
| </p> |
| </dd> |
| <dt id='index-MENU_005fENTRY_005fCOLON'><span><code class="code">MENU_ENTRY_COLON</code><a class="copiable-link" href='#index-MENU_005fENTRY_005fCOLON'> ¶</a></span></dt> |
| <dd><p>Symbol used between the menu entry and the description; default |
| ‘<samp class="samp">:</samp>’. |
| </p> |
| </dd> |
| <dt id='index-MENU_005fSYMBOL'><span><code class="code">MENU_SYMBOL</code><a class="copiable-link" href='#index-MENU_005fSYMBOL'> ¶</a></span></dt> |
| <dd><p>Symbol used in front of menu entries when node names are used |
| for menu entries formatting; default is undefined and set to |
| <code class="code">&bull;</code> if <code class="code">USE_NUMERIC_ENTITY</code> is not set, and to |
| <code class="code">&#8217;</code> if set. |
| </p> |
| </dd> |
| <dt id='index-MONOLITHIC'><span><code class="code">MONOLITHIC</code><a class="copiable-link" href='#index-MONOLITHIC'> ¶</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 class="code">NO_CSS</code><a class="copiable-link" href='#index-NO_005fCSS'> ¶</a></span></dt> |
| <dd><p>Do not use CSS; default false. See <a class="xref" href="HTML-CSS.html">HTML CSS</a>. |
| </p> |
| </dd> |
| <dt id='index-NO_005fCUSTOM_005fHTML_005fATTRIBUTE'><span><code class="code">NO_CUSTOM_HTML_ATTRIBUTE</code><a class="copiable-link" href='#index-NO_005fCUSTOM_005fHTML_005fATTRIBUTE'> ¶</a></span></dt> |
| <dd><p>Do not output HTML with custom attributes in elements; default false. |
| </p> |
| </dd> |
| <dt id='index-NO_005fNUMBER_005fFOOTNOTE_005fSYMBOL'><span><code class="code">NO_NUMBER_FOOTNOTE_SYMBOL</code><a class="copiable-link" href='#index-NO_005fNUMBER_005fFOOTNOTE_005fSYMBOL'> ¶</a></span></dt> |
| <dd><p>Symbol used for footnotes if <code class="code">NUMBER_FOOTNOTES</code> is false. |
| Default is <code class="code">*</code>. |
| </p> |
| </dd> |
| <dt id='index-PRE_005fBODY_005fCLOSE'><span><code class="code">PRE_BODY_CLOSE</code><a class="copiable-link" href='#index-PRE_005fBODY_005fCLOSE'> ¶</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_005fABOUT'><span><code class="code">PROGRAM_NAME_IN_ABOUT</code><a class="copiable-link" href='#index-PROGRAM_005fNAME_005fIN_005fABOUT'> ¶</a></span></dt> |
| <dd><p>Used when an About element is output. If set, output the program |
| name and miscellaneous related information in About special element; |
| default false. |
| </p> |
| </dd> |
| <dt id='index-PROGRAM_005fNAME_005fIN_005fFOOTER'><span><code class="code">PROGRAM_NAME_IN_FOOTER</code><a class="copiable-link" href='#index-PROGRAM_005fNAME_005fIN_005fFOOTER'> ¶</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 class="code">SECTION_NAME_IN_TITLE</code><a class="copiable-link" href='#index-SECTION_005fNAME_005fIN_005fTITLE'> ¶</a></span></dt> |
| <dd><p>If set, when output is split, use the argument of the chapter |
| structuring command (e.g., <code class="code">@chapter</code> or <code class="code">@section</code>) |
| in the <code class="code"><title></code> instead of the argument to <code class="code">@node</code>. |
| </p> |
| </dd> |
| <dt id='index-SHOW_005fBUILTIN_005fCSS_005fRULES'><span><code class="code">SHOW_BUILTIN_CSS_RULES</code><a class="copiable-link" href='#index-SHOW_005fBUILTIN_005fCSS_005fRULES'> ¶</a></span></dt> |
| <dd><p>Output the built-in default CSS rules on the standard output and exit. |
| </p> |
| </dd> |
| <dt id='index-SHOW_005fTITLE'><span><code class="code">SHOW_TITLE</code><a class="copiable-link" href='#index-SHOW_005fTITLE'> ¶</a></span></dt> |
| <dd><p>If set, output the title at the beginning of the document; |
| default ‘<samp class="samp">undef</samp>’. If set to ‘<samp class="samp">undef</samp>’, setting |
| <code class="code">NO_TOP_NODE_OUTPUT</code> also sets <code class="code">SHOW_TITLE</code> for HTML. |
| </p> |
| |
| </dd> |
| <dt id='index-SIMPLE_005fMENU'><span><code class="code">SIMPLE_MENU</code><a class="copiable-link" href='#index-SIMPLE_005fMENU'> ¶</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 class="xref" href="Menu-Parts.html">The Parts of a Menu</a>. |
| </p> |
| </dd> |
| <dt id='index-TOC_005fLINKS'><span><code class="code">TOC_LINKS</code><a class="copiable-link" href='#index-TOC_005fLINKS'> ¶</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 class="code">TOP_FILE</code><a class="copiable-link" href='#index-TOP_005fFILE'> ¶</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 class="code">TOP_NODE_FILE_TARGET</code><a class="copiable-link" href='#index-TOP_005fNODE_005fFILE_005fTARGET'> ¶</a></span></dt> |
| <dd><p>File name used for the Top node in cross-references; |
| default is <code class="code">index.html</code>. |
| </p> |
| </dd> |
| <dt id='index-TOP_005fNODE_005fUP_005fURL'><span><code class="code">TOP_NODE_UP_URL</code><a class="copiable-link" href='#index-TOP_005fNODE_005fUP_005fURL'> ¶</a></span></dt> |
| <dd><p>A url used for Top node up references; the default is |
| <code class="code">undef</code>, in that case no Top node Up reference is generated. |
| For more about the Top node pointers, see <a class="pxref" href="First-Node.html">The First Node</a>. For |
| overriding the Up pointer name in case <code class="code">TOP_NODE_UP_URL</code> is set |
| and for other formats, see <code class="code">TOP_NODE_UP</code> in |
| <a class="ref" href="Other-Customization-Variables.html">Other Customization Variables</a>. |
| </p> |
| </dd> |
| <dt id='index-USE_005fACCESSKEY'><span><code class="code">USE_ACCESSKEY</code><a class="copiable-link" href='#index-USE_005fACCESSKEY'> ¶</a></span></dt> |
| <dd><a class="index-entry-id" id="index-accesskey-2"></a> |
| <p>Use <code class="code">accesskey</code> in cross-references; default true. |
| </p> |
| </dd> |
| <dt id='index-USE_005fISO'><span><code class="code">USE_ISO</code><a class="copiable-link" href='#index-USE_005fISO'> ¶</a></span></dt> |
| <dd><p>Use entities for doubled single-quote characters |
| (see <a class="pxref" href="Inserting-Quotation-Marks.html">Inserting Quotation Marks</a>), and ‘<samp class="samp">---</samp>’ and ‘<samp class="samp">--</samp>’ |
| (see <a class="pxref" href="Conventions.html">General Syntactic Conventions</a>); default true. |
| </p> |
| </dd> |
| <dt id='index-USE_005fLINKS'><span><code class="code">USE_LINKS</code><a class="copiable-link" href='#index-USE_005fLINKS'> ¶</a></span></dt> |
| <dd><a class="index-entry-id" id="index-_003clink_003e-HTML-tag_002c-in-_003chead_003e"></a> |
| <a class="index-entry-id" id="index-_003chead_003e-HTML-tag_002c-and-_003clink_003e"></a> |
| <p>Generate <code class="code"><link></code> elements in the HTML <code class="code"><head></code> |
| output; default true. |
| </p> |
| </dd> |
| <dt id='index-USE_005fNODE_005fDIRECTIONS'><span><code class="code">USE_NODE_DIRECTIONS</code><a class="copiable-link" href='#index-USE_005fNODE_005fDIRECTIONS'> ¶</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 class="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 class="ref" 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 class="code">USE_REL_REV</code><a class="copiable-link" href='#index-USE_005fREL_005fREV'> ¶</a></span></dt> |
| <dd><p>Use <code class="code">rel</code> in cross-references; default true. |
| </p> |
| </dd> |
| <dt id='index-USE_005fXML_005fSYNTAX'><span><code class="code">USE_XML_SYNTAX</code><a class="copiable-link" href='#index-USE_005fXML_005fSYNTAX'> ¶</a></span></dt> |
| <dd><p>Use XML/XHTML compatible syntax. |
| </p> |
| </dd> |
| <dt id='index-VERTICAL_005fHEAD_005fNAVIGATION'><span><code class="code">VERTICAL_HEAD_NAVIGATION</code><a class="copiable-link" href='#index-VERTICAL_005fHEAD_005fNAVIGATION'> ¶</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 class="code">WORDS_IN_PAGE</code><a class="copiable-link" href='#index-WORDS_005fIN_005fPAGE'> ¶</a></span></dt> |
| <dd><a class="index-entry-id" id="index-Navigation-panel_002c-bottom-of-page"></a> |
| <a class="index-entry-id" id="index-Navigation-footer"></a> |
| <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 class="code">XREF_USE_FLOAT_LABEL</code><a class="copiable-link" href='#index-XREF_005fUSE_005fFLOAT_005fLABEL'> ¶</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 class="pxref" href="_0040float.html"><code class="code">@float</code> [<var class="var">type</var>][,<var class="var">label</var>]: Floating Material</a>). The default is off. |
| </p> |
| </dd> |
| <dt id='index-XREF_005fUSE_005fNODE_005fNAME_005fARG'><span><code class="code">XREF_USE_NODE_NAME_ARG</code><a class="copiable-link" href='#index-XREF_005fUSE_005fNODE_005fNAME_005fARG'> ¶</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 class="code">USE_NODES</code> is set, otherwise the section name. If set to |
| ‘<samp class="samp">undef</samp>’, use the first argument in preformatted environments, |
| otherwise use the node name or section name depending on |
| <code class="code">USE_NODES</code>. The default is ‘<samp class="samp">undef</samp>’. |
| </p> |
| </dd> |
| </dl> |
| |
| |
| </div> |
| <hr> |
| <div class="nav-panel"> |
| <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> |
