[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Texi2html-cvs] texi2html ChangeLog doc/.cvsignore doc/texi2htm...
|
From: |
Derek Robert Price |
|
Subject: |
[Texi2html-cvs] texi2html ChangeLog doc/.cvsignore doc/texi2htm... |
|
Date: |
Tue, 23 Dec 2008 01:55:35 +0000 |
CVSROOT: /cvsroot/texi2html
Module name: texi2html
Changes by: Derek Robert Price <dprice> 08/12/23 01:55:35
Modified files:
. : ChangeLog
doc : .cvsignore
Removed files:
doc : texi2html.html
Log message:
* doc/.cvsignore: Ignore this...
* doc/texi2html.html: ...removed file, since it is generated during
build.
CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/texi2html/ChangeLog?cvsroot=texi2html&r1=1.344&r2=1.345
http://cvs.savannah.gnu.org/viewcvs/texi2html/doc/.cvsignore?cvsroot=texi2html&r1=1.6&r2=1.7
http://cvs.savannah.gnu.org/viewcvs/texi2html/doc/texi2html.html?cvsroot=texi2html&r1=1.105&r2=0
Patches:
Index: ChangeLog
===================================================================
RCS file: /cvsroot/texi2html/texi2html/ChangeLog,v
retrieving revision 1.344
retrieving revision 1.345
diff -u -b -r1.344 -r1.345
--- ChangeLog 16 Dec 2008 11:18:31 -0000 1.344
+++ ChangeLog 23 Dec 2008 01:55:34 -0000 1.345
@@ -1,3 +1,9 @@
+2008-12-22 Derek Price <address@hidden>
+
+ * doc/.cvsignore: Ignore this...
+ * doc/texi2html.html: ...removed file, since it is generated during
+ build.
+
2008-12-16 Patrice Dumas <address@hidden>
* test/*: handle more gracefully missing latex2html or tex4ht.
Index: doc/.cvsignore
===================================================================
RCS file: /cvsroot/texi2html/texi2html/doc/.cvsignore,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -b -r1.6 -r1.7
--- doc/.cvsignore 5 Feb 2005 17:34:40 -0000 1.6
+++ doc/.cvsignore 23 Dec 2008 01:55:34 -0000 1.7
@@ -21,3 +21,4 @@
texi2html.dvi
texi2html.ps
texi2html.tmp
+texi2html.html
Index: doc/texi2html.html
===================================================================
RCS file: doc/texi2html.html
diff -N doc/texi2html.html
--- doc/texi2html.html 16 Dec 2008 11:18:32 -0000 1.105
+++ /dev/null 1 Jan 1970 00:00:00 -0000
@@ -1,7829 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html401/loose.dtd";>
-<html>
-<!-- Portions of texi2html
- Copyright C 1999, 2000 Lionel Cons
-
- Copyright C 1999, 2000 Karl Berry
-
- Copyright C 1999, 2000 Olaf Bachmann
-
- Copyright C 2002, 2003, 2004, 2005, 2006, 2007 Patrice Dumas
-
- Copyright C 2001, 2002, 2003, 2004, 2005, 2006 Derek Price
-
- Copyright C many others.
-
-
-
- Portions of this manual
- Copyright C 1999, 2000 Karl Heinz Marbaise (manual)
-
- Copyright C 2003, 2007 Derek Price (manual)
-
- Copyright C 2003, 2004, 2005, 2006, 2007 Patrice Dumas (manual)
-
-
-
-Permission is granted to make and distribute verbatim
-copies of this manual provided the copyright notice and
-this permission notice are preserved on all copies.
-
-Permission is granted to copy and distribute modified
-versions of this manual under the conditions for verbatim
-copying, provided that the entire resulting derived work is
-distributed under the terms of a permission notice
-identical to this one.
-
-Permission is granted to copy and distribute translations
-of this manual into another language, under the above
-conditions for modified versions, except that this
-permission notice may be stated in a translation approved
-by the Free Software Foundation.
- -->
-<!-- Created on December 16, 2008 by texi2html 1.79
-texi2html was written by:
- Lionel Cons <address@hidden> (original author)
- Karl Berry <address@hidden>
- Olaf Bachmann <address@hidden>
- and many others.
-Maintained by: Many creative people.
-Send bugs and suggestions to <address@hidden>
--->
-<head>
-<title>Texi2HTML – Texinfo to HTML v1.79</title>
-
-<meta name="description" content="Texi2HTML – Texinfo to HTML v1.79">
-<meta name="keywords" content="Texi2HTML – Texinfo to HTML v1.79">
-<meta name="resource-type" content="document">
-<meta name="distribution" content="global">
-<meta name="Generator" content="texi2html 1.79">
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<style type="text/css">
-<!--
-a.summary-letter {text-decoration: none}
-blockquote.smallquotation {font-size: smaller}
-pre.display {font-family: serif}
-pre.format {font-family: serif}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: serif; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: serif; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.roman {font-family:serif; font-weight:normal;}
-span.sansserif {font-family:sans-serif; font-weight:normal;}
-ul.toc {list-style: none}
--->
-</style>
-
-
-</head>
-
-<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
-
-<table>
-<tr><td width="12%">Portions of <code>texi2html</code></td></tr>
-<tr><td width="12%"></td><td width="88%">Copyright © 1999, 2000 Lionel
Cons<br></td></tr>
-<tr><td width="12%"></td><td width="88%">Copyright © 1999, 2000 Karl
Berry<br></td></tr>
-<tr><td width="12%"></td><td width="88%">Copyright © 1999, 2000 Olaf
Bachmann<br></td></tr>
-<tr><td width="12%"></td><td width="88%">Copyright © 2002, 2003, 2004,
2005, 2006, 2007 Patrice Dumas<br></td></tr>
-<tr><td width="12%"></td><td width="88%">Copyright © 2001, 2002, 2003,
2004, 2005, 2006 Derek Price<br></td></tr>
-<tr><td width="12%"></td><td width="88%">Copyright © many
others.<br></td></tr>
-<tr><td width="12%"></td><td width="88%"></td></tr>
-<tr><td width="12%"></td><td width="88%"></td></tr>
-<tr><td width="12%">Portions of this manual</td></tr>
-<tr><td width="12%"></td><td width="88%">Copyright © 1999, 2000 Karl
Heinz Marbaise (manual)<br></td></tr>
-<tr><td width="12%"></td><td width="88%">Copyright © 2003, 2007 Derek
Price (manual)<br></td></tr>
-<tr><td width="12%"></td><td width="88%">Copyright © 2003, 2004, 2005,
2006, 2007 Patrice Dumas (manual)<br></td></tr>
-</table>
-
-<p>Permission is granted to make and distribute verbatim
-copies of this manual provided the copyright notice and
-this permission notice are preserved on all copies.
-</p>
-<p>Permission is granted to copy and distribute modified
-versions of this manual under the conditions for verbatim
-copying, provided that the entire resulting derived work is
-distributed under the terms of a permission notice
-identical to this one.
-</p>
-<p>Permission is granted to copy and distribute translations
-of this manual into another language, under the above
-conditions for modified versions, except that this
-permission notice may be stated in a translation approved
-by the Free Software Foundation.
-</p>
-
-
-<a name="Top"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Texi2HTML"></a>
-<h1 class="settitle">Texi2HTML</h1>
-
-<a name="index-bug-report"></a>
-
-<p>This manual, last updated 1 November 2008, describes version 1.79
-of the <code>texi2html</code> Perl script which converts
-<a href="http://www.texinfo.org";>Texinfo</a> into <a
href="http://w3c.org";>HTML</a>.
-</p>
-<p>Please send bug reports concerning this manual to the Texi2HTML developement
-list <a href="mailto:address@hidden";>address@hidden</a>. Please state the exact
-version of the manual which contains the bug, as given above.
-</p>
-
-<table><tr><td> </td><td><pre class="example"><strong>This manual is
currently under construction and of course incomplete. ;-)</strong>
-</pre></td></tr></table>
-
-<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top"><a href="#Overview">1.
Overview</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Obtaining-texi2html">2. Obtaining
<code>texi2html</code></a></td><td> </td><td align="left"
valign="top">
- Obtaining a copy of the <code>texi2html</code>
- source code distribution
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Installation">3. Installation of
<code>texi2html</code></a></td><td> </td><td align="left"
valign="top"> Installing <code>texi2html</code>
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Invoking-texi2html">4. Invoking
<code>texi2html</code></a></td><td> </td><td align="left"
valign="top"> Description of the command line options
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Initialization-files">5. Overview
of initialization files content and loading</a></td><td> </td><td
align="left" valign="top"> What kind of variables and subroutines appear
- in init files and how they are called
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Changing-the-page-layout">6. Fine
tuning of the page layout</a></td><td> </td><td align="left"
valign="top"></td></tr>
-<tr><td align="left" valign="top"><a href="#Customizing-HTML">7. Customizing
<acronym>HTML</acronym> and text style in init
files</a></td><td> </td><td align="left" valign="top"> Fine
tuning of the <acronym>HTML</acronym> elements
- associated with the texinfo constructs
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Internationalization">A.
Internationalization</a></td><td> </td><td align="left"
valign="top"> Help translating!
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Incompatibilities">B.
Incompatibilities with previous versions</a></td><td> </td><td
align="left" valign="top"></td></tr>
-<tr><td align="left" valign="top"><a href="#Specificities">C. How little
texi2html texinfo differs from GNU texinfo</a></td><td> </td><td
align="left" valign="top"> The minor differences with regard with
texinfo
- valid for makeinfo or texi2dvi
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Indexop">D. Command Line Option
Index</a></td><td> </td><td align="left" valign="top"></td></tr>
-<tr><td align="left" valign="top"><a href="#Indexvr">E. Variable
Index</a></td><td> </td><td align="left" valign="top"></td></tr>
-<tr><td align="left" valign="top"><a href="#Indexcp">F. Concept
Index</a></td><td> </td><td align="left" valign="top"></td></tr>
-<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">
-</pre></th></tr></table>
-<hr size="1">
-<a name="Overview"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Top" title="Previous section
in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#whytexi2html" title="Next section
in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Beginning of this
chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Top" title="Up section"> Up
</a>]</td>
-<td valign="middle" align="left">[<a href="#Obtaining-texi2html" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Overview-1"></a>
-<h1 class="chapter">1. Overview</h1>
-
-<a name="index-Texinfo"></a>
-<a name="index-examples-of-manuals"></a>
-
-<p><a href="http://www.texinfo.org";>Texinfo</a> is the official
-documentation format of the <a href="http://www.gnu.org";>GNU</a>
-project. It uses a single source file to produce both
-online information and printed output.
-</p>
-<p>It is often desirable to have a way to produce
-<acronym>HTML</acronym> from Texinfo sources, as GNU-Info files are
-produced. It is much simpler to run a converter than it is to
-rewrite all the documentation in <acronym>HTML</acronym>, especially
-considering that there is so much Texinfo documentation in
-the world.
-</p>
-<p>Some time ago <code>makeinfo</code> wasn’t able to produce
-<acronym>HTML</acronym> output format, but people still wanted documentation in
-<acronym>HTML</acronym>. This was the birthing hour for
-<code>texi2html</code>. The basic purpose of <code>texi2html</code>
-is to convert Texinfo documents into <acronym>HTML</acronym>.
-</p>
-<p>Since then, <acronym>HTML</acronym> support in <code>makeinfo</code> has
improved, but
-<code>texi2html</code> is still stronger in many areas, including the degree to
-which it allows customization. With <code>texi2html</code>, some important
-aspects of the resulting <acronym>HTML</acronym> files may be specified via
command
-line options, and configuration files provide an even finer degree of control
-over the final output, allowing most every aspect of the final output not
-specified in the Texinfo input file to be specified. Configuration files are
-written in <code>perl</code>, like the main program, and anything which may be
-specified on the command line may also be specified within a configuration
-file.
-</p>
-<p>For an example of the kind of pages <code>texi2html</code> is capable of
-producing, have a look at the following sites:
-<a href="http://www.singular.uni-kl.de/Manual/html/";>the Singular Manual</a>,
-<a href="http://ccvs.cvshome.org/docs/manual";>the Cederqvist (CVS Manual)</a>.
-</p>
-<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top"><a href="#whytexi2html">1.1 Why
<code>texi2html</code> and not
<code>makeinfo</code>?</a></td><td> </td><td align="left"
valign="top"></td></tr>
-</table>
-
-<hr size="6">
-<a name="whytexi2html"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Overview" title="Previous
section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Obtaining-texi2html" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Overview" title="Beginning of this
chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Overview" title="Up section"> Up
</a>]</td>
-<td valign="middle" align="left">[<a href="#Obtaining-texi2html" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Why-texi2html-and-not-makeinfo_003f"></a>
-<h2 class="section">1.1 Why <code>texi2html</code> and not
<code>makeinfo</code>?</h2>
-
-<a name="index-makeinfo"></a>
-
-<p>You would like to produce <acronym>HTML</acronym> files from your existing
Texinfo
-files? There are two programs you can use to do this. The first is
-<code>makeinfo</code> (see <a
href="texinfo.html#Generating-HTML">(texinfo)Generating HTML</a> section
‘Generating HTML’ in <cite>GNU Texinfo</cite>).
-The second is <code>texi2html</code>.
-</p>
-<p>The design goal of <code>makeinfo</code>’s <acronym>HTML</acronym>
output was to produce
-readable <acronym>HTML</acronym> output. It is now possible to use
<acronym>CSS</acronym>
-for <acronym>HTML</acronym> customization. Another possibility is to use
intermediate
-formats, like docbook or <code>makeinfo</code> <acronym>XML</acronym>
-and <acronym>XSL</acronym> stylesheets to customize the resulting document.
Still the
-output produced by <code>makeinfo</code> isn’t customizable.
-</p>
-<p>The current development of <code>texi2html</code> tries to
-provide for producing the more interesting and sophisticated
<acronym>HTML</acronym>
-pages that today’s Internet users have come to expect.
-The goal behind <code>texi2html</code> is to generate attractive
<acronym>HTML</acronym> by
-default but also to allow users considerable freedom to affect the final
-style and design of the output <acronym>HTML</acronym> pages. This is
achieved via
-command line options and flexible configuration files.
-</p>
-
-<p>In contrast to the <acronym>HTML</acronym> produced by <code>makeinfo
--html</code> (the
-<code>makeinfo</code> program is part of the Texinfo distribution), the
-<code>texi2html</code> program, among other differences, allows for the
-customization of the entire page layout, including headers, footers, style
-sheets, etc., allows for customization of the low level <acronym>HTML</acronym>
-formatting, provides for splitting documents at various levels, and provides
-for using the <code>latex2html</code> program to convert <code>@tex</code>
sections of
-the Texinfo source.
-</p>
-<p>The focus on <acronym>HTML</acronym> is still present but with the help of
the
-customization files it is now possible to use <code>texi2html</code> to
-produce other formats as well. <code>texi2html</code> may for example be
-turned into a texinfo to roff translator with the help of a customization file
-provided with the distribution.
-</p>
-<p><code>texi2html</code> should reasonably convert all Texinfo
-4.8 constructs. If you find it does not, please send a bug report to the
-<a href="mailto:address@hidden";>address@hidden</a> email list.
-</p>
-<hr size="6">
-<a name="Obtaining-texi2html"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#whytexi2html" title="Previous
section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Installation" title="Next section
in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Overview" title="Beginning of this
chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Top" title="Up section"> Up
</a>]</td>
-<td valign="middle" align="left">[<a href="#Installation" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Obtaining-texi2html-1"></a>
-<h1 class="chapter">2. Obtaining <code>texi2html</code></h1>
-<a name="index-downloading-texi2html-source"></a>
-<a name="index-texi2html-source_002c-downloading"></a>
-<a name="index-source-code-for-texi2html_002c-downloading"></a>
-
-<p>The latest version of the source code for <code>texi2html</code> should be
-available from
-<a href="http://www.nongnu.org/texi2html/";>www.nongnu.org/texi2html/</a>.
-<code>texi2html</code> is also available with
-<a href="http://www.tug.org/teTeX/";>teTeX</a> and
-<a href="http://www.tug.org/texlive/";>TeX Live</a>.
-</p>
-<hr size="6">
-<a name="Installation"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Obtaining-texi2html"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Requirements" title="Next section
in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Obtaining-texi2html"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Top" title="Up section"> Up
</a>]</td>
-<td valign="middle" align="left">[<a href="#Invoking-texi2html" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Installation-of-texi2html"></a>
-<h1 class="chapter">3. Installation of <code>texi2html</code></h1>
-<a name="index-Installation"></a>
-<a name="index-configure"></a>
-
-<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top"><a href="#Requirements">3.1
Requirements</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Configuring-and-rebuilding">3.2
Configuring the source and rebuilding</a></td><td> </td><td
align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Installing">3.3
Installing</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Advanced-build-features">3.4
Advanced build features</a></td><td> </td><td align="left"
valign="top">
-</td></tr>
-</table>
-
-<hr size="6">
-<a name="Requirements"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Installation" title="Previous
section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Configuring-and-rebuilding"
title="Next section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Installation" title="Beginning of
this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Installation" title="Up section">
Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Invoking-texi2html" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Requirements-1"></a>
-<h2 class="section">3.1 Requirements</h2>
-
-<p>To install <code>texi2html</code>, you must first obtain a copy of the
-source distribution. See section <a href="#Obtaining-texi2html">Obtaining
<code>texi2html</code></a>.
-</p>
-<p><code>texi2html</code> requires <code>perl</code> version
-5.00405 or above to be run. An older perl 5 version with
-<code>File::Spec</code> is also likely to work. The current version has
-been lightly tested on a wide range of perl, but has not been
-tested extensively on versions of <code>perl</code> below 5.6.
-To play nice with encodings you
-also need the <code>Encode</code> and <code>Unicode::Normalize</code> modules.
-</p>
-<p>To rebuild the script perl isn’t required in most cases. For more
-information about advanced build features, see <a
href="#Advanced-build-features">Advanced build features</a>.
-</p>
-<hr size="6">
-<a name="Configuring-and-rebuilding"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Requirements" title="Previous
section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Installing" title="Next section in
reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Installation" title="Beginning of
this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Installation" title="Up section">
Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Invoking-texi2html" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Configuring-the-source-and-rebuilding"></a>
-<h2 class="section">3.2 Configuring the source and rebuilding</h2>
-
-<p><code>texi2html</code> is a standard Automake-based distribution.
-If you have a source version, you should run <code>./configure</code>
-to configure the sources and <code>make</code> to build the script.
-</p>
-<p><code>./configure</code>
-accepts options to select the installation directory for the
‘<tt>texi2html</tt>’
-file, the default directories <code>texi2html</code> will use to look for
-configuration files, and other details. Run <code>./configure --help</code>
for
-more information.
-Running <code>./configure</code> creates
‘<tt>texi2html_configured.pl</tt>’ from
-‘<tt>texi2html.pl</tt>’, and also builds the <code>make</code>
configuration
-files (‘<tt>Makefile</tt>’s).
-</p>
-<p>Running <code>make</code> combines five files into the final
-‘<tt>texi2html</tt>’ program file:
-</p><ul>
-<li> ‘<tt>texi2html_configured.pl</tt>’ contains the base program,
-</li><li> ‘<tt>MySimple.pm</tt>’ handles the command line options,
-</li><li> ‘<tt>texi2html.init</tt>’ is the default configuration
file, and
-</li><li> ‘<tt>T2h_i18n.pm</tt>’ is used for internationalization.
-</li><li> ‘<tt>translations.pl</tt>’ contains the translations of
the strings used in
-documents.
-</li></ul>
-
-<p>Running <code>make</code> also rebuilds the documentation if needed.
-</p>
-<hr size="6">
-<a name="Installing"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Configuring-and-rebuilding"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Advanced-build-features"
title="Next section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Installation" title="Beginning of
this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Installation" title="Up section">
Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Invoking-texi2html" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Installing-1"></a>
-<h2 class="section">3.3 Installing</h2>
-
-<p><code>make install</code> performs the installation to the locations
specified to
-the <code>./configure</code> script. This usually involves placing the actual
-‘<tt>texi2html</tt>’ file someplace in your path, such as
‘<tt>/usr/local/bin</tt>’ or
-‘<tt>/usr/bin</tt>’.
-</p>
-<p>Installing <code>texi2html</code> in your path should be sufficient
-to run it. To use default initialization files, or a configuration file for
-LaTeX2HTML when using <code>latex2html</code> to convert <code>@tex</code>
sections
-(see section <a href="#Expanding-TeX-regions">Expanding <code>@tex</code> and
<code>@math</code> regions using LaTeX2HTML</a>), install them in the package
data directory
-specified to configure. This is
‘<tt>/usr/local/share/texi2html/</tt>’ by default,
-but depends on the value of the <a name="index-pkgdatadir_003ddir"></a>
-‘<samp>--pkgdatadir=<var>dir</var></samp>’ option passed to
-the <code>./configure</code> script. Files used for strings customization and
-internationalization are also searched for in the ‘<tt>i18n</tt>’
directory
-of this directory. See section <a href="#Using-init-files">Use initialization
files for fine tuning</a> for more.
-</p>
-<hr size="6">
-<a name="Advanced-build-features"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Installing" title="Previous
section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Invoking-texi2html" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Installation" title="Beginning of
this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Installation" title="Up section">
Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Invoking-texi2html" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Advanced-build-features-1"></a>
-<h2 class="section">3.4 Advanced build features</h2>
-
-<p>This section documents features that are unlikely to be used but deserve
-a bit of documentation.
-</p>
-<p>A <code>./configure</code> switch,
-<a name="index-with_002dunicode"></a>
-‘<samp>--with-unicode</samp>’ allows to choose whether the unicode
code should
-be used or not. The default is to detect it with a test. This
-code requires <code>Encode</code> and <code>Unicode::Normalize</code> modules.
-</p>
-<p>A similar <code>./configure</code> switch,
-<a name="index-with_002dunidecode"></a>
-‘<samp>--with-unidecode</samp>’ allows to choose whether the perl
module
-<code>Text::Unidecode</code> should be used or not. The default is to detect
it
-with a test. This code requires the <code>Text::Unidecode</code> module.
-</p>
-<p><code>perl</code> isn’t
-needed to build the script. the script is build by
‘<tt>./configure</tt>’
-and a shell script launched by <code>make</code> which is a simple
-wrapper around a <code>sed</code> one-liner. The <code>perl</code> command
-can be specified with the environment variable <code>$PERL</code>, otherwise
-it is detected. <code>perl</code> is required to rebuild the documentation
-as the <acronym>HTML</acronym> documentation is rebuild with
<code>texi2html</code>
-itself.
-</p>
-<p>The translations are managed by a script <code>manage_i18n.pl</code>,
created
-by <code>./configure</code>. <code>manage_i18n.pl</code> requires
-<code>Data::Dumper</code> to function normally. If this module isn’t
there
-<code>./configure</code> detects it and <code>manage_i18n.pl</code>
doesn’t
-really rebuild the translations, but only copy files. It is possible
-to use the <code>./configure</code> switch <a
name="index-enable_002dtranslations"></a>
-‘<samp>--enable-translations</samp>’
-to override the <code>./configure</code> detection. For more about
-translations, see <a href="#Internationalization">Internationalization</a>.
-</p>
-<p>It is possible to build from outside of the source directory, for example
-the following should work:
-</p>
-<table><tr><td> </td><td><pre class="example">tar xzvf
texi2html-1.79.tar.gz
-mkdir texi2html_build
-cd texi2html_build
-../texi2html-1.79/configure && make
-</pre></td></tr></table>
-
-<p>All these features enables to build <code>texi2html</code> on a platform
-in order to run it on another platform, a kind of cross-building. The
-<code>./configure</code> switches and <code>$PERL</code> allows to specify
-everything needed for the build of the <code>texi2html</code> script.
-</p>
-<hr size="6">
-<a name="Invoking-texi2html"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Advanced-build-features"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#General-options" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Installation" title="Beginning of
this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Top" title="Up section"> Up
</a>]</td>
-<td valign="middle" align="left">[<a href="#Initialization-files" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Invoking-texi2html-1"></a>
-<h1 class="chapter">4. Invoking <code>texi2html</code></h1>
-
-<p>To produce an <acronym>HTML</acronym> manual, run <code>texi2html</code>
with a Texinfo
-file as an argument. For example, this manual is created with:
-</p>
-<table><tr><td> </td><td><pre class="example">$ texi2html texi2html.texi
-</pre></td></tr></table>
-
-<p><code>texi2html</code> can accept more than one manual on the command line,
and
-will proceed with each of the manuals in turn.
-</p>
-<p>The behaviour of <code>texi2html</code> may be changed with command line
-options. These command line options are always associated with corresponding
-<code>perl</code> variables which may appear in init files, and these
-variables are presented in this chapter each time a switch is described.
-</p>
-<p>Boolean command line switches always have a corresponding negated switch,
-obtained by prepending ‘<samp>no</samp>’ or
‘<samp>no-</samp>’ to the switch name. For example
-<a name="index-nomenu"></a>
-‘<samp>--nomenu</samp>’ does the reverse of <a
name="index-menu"></a>
-‘<samp>--menu</samp>’.
-</p>
-<p>When more than one manual is processed, the command line apply to all the
-manuals, except for command-line switches setting the output file names.
-</p>
-<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top"><a href="#General-options">4.1 General
options</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Splitting-output">4.2 Specifying
where to split the generated document</a></td><td> </td><td
align="left" valign="top"> The <acronym>HTML</acronym> output may be
split at
- different levels
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Output-files">4.3 Setting output
file and directory names</a></td><td> </td><td align="left"
valign="top">
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Expansion">4.4 Specifying which
regions get expanded</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Texinfo-related-options">4.5
Command line options related to Texinfo language
features</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Page-layout-options">4.6 Page
layout related command line options</a></td><td> </td><td
align="left" valign="top"> Customizing page layout
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Style-options">4.7 Customizing the
<acronym>HTML</acronym> and text style</a></td><td> </td><td
align="left" valign="top"></td></tr>
-<tr><td align="left" valign="top"><a href="#Expanding-TeX-regions">4.8
Expanding <code>@tex</code> and <code>@math</code> regions using
LaTeX2HTML</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Using-init-files">4.9 Use
initialization files for fine tuning</a></td><td> </td><td
align="left" valign="top"> Specifying initialization files for fine
tuning
-</td></tr>
-</table>
-
-<hr size="6">
-<a name="General-options"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Invoking-texi2html"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Splitting-output" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Invoking-texi2html"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Invoking-texi2html" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Initialization-files" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="General-options-1"></a>
-<h2 class="section">4.1 General options</h2>
-
-<p>Miscellaneous general options:
-</p><dl compact="compact">
-<dt> <a name="index-error_002dlimit_003dnum"></a>
-<p>‘<samp>--error-limit=<var>num</var></samp>’
-</p></dt>
-<dd><p>Quit after <var>num</var> errors (default 1000), (variable <a
name="index-_0024ERROR_005fLIMIT"></a>
-<code>$ERROR_LIMIT</code>).
-</p></dd>
-<dt> <a name="index-help"></a>
-<p>‘<samp>--help</samp>’
-</p></dt>
-<dd><p>Display a short help and exit.
-</p></dd>
-<dt> <a name="index-verbose"></a>
-<p>‘<samp>--verbose</samp>’
-</p></dt>
-<dd><p>Be verbose.
-</p></dd>
-<dt> <a name="index-version"></a>
-<p>‘<samp>--version</samp>’
-</p></dt>
-<dd><p>Display version information and exit.
-</p></dd>
-</dl>
-
-<hr size="6">
-<a name="Splitting-output"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#General-options"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Output-files" title="Next section
in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Invoking-texi2html"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Invoking-texi2html" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Initialization-files" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Specifying-where-to-split-the-generated-document"></a>
-<h2 class="section">4.2 Specifying where to split the generated document</h2>
-
-<p>The <acronym>HTML</acronym> manual resulting from the processing of the
Texinfo source
-may be split into files at different levels. This is specified with the
-option <a name="index-split"></a>
-‘<samp>--split</samp>’ which takes an argument, namely the level
of splitting
-(variable: <a name="index-_0024SPLIT"></a>
-<code>$SPLIT</code>). This level may be:
-</p>
-<dl compact="compact">
-<dt> ‘<samp>chapter</samp>’</dt>
-<dd><p>The document is split at <code>@chapter</code>, <code>@appendix</code>,
or <code>@unnumbered</code>.
-</p></dd>
-<dt> ‘<samp>section</samp>’</dt>
-<dd><p>The document is split at the same places as it is using the
‘<samp>chapter</samp>’
-argument, and also at <code>@section</code>, <code>@appendixsec</code> or
-<code>@unnumberedsec</code>.
-</p></dd>
-<dt> ‘<samp>node</samp>’</dt>
-<dd><p>The document is split at every sectioning command. It is not
necessarily
-split at each node, if the <code>@node</code> structure doesn’t
correspond with
-the sectioning command structure (see below).
-</p></dd>
-<dt> ‘<samp>none</samp>’</dt>
-<dd><p>The document isn’t split. This is the default.
-</p></dd>
-</dl>
-
-<p>There are two kinds of commands which may be used to define sectioning
-elements in Texinfo: <code>@node</code> and the structuring commands
(<code>@top</code>,
-<code>@section</code>, <code>@appendixsubsec</code>, and so on). A node just
preceding
-a structuring command is considered to be part of the same sectioning element
-as that command. If the <code>@node Top</code> isn’t associated with a
structuring
-command it also defines a sectioning element.
-</p>
-<p>By default, nodes which aren’t associated with a structuring command
are not
-considered to be sectioning commands. They are always considered to be part
-of a sectioning element defined by a structuring command. It is possible to
-change this behaviour via the <a name="index-use_002dnodes"></a>
-‘<samp>--use-nodes</samp>’ option (variable
-<a name="index-_0024USE_005fNODES"></a>
-<code>$USE_NODES</code>). In this case, nodes not associated with structuring
-commands are also considered to be sectioning commands defining a sectioning
-element.
-</p>
-<p>This default behaviour mimics <code>texi2dvi</code> behaviour, which
ignores
-<code>@node</code> commands for the purprose of sectioning, while the second
-looks like <code>makeinfo</code> behaviour (see <a
href="texinfo.html#Two-Paths">(texinfo)Two Paths</a> section ‘Two
Paths’ in <cite>GNU Texinfo</cite>).
-</p>
-<p>As an illustration, the following table shows how a sample Texinfo document
is
-divided into sectioning elements when <a name="index-use_002dnodes-1"></a>
-‘<samp>--use-nodes</samp>’ is used and not:
-</p>
-<table>
-<tr><td width="20%">Texinfo code</td><td width="10%"></td><td
width="20%">default case</td><td width="10%"></td><td width="20%">with <a
name="index-use_002dnodes-2"></a>
-‘<samp>--use-nodes</samp>’</td></tr>
-<tr><td width="20%"><br>
-<br>
-<table><tr><td> </td><td><pre class="example">@node node1
address@hidden node 1
-node1 text
-
address@hidden node2
-node2 text
-
address@hidden node3
-node3 text
address@hidden node 3
-chapter text
-</pre></td></tr></table></td><td width="10%"></td><td width="20%">first
element:
-
-<table><tr><td> </td><td><pre class="example">@node node1
address@hidden node 1
-node1 text
-
address@hidden node2
-node2 text
-</pre></td></tr></table>
-
-<p>second element:
-</p>
-<table><tr><td> </td><td><pre class="example">@node node3
-node3 text
address@hidden node 3
-chapter text
-</pre></td></tr></table></td><td width="10%"></td><td width="20%">first
element:
-
-<table><tr><td> </td><td><pre class="example">@node node1
address@hidden node 1
-node1 text
-</pre></td></tr></table>
-
-<p>second element:
-</p>
-<table><tr><td> </td><td><pre class="example">@node node2
-node2 text
-</pre></td></tr></table>
-
-<p>third element:
-</p>
-<table><tr><td> </td><td><pre class="example">@node node3
-node3 text
address@hidden node 3
-chapter text
-</pre></td></tr></table></td></tr>
-</table>
-
-<hr size="6">
-<a name="Output-files"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Splitting-output"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Expansion" title="Next section in
reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Invoking-texi2html"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Invoking-texi2html" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Initialization-files" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Setting-output-file-and-directory-names"></a>
-<h2 class="section">4.3 Setting output file and directory names</h2>
-
-<p>The manual name is constructed by stripping the
‘<samp>.texi</samp>’,
-‘<samp>.txi</samp>’, ‘<samp>.texinfo</samp>’, or
‘<samp>.txinfo</samp>’ extension from the Texinfo file
-name.
-</p>
-<p>By default, <code>texi2html</code> generates the manual file in the current
-directory if the manual isn’t split. A ‘<samp>.html</samp>’
file extension is appended
-to the manual name.
-</p>
-<p>If the manual is split the files are put in a directory named after the
-manual name. The file name is constructed using the manual name as basename.
-An underscore followed by a number is appended
-to the basename for each files corresponding with sectioning elements, with the
-exception of the top element. For the top element there is nothing appended.
-The files containing special elements pages
-have an underscore and a 3 letter code corresponding to their content
-(‘<samp>toc</samp>’ for table of contents,
‘<samp>abt</samp>’ for about, ‘<samp>ovr</samp>’ for
-overview, ‘<samp>fot</samp>’ for footnotes if they are separated)
appended.
-Lastly, an ‘<samp>.html</samp>’ file extension is appended.
-</p>
-<p>Thus, if the texinfo file ‘<tt>afile.texi</tt>’ is processed
and split at chapters
-into 3 files, the generated files (in directory ‘<tt>afile</tt>’)
will be:
-</p>
-<table><tr><td> </td><td><pre class="example">afile.html -->
<code>@node Top</code> or <code>@top</code> section
-afile_1.html --> Chapter 1
-afile_2.html --> Chapter 2
-afile_toc.html --> Table of Contents
-afile_abt.html --> About Page
-</pre></td></tr></table>
-
-<p>This default behavior may be modified by several command line options. If
the
-output isn’t split, the prefix file name may be overrided by the
-<a name="index-output"></a>
-‘<samp>--output</samp>’ command line option (variable <a
name="index-_0024OUT"></a>
-<code>$OUT</code>). If the output
-is split, and <a name="index-output-1"></a>
-‘<samp>--output</samp>’ is set, the files are placed in the
directory
-specified by the argument to the option.
-</p>
-<p>The basename may be overridden with <a name="index-prefix"></a>
-‘<samp>--prefix</samp>’ (variable
-<a name="index-_0024PREFIX"></a>
-<code>$PREFIX</code>). If <a name="index-short_002dext"></a>
-‘<samp>--short-ext</samp>’ is given,
‘<samp>.htm</samp>’ is appended
-instead of ‘<samp>.html</samp>’ in the final step (variable <a
name="index-_0024SHORTEXTN"></a>
-<code>$SHORTEXTN</code>).
-The <a name="index-top_002dfile"></a>
-‘<samp>--top-file</samp>’ option
-overrides the top element file name (variable <a
name="index-_0024TOP_005fFILE"></a>
-<code>$TOP_FILE</code>). This can
-be used to name the top element file ‘<samp>index.html</samp>’.
Similarly,
-<a name="index-toc_002dfile"></a>
-‘<samp>--toc-file</samp>’ changes the name of the table of
contents file (variable
-<a name="index-_0024TOC_005fFILE"></a>
-<code>$TOC_FILE</code>).
-</p>
-<p>Reusing the example above, but this time calling <code>texi2html</code>
like so:
-</p>
-<table><tr><td> </td><td><pre class="example">$ texi2html -split chapter
-prefix manual -short-ext -top-file index.htm -toc-file contents.htm afile.texi
-</pre></td></tr></table>
-
-<p>we get, in ‘<tt>manual</tt>’:
-</p>
-<table><tr><td> </td><td><pre class="example">index.htm -->
<code>@node Top</code> or <code>@top</code> section
-manual_1.htm --> Chapter 1
-manual_2.htm --> Chapter 2
-contents.htm --> Table of Contents
-manual_abt.htm --> About Page
-</pre></td></tr></table>
-
-<p>The file names generated by <code>texi2html</code> differ from those
generated
-by <code>makeinfo</code>. <code>makeinfo</code> uses the
<code>@setfilename</code>
-to determine the manual name<a name="DOCF1" href="#FOOT1">(1)</a>.
-Also <code>makeinfo</code> uses the node name to construct
-the file names while splitting at nodes.
-</p>
-<p>It is possible to get the same
-behaviour out of <code>texi2html</code> by specifying the
-<a name="index-node_002dfiles"></a>
-‘<samp>--node-files</samp>’ option (variable <a
name="index-_0024NODE_005fFILES"></a>
-<code>$NODE_FILES</code>).
-The default is false for this option.
-If the output
-isn’t split at nodes, <code>texi2html</code> will still output files
named after
-the nodes, without real content but redirecting to the right file.
-This trick enables the generated <acronym>HTML</acronym> manual to be a
-target for the cross-references of other manuals generated by
-<code>makeinfo</code> or <code>texi2html</code>.
-</p>
-<p>In case the files are named after the node names,
-another command-line option, <a
name="index-transliterate_002dfile_002dnames"></a>
-‘<samp>--transliterate-file-names</samp>’
-can be set to trigger ASCII transliteration of node file names
-(variable <a name="index-_0024TRANSLITERATE_005fNODE"></a>
-<code>$TRANSLITERATE_NODE</code>). Transliteration is set in the
-default case.
-</p>
-<hr size="6">
-<a name="Expansion"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Output-files" title="Previous
section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Texinfo-related-options"
title="Next section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Invoking-texi2html"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Invoking-texi2html" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Initialization-files" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Specifying-which-regions-get-expanded"></a>
-<h2 class="section">4.4 Specifying which regions get expanded</h2>
-
-<p>The default for <code>texi2html</code> is to expand the
<code>@ifhtml</code>,
-<code>@html</code>, and <code>@menu</code> regions, all the
<code>@ifnot</code> regions
-except <code>@ifnothtml</code>, and no other <code>@if</code> regions.
-</p>
-<p>It is possible to expand other regions by setting <a
name="index-if_003cregion_003e"></a>
-‘<samp>--if<region></samp>’,
-where ‘<samp><region></samp>’ is replaced by the literal
name of the region (for
-example, ‘<samp>--iftex</samp>’). Symetrically, if <a
name="index-no_002dif_003cregion_003e"></a>
-‘<samp>--no-if<region></samp>’ is
-specified, the ‘<samp><region></samp>’ region is ignored.
The configuration file
-array, <a name="index-_0040EXPAND"></a>
-<code>@EXPAND</code>, holds the names of regions which should be
-expanded. The only region name present in <code>@EXPAND</code> in the default
case
-is ‘<samp>html</samp>’.
-</p>
-<p>If <a name="index-nomenu-1"></a>
-‘<samp>--nomenu</samp>’ is set, the <code>@menu</code> sections
are not expanded
-(variable <a name="index-_0024SHOW_005fMENU"></a>
-<code>$SHOW_MENU</code>). The default is to expand <code>@menu</code>
-sections.
-</p>
-<hr size="6">
-<a name="Texinfo-related-options"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Expansion" title="Previous
section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Page-layout-options" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Invoking-texi2html"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Invoking-texi2html" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Initialization-files" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Command-line-options-related-to-Texinfo-language-features"></a>
-<h2 class="section">4.5 Command line options related to Texinfo language
features</h2>
-
-<p>Miscalleneous Texinfo related things may be specified via command line
options.
-</p>
-<dl compact="compact">
-<dt> <a name="index-lang_003dlang"></a>
-<p>‘<samp>--lang=<var>lang</var></samp>’
-</p></dt>
-<dd><p>Sets the document language similar to the Texinfo directive,
-<code>@documentlanguage <var>lang</var></code> (variable <a
name="index-_0024LANG"></a>
-<code>$LANG</code>).
-The default is ‘<samp>en</samp>’, that is, use the english
language strings.
-</p></dd>
-<dt> <a name="index-Dvar"></a>
-<p>‘<samp>-D<var>var</var></samp>’
-</p></dt>
-<dd><p>Sets <var>var</var>. Equivalent to, <code>@set <var>var</var>
1</code>, in Texinfo.
-</p></dd>
-<dt> <a name="index-Uvar"></a>
-<p>‘<samp>-U<var>var</var></samp>’
-</p></dt>
-<dd><p>Clears <var>var</var>. Equivalent to, <code>@clear
<var>var</var></code>, in Texinfo.
-</p></dd>
-<dt> <a name="index-Pdir"></a>
-<p>‘<samp>-P<var>dir</var></samp>’
-</p></dt>
-<dd><p>Prepend <var>dir</var> to the list of directories to search for
-<code>@include</code> files (the associated array is <a
name="index-_0040PREPEND_005fDIRS"></a>
-<code>@PREPEND_DIRS</code>,
-empty in the default case).
-</p></dd>
-<dt> <a name="index-Idir"></a>
-<p>‘<samp>-I<var>dir</var></samp>’
-</p></dt>
-<dd><p>Append <var>dir</var> to the list of directories to search for
-<code>@include</code> files (the associated array is <a
name="index-_0040INCLUDE_005fDIRS"></a>
-<code>@INCLUDE_DIRS</code>,
-empty in the default case).
-</p></dd>
-</dl>
-
-<p>The include files are always searched for in the current directory.
-</p>
-<hr size="6">
-<a name="Page-layout-options"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Texinfo-related-options"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Style-options" title="Next section
in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Invoking-texi2html"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Invoking-texi2html" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Initialization-files" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Page-layout-related-command-line-options"></a>
-<h2 class="section">4.6 Page layout related command line options</h2>
-
-<p>If the <a name="index-frames"></a>
-‘<samp>--frames</samp>’ option is specified,
<acronym>HTML</acronym> frames
-are used. A file describing the frame layout is generated, and the
-document page is associated with a frame where the short table of
-content appears (variable <a name="index-_0024FRAMES"></a>
-<code>$FRAMES</code>). The default is not
-to use frames.
-</p>
-<p>It is also possible to suppress the section navigation panel with
-<a name="index-no_002dheaders"></a>
-‘<samp>--no-headers</samp>’ (variable <a
name="index-_0024SECTION_005fNAVIGATION"></a>
-<code>$SECTION_NAVIGATION</code>, the default
-is to output all the navigation panels), and to specify
-whether footnotes should appear at the foot of the same page which contains
-the reference to the note with <a name="index-footnote_002dstyle"></a>
-‘<samp>--footnote-style</samp>’ set to
-‘<samp>end</samp>’ or on a separate page with
‘<samp>--footnote-style</samp>’
-set to ‘<samp>separate</samp>’ (variable <a
name="index-_0024SEPARATED_005fFOOTNOTES"></a>
-<code>$SEPARATED_FOOTNOTES</code> set to 0
-or 1).
-The default is to have separated footnotes.
-</p>
-<hr size="6">
-<a name="Style-options"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Page-layout-options"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Expanding-TeX-regions" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Invoking-texi2html"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Invoking-texi2html" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Initialization-files" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Customizing-the-HTML-and-text-style"></a>
-<h2 class="section">4.7 Customizing the <acronym>HTML</acronym> and text
style</h2>
-
-<a name="index-CSS"></a>
-
-<p>Miscalleneous style changes may be achieved with command line options.
-</p>
-<dl compact="compact">
-<dt> <a name="index-doctype_003dDTD"></a>
-<p>‘<samp>--doctype=<var>DTD</var></samp>’
-</p></dt>
-<dt> <a name="index-frameset_002ddoctype_003dDTD"></a>
-<p>‘<samp>--frameset-doctype=<var>DTD</var></samp>’
-</p></dt>
-<dd><p>You can specify the document DTD by setting these options.
-<a name="index-frameset_002ddoctype"></a>
-‘<samp>--frameset-doctype</samp>’ applies to the file describing
the frames when
-frames are used (corresponding variables are <a name="index-_0024DOCTYPE"></a>
-<code>$DOCTYPE</code> and
-<a name="index-_0024FRAMESET_005fDOCTYPE"></a>
-<code>$FRAMESET_DOCTYPE</code>).
-</p>
-<p>The default for the document doctype is:
-</p><table><tr><td> </td><td><pre class="example"><!DOCTYPE html
PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html401/loose.dtd">
-</pre></td></tr></table>
-<p>And for the frameset doctype:
-</p><table><tr><td> </td><td><pre class="example"><!DOCTYPE html
PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN"
"http://www.w3.org/TR/html401/frameset.dtd">
-</pre></td></tr></table>
-
-</dd>
-<dt> <a name="index-iso"></a>
-<p>‘<samp>--iso</samp>’
-</p></dt>
-<dd><p>If this option is set, ISO8859 entities are used for some special
symbols,
-like Copyright © (variable <a name="index-_0024USE_005fISO"></a>
-<code>$USE_ISO</code>). It is the default.
-</p>
-</dd>
-<dt> <a name="index-css_002dinclude_003dfile"></a>
-<p>‘<samp>--css-include=<var>file</var></samp>’
-</p></dt>
-<dd><p>This command line switch provides for the inclusion of an external
-Cascading Style Sheet (<acronym>CSS</acronym>) file. More than one file may be
-specified, and ‘<samp>-</samp>’ stands for the standard input
(array
-<a name="index-_0040CSS_005fFILES"></a>
-<code>@CSS_FILES</code>).
-</p>
-<p>The option use is the same than for <code>makeinfo</code> and is described
-extensively in <a href="texinfo.html#HTML-CSS">(texinfo)HTML CSS</a> section
‘HTML CSS’ in <cite>GNU Texinfo</cite>.
-Briefly, the <acronym>CSS</acronym> <code>@import</code> lines from the
external file
-<acronym>CSS</acronym> file are pasted before the
-<code>texi2html</code> <acronym>CSS</acronym> rules, and the external file
<acronym>CSS</acronym>
-rules are pasted after the <code>texi2html</code> <acronym>CSS</acronym>
rules.
-</p>
-</dd>
-<dt> <a name="index-css_002dref_003dURL"></a>
-<p>‘<samp>--css-ref=<var>URL</var></samp>’
-</p></dt>
-<dd><p>This command line switch provides for the inclusion of an reference
-to a Cascading Style Sheet (<acronym>CSS</acronym>) URL. More than one URL
may be
-specified (array <a name="index-_0040CSS_005fREFS"></a>
-<code>@CSS_REFS</code>).
-</p>
-</dd>
-<dt> <a name="index-html_002dxref_002dprefix_003dpath"></a>
-<p>‘<samp>--html-xref-prefix=<var>path</var></samp>’
-</p></dt>
-<dd><p>This option sets the base directory for external
<acronym>HTML</acronym> texinfo manuals
-(variable <a name="index-_0024EXTERNAL_005fDIR"></a>
-<code>$EXTERNAL_DIR</code>). Defaults to ‘<samp>../</samp>’.
-</p>
-</dd>
-<dt> <a name="index-def_002dtable"></a>
-<p>‘<samp>--def-table</samp>’
-</p></dt>
-<dd><p>If this option is set, <acronym>HTML</acronym> tables are used to
format definition
-commands, rather than <acronym>HTML</acronym> definition tables (variable
-<a name="index-_0024DEF_005fTABLE"></a>
-<code>$DEF_TABLE</code>). Default is false.
-</p>
-</dd>
-<dt> <a name="index-short_002dref"></a>
-<p>‘<samp>--short-ref</samp>’
-</p></dt>
-<dd><p>If this option is set, cross-references are given without section
numbers
-(variable <a name="index-_0024SHORT_005fREF"></a>
-<code>$SHORT_REF</code>). Default is false.
-</p>
-</dd>
-<dt> <a name="index-number_002dsections"></a>
-<p>‘<samp>--number-sections</samp>’
-</p></dt>
-<dd><p>If this option is set, sections are numbered (variable
-<a name="index-_0024NUMBER_005fSECTIONS"></a>
-<code>$NUMBER_SECTIONS</code>). This is the default.
-</p>
-</dd>
-<dt> <a name="index-toc_002dlinks"></a>
-<p>‘<samp>--toc-links</samp>’
-</p></dt>
-<dd><p>If this option is set, links from headings to <acronym>TOC</acronym>
entries are
-created (variable <a name="index-_0024TOC_005fLINKS"></a>
-<code>$TOC_LINKS</code>). Default is false.
-</p></dd>
-</dl>
-
-<hr size="6">
-<a name="Expanding-TeX-regions"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Style-options" title="Previous
section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Using-init-files" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Invoking-texi2html"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Invoking-texi2html" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Initialization-files" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Expanding-_0040tex-and-_0040math-regions-using-LaTeX2HTML"></a>
-<h2 class="section">4.8 Expanding <code>@tex</code> and <code>@math</code>
regions using LaTeX2HTML</h2>
-
-<p>It is possible to use <a href="http://www.latex2html.org/";>LaTeX2HTML</a>
-to process <code>@tex</code> regions and <code>@math{}</code> commands. This
is an
-attractive way to display mathematical constructs in the
<acronym>HTML</acronym>
-manual. The <a name="index-l2h"></a>
-‘<samp>--l2h</samp>’ option activates this feature (variable
-<var>$L2H</var>). It is usually desirable to expand <code>@tex</code>
sections when this
-option is specified (see section <a href="#Expansion">Specifying which regions
get expanded</a>). The default is not to use this
-feature.
-</p>
-<p>The <a name="index-l2h_002dl2h_003dprogram"></a>
-‘<samp>--l2h-l2h=<var>program</var></samp>’ option enables
changing the name/location
-of the LaTeX2HTML program processing TeX regions (variable
-<a name="index-_0024L2H_005fL2H"></a>
-<code>$L2H_L2H</code>). The default is <code>latex2html</code>.
-</p>
-<a name="index-l2h_002dtmp"></a>
-<p>‘<samp>--l2h-tmp</samp>’ sets the directory used for temporary
-files, this name shouldn’t contain a dot ‘<samp>.</samp>’
-(variable is <a name="index-_0024L2H_005fTMP"></a>
-<code>$L2H_TMP</code>). Defaults to the current dir.
-</p>
-<p>The file specified by <a name="index-l2h_002dfile"></a>
-‘<samp>--l2h-file</samp>’ is
-used as LaTeX2HTML init file. It is searched at the same places than
-init files (see section <a href="#Using-init-files">Use initialization files
for fine tuning</a>), and the default is ‘<tt>l2h.init</tt>’.
-</p>
-<hr size="6">
-<a name="Using-init-files"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Expanding-TeX-regions"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Initialization-files" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Invoking-texi2html"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Invoking-texi2html" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Initialization-files" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Use-initialization-files-for-fine-tuning"></a>
-<h2 class="section">4.9 Use initialization files for fine tuning</h2>
-
-<a name="index-internationalization"></a>
-<a name="index-Config"></a>
-
-<p>Initialization variables are read first from
-‘<tt>/usr/local/share/texi2html/Config</tt>’ (the exact location
being
-changeable with the <a name="index-pkgdatadir_003ddir-1"></a>
-‘<samp>--pkgdatadir=dir</samp>’ option of the
-<code>configure</code> script, see <a href="#Installation">Installation of
<code>texi2html</code></a>),
-‘<tt>/usr/local/etc/texi2html/Config</tt>’ (the exact location
being
-changeable with the <a name="index-sysconfdir_003ddir"></a>
-‘<samp>--sysconfdir=dir</samp>’ option of the
-<code>configure</code> script, see <a href="#Installation">Installation of
<code>texi2html</code></a>), from ‘<tt>./Config</tt>’
-then from ‘<tt>$HOME/.texi2html/Config</tt>’. Any command-line
option
-can override the corresponding option set in init file, and the
-option <a name="index-init_002dfile"></a>
-‘<samp>--init-file</samp>’ specifies an init file to be loaded,
with
-later settings overriding earlier ones.
-</p>
-<p>The init files specified with <a name="index-init_002dfile-1"></a>
-‘<samp>--init-file</samp>’ are searched
-first in the current directory, then in the
‘<tt>$HOME/.texi2html/</tt>’
-directory, in the ‘<tt>/usr/local/etc/texi2html/</tt>’ directory
and lastly
-in the ‘<tt>/usr/local/share/texi2html/</tt>’ directory.
-</p>
-<p>A file is also included based on the language selected,
-by <a name="index-_0024LANG-1"></a>
-<code>$LANG</code>, <a name="index-document_002dlanguage"></a>
-‘<samp>--document-language</samp>’ or
-<code>@documentlanguage</code>.
-If no language was selected ‘<samp>en</samp>’ is considered to be
-the language. All the files with name the language name in
-‘<tt>/usr/local/share/texi2html/i18n/</tt>’,
-‘<tt>/usr/local/etc/texi2html/i18n/</tt>’,
-‘<tt>$HOME/.texi2html/i18n/</tt>’ and then
‘<tt>./i18n/</tt>’ are included.
-</p>
-<p>The default initialization options are defined in the
-‘<tt>texi2html.init</tt>’ file contained in the
<code>texi2html</code>
-distribution (which gets included near the beginning of the
-<code>texi2html</code> script that gets installed).
-</p>
-<p>To customize <code>texi2html</code> it is best if you copy the
-appropriate sections from the ‘<tt>texi2html.init</tt>’
-contents into an appropriate local initialization file,
-make the necessary changes there, and then have
-<code>texi2html</code> read this initialization file by one of
-the means described above.
-</p>
-<p>Some init files are provided with <code>texi2html</code>, for example
-‘<tt>book.init</tt>’ which produces an output more in line with
-what could be in a book, or ‘<tt>chm.init</tt>’ outputs files
-that can be used to produce a CHM file.
-</p>
-<hr size="6">
-<a name="Initialization-files"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Using-init-files"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Encodings" title="Next section in
reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Invoking-texi2html"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Top" title="Up section"> Up
</a>]</td>
-<td valign="middle" align="left">[<a href="#Changing-the-page-layout"
title="Next chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Overview-of-initialization-files-content-and-loading"></a>
-<h1 class="chapter">5. Overview of initialization files content and
loading</h1>
-
-<p>The initialization files are <code>perl</code> files, read as explained
-in <a href="#Using-init-files">Use initialization files for fine tuning</a>.
You don’t need to know much of <code>perl</code>
-to do some simple changes in variable values, however, to be able to
-really take advantage of all the features of the initialization file,
-a good knowledge of <code>perl</code> is required.
-</p>
-<p>In initialization file two kind of variables appear. These are normal
-variables (including arrays and hashes) and references on functions.
-The later permits the dynamic redefinition of functions used to produce
-the <acronym>HTML</acronym> manual. You should be able to change the value of
some
-normal variables without a deep knowledge of <code>perl</code>, by looking
-at the existing examples. The possible mistakes in that case could be
-omitted ‘<samp>;</samp>’, and bad quoting.
-</p>
-<p>Initialization file are loaded from the main program by
-the mean of a <code>require</code>, while in the <code>Texi2HTML::Config</code>
-namespace. This means that the namespace of the main program and
-the namespace of initialization files are distinct, which ensures
-that no name clash should happen. The variables are declared with
-<code>use vars</code>, such that it should be possible to use the
-<code>use strict</code> pragma in the initialization file code.
-</p>
-<p>To avoid messing with the variables in the <code>main</code> namespace
-all the global variables which could be of use in the init files
-are in the <code>Texi2HTML</code> namespace. Notice that the functions
-of the main program are still in the <code>main</code> namespace.
-</p>
-<p>Since <code>texi2html</code> can proceed more than one file on the
-command line, you should make sure that you initialize the variables
-that are used during a manual formatting. The handlers explained
-later can be used for that (see section <a
href="#Bypassing-normal-formatting">Bypassing normal formatting</a>).
-</p>
-<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top"><a href="#Encodings">5.1 Setting the
encodings</a></td><td> </td><td align="left" valign="top"></td></tr>
-<tr><td align="left" valign="top"><a href="#Redefining-functions">5.2
Redefining functions in initialization files</a></td><td> </td><td
align="left" valign="top"> Function redefinition is achieved with
- redefinition of references on functions.
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Function-prototypes">5.3
Conventions used for function prototypes</a></td><td> </td><td
align="left" valign="top"> Conventions used in that manual for function
- reference prototypes display.
-</td></tr>
-</table>
-
-<hr size="6">
-<a name="Encodings"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Initialization-files"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Redefining-functions" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Initialization-files"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Initialization-files" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Changing-the-page-layout"
title="Next chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Setting-the-encodings"></a>
-<h2 class="section">5.1 Setting the encodings</h2>
-
-<p>There are four encodings relevant for <code>texi2html</code>, they are
-associated with corresponding configuration variables. If these
-variables are defined they
-determine a corresponding value in <code>%Texi2HTML::THISDOC</code>
-which is otherwise autodetected:
-</p><ol>
-<li> The variable <a name="index-_0024DOCUMENT_005fENCODING"></a>
-<code>$DOCUMENT_ENCODING</code> corresponds with
-the document encoding.
-If defined, this variable sets
-<a
name="index-_0024Texi2HTML_003a_003aTHISDOC_007b_0027DOCUMENT_005fENCODING_0027_007d"></a>
-<code>$Texi2HTML::THISDOC{'DOCUMENT_ENCODING'}</code>.
-If not defined, the encoding appearing in <code>@documentencoding</code> will
-be used to set <a
name="index-_0024Texi2HTML_003a_003aTHISDOC_007b_0027DOCUMENT_005fENCODING_0027_007d-1"></a>
-<code>$Texi2HTML::THISDOC{'DOCUMENT_ENCODING'}</code>.
-The <code>@documentencoding</code> value appears in
-<a
name="index-_0024Texi2HTML_003a_003aTHISDOC_007b_0027documentencoding_0027_007d"></a>
-<code>$Texi2HTML::THISDOC{'documentencoding'}</code>.
-</li><li> The texinfo files encoding.
-If <a name="index-_0024IN_005fENCODING"></a>
-<code>$IN_ENCODING</code> is set, this sets
-<a
name="index-_0024Texi2HTML_003a_003aTHISDOC_007b_0027IN_005fENCODING_0027_007d"></a>
-<code>$Texi2HTML::THISDOC{'IN_ENCODING'}</code>.
-Otherwise, when <code>$Texi2HTML::THISDOC{'DOCUMENT_ENCODING'}</code>
-is set, <code>$Texi2HTML::THISDOC{'IN_ENCODING'}</code> is also set
-if the encoding is supported by perl.
-</li><li> The out files encoding. It is associated with the variable
-<a name="index-_0024OUT_005fENCODING"></a>
-<code>$OUT_ENCODING</code>. If defined,
-<a
name="index-_0024Texi2HTML_003a_003aTHISDOC_007b_0027OUT_005fENCODING_0027_007d"></a>
-<code>$Texi2HTML::THISDOC{'OUT_ENCODING'}</code> is set accordingly.
-If not defined, the value of
-<code>$Texi2HTML::THISDOC{'ENCODING_NAME'}</code>
-or
-<code>$Texi2HTML::THISDOC{'IN_ENCODING'}</code>
-is used if one of these variables is set.
-</li><li> The encoding advertized in out files, associated with the variable
-<a name="index-_0024ENCODING_005fNAME"></a>
-<code>$ENCODING_NAME</code>. It sets
-<a
name="index-_0024Texi2HTML_003a_003aTHISDOC_007b_0027ENCODING_005fNAME_0027_007d"></a>
-<code>$Texi2HTML::THISDOC{'ENCODING_NAME'}</code> if defined.
-
-<p>If unset the value of this variable is based on the
-other ENCODING values, and if they are all undefined, the variable
-<a name="index-_0024DEFAULT_005fENCODING"></a>
-<code>$DEFAULT_ENCODING</code> is used.
-</p></li></ol>
-
-<p>The values for the encoding related variables are set in the default
-<code>init_out</code> function reference (see section <a
href="#Output-initialization">Preparing the output</a>).
-</p>
-<p>In general the <code>$DOCUMENT_ENCODING</code> and
<code>$IN_ENCODING</code> are
-set to the right values. <code>$OUT_ENCODING</code> is also rightly set
-according to <code>$ENCODING_NAME</code>.
-To force a given encoding for the output, the
-<code>$ENCODING_NAME</code> value may be set. The current default output
encoding
-is UTF-8.
-</p>
-<hr size="6">
-<a name="Redefining-functions"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Encodings" title="Previous
section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Function-prototypes" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Initialization-files"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Initialization-files" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Changing-the-page-layout"
title="Next chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Redefining-functions-in-initialization-files"></a>
-<h2 class="section">5.2 Redefining functions in initialization files</h2>
-
-<p>To redefine a function you must replace the corresponding funtion
-reference with a reference on your function.
-Thus you should write your function, give it a name you
-are certain it is unique in the <code>Texi2HTML::Config</code> namespace,
-and override the value of the function reference with your own
-function reference. When another function from the main program
-(or from another functions of an initialization file) calls the reference,
-your function will be used.
-</p>
-<p>For example the function
-reference corresponding with the function called when doing an
-anchor is called <code>$anchor</code>. Thus if you want to override the
-corresponding function
-you could write:
-</p>
-<table><tr><td> </td><td><pre class="example"># override the function
reference
-$anchor = \&my_own_function;
-
-# the function reference now refers to
-sub my_own_function {
-# process arguments and return an html anchor
-}
-</pre></td></tr></table>
-
-<hr size="6">
-<a name="Function-prototypes"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Redefining-functions"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Changing-the-page-layout"
title="Next section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Initialization-files"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Initialization-files" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Changing-the-page-layout"
title="Next chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Conventions-used-for-function-prototypes"></a>
-<h2 class="section">5.3 Conventions used for function prototypes</h2>
-
-<p>As the functions are defined by a reference name, we will always
-use the reference name in function prototypes. For the function arguments
-we will use <code>address@hidden</code> for a reference on an array and
similarly
-<code>\%hash</code> for a reference on a hash.
-</p>
-<p>Thus, the prototype for the function associated with the function
-reference ‘<samp>$formatting_function</samp>’ will be:
-</p>
-<dl>
-<dt><a name="index-formatting_005ffunction"></a><u>Function Reference:</u>
$text <b>formatting_function</b><i> $arg1 address@hidden</i></dt>
-<dd><p><code>formatting_function</code> takes as first argument
<var>$arg2</var>,
-as second argument a reference on an array <var>address@hidden</var>
-and returns the formatted text <var>$text</var>.
-</p></dd></dl>
-
-<p>To redefined the corresponding function, you should write:
-</p>
-<table><tr><td> </td><td><pre class="example">$formatting_function =
\&my_formatting_function
-
-sub my_formatting_function($ $)
-{
- my $arg1 = shift;
- my $arg2 = shift;
- # prepare $formatted_text
- .....
- return $formatted_text
-}
-</pre></td></tr></table>
-
-<hr size="6">
-<a name="Changing-the-page-layout"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Function-prototypes"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#The-different-pages" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Initialization-files"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Top" title="Up section"> Up
</a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Fine-tuning-of-the-page-layout"></a>
-<h1 class="chapter">6. Fine tuning of the page layout</h1>
-
-<p>Some features of the page layout might be specified with command line
-options, the corresponding variables are described in
-<a href="#Page-layout-options">Page layout related command line options</a>.
-Fine tuning of the page layout may be achieved
-with redefinition of other variables and function references in the
-initialization files.
-</p>
-<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top"><a href="#The-different-pages">6.1 The
different categories of pages and sectioning
elements</a></td><td> </td><td align="left" valign="top"> The
different categories of pages.
-</td></tr>
-<tr><td align="left" valign="top"><a href="#The-page-layout">6.2 Page layout
and navigation panel overview</a></td><td> </td><td align="left"
valign="top"> The elements of a page.
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Navigation-panel">6.3
Customization of the navigation panels buttons</a></td><td> </td><td
align="left" valign="top"> How to change the navigation panel.
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Program-variables">6.4 Main
program variables and usefull functions</a></td><td> </td><td
align="left" valign="top"> The available main program variables and
some
- usefull functions from the main program.
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Output-initialization">6.5
Preparing the output</a></td><td> </td><td align="left"
valign="top"> Setting variables before the document
- production but after the texinfo parsing.
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Output-finalization">6.6
Finalizing the output</a></td><td> </td><td align="left"
valign="top"> Cleaning after document generation.
-</td></tr>
-<tr><td align="left" valign="top"><a href="#css">6.7 Customizing the
<code>texi2html</code> css lines</a></td><td> </td><td align="left"
valign="top"> Customizing css lines.
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Customizing-header">6.8
Customizing the page header</a></td><td> </td><td align="left"
valign="top">
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Customizing-section">6.9
Customizing the sections</a></td><td> </td><td align="left"
valign="top">
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Customizing-footer">6.10
Customizing the page footer</a></td><td> </td><td align="left"
valign="top">
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Special-pages">6.11 Special pages
formatting</a></td><td> </td><td align="left" valign="top">
Customizing table of contents, top, about page.
-</td></tr>
-<tr><td align="left" valign="top"><a href="#File-and-target-names">6.12
Customizing the file and target names</a></td><td> </td><td
align="left" valign="top"></td></tr>
-<tr><td align="left" valign="top"><a href="#External-index-files">6.13
Generation of external files for index entries</a></td><td> </td><td
align="left" valign="top"> Putting index entries in external files.
-</td></tr>
-</table>
-
-<hr size="6">
-<a name="The-different-pages"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Changing-the-page-layout"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#The-page-layout" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Changing-the-page-layout"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Changing-the-page-layout"
title="Up section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="The-different-categories-of-pages-and-sectioning-elements"></a>
-<h2 class="section">6.1 The different categories of pages and sectioning
elements</h2>
-
-<p>The following sectioning elements can be associated with pages:
-</p>
-<dl compact="compact">
-<dt> <em>Normal elements</em></dt>
-<dd><p>These are normal sections or nodes. Their association with pages is
-determined by the splitting of the document. See section <a
href="#Splitting-output">Specifying where to split the generated document</a>.
-</p></dd>
-<dt> <em>Top element</em></dt>
-<dd><p>The top element is the higher element in the document structure.
-If there is a <code>@top</code> section it is the element associated with
-that section. Otherwise it is the element associated with the
-<code>@node Top</code>. If there is no <code>@node Top</code> the first
element is the
-top element.
-</p>
-<p>The top element is formatted differently than a normal element if there
-is a <code>@top</code> section or the <code>@node Top</code> isn’t
associated
-with a sectioning command.
-</p></dd>
-<dt> <em>Misc elements</em></dt>
-<dd><p>These elements are associated with pages if the document is split.
-There are four misc elements:
-</p><ol>
-<li> Table of contents
-</li><li> Short table of contents, also called Overview
-</li><li> Footnotes page
-</li><li> About page
-</li></ol>
-
-<p>The <em>About page</em> shouldn’t be present for documents consisting
-in only one sectioning element, or for documents unsplit and without
-navigation information. The <em>Footnote page</em> should only
-be present if the footnotes appear on a separated page
-(see section <a href="#Page-layout-options">Page layout related command line
options</a>), however a footnote element is present if
-the document isn’t split. The <em>Table of contents</em> should only
-be formatted if <code>@contents</code> is present in the document.
-Similarly the <em>Overview</em> should only appear if
<code>@shortcontents</code>
-or <code>@summarycontents</code> is present. The Table of contents and
-the Overview may also be directly included within the document, not
-as separate pages (see section <a href="#Contents-and-Overview-text">Table of
contents and Short table of contents</a>).
-</p></dd>
-</dl>
-
-<hr size="6">
-<a name="The-page-layout"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#The-different-pages"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Navigation-panel" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Changing-the-page-layout"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Changing-the-page-layout"
title="Up section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Page-layout-and-navigation-panel-overview"></a>
-<h2 class="section">6.2 Page layout and navigation panel overview</h2>
-
-<p>A page is broken up in three parts. A page header, the sections
-and a page footer. A common element in the page layout is a navigation
-panel with icons or text linking to other sections or pages. Another
-common element is a rule, separating sections or footer. The navigation
-panel and the rules may be part of the sections or part of headers or
-footers. You may use the variables <a name="index-_0024SMALL_005fRULE"></a>
-<code>$SMALL_RULE</code>,
-<a name="index-_0024DEFAULT_005fRULE"></a>
-<code>$DEFAULT_RULE</code>, <a name="index-_0024MIDDLE_005fRULE"></a>
-<code>$MIDDLE_RULE</code> and <a name="index-_0024BIG_005fRULE"></a>
-<code>$BIG_RULE</code>
-for rules of different sizes.
-The defaults are
-</p><table><tr><td> </td><td><pre class="example">$SMALL_RULE = '<hr
size="1">';
-$DEFAULT_RULE = '<hr>';
-$MIDDLE_RULE = '<hr size="2">';
-$BIG_RULE = '<hr size="6">';
-</pre></td></tr></table>
-
-
-<p>In the header some important meta data may be defined, like the
-title or style information, and textual informations may be present
-in comments. All this doesn’t appear directly in the displayed
-<acronym>HTML</acronym>, though.
-</p>
-<p>The page layout is mainly controlled by functions, the precise functions
-called depending on the document splitting. The navigation panel, however,
-can be customized with variables.
-</p>
-<a name="Element-labels-1"></a>
-<h3 class="subheading">Element labels</h3>
-<p><a name="Element-labels"></a>
-</p>
-<p>There are 19 items associated with elements. Each of these
-is associated with a name and a reference to the
-element they represent, when such an element exists.
-The element is either a global element or an element relative to the current
-element. The relative elements are found with respect with the document
-structure defined by the section structuring commands (<code>@chapter</code>,
-<code>@unnumbered</code>…) or by the nodes (in that case the node
-directions are specified on node line or in menu organization).
-These items are called <em>element labels</em>. They may be associated with
-a button (see section <a href="#Button-specifications">Specifying the buttons
formatting</a>), and used in the formatting functions
-(see section <a href="#Program-variables">Main program variables and usefull
functions</a>).
-</p>
-<p>Here is the list:
-</p>
-<dl compact="compact">
-<dt> <em>‘<samp> </samp>’</em></dt>
-<dd><p>An empty button
-</p></dd>
-<dt> <em>Top</em></dt>
-<dd><p>Top element. The associated name is <a
name="index-_0024TOP_005fHEADING"></a>
-<code>$TOP_HEADING</code> if that variable is
-defined. This variable is not set by default.
-</p></dd>
-<dt> <em>Contents</em></dt>
-<dd><p>Table of contents
-</p></dd>
-<dt> <em>About</em></dt>
-<dd><p>About (help) page
-</p></dd>
-<dt> <em>Overview</em></dt>
-<dd><p>Overview, short table of contents
-</p></dd>
-<dt> <em>First</em></dt>
-<dd><p>First element in reading order
-</p></dd>
-<dt> <em>Last</em></dt>
-<dd><p>Last element in reading order
-</p></dd>
-<dt> <em>Index</em></dt>
-<dd><p>The first chapter with <code>@printindex</code>. The associated name
-is <a name="index-_0024INDEX_005fCHAPTER"></a>
-<code>$INDEX_CHAPTER</code>, if the variable is set. This variable is not set
-by default.
-</p></dd>
-<dt> <em>This</em></dt>
-<dd><p>The current element
-</p></dd>
-<dt> <em>Back</em></dt>
-<dd><p>Preceding element in reading order
-</p></dd>
-<dt> <em>FastBack</em></dt>
-<dd><p>Beginning of this chapter or previous chapter if the element is a
chapter
-</p></dd>
-<dt> <em>Prev</em></dt>
-<dd><p>Previous section on the same level
-</p></dd>
-<dt> <em>NodePrev</em></dt>
-<dd><p>Previous node
-</p></dd>
-<dt> <em>Forward</em> </dt>
-<dd><p>Next element in reading order
-</p></dd>
-<dt> <em>FastForward</em></dt>
-<dd><p>Next chapter
-</p></dd>
-<dt> <em>Next</em></dt>
-<dd><p>Next section on the same level
-</p></dd>
-<dt> <em>NodeNext</em></dt>
-<dd><p>Next node
-</p></dd>
-<dt> <em>Following</em></dt>
-<dd><p>Next node in node reading order
-</p></dd>
-<dt> <em>Up</em></dt>
-<dd><p>Up section
-</p></dd>
-<dt> <em>NodeUp</em></dt>
-<dd><p>Up node
-</p></dd>
-<dt> <em>FileNext</em></dt>
-<dd><p>Forward element first in the next page (or file)
-</p></dd>
-<dt> <em>FilePrev</em></dt>
-<dd><p>Backward element first in the previous page (or file)
-</p></dd>
-</dl>
-
-<hr size="6">
-<a name="Navigation-panel"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#The-page-layout"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#General-purpose-variables"
title="Next section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Changing-the-page-layout"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Changing-the-page-layout"
title="Up section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Customization-of-the-navigation-panels-buttons"></a>
-<h2 class="section">6.3 Customization of the navigation panels buttons</h2>
-
-<p>A lot of customization of the navigation panel may be achieved without
-redefining functions, with variables redefinition.
-In case it isn’t enough, it is also possible to redefine the function
-doing the navigation panel formatting.
-</p>
-<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top"><a href="#General-purpose-variables">6.3.1
Controlling the navigation panel panel at a high
level</a></td><td> </td><td align="left" valign="top">
Variables controlling the navigation panel
- at a global level
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Button-specifications">6.3.2
Specifying the buttons formatting</a></td><td> </td><td align="left"
valign="top">
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Panel-formatting-function">6.3.3
Changing the navigation panel formatting</a></td><td> </td><td
align="left" valign="top">
-</td></tr>
-</table>
-
-<hr size="6">
-<a name="General-purpose-variables"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Navigation-panel"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Button-specifications" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Changing-the-page-layout"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Navigation-panel" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Controlling-the-navigation-panel-panel-at-a-high-level"></a>
-<h3 class="subsection">6.3.1 Controlling the navigation panel panel at a high
level</h3>
-
-<p>The global formatting of the navigation panels may be
-changed with the following variables:
-</p>
-<dl compact="compact">
-<dt> <code>$VERTICAL_HEAD_NAVIGATION</code>
-<a name="index-_0024VERTICAL_005fHEAD_005fNAVIGATION"></a>
-</dt>
-<dd><p>A vertical navigation panel will be used for the header navigation
-panel if this variable is true.
-</p></dd>
-<dt> <code>$ICONS</code>
-<a name="index-_0024ICONS"></a>
-</dt>
-<dd><p>Icons are used instead of
-textual buttons if this variable is true.
-</p></dd>
-<dt> <code>$SECTION_NAVIGATION</code>
-<a name="index-_0024SECTION_005fNAVIGATION-1"></a>
-</dt>
-<dd><p>If this variable is false there is no section navigation, no navigation
-panels for the elements within the pages, only at
-the beginning and the end of the page (see section <a
href="#Page-layout-options">Page layout related command line options</a>).
-</p></dd>
-</dl>
-
-<hr size="6">
-<a name="Button-specifications"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#General-purpose-variables"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Panel-formatting-function"
title="Next section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Changing-the-page-layout"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Navigation-panel" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Specifying-the-buttons-formatting"></a>
-<h3 class="subsection">6.3.2 Specifying the buttons formatting</h3>
-
-<p>Several arrays and hashes enable a precise control on the buttons and
-their display.
-The following arrays determine the buttons present in navigation panels:
-</p>
-<dl compact="compact">
-<dt> <code>@SECTION_BUTTONS</code>
-<a name="index-_0040SECTION_005fBUTTONS"></a>
-</dt>
-<dd><p>This array is used for the navigation panel buttons present at the
begining
-of sectioning elements. If split at node or section they are also used
-at the page footer, and in the case of section navigation at the page header.
-</p></dd>
-<dt> <code>@SECTION_FOOTER_BUTTONS</code>
-<a name="index-_0040SECTION_005fFOOTER_005fBUTTONS"></a>
-</dt>
-<dt> <code>@NODE_FOOTER_BUTTONS</code>
-<a name="index-_0040NODE_005fFOOTER_005fBUTTONS"></a>
-</dt>
-<dd><p>This array is used for the navigation panel buttons present at the
footer
-of pages when split at node or at section.
-</p>
-<p>If <a name="index-_0024WORDS_005fIN_005fPAGE"></a>
-<code>$WORDS_IN_PAGE</code> is set and the output is split at nodes, these
-buttons are only present if there are more than <a
name="index-_0024WORDS_005fIN_005fPAGE-1"></a>
-<code>$WORDS_IN_PAGE</code>
-words in the sectioning element text. This counting is very rough and include
-punctuation marks, html elements, numbers. The default is to include the
-buttons after 300 words.
-</p></dd>
-<dt> <code>@CHAPTER_BUTTONS</code>
-<a name="index-_0040CHAPTER_005fBUTTONS"></a>
-</dt>
-<dd><p>This array is used for the buttons appearing at the page footer if
split at
-chapter, and at the page header if split at chapter and there is no section
-navigation.
-</p></dd>
-<dt> <code>@MISC_BUTTONS</code>
-<a name="index-_0040MISC_005fBUTTONS"></a>
-</dt>
-<dd><p>These buttons appear at the beginning of special and sections
-and at the end of these section pages if the output is split.
-</p></dd>
-<dt> <code>@LINKS_BUTTONS</code>
-<a name="index-_0040LINKS_005fBUTTONS"></a>
-</dt>
-<dd><p>These are used for <code><link></code> elements if they are
output in the
-headers.
-</p></dd>
-</dl>
-
-<p>The array specify the buttons displayed in navigation panels,
-and how the button is displayed.
-Each element is associated with
-a button of the navigation panel from left to right.
-The signification of the array element value is the following:
-</p>
-<dl compact="compact">
-<dt> <em>reference on a function</em></dt>
-<dd><p>The function is called with argument a boolean true if the navigation
-panel should be vertical. Should return the formatted button text.
-</p></dd>
-<dt> <em>reference on a scalar</em></dt>
-<dd><p>The scalar value is printed. For some possibly
-usefull scalars, <a href="#Elements-hashes">Accessing elements
informations</a>.
-</p></dd>
-<dt> <em>reference on an array</em></dt>
-<dd><p>In this case the first array element should be a reference on text and
the
-second element an element label. In that case a link to the
-element associated with the element label with the scalar value
-text is generated.
-</p>
-<p>For example if the buttons array element is
-</p><table><tr><td> </td><td><pre class="example">[ 'Next',
\$Texi2HTML::NODE{Next} ]
-</pre></td></tr></table>
-
-<p>The button will be a link to the next section with text
-<a name="index-_0024Texi2HTML_003a_003aNODE_007bNext_007d"></a>
-<code>$Texi2HTML::NODE{Next}</code>.
-</p></dd>
-<dt> <em>element label</em></dt>
-<dd><p>If icons are not used, the button is a link to the corresponding
-element which text is defined by the value associated with the
-element label in the <a name="index-_0025NAVIGATION_005fTEXT"></a>
-<code>%NAVIGATION_TEXT</code> hash, surrounded
-by ‘<samp>[</samp>’ and ‘<samp>]</samp>’. If the
element label is ‘<samp> </samp>’, there is
-no ‘<samp>[</samp>’ and ‘<samp>]</samp>’.
-The element of the <code>%NAVIGATION_TEXT</code> hash are defined
-dynamically, in the <code>init_out</code> function reference
-(see section <a href="#Output-initialization">Preparing the output</a>).
-</p>
-<p>If icons are used, the button is an image with file determined by
-the value associated with the element label in the <a
name="index-_0025ACTIVE_005fICONS"></a>
-<code>%ACTIVE_ICONS</code>
-hash if the the link really leads to an element, or in the <a
name="index-_0025PASSIVE_005fICONS"></a>
-<code>%PASSIVE_ICONS</code>
-hash if there is no element to link to. Of course if there is a link to the
-element the icon links to that element. The button name and
-the button description are used in HTML attributes to have a textual
-description of the icon. The corresponding strings are in
-<a name="index-_0025BUTTONS_005fNAME"></a>
-<code>%BUTTONS_NAME</code> for the button name and
<code>%NAVIGATION_TEXT</code>
-for the description.
-</p></dd>
-</dl>
-
-<p>If <a name="index-_0024USE_005fACCESSKEY"></a>
-<code>$USE_ACCESSKEY</code> is set, the <code>accesskey</code> attribute
-is used in navigation. In that case the <a
name="index-_0025BUTTONS_005fACCESSKEY"></a>
-<code>%BUTTONS_ACCESSKEY</code>
-hash is used for the access key.
-</p>
-<p>Similarly, if
-If <a name="index-_0024USE_005fREL_005fREV"></a>
-<code>$USE_REL_REV</code> is set, the <code>rel</code> attribute is used
-in navigation. In that case the <a name="index-_0025BUTTONS_005fREL"></a>
-<code>%BUTTONS_REL</code> hash is used for
-the rel attribute.
-</p>
-
-<hr size="6">
-<a name="Panel-formatting-function"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Button-specifications"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Program-variables" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Changing-the-page-layout"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Navigation-panel" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Changing-the-navigation-panel-formatting"></a>
-<h3 class="subsection">6.3.3 Changing the navigation panel formatting</h3>
-
-<p>If you are not satisfied with this scheme, it is possible to
-control exactly the formatting of navigation panels by redefining a function
-reference. The function controlling the display of navigation panel is
-associated with the following function reference:
-</p>
-<dl>
-<dt><a name="index-print_005fnavigation"></a><u>Function Reference:</u>
$navigation_text <b>print_navigation</b><i> address@hidden $vertical</i></dt>
-<dd><p><var>address@hidden</var> is an array reference which should hold the
specification of
-the buttons for that navigation panel. <var>$vertical</var> is true if the
-navigation panel should be vertical.
-Returns the formatted navigation panel in <var>$navigation_text</var>.
-</p></dd></dl>
-
-<hr size="6">
-<a name="Program-variables"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Panel-formatting-function"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Elements-hashes" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Changing-the-page-layout"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Changing-the-page-layout"
title="Up section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Main-program-variables-and-usefull-functions"></a>
-<h2 class="section">6.4 Main program variables and usefull functions</h2>
-
-<p>In the functions
-controlling the page layout some global variables set by the main
-program are available, with value corresponding with the current
-layout element.
-</p>
-<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top"><a href="#Elements-hashes">6.4.1 Accessing
elements informations</a></td><td> </td><td align="left"
valign="top"> Accessing information related with the
- different elements
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Global-informations">6.4.2
Accessing global informations</a></td><td> </td><td align="left"
valign="top"> Accessing global informations, like date,
- title…
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Global-functions">6.4.3 Function
usefull in page formatting</a></td><td> </td><td align="left"
valign="top"> main program usefull functions
-</td></tr>
-</table>
-
-
-<hr size="6">
-<a name="Elements-hashes"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Program-variables"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Global-informations" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Changing-the-page-layout"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Program-variables" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Accessing-elements-informations"></a>
-<h3 class="subsection">6.4.1 Accessing elements informations</h3>
-
-<p>Four hashes are available, with key the elements labels (as described
-in <a href="#Element-labels">Element labels</a>) and values:
-</p>
-<dl compact="compact">
-<dt> <code>%Texi2HTML::NAME</code>
-<a name="index-_0025Texi2HTML_003a_003aNAME"></a>
-</dt>
-<dd><p>The formatted element name
-</p></dd>
-<dt> <code>%Texi2HTML::HREF</code>
-<a name="index-_0025Texi2HTML_003a_003aHREF"></a>
-</dt>
-<dd><p>The element hypertext reference
-</p></dd>
-<dt> <code>%Texi2HTML::NODE</code>
-<a name="index-_0025Texi2HTML_003a_003aNODE"></a>
-</dt>
-<dd><p>The element node name
-</p></dd>
-<dt> <code>%Texi2HTML::NO_TEXI</code>
-<a name="index-_0025Texi2HTML_003a_003aNO_005fTEXI"></a>
-</dt>
-<dd><p>The element name after removal of texi commands
-</p></dd>
-</dl>
-
-<p>If <a name="index-_0024USE_005fNODE_005fTARGET"></a>
-<code>$USE_NODE_TARGET</code> is set, the node anchors are used as
-target for the section HREF, if there is a node associated to
-that section.
-</p>
-<hr size="6">
-<a name="Global-informations"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Elements-hashes"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Global-functions" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Changing-the-page-layout"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Program-variables" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Accessing-global-informations"></a>
-<h3 class="subsection">6.4.2 Accessing global informations</h3>
-
-<p>Three kinds of global informations are available, miscalleneous global
-strings, flags set by <code>@set</code> and special flags and section lines.
-</p>
-<a name="Global-strings"></a>
-<h4 class="subsubheading">Global strings</h4>
-<p>The <a name="index-_0025Texi2HTML_003a_003aTHISDOC"></a>
-<code>%Texi2HTML::THISDOC</code> hash holds some global informations:
-</p>
-<dl compact="compact">
-<dt> <code>fulltitle</code></dt>
-<dd><p>title set by <code>@settitle</code>. If there is no
<code>@settitle</code> other
-possibilities are tried (<code>@title</code>,
<code>@shorttitlepage</code>…).
-</p></dd>
-<dt> <code>fulltitle_no_texi</code></dt>
-<dd><p>fulltitle without texi formatting
-</p></dd>
-<dt> <code>fulltitle_texi</code></dt>
-<dd><p>fulltitle with texi commands
-</p></dd>
-<dt> <code>title</code></dt>
-<dd><p>title set by <code>@title</code>.
-</p></dd>
-<dt> <code>title_no_texi</code></dt>
-<dd><p>title without texi formatting
-</p></dd>
-<dt> <code>title_texi</code></dt>
-<dd><p>title with texi commands
-</p></dd>
-<dt> <code>author</code></dt>
-<dd><p>Authors list set by <code>@author</code>.
-</p></dd>
-<dt> <code>authors</code></dt>
-<dd><p>A reference on an array containing each author set by
<code>@author</code>.
-</p></dd>
-<dt> <code>copying_comment</code></dt>
-<dd><p>Text appearing in <code>@copying</code> with all the texinfo commands
removed,
-put in comments.
-</p></dd>
-<dt> <code>program</code></dt>
-<dd><p>The name and version of <code>texi2html</code>.
-</p></dd>
-<dt> <code>program_homepage</code></dt>
-<dd><p>Homepage for <code>texi2html</code>.
-</p></dd>
-<dt> <code>program_authors</code></dt>
-<dd><p>Authors of <code>texi2html</code>.
-</p></dd>
-<dt> <code>file_base_name</code></dt>
-<dd><p>base name of the texinfo manual file.
-</p></dd>
-<dt> <code>filename</code></dt>
-<dd><p>This is a reference on a hash that holds the filenames for special
elements.
-These files may not be used in certain cases, for example the <code>toc</code>
-element file name may not be relevant if table of contents is not output
-separately.
-The keys are
-</p><dl compact="compact">
-<dt> <code>doc</code></dt>
-<dd><p>the document file if not split, if split should be the top element
file.
-</p></dd>
-<dt> <code>top</code></dt>
-<dd><p>Top element file name.
-</p></dd>
-<dt> <code>toc</code> </dt>
-<dd><p>Table of contents element file name.
-</p></dd>
-<dt> <code>stoc</code></dt>
-<dd><p>Overview (also called short table of contents) element file name.
-</p></dd>
-<dt> <code>about</code></dt>
-<dd><p>About element file name.
-</p></dd>
-<dt> <code>foot</code></dt>
-<dd><p>Footnotes element file name.
-</p></dd>
-<dt> <code>frame</code></dt>
-<dd><p>Main frame file.
-</p></dd>
-<dt> <code>toc_frame</code></dt>
-<dd><p>Table of contents frame file name.
-</p></dd>
-</dl>
-</dd>
-<dt> <code>input_file_name</code></dt>
-<dd><p>Name of the texinfo manual file given on the command line.
-</p></dd>
-<dt> <code>destination_directory</code></dt>
-<dd><p>Destination directory for the resulting files.
-</p></dd>
-<dt> <code>extension</code></dt>
-<dd><p>Extension for the output files.
-</p></dd>
-<dt> <code>toc_file</code></dt>
-<dd><p>The file name of the table of contents, should always be valid, even
-when table of contents are output directly in the document.
-</p></dd>
-<dt> <code>inline_contents</code></dt>
-<dd><p>A reference on a hash containing two key, one for each type of table
-of contents:
-</p><dl compact="compact">
-<dt> <code>contents</code></dt>
-<dd><p>The associated value is a
-reference on an array containg the line resulting from formatting
-the table of contents, including a heading and a reference.
-</p></dd>
-<dt> <code>shortcontents</code></dt>
-<dd><p>The associated value is a
-reference on an array containg the line resulting from formatting
-the short table of contents, including a heading and a reference.
-</p></dd>
-</dl>
-</dd>
-<dt> <code>today</code></dt>
-<dd><p>The date. May be overriden by <code>$DATE</code>.
-</p></dd>
-<dt> <code>user</code></dt>
-<dd><p>The user running <code>texi2html</code>. Maybe overriden by
<code>$USER</code>.
-</p></dd>
-<dt> <code>css_import_lines</code></dt>
-<dd><p>reference on an array containing the <code>@import</code> lines of
-<acronym>CSS</acronym> files.
-</p></dd>
-<dt> <code>css_lines</code></dt>
-<dd><p>reference on an array containing the normal lines of
-<acronym>CSS</acronym> files.
-</p></dd>
-</dl>
-
-<p>It also holds the arg of the following commands, associated with the
command
-name: kbdinputstyle, paragraphindent, setchapternewpage, headings,
-footnotestyle,
- exampleindent, firstparagraphindent, everyheading, everyfooting,
- evenheading, evenfooting, oddheading, oddfooting, setcontentsaftertitlepage,
-setshortcontentsaftertitlepage, frenchspacing.
-If the command doesn’t have any arg, it will be true is it was set.
-</p>
-
-<a name="Flags"></a>
-<h4 class="subsubheading">Flags</h4>
-<p>Flags defined by <code>@set</code> may be accessed through the
-<a name="index-_0025main_003a_003avalue"></a>
-<code>%main::value</code> hash. The key is the flag name, the value is the
-flag value at the end of the document.
-</p>
-<p>Special flags are set by the main program. They correspond with a texinfo
-command, like <code>@setfilename</code>, or <code>@settitle</code>,
-<code>@author</code>… The corresponding flag is the command name with
-‘<samp>_</samp>’ appended, for example, <code>_titlefont</code>
corresponds with
-<code>@titlefont</code>. Like other flags they are available in
-<a name="index-_0025main_003a_003avalue-1"></a>
-<code>%main::value</code>.
-</p>
-
-<a name="Section-lines"></a>
-<h4 class="subsubheading">Section lines</h4>
-
-<p>The following array references or arrays holds formatted lines:
-</p>
-<dl compact="compact">
-<dt> <code>$Texi2HTML::THIS_SECTION</code>
-<a name="index-_0024Texi2HTML_003a_003aTHIS_005fSECTION"></a>
-</dt>
-<dd><p>Lines of the current element.
-</p></dd>
-<dt> <code>$Texi2HTML::OVERVIEW</code>
-<a name="index-_0024Texi2HTML_003a_003aOVERVIEW"></a>
-</dt>
-<dd><p>Lines of short table of contents. See section <a
href="#Special-pages">Special pages formatting</a>.
-</p></dd>
-<dt> <code>$Texi2HTML::TOC_LINES</code>
-<a name="index-_0024Texi2HTML_003a_003aTOC_005fLINES"></a>
-</dt>
-<dd><p>Lines of table of contents. See section <a
href="#Special-pages">Special pages formatting</a>.
-</p></dd>
-<dt> <code>$Texi2HTML::TITLEPAGE</code>
-<a name="index-_0024Texi2HTML_003a_003aTITLEPAGE"></a>
-</dt>
-<dd><p>The title page formatted with special title commands
(<code>@author</code>,
-<code>@title</code>) expanded. See section <a href="#Title-page">Formatting of
title page</a>.
-</p></dd>
-</dl>
-
-<hr size="6">
-<a name="Global-functions"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Global-informations"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Output-initialization" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Changing-the-page-layout"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Program-variables" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Function-usefull-in-page-formatting"></a>
-<h3 class="subsection">6.4.3 Function usefull in page formatting</h3>
-
-<p>The usefull function is a function used to print an array of lines, which
-also counts the number of words in the array, if needed.
-</p>
-<dl>
-<dt><a name="index-main_003a_003aprint_005flines"></a><u>Function:</u>
$words_number <b>main::print_lines</b><i> $filehandle address@hidden</i></dt>
-<dd><p><var>$filehandle</var> is the opened filehandle the function should
write to.
-<var>address@hidden</var> is the array line the function should write to the
file.
-If this argument is omitted, the function uses <a
name="index-_0024Texi2HTML_003a_003aTHIS_005fSECTION-1"></a>
-<code>$Texi2HTML::THIS_SECTION</code>.
-<var>$words_number</var> is the number of words in the array, only defined if
-split at nodes and <a name="index-_0024WORDS_005fIN_005fPAGE-2"></a>
-<code>$WORDS_IN_PAGE</code> is defined.
-</p></dd></dl>
-
-<hr size="6">
-<a name="Output-initialization"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Global-functions"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Output-finalization" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Changing-the-page-layout"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Changing-the-page-layout"
title="Up section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Preparing-the-output"></a>
-<h2 class="section">6.5 Preparing the output</h2>
-
-<p>After the texinfo file has been parsed, some information is available
-which can be used to modify some variables and prepare the outputting.
-For example the document language, the document encoding,
-values set with <code>@set</code> or <code>@setfilename</code> and other
similar
address@hidden are not known before the texinfo parsing.
-</p>
-<p>The following function reference may be redefined to be called after
-texinfo processing and before document generation:
-</p>
-<dl>
-<dt><a name="index-init_005fout"></a><u>Function Reference:</u>
<b>init_out</b></dt>
-<dd><p>This function perform the initialization of variables and any other
-task before document outputting.
-</p></dd></dl>
-
-<p>In the default case the <a name="index-_0024BODYTEXT"></a>
-<code>$BODYTEXT</code> (see section <a href="#Customizing-header">Customizing
the page header</a>)
-and the hashes <a name="index-_0025NAVIGATION_005fTEXT-1"></a>
-<code>%NAVIGATION_TEXT</code>,
-<a name="index-_0025BUTTONS_005fNAME-1"></a>
-<code>%BUTTONS_NAME</code> (see section <a
href="#Button-specifications">Specifying the buttons formatting</a>),
-<a name="index-_0025BUTTONS_005fGOTO"></a>
-<code>%BUTTONS_GOTO</code> (see section <a href="#About-text">Formatting of
about text</a>) are initialized.
-Indeed the initialization of these variables is dependent upon
-the document language selection. Similarly the encoding variables are set
-based on the information now available (see section <a
href="#Encodings">Setting the encodings</a>).
-</p>
-<p>To perform the default initializations and also add more code, you could
-do as in the following example (save the default function reference and call
-it in your own function) :
-</p>
-<table><tr><td> </td><td><pre class="example">my $default_init_out =
$init_out;
-$init_out = \&makeinfo_like_init_out;
-sub makeinfo_like_init_out()
-{
- &$default_init_out();
- $NAVIGATION_TEXT{'Following'} = ' &gt; ';
-}
-</pre></td></tr></table>
-
-<hr size="6">
-<a name="Output-finalization"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Output-initialization"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#css" title="Next section in
reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Changing-the-page-layout"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Changing-the-page-layout"
title="Up section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Finalizing-the-output"></a>
-<h2 class="section">6.6 Finalizing the output</h2>
-
-<p>If you want to do some cleaning after the document was generated (close
-files, write at the end of files and so on), the following function
-reference may be redefined:
-</p>
-<dl>
-<dt><a name="index-finish_005fout"></a><u>Function Reference:</u>
<b>finish_out</b></dt>
-<dd><p>This function is called after the document generation.
-</p></dd></dl>
-
-<p>The default is to do nothing.
-</p>
-<hr size="6">
-<a name="css"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Output-finalization"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-header" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Changing-the-page-layout"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Changing-the-page-layout"
title="Up section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Customizing-the-texi2html-css-lines"></a>
-<h2 class="section">6.7 Customizing the <code>texi2html</code> css lines</h2>
-
-<a name="index-CSS-1"></a>
-
-
-<p>If the variable <a name="index-_0024CSS_005fLINES"></a>
-<code>$CSS_LINES</code> is set it is used for the css
-entries. For example if you don’t want any css entries, set
-</p>
-<table><tr><td> </td><td><pre class="example">$CSS_LINES = '';
-</pre></td></tr></table>
-
-<p>If this variable is <code>undef</code> (as in th edefault case),
-it is possible to modify the <code>texi2html</code> css lines by modifying
-the entries or adding to the <a name="index-_0025css_005fmap"></a>
-<code>%css_map</code> hash. Each key is a css
-selector, the corresponding value is a style string.
-</p>
-<p>Another possiblility is to modify the array corresponding with the array
-reference <code>$Texi2HTML::THISDOC{'css_import_lines'}</code> that contains
the
-<code>@import</code> lines of <acronym>CSS</acronym> files, and similarly it
is possible
-to modify the array corresponding with the array
-reference <code>$Texi2HTML::THISDOC{'css_lines'}</code> that contains
-the normal <acronym>CSS</acronym> files lines (for details on what corresponds
with
-those different lines, see <a href="texinfo.html#HTML-CSS">(texinfo)HTML
CSS</a> section ‘HTML CSS’ in <cite>GNU Texinfo</cite>).
-The right place to modify these arrays is in a function appearing in
-the <code>@command_handler_process</code> array
-(see section <a href="#Bypassing-normal-formatting">Bypassing normal
formatting</a>). Later, the <acronym>CSS</acronym> lines
-are allready expanded, by the function reference below.
-</p>
-
-<p>In th edefault case, the resulting css lines are in <a
name="index-_0024Texi2html_003a_003aTHISDOC_007b_0027CSS_005fLINES_0027_007d"></a>
-<code>$Texi2html::THISDOC{'CSS_LINES'}</code>.
-It is also possible to change completely the way
<code>$Texi2html::THISDOC{'CSS_LINES'}</code> are
-generated by redefining the following function reference:
-</p>
-
-<dl>
-<dt><a name="index-css_005flines"></a><u>Function Reference:</u>
<b>css_lines</b><i> address@hidden address@hidden</i></dt>
-<dd><p>This function should be used to construct the variable
-<code>$Texi2html::THISDOC{'CSS_LINES'}</code>.
-<var>address@hidden</var> are the <code>@import</code> lines of the
-files specified with <a name="index-include_002dcss"></a>
-‘<samp>--include-css</samp>’,
-and <var>address@hidden</var> are the css commands lines of these files.
-See section <a href="#Style-options">Customizing the <acronym>HTML</acronym>
and text style</a>.
-</p></dd></dl>
-
-<hr size="6">
-<a name="Customizing-header"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#css" title="Previous section
in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-section" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Changing-the-page-layout"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Changing-the-page-layout"
title="Up section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Customizing-the-page-header"></a>
-<h2 class="section">6.8 Customizing the page header</h2>
-
-<p>It is possible to add lines to the text within the
<code><head></code>
-<acronym>HTML</acronym> elements, by defining the variable <a
name="index-_0024EXTRA_005fHEAD"></a>
-<code>$EXTRA_HEAD</code>.
-Similarly it is possible to add text just after the <code><body></code>
-element with the variable <a name="index-_0024AFTER_005fBODY_005fOPEN"></a>
-<code>$AFTER_BODY_OPEN</code>.
-These variables are empty by default.
-</p>
-<p>The HTML encoding of the resulting document is defined by
-<a name="index-_0024ENCODING_005fNAME-1"></a>
-<code>$ENCODING_NAME</code>. If the variable isn’t defined,
-the <code>@documentencoding</code> value is used, or the
-<a name="index-_0024OUT_005fENCODING-1"></a>
-<code>$OUT_ENCODING</code> value, if set. <code>$ENCODING_NAME</code> may
-influence the value of <code>$OUT_ENCODING</code>, which corresponds with
-the encoding used when writing to the resulting files.
-See section <a href="#Encodings">Setting the encodings</a>.
-</p>
-<p>The description of the document may be specified in
-<a name="index-_0024DOCUMENT_005fDESCRIPTION"></a>
-<code>$DOCUMENT_DESCRIPTION</code>.
-If this variable is undef, the text
-associated with <code>@documentdescription</code> 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 value used during document formatting
-is <a
name="index-_0024Texi2HTML_003a_003aTHISDOC_007b_0027DOCUMENT_005fDESCRIPTION_0027_007d"></a>
-<code>$Texi2HTML::THISDOC{'DOCUMENT_DESCRIPTION'}</code>.
-</p>
-<p>The <code><body></code> element attributes may be set by defining the
-variable <a name="index-_0024BODYTEXT-1"></a>
-<code>$BODYTEXT</code>. The resulting attributes are
-in <a
name="index-_0024Texi2HTML_003a_003aTHISDOC_007b_0027BODYTEXT_0027_007d"></a>
-<code>$Texi2HTML::THISDOC{'BODYTEXT'}</code>.
-If you want to define that variable
-dynamically, you should use the <code>init_out</code> function reference
-(see section <a href="#Output-initialization">Preparing the output</a>).
-</p>
-<p><code><link></code> element are used in the header if <a
name="index-_0024USE_005fLINKS"></a>
-<code>$USE_LINKS</code>
-is set. <a name="index-_0040LINKS_005fBUTTONS-1"></a>
-<code>@LINKS_BUTTONS</code> determines which links are used.
-<a name="index-_0025BUTTONS_005fREL-1"></a>
-<code>%BUTTONS_REL</code> determines the link type associated with the
-<code>rel</code> attribute.
-</p>
-<p>The default functions call the function associated with
-<a name="index-_0024print_005fhead_005fnavigation"></a>
-<code>$print_head_navigation</code> to format the navigation panel for the
-page header. Thus you can control parts of the formatting by
-redefining the function reference.
-</p>
-<dl>
-<dt><a name="index-print_005fhead_005fnavigation"></a><u>Function
Reference:</u> <b>print_head_navigation</b><i> $filehandle
address@hidden</i></dt>
-<dd><p><var>$filehandle</var> is the opened filehandle the function should
write to.
-<var>address@hidden</var> is an array reference which should hold the
specification of
-the buttons for the navigation panel.
-</p></dd></dl>
-
-<p>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 <a name="index-_0024print_005fpage_005fhead"></a>
-<code>$print_page_head</code> is called for all the pages, and after that,
-the function associated with <a
name="index-_0024print_005fchapter_005fheader"></a>
-<code>$print_chapter_header</code> is called
-if the document is split at chapters, or the function associated with
-<a name="index-_0024print_005fsection_005fheader"></a>
-<code>$print_section_header</code> is called if the document is split at
sections.
-</p>
-<dl>
-<dt><a name="index-print_005fpage_005fhead"></a><u>Function Reference:</u>
<b>print_page_head</b><i> $filehandle</i></dt>
-<dd><p><var>$filehandle</var> is the opened filehandle the function should
write to.
-This function should print the page head, including the
<code><body></code>
-element.
-</p></dd></dl>
-
-<dl>
-<dt><a name="index-print_005fchapter_005fheader"></a><u>Function
Reference:</u> <b>print_chapter_header</b><i> $filehandle</i></dt>
-<dd><p><var>$filehandle</var> is the opened filehandle the function should
write to.
-This function is called if the document is split at chapters, after
-<code>print_page_head</code>.
-</p></dd></dl>
-
-<dl>
-<dt><a name="index-print_005fsection_005fheader"></a><u>Function
Reference:</u> <b>print_section_header</b><i> $filehandle</i></dt>
-<dd><p><var>$filehandle</var> is the opened filehandle the function should
write to.
-This function is called if the document is split at sections, after
-<code>print_page_head</code>.
-</p></dd></dl>
-
-<hr size="6">
-<a name="Customizing-section"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Customizing-header"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-footer" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Changing-the-page-layout"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Changing-the-page-layout"
title="Up section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Customizing-the-sections"></a>
-<h2 class="section">6.9 Customizing the sections</h2>
-
-<p>The functions associated with the following function references are used
for
-the formatting of sections:
-</p>
-<dl>
-<dt><a name="index-print_005felement_005fheader"></a><u>Function
Reference:</u> $element_header <b>print_element_header</b><i> $first_in_page
$previous_is_top</i></dt>
-<dd><p><var>$first_in_page</var> is true if this section is the first section
in the page.
-<var>$previous_is_top</var> is true if this section is the section following
the
-Top section.
-This function should return <var>$element_header</var>, the current section
header.
-</p></dd></dl>
-
-<dl>
-<dt><a name="index-print_005fsection"></a><u>Function Reference:</u>
<b>print_section</b><i> $filehandle $first_in_page $previous_is_top</i></dt>
-<dd><p><var>$filehandle</var> is the opened filehandle the function should
write to.
-<var>$first_in_page</var> is true if this section is the first section in the
page.
-<var>$previous_is_top</var> is true if this section is the section following
the
-Top section.
-This function should print the current section contents.
-</p></dd></dl>
-
-<dl>
-<dt><a name="index-end_005fsection"></a><u>Function Reference:</u>
<b>end_section</b><i> $filehandle $last_element_or_before_top</i></dt>
-<dd><p><var>$filehandle</var> is the opened filehandle the function should
write to.
-<var>$last_element_or_before_top</var> is true if this section precedes the
top
-element or is the last one in page, or before the special elements.
-</p></dd></dl>
-
-<hr size="6">
-<a name="Customizing-footer"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Customizing-section"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Special-pages" title="Next section
in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Changing-the-page-layout"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Changing-the-page-layout"
title="Up section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Customizing-the-page-footer"></a>
-<h2 class="section">6.10 Customizing the page footer</h2>
-
-<p>It is possible to add text just before the <code></body></code>
-element with the variable <a name="index-_0024PRE_005fBODY_005fCLOSE"></a>
-<code>$PRE_BODY_CLOSE</code>. Nothing is added
-by default.
-</p>
-
-<p>A user name and a date are collected to be output in the footer.
-You can change them by defining <a name="index-_0024USER"></a>
-<code>$USER</code> and <a name="index-_0024DATE"></a>
-<code>$DATE</code>
-in the initialization file.
-</p>
-<p>The default functions call the function associated with
-<a name="index-_0024print_005ffoot_005fnavigation"></a>
-<code>$print_foot_navigation</code> to format the navigation panel for the
-page footer. Thus you can control parts of the formatting by
-redefining the function reference.
-</p>
-<dl>
-<dt><a name="index-print_005ffoot_005fnavigation"></a><u>Function
Reference:</u> <b>print_foot_navigation</b><i> $filehandle
address@hidden</i></dt>
-<dd><p><var>$filehandle</var> is the opened filehandle the function should
write to.
-<var>address@hidden</var> is an array reference which should hold the
specification of
-the buttons for the navigation panel.
-</p></dd></dl>
-
-<p>If you want even more control, you can have more control over the page
footer
-formatting by redefining three function references.
-The function associated with <a
name="index-_0024print_005fchapter_005ffooter"></a>
-<code>$print_chapter_footer</code> is called
-if the document is split at chapters, or the function associated with
-<a name="index-_0024print_005fsection_005ffooter"></a>
-<code>$print_section_footer</code> is called if the document is split at
sections.
- After that the function associated
-with <a name="index-_0024print_005fpage_005ffoot"></a>
-<code>$print_page_foot</code> is called.
-</p>
-<dl>
-<dt><a name="index-print_005fpage_005ffoot"></a><u>Function Reference:</u>
<b>print_page_foot</b><i> $filehandle</i></dt>
-<dd><p><var>$filehandle</var> is the opened filehandle the function should
write to.
-This function should print the page foot, including the
<code></body></code>
-element.
-</p></dd></dl>
-
-<dl>
-<dt><a name="index-print_005fchapter_005ffooter"></a><u>Function
Reference:</u> <b>print_chapter_footer</b><i> $filehandle</i></dt>
-<dd><p><var>$filehandle</var> is the opened filehandle the function should
write to.
-This function is called if the document is split at chapters, before
-<code>print_page_foot</code>.
-</p></dd></dl>
-
-<dl>
-<dt><a name="index-print_005fsection_005ffooter"></a><u>Function
Reference:</u> <b>print_section_footer</b><i> $filehandle</i></dt>
-<dd><p><var>$filehandle</var> is the opened filehandle the function should
write to.
-This function is called if the document is split at sections, before
-<code>print_page_foot</code>.
-</p></dd></dl>
-
-
-<hr size="6">
-<a name="Special-pages"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Customizing-footer"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Special-pages-content" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Changing-the-page-layout"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Changing-the-page-layout"
title="Up section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Special-pages-formatting"></a>
-<h2 class="section">6.11 Special pages formatting</h2>
-
-<p>For the special elements, two things must be formatted: the content
-and the page layout
-</p>
-<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top"><a href="#Special-pages-content">6.11.1
Customizing the content of the special pages</a></td><td> </td><td
align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Special-pages-layout">6.11.2
Customizing the layout of the special pages</a></td><td> </td><td
align="left" valign="top">
-</td></tr>
-</table>
-
-<hr size="6">
-<a name="Special-pages-content"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Special-pages" title="Previous
section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Top-element-text" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Changing-the-page-layout"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Special-pages" title="Up section">
Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Customizing-the-content-of-the-special-pages"></a>
-<h3 class="subsection">6.11.1 Customizing the content of the special pages</h3>
-
-<p>The label for the special elements, except for the Top element
-is formatted according to the function reference <a
name="index-_0024misc_005felement_005flabel"></a>
-<code>$misc_element_label</code>:
-</p>
-<dl>
-<dt><a name="index-misc_005felement_005flabel"></a><u>Function Reference:</u>
$misc_element_label <b>misc_element_label</b><i> $identifier $page_name</i></dt>
-<dd><p><var>$identifier</var> is the identifier associated with the special
element.
-<var>$page_name</var> is the special element name. It should return a label
that
-can be used for references to the special element.
-</p></dd></dl>
-
-<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top"><a href="#Top-element-text">6.11.1.1 Top
element text formatting</a></td><td> </td><td align="left"
valign="top">
-</td></tr>
-<tr><td align="left" valign="top"><a
href="#Contents-and-Overview-text">6.11.1.2 Table of contents and Short table
of contents</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Footnotes-text">6.11.1.3
Formatting of footnotes text</a></td><td> </td><td align="left"
valign="top">
-</td></tr>
-<tr><td align="left" valign="top"><a href="#About-text">6.11.1.4 Formatting of
about text</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Title-page">6.11.1.5 Formatting of
title page</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-</table>
-
-<hr size="6">
-<a name="Top-element-text"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Special-pages-content"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Contents-and-Overview-text"
title="Next section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Changing-the-page-layout"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Special-pages-content" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Top-element-text-formatting"></a>
-<h4 class="subsubsection">6.11.1.1 Top element text formatting</h4>
-<p>The top element formatting is controlled by three function which also
-controls the layout of the top element page or section. The associated
-function references are:
-</p>
-<dl>
-<dt><a name="index-print_005fTop_005fheader"></a><u>Function Reference:</u>
<b>print_Top_header</b><i> $filehandle $begin_page</i></dt>
-<dd><p><var>$filehandle</var> is the opened filehandle the function should
write to.
-<var>$begin_page</var> is true if the element is the first in a page.
-This function should begin the Top element. At the time this function is called
-the top element text hasn’t been parsed.
-</p></dd></dl>
-
-<dl>
-<dt><a name="index-print_005fTop"></a><u>Function Reference:</u>
<b>print_Top</b><i> $filehandle $has_top_heading</i></dt>
-<dd><p><var>$filehandle</var> is the opened filehandle the function should
write to.
-<var>$has_top_heading</var> is true if there is a <code>@heading</code>
command or
-<code>@titlefont</code> command appearing in the Top element text.
-This function should be used to format the Top element text and navigation
-panel.
-</p></dd></dl>
-
-<dl>
-<dt><a name="index-print_005fTop_005ffooter"></a><u>Function Reference:</u>
<b>print_Top_footer</b><i> $filehandle $end_page</i></dt>
-<dd><p><var>$filehandle</var> is the opened filehandle the function should
write to.
-<var>$end_page</var> is true if the element is the last in a page.
-This function should end the Top element.
-</p></dd></dl>
-
-<hr size="6">
-<a name="Contents-and-Overview-text"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Top-element-text"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Footnotes-text" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Changing-the-page-layout"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Special-pages-content" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Table-of-contents-and-Short-table-of-contents"></a>
-<h4 class="subsubsection">6.11.1.2 Table of contents and Short table of
contents</h4>
-
-<p>Two possibilities exist for the formatting of table of contents (and
-short table of contents). In the default case, the table of contents
-are in separate elements, at the end of the document if the document
-is unsplit or in separate files. This is consistent with <code>makeinfo</code>
-where menus are used for navigation. Another mode may be selected by
-setting <a name="index-_0024INLINE_005fCONTENTS"></a>
-<code>$INLINE_CONTENTS</code>. In that case the table of contents
-are not output as separate elements but
-are instead output where the corresponding @-command,
-for example <code>@contents</code>,
-is set. This behaviour is more consistent with <code>texi2dvi</code>.
-If <code>@setcontentsaftertitlepage</code> appears in the document,
-and even if <code>$INLINE_CONTENTS</code> is set, the table of contents are
-merged in the title (which isn’t output in the default case, see
-<a href="#Title-page">Formatting of title page</a>).
-</p>
-<p>Several variables may be used to control the formatting of table of
contents
-and short table of contents:
-</p>
-<dl compact="compact">
-<dt> <code>$DO_CONTENTS</code>
-<a name="index-_0024DO_005fCONTENTS"></a>
-</dt>
-<dd><p>If the variable is true a table of contents is done even if there is no
-<code>@contents</code> command.
-If it is defined and false, no table of contents
-is done even if there is a <code>@contents</code> command.
-</p></dd>
-<dt> <code>$DO_SCONTENTS</code>
-<a name="index-_0024DO_005fSCONTENTS"></a>
-</dt>
-<dd><p>If the variable is true a short table of contents is done even if there
is no
-<code>@summarycontents</code> command.
-If it is defined and false, no short table of contents
-is done even if there is a <code>@summarycontents</code> command.
-</p></dd>
-<dt> <code>$BEFORE_OVERVIEW</code>
-<a name="index-_0024BEFORE_005fOVERVIEW"></a>
-</dt>
-<dd><p>The variable value is inserted before the short table of contents text.
-</p></dd>
-<dt> <code>$AFTER_OVERVIEW</code>
-<a name="index-_0024AFTER_005fOVERVIEW"></a>
-</dt>
-<dd><p>The variable value is inserted after the short table of contents text.
-</p></dd>
-<dt> <code>$BEFORE_TOC_LINES</code>
-<a name="index-_0024BEFORE_005fTOC_005fLINES"></a>
-</dt>
-<dd><p>The variable value is inserted before the table of contents text.
-</p></dd>
-<dt> <code>$AFTER_TOC_LINES</code>
-<a name="index-_0024AFTER_005fTOC_005fLINES"></a>
-</dt>
-<dd><p>The variable value is inserted after the table of contents text.
-</p></dd>
-<dt> <code>$NO_BULLET_LIST_STYLE</code>
-<a name="index-_0024NO_005fBULLET_005fLIST_005fSTYLE"></a>
-</dt>
-<dd><p>This should contain a css style used for the list style when there
-is no bullet.
-</p></dd>
-<dt> <code>$NO_BULLET_LIST_ATTRIBUTE</code>
-<a name="index-_0024NO_005fBULLET_005fLIST_005fATTRIBUTE"></a>
-</dt>
-<dd><p>This should contain an attribute text used for the list element when
there
-is no bullet. For example it is used in the tables of if they are
-formatted with a list.
-</p></dd>
-</dl>
-
-<p>More control on the table of contents and short table of contents formatting
-may be achieved by redefining a function with the following associated
-function reference:
-</p>
-<dl>
-<dt><a name="index-toc_005fbody"></a><u>Function Reference:</u>
<b>toc_body</b><i> address@hidden</i></dt>
-<dd><p><var>address@hidden</var> is an array reference contining informations
about
-all the elements of the document. Each of the entry of this array is an hash
-reference which entries correspond with different informations
-about the element. Interesting keys have the following meaning:
-</p>
-<dl compact="compact">
-<dt> <code>top</code></dt>
-<dd><p>true if the element is the top element,
-</p></dd>
-<dt> <code>index_page</code></dt>
-<dd><p>true if the element is an index page added because of index splitting,
-</p></dd>
-<dt> <code>toc_level</code></dt>
-<dd><p>level of the element in the table of content. Highest level
-is 1 for the top element and for chapters, appendix and so on,
-2 for section, unnumberedsec and so on...
-</p></dd>
-<dt> <code>tocid</code></dt>
-<dd><p>label used for reference linking to the element in table of
-contents,
-</p></dd>
-<dt> <code>file</code> </dt>
-<dd><p>the file containing the element, usefull to do href to that file
-in case the document is split,
-</p></dd>
-<dt> <code>text</code></dt>
-<dd><p>text of the element, with section number,
-</p></dd>
-<dt> <code>name</code></dt>
-<dd><p>text of the element, without section number.
-</p></dd>
-</dl>
-
-<p>This function doesn’t return anything but should fill the array
corresponding
-with the
-<a name="index-_0024Texi2HTML_003a_003aTOC_005fLINES-1"></a>
-<code>$Texi2HTML::TOC_LINES</code> and
-<a name="index-_0024Texi2HTML_003a_003aOVERVIEW-1"></a>
-<code>$Texi2HTML::OVERVIEW</code> references with the table of contents and
short
-table of contents.
-</p>
-</dd></dl>
-
-<p>Another function reference is used to add a heading and a reference, to
-be used with <code>$INLINE_CONTENTS</code> or merged in the title. Its output
-is not used when the table of contents are separate elements.
-</p>
-<dl>
-<dt><a name="index-_0040inline_005fcontents_005flines"></a><u>Function
Reference:</u> \ <b>@inline_contents_lines</b><i> inline_contents $filehandle
$command $element</i></dt>
-<dd><p>This function reference returns a reference on an array holding
-the lines containing the contents, heading and reference.
-<var>$filehandle</var> is a reference on the currently opened file if
-the function is called because a <code>@contents</code> or
-<code>@shortcontents</code> command was encountered, it is undef otherwise.
-<var>$command</var> is either ‘<samp>contents</samp>’ or
‘<samp>shortcontents</samp>’.
-<var>$element</var> is a hash reference containing informations about the
-table of contents context. Relevant keys are:
-</p><dl compact="compact">
-<dt> <code>target</code></dt>
-<dd><p>The identifier associated with the table of contents, used for example
-to do references to the table of contents using href in
<acronym>HTML</acronym>.
-</p></dd>
-<dt> <code>id</code></dt>
-<dd><p>The identifier associated with the element, used to do labels. In
-general the same than the <code>target</code>, but not necessarily.
-</p></dd>
-<dt> <code>file</code></dt>
-<dd><p>The file name containing the table of contents.
-</p></dd>
-</dl>
-
-</dd></dl>
-
-<hr size="6">
-<a name="Footnotes-text"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Contents-and-Overview-text"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#About-text" title="Next section in
reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Changing-the-page-layout"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Special-pages-content" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Formatting-of-footnotes-text"></a>
-<h4 class="subsubsection">6.11.1.3 Formatting of footnotes text</h4>
-
-<p>The footnotes text is allready formatting when <code>@footnote</code>
commands
-are expanded. See section <a href="#Footnotes">Customizing the footnotes
formatting</a>.
-</p>
-<hr size="6">
-<a name="About-text"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Footnotes-text"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Title-page" title="Next section in
reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Changing-the-page-layout"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Special-pages-content" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Formatting-of-about-text"></a>
-<h4 class="subsubsection">6.11.1.4 Formatting of about text</h4>
-
-<p>The default about element contains an explaination of the buttons used
-in the document (<code>@SECTION_BUTTONS</code>, <a
href="#Button-specifications">Specifying the buttons formatting</a>) and
-an example locating the buttons targets in an example.
-The formatting of this text may be influenced by the following
-hashes and variables:
-</p>
-<dl compact="compact">
-<dt> <code>$PRE_ABOUT</code> </dt>
-<dt> <code>$AFTER_ABOUT</code></dt>
-<dd><p>This variable may be a scalar or a function reference.
-If it is a scalar, the value is used.
-If this is a function reference it is expanded and the returned text is
-used. The text is added before or after the main about text.
-</p></dd>
-<dt> <code>%BUTTONS_GOTO</code></dt>
-<dd>
-<p>The keys of this hash are element labels (see <a
href="#Element-labels">Element labels</a>). The value
-is the text associated with the element label in the about text.
-The element of the hash are defined
-dynamically, you should in the <code>init_out</code> function reference
-(see section <a href="#Output-initialization">Preparing the output</a>).
-</p>
-
-</dd>
-<dt> <code>%BUTTONS_EXAMPLE</code></dt>
-<dd>
-<p>The keys of this hash are element labels (see <a
href="#Element-labels">Element labels</a>). The value
-is the text associated with the element label in the about example,
-typically a section number.
-</p>
-</dd>
-</dl>
-
-<p>If this is not enough and you want to control exactly the formatting of
-the about text, you can redefine the function associated with the following
-function reference:
-</p>
-<dl>
-<dt><a name="index-print_005fabout"></a><u>Function Reference:</u> $about_text
<b>print_about</b></dt>
-<dd><p>This function should return the about text.
-</p></dd></dl>
-
-<hr size="6">
-<a name="Title-page"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#About-text" title="Previous
section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Special-pages-layout" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Changing-the-page-layout"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Special-pages-content" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Formatting-of-title-page"></a>
-<h4 class="subsubsection">6.11.1.5 Formatting of title page</h4>
-
-<p>The title page is first formatted using the text appearing in
-the <code>@titlepage</code> section, and put in <a
name="index-_0024Texi2HTML_003a_003aTITLEPAGE-1"></a>
-<code>$Texi2HTML::TITLEPAGE</code>.
-The information appearing in <code>@title</code>, <code>@subtitle</code> or
-<code>@author</code> is then added using the following
-function reference:
-</p>
-<dl>
-<dt><a name="index-titlepage"></a><u>Function Reference:</u>
<b>titlepage</b></dt>
-<dd><p>This function should complete <code>$Texi2HTML::TITLEPAGE</code>.
-</p></dd></dl>
-
-<p>In the default case, in this function the table of contents and short
-table of contents are also added if they are to be output and
-<code>@setcontentsaftertitlepage</code>
-or <code>@setshortcontentsaftertitlepage</code> appear in the document
-(see section <a href="#Contents-and-Overview-text">Table of contents and Short
table of contents</a>).
-</p>
-<p>In the default case the resulting title page output is not used in
-the document, except if the top node is not associated with any
-content.
-</p>
-<hr size="6">
-<a name="Special-pages-layout"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Title-page" title="Previous
section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#File-and-target-names" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Changing-the-page-layout"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Special-pages" title="Up section">
Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Customizing-the-layout-of-the-special-pages"></a>
-<h3 class="subsection">6.11.2 Customizing the layout of the special pages</h3>
-
-<p>The formatting of each of the special pages, or section in case
-the document is not split, is controlled by a function.
-The associated function reference is called accordingly:
-</p>
-<dl compact="compact">
-<dt> <code>print_Top</code>
-<a name="index-print_005fTop-1"></a>
-</dt>
-<dt> <code>print_Top_header</code>
-<a name="index-print_005fTop_005fheader-1"></a>
-</dt>
-<dt> <code>print_Top_footer</code>
-<a name="index-print_005fTop_005ffooter-1"></a>
-</dt>
-<dd><p>Formatting of top element page or section. It is also used for the
formatting
-of the top element text (see section <a href="#Top-element-text">Top element
text formatting</a>).
-</p></dd>
-<dt> <code>print_Toc</code>
-<a name="index-print_005fToc"></a>
-</dt>
-<dd><p>Formatting of table of contents page or section
-</p></dd>
-<dt> <code>print_Overview</code>
-<a name="index-print_005fOverview"></a>
-</dt>
-<dd><p>Formatting of short table of contents page or section
-</p></dd>
-<dt> <code>print_About</code>
-<a name="index-print_005fAbout"></a>
-</dt>
-<dd><p>Formatting of about (help) page or section
-</p></dd>
-<dt> <code>print_Footnotes</code>
-<a name="index-print_005fFootnotes"></a>
-</dt>
-<dd><p>Formatting of footnotes section or page in case footnotes are on a
-separated page or the document isn’t split.
-</p></dd>
-</dl>
-
-<p>In the default case, <a name="index-_0024print_005fTop"></a>
-<code>$print_Top</code> calls <a
name="index-_0024print_005fTop_005fheader"></a>
-<code>$print_Top_header</code> for
-the header and <a name="index-_0024print_005fTop_005ffooter"></a>
-<code>$print_Top_footer</code> for the footer of top element.
-All the other function call <a name="index-_0024print_005fmisc"></a>
-<code>$print_misc</code> which in turn calls
-<a name="index-_0024print_005fmisc_005fheader"></a>
-<code>$print_misc_header</code> for the headers and <a
name="index-_0024print_005fmisc_005ffooter"></a>
-<code>$print_misc_footer</code>
-for the footers.
-</p>
-<hr size="6">
-<a name="File-and-target-names"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Special-pages-layout"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#External-index-files" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Changing-the-page-layout"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Changing-the-page-layout"
title="Up section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Customizing-the-file-and-target-names"></a>
-<h2 class="section">6.12 Customizing the file and target names</h2>
-
-<a name="File-names"></a>
-<h3 class="subheading">File names</h3>
-
-<p>It is possible to specify the file names with more control than with the
-command line options (see section <a href="#Output-files">Setting output file
and directory names</a>).
-First the extension may be overrided by the variable <a
name="index-_0024EXTENSION"></a>
-<code>$EXTENSION</code>
-value. The variable should be <code>undef</code> if no extension is
-to be added.
-Two function references enable
-further customization. One is usefull in case <a
name="index-_0024NODE_005fFILES-1"></a>
-<code>$NODE_FILES</code> is true
-and it is used to customize the node file name.
-</p>
-<dl>
-<dt><a name="index-node_005ffile_005fname"></a><u>Function Reference:</u>
$node_file <b>node_file_name</b><i> \%node</i></dt>
-<dd><p><var>\%node</var> is a hash reference with the following interesting
keys (there
-are much more keys):
-</p><dl compact="compact">
-<dt> <code>texi</code></dt>
-<dd><p>The texinfo node name.
-</p></dd>
-<dt> <code>with_section</code></dt>
-<dd><p>True if associated with a section.
-</p></dd>
-</dl>
-<p>The result is the node file name <var>$node_file</var>.
-</p></dd></dl>
-
-<p>The other is used to
-customize the file names associated with each element, and the
-name of the file associated with the special elements.
-</p><dl>
-<dt><a name="index-element_005ffile_005fname"></a><u>Function Reference:</u>
$file <b>element_file_name</b><i> \%element $type $docu_name</i></dt>
-<dd><p><var>\%element</var> is undefined for the special elements (about,
overview,
-table of contents, footnotes).
-Otherwise it is a hash reference with the following interesting keys (there
-are much more keys):
-</p><dl compact="compact">
-<dt> <code>texi</code></dt>
-<dd><p>The texinfo element name.
-</p></dd>
-<dt> <code>number</code></dt>
-<dd><p>The number associated with a section.
-</p></dd>
-<dt> <code>doc_nr</code></dt>
-<dd><p>A number incremented whenever a new file should begin, based on how the
-document is split (see section <a href="#Splitting-output">Specifying where to
split the generated document</a>).
-</p></dd>
-<dt> <code>text</code></dt>
-<dd><p>The element text.
-</p></dd>
-<dt> <code>name</code></dt>
-<dd><p>The element text without section number.
-</p></dd>
-</dl>
-<p><var>$type</var> is empty for normal elements.
-For the top element it is ‘<samp>top</samp>’, for the table of
contents it
-is ‘<samp>toc</samp>’, for the overview it is
‘<samp>stoc</samp>’, for the
-footnotes it is ‘<samp>foot</samp>’ and for about is
‘<samp>about</samp>’. If
-frames are used (see section <a href="#Page-layout-options">Page layout
related command line options</a>), the function reference
-is also called for ‘<samp>frame</samp>’, the frame file name, and
-‘<samp>toc_frame</samp>’ the table of content frame file name.
-<var>$docu_name</var> is the basename of the texinfo manual.
-The result is the element or special element file name.
-</p></dd></dl>
-
-<a name="target-names"></a>
-<h3 class="subheading">target names</h3>
-
-<p>Similarly target and id may be set. The <em>id</em> is placed where the
-item is located, the <em>target</em> is used to construct references to
-that item. In general they should be equal, but not always, for example
-in the default case, the target for a section is the node id.
-The following function reference, is
-for target items (nodes, anchors, floats):
-</p>
-<dl>
-<dt><a name="index-node_005ftarget_005fname"></a><u>Function Reference:</u>
($target,$id) <b>node_target_name</b><i> \%node, $default_target,
$default_id</i></dt>
-<dd><p><var>\%node</var> is the same as in the <code>node_file_name</code>
function reference
-above.
-<var>$default_target</var> is the target already set (it is also
-in <code>$node->{'target'}</code>), and <var>$default_id</var> is similarly
-the id already set.
-</p></dd></dl>
-
-<p>For element associated with files (which may be nodes), the function
-reference is:
-</p>
-<dl>
-<dt><a name="index-element_005ftarget_005fname"></a><u>Function Reference:</u>
($target,$id) <b>element_target_name</b><i> \%element, $default_target,
$default_id</i></dt>
-<dd><p>the <var>\%element</var> is the same than in
<code>element_file_name</code>, and
-<var>$default_target</var> and <var>$default_id</var> are the target and id
already set.
-</p></dd></dl>
-
-<p>Placed items
-(floats, footnotes, index entries, anchors, contents,
-shortcontents and headings)
-file and target may also be set. In the default case, they should
-be rightly set, so be careful when changing them. The following
-function reference can be used:
-</p>
-<dl>
-<dt><a name="index-placed_005ftarget_005ffile_005fname"></a><u>Function
Reference:</u> ($target, $id, $file) <b>placed_target_file_name</b><i>
\%placed_item, \%element, $default_target, $default_id, $default_file,
$context</i></dt>
-<dd><p><var>\%placed_item</var> is a hash reference describing the placed item,
-in the same vein than above.
-the <var>\%element</var> is the same than in <code>element_file_name</code>,
-corresponding with the element containing the placed item.
-<var>$default_file</var>, <var>default_id</var> and
-<var>$default_target</var> are the file, id and target already set.
-<var>$context</var> describes the context, it is empty in the normal cases,
-and can also be set to ‘<samp>footnotes</samp>’ if in footnotes,
or to
-‘<samp>no_associated_element</samp>’ if the placed item is out of
any element
-(typically in <code>@titlepage</code>, <code>@copying</code>).
-</p></dd></dl>
-
-<p>For special elements, the <a
name="index-_0025misc_005fpages_005ftargets"></a>
-<code>%misc_pages_targets</code> hash is
-used to set the target and id. The possibilities for the keys
-are ‘<samp>Overview</samp>’,
-‘<samp>Contents</samp>’, ‘<samp>Footnotes</samp>’ and
‘<samp>About</samp>’.
-</p>
-<hr size="6">
-<a name="External-index-files"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#File-and-target-names"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Changing-the-page-layout"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Changing-the-page-layout"
title="Up section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Generation-of-external-files-for-index-entries"></a>
-<h2 class="section">6.13 Generation of external files for index entries</h2>
-
-<p>Within the document, <code>@printindex</code> commands are expanded as
explained
-in <a href="#Index-list">Customizing the formatting of index lists</a>. In
case you want to do something special with index
-entries, outside of the document, you should first set the variable
-<a name="index-_0024IDX_005fSUMMARY"></a>
-<code>$IDX_SUMMARY</code> true. After that some function reference will be
called
-for each non empty index. For each index there are 3 function
-references, one called for initialization, one called for each index entry
-and the last one called for finalization.
-</p>
-<dl>
-<dt><a name="index-index_005fsummary_005ffile_005fbegin"></a><u>Function
Reference:</u> <b>index_summary_file_begin</b><i> $index_name $is_printed
$manual_name</i></dt>
-<dd><p><var>$index_name</var> is the two letters name for the index.
-This function
-is called for each index
-appearing in the document, before
-<code>index_summary_file_entry</code>.
-<var>$is_printed</var> is true if there is a <code>@printindex</code> for that
index.
-<var>$manual_name</var> is the manual basename.
-</p></dd></dl>
-
-<dl>
-<dt><a name="index-index_005fsummary_005ffile_005fentry"></a><u>Function
Reference:</u> <b>index_summary_file_entry</b><i> $index_name $entry_text
$entry_reference $formatted_entry $texi_entry $entry_element_reference
$entry_element_header $is_printed $manual_name</i></dt>
-<dd><p>This function is called for each entry of an index.
<var>index_name</var> is the
-name of the index. <var>$entry_text</var> is the entry in plain text,
-<var>$formatted_entry</var> is the index entry formatted,
<var>$texi_entry</var> is the
-entry with texinfo commands. <var>$entry_reference</var> is the reference
placed
-at the index entry place, in the form ‘<samp>file#id</samp>’.
-<var>$entry_element_header</var> is the formatted header of the element
containing
-the index entry. <var>entry_element_header</var> is the reference to the
-beginning of the element containing the index entry, in the form
-‘<samp>file#id</samp>’.
-<var>$is_printed</var> is true if there is a <code>@printindex</code> for that
index.
-<var>$manual_name</var> is the manual basename.
-</p></dd></dl>
-
-<dl>
-<dt><a name="index-index_005fsummary_005ffile_005fend"></a><u>Function
Reference:</u> <b>index_summary_file_end</b><i> $index_name $is_printed
$manual_name</i></dt>
-<dd><p><var>$index_name</var> is the two letters name for the index. This
function
-is called for each index appearing in the document, after
-<code>index_summary_file_entry</code>.
-<var>$is_printed</var> is true if there is a <code>@printindex</code> for that
index.
-<var>$manual_name</var> is the manual basename.
-</p></dd></dl>
-
-<hr size="6">
-<a name="Customizing-HTML"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#External-index-files"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Three-contexts" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Changing-the-page-layout"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Top" title="Up section"> Up
</a>]</td>
-<td valign="middle" align="left">[<a href="#Internationalization" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Customizing-HTML-and-text-style-in-init-files"></a>
-<h1 class="chapter">7. Customizing <acronym>HTML</acronym> and text style in
init files</h1>
-
-<p>Some simple customization may be achieved with the redefinition of the
-variables
-associated with the command line options. For the description and an
-explanation of the meaning of these variables, <a
href="#Style-options">Customizing the <acronym>HTML</acronym> and text
style</a>.
-</p>
-<p>Other variables and hash entries can be modified in initialization file
-to achieve more customization.
-Lastly, functions references corresponding with functions called from
-the main program and initialization files may
-be redefined.
-</p>
-<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top"><a href="#Three-contexts">7.1 Three contexts
for expansions: preformatted, normal and
string</a></td><td> </td><td align="left" valign="top">
there are three different contexts for command
- expansion: normal text, preformatted text and
- strings.
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Three-passes">7.2 Three passes:
macro expansion, document structure and output</a></td><td> </td><td
align="left" valign="top"> <code>texi2html</code> process
texinfo in 3 passes.
- In almost every cases, you shouldn’t
care.
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Commands-without-argument">7.3
Customizing the formatting of commands without
argument</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Punctuation-commands">7.4
Punctuation commands</a></td><td> </td><td align="left"
valign="top"> <code>@:</code>
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Style-and-accent-commands">7.5
Customizing accent, style and other simple
commands</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Anchors-images-and-spaces">7.6
Formatting of special simple commands</a></td><td> </td><td
align="left" valign="top"> Formatting of <code>@anchor</code>,
<code>@image</code>, <code>@sp</code>, <code>@acronym</code>, <code>@abbr</code>
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Text">7.7 Processing special
characters in text</a></td><td> </td><td align="left" valign="top">
Some characters are processed specially
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Strings">7.8 Customizing strings
written by <code>texi2html</code></a></td><td> </td><td align="left"
valign="top"> <code>texi2html</code> write some strings in
the output
- different for each languages
-</td></tr>
-<tr><td align="left" valign="top"><a href="#References">7.9
References</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Alignement-commands">7.10 Commands
used for centering and flushing of text</a></td><td> </td><td
align="left" valign="top"> <code>@center</code>,
<code>@flushleft</code>…
-</td></tr>
-<tr><td align="left" valign="top"><a
href="#Paragraph-and-preformatted-region">7.11 Formatting (or not) a paragraph
and a preformatted region</a></td><td> </td><td align="left"
valign="top">
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Complex-formats">7.12 Formatting
of complex formats (<code>@example</code>,
<code>@display</code>…)</a></td><td> </td><td align="left"
valign="top"> <code>@example</code>, <code>@display</code>…
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Lists-tables">7.13 Customizing the
formatting of lists and tables</a></td><td> </td><td align="left"
valign="top">
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Definitions">7.14 Definition
commands formatting</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Headings">7.15 Customizing
headings formatting</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Special-regions">7.16 Formatting
of special regions (<code>@verbatim</code>, <code>@cartouche</code>,
<code>@quotation</code>)</a></td><td> </td><td align="left"
valign="top"> <code>@verbatim</code>, <code>@cartouche</code>,
<code>@quotation</code>
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Menus">7.17 Menu
formatting</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Indices">7.18 Indices
formatting</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Floats-and-lists-of-floats">7.19
Floats and lists of floats</a></td><td> </td><td align="left"
valign="top"> <code>@float</code> and <code>@listoffloats</code>
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Footnotes">7.20 Customizing the
footnotes formatting</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Customizing-format-opening">7.21
Customizing format opening</a></td><td> </td><td align="left"
valign="top"> How to run some code when a format is opened
- (like <code>@table</code>,
<code>@flushleft</code>, <code>@example</code>…
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Bypassing-normal-formatting">7.22
Bypassing normal formatting</a></td><td> </td><td align="left"
valign="top">
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Handling-special-regions">7.23
Handling special regions</a></td><td> </td><td align="left"
valign="top"> Keep <code>@titlepage</code>,
<code>@documentdescription</code> or <code>@copying</code>
- and format <code>@insertcopying</code>
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Other-and-unknown-commands">7.24
Customizing other commands, and unknown
commands</a></td><td> </td><td align="left" valign="top"> You can
handle specifically other commands
-</td></tr>
-<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">
-</pre></th></tr></table>
-
-<hr size="6">
-<a name="Three-contexts"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Customizing-HTML"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Three-passes" title="Next section
in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Beginning
of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Internationalization" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a
name="Three-contexts-for-expansions_003a-preformatted_002c-normal-and-string"></a>
-<h2 class="section">7.1 Three contexts for expansions: preformatted, normal
and string</h2>
-
-<p>There are three contexts of interest, one is the normal context, the other
-is a special context, called the <em>preformatted</em> context and the last is
-the string context. The preformatted
-context occurs when the spacing between words is kept. This is the
-case, for example, in <code>@display</code> or <code>@example</code> regions,
and in
-menu comments (see section <a href="#Menus">Menu formatting</a>). The
preformatted regions are usually
-rendered in <code><pre></code> elements in <acronym>HTML</acronym>.
-The string context occurs when rendering strings without formatting elements,
-in comments or titles for example.
-</p>
-<hr size="6">
-<a name="Three-passes"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Three-contexts"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Commands-without-argument"
title="Next section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Beginning
of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Internationalization" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a
name="Three-passes_003a-macro-expansion_002c-document-structure-and-output"></a>
-<h2 class="section">7.2 Three passes: macro expansion, document structure and
output</h2>
-
-<p>There are three passes in <code>texi2html</code>. During
-pass 0, the <code>@macro</code> are
-expanded, in pass 1 the document structure is gathered and in pass 2
-the result is output. In most cases you shouldn’t care about
-it, as almost all of the output customization is done in pass 2.
-Only if you want to do something before the pass 2 should you care.
-</p>
-<hr size="6">
-<a name="Commands-without-argument"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Three-passes" title="Previous
section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Punctuation-commands" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Beginning
of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Internationalization" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Customizing-the-formatting-of-commands-without-argument"></a>
-<h2 class="section">7.3 Customizing the formatting of commands without
argument</h2>
-
-<p>This includes the commands whose name is a nonletter character like
<code>@@</code>,
-the commands with lettered characters and braces
-but whose braces should be empty, like <code>@TeX{}</code>, or some commands
-associated with accentted letters like <code>@AA{}</code>. If there happens to
-be something within the braces, it is put after the command, thus
-</p><table><tr><td> </td><td><pre class="example">@TeX{something}
-</pre></td></tr></table>
-<p>leads to the same than
-</p><table><tr><td> </td><td><pre class="example">@TeX{} something
-</pre></td></tr></table>
-
-<p>Each of these categories of commands have three associated hashes, one
-for normal
-context, the other for preformatted context and the last in strings. The
-keys of the hashes are the
-command names, the associated value is the text replacing the command.
-</p>
-<p>The hashes are:
-</p><table>
-<tr><td>command type</td><td>normal text</td><td>preformatted
text</td><td>string</td></tr>
-<tr><td>one nonlettered character</td><td><a
name="index-_0025simple_005fmap"></a>
-<code>%simple_map</code></td><td><a
name="index-_0025simple_005fmap_005fpre"></a>
-<code>%simple_map_pre</code></td><td><a
name="index-_0025simple_005fmap_005ftexi"></a>
-<code>%simple_map_texi</code></td></tr>
-<tr><td>nothing in braces</td><td><a name="index-_0025things_005fmap"></a>
-<code>%things_map</code></td><td><a name="index-_0025pre_005fmap"></a>
-<code>%pre_map</code></td><td><a name="index-_0025texi_005fmap"></a>
-<code>%texi_map</code></td></tr>
-</table>
-
-<p>To change the <acronym>HTML</acronym> resulting from these constructs, just
change the
-value. For example, if you want <code>&shy;</code> to be outputted for
<code>@-</code>
-in normal and preformatted context, write in your init file:
-</p>
-<table><tr><td> </td><td><pre class="example">$simple_map{'-'} =
'&shy;';
-$simple_map_pre{'-'} = '&shy;';
-</pre></td></tr></table>
-
-
-<hr size="6">
-<a name="Punctuation-commands"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Commands-without-argument"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Style-and-accent-commands"
title="Next section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Beginning
of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Internationalization" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Punctuation-commands-1"></a>
-<h2 class="section">7.4 Punctuation commands</h2>
-
-<p>The formatting of a punctuation character followed by <code></code> is
determined
-by the hash <a
name="index-_0025colon_005fcommand_005fpunctuation_005fcharacters"></a>
-<code>%colon_command_punctuation_characters</code>. If a <code></code>
-command is preceded by a character in th is hash, it is replaced by the
-associated value. In the default case, the associated value is also the
-character, so this leave the punctuation character unmodified.
-</p>
-<p>The following function reference may be redefined to handle characters
-that are in <code>%colon_command_punctuation_characters</code>:
-</p>
-<dl>
-<dt><a name="index-_0024colon_005fcommand"></a><u>Function Reference:</u>
$punctuation <b>$colon_command</b><i> $character</i></dt>
-<dd><p>The <var>$character</var> is a character appearing in
-<code>%colon_command_punctuation_characters</code> and preceding a
<code></code>
-command. In the default case the associated value in
-<code>%colon_command_punctuation_characters</code> is returned.
-</p></dd></dl>
-
-<hr size="6">
-<a name="Style-and-accent-commands"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Punctuation-commands"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Hash-reference-interface"
title="Next section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Beginning
of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Internationalization" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Customizing-accent_002c-style-and-other-simple-commands"></a>
-<h2 class="section">7.5 Customizing accent, style and other simple
commands</h2>
-
-<p>The formatting of the <acronym>HTML</acronym> produced by style and
indicatric
-commands (<code>@tt</code>, <code>@code</code>,
-<code>@email</code>, <code>@titlefont</code>), the accentuation related
-commands taking argument (<code>@'</code>, <code>@udotaccent</code>,
<code>@dotless</code>)
-and miscalleneous commands (<code>@email</code>, <code>@verb</code>,
<code>@w</code>,
-<code>@uref</code>, <code>@math</code>, <code>@asis</code>) is controlled by
two hash in the
-default case,
-<a name="index-_0025style_005fmap"></a>
-<code>%style_map</code> for normal context, <a
name="index-_0025style_005fmap_005fpre"></a>
-<code>%style_map_pre</code> for
-preformatted context and <a name="index-_0025style_005fmap_005ftexi"></a>
-<code>%style_map_texi</code> in string context.
-</p>
-<p>The key of the hashes are the command names. There are two possibilities for
-the values corresponding with two interfaces. The values may be strings or
-hash references, and you can chose the interface depending on the one you
-prefer. The interface with hash reference is a bit more flexible but might also
-be regarded as more complex. If you don’t like either of these
interfaces you
-can define your own.
-</p>
-<p>Some remarks are in order:
-</p>
-<ul>
-<li>
-The nonlettered accent commands which following character is considered
-to be the argument (like in <code>@`a</code>) should be keys of the
-hash <a name="index-_0025accent_005fmap"></a>
-<code>%accent_map</code> hash, even if no value is associated.
-</li><li>
-<code>@math</code> is handled differently if LaTeX2HTML is used.
-</li></ul>
-
-<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top"><a href="#Hash-reference-interface">7.5.1 An
interface for commands formatting with a hash
reference</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top"><a href="#String-interface">7.5.2 An
interface for commands formatting with a
string</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Define-your-own-interface">7.5.3
Defining the style and indicatric commands
interface</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-</table>
-
-<hr size="6">
-<a name="Hash-reference-interface"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Style-and-accent-commands"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#String-interface" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Beginning
of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Style-and-accent-commands"
title="Up section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Internationalization" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="An-interface-for-commands-formatting-with-a-hash-reference"></a>
-<h3 class="subsection">7.5.1 An interface for commands formatting with a hash
reference</h3>
-
-<p>The key of the hashes are the command names. The value determine how the
command argument
-is formatted. This value is a reference on a hash. In this hash each key
-corresponds with a type of information for the formatting, and the value is
-the corresponding information. For example, in
-</p>
-<table><tr><td> </td><td><pre class="example">$style_map{'command'} = {
'args' => ['code'], 'attribute' => 'code'};
-</pre></td></tr></table>
-
-<p>the arguments for <code>@command</code> are interpreted as specified by
-the values associated with the ‘<samp>args</samp>’ key while the
attribute associated
-with that command is ‘<samp>code</samp>’.
-</p>
-<p>The following keys in the hashes associated with each command have the
-following meaning:
-</p>
-<dl compact="compact">
-<dt> ‘<samp>args</samp>’</dt>
-<dd><p><a name="Reference-hash-args"></a>
-The value associated is a reference on an array. Each element of the array
-defines how the arguments (separated by ‘<samp>,</samp>’ in the
texinfo code) for
-the @-command should be
-formatted. The possibilities are
-</p><dl compact="compact">
-<dt> <code>normal</code></dt>
-<dd><p>for normal text,
-</p></dd>
-<dt> <code>code</code></dt>
-<dd><p>for text with ‘<samp>---</samp>’,
‘<samp>--</samp>’, ‘<samp>''</samp>’ and
‘<samp>``</samp>’ kept as is,
-</p></dd>
-<dt> <code>keep</code></dt>
-<dd><p>if the texinfo should be kept as is, without interpretation of the
@-commands.
-</p></dd>
-</dl>
-
-<p>For example, we have
-</p><table><tr><td> </td><td><pre
class="example">$style_map{'email'}->{'args'} = ['code', 'normal'];
-</pre></td></tr></table>
-
-<p>because ‘<samp>---</samp>’, ‘<samp>--</samp>’,
‘<samp>''</samp>’ and ‘<samp>``</samp>’ should be kept
as is in
-the first argument of <code>@email</code>.
-</p>
-<p>The default is ‘<samp>['normal']</samp>’.
-</p>
-</dd>
-<dt> ‘<samp>attribute</samp>’</dt>
-<dd>
-<p>If the associated value is a word, it is considered to be an
<acronym>HTML</acronym>
-element name, and the argument is enclosed between the element opening
-and the element closing. For example, if the value is <code>elem</code>, the
-resulting <acronym>HTML</acronym> is
<code><elem><var>arg</var></elem></code>.
-</p>
-<p>If the text is a word followed by some text,
-the word and is interpreted as above, and the
-text is considered to be the attributes text of the element.
-Thus <code>elem class="elem"</code> leads to
-<code><elem class="elem"><var>arg</var></elem></code>.
-</p>
-<p>This works only if there is only one argument.
-</p>
-</dd>
-<dt> ‘<samp>begin</samp>’</dt>
-<dd>
-<p>The associated value is added in front of the text.
-</p>
-</dd>
-<dt> ‘<samp>begin</samp>’</dt>
-<dd>
-<p>The associated value is added after the text.
-</p>
-</dd>
-<dt> ‘<samp>quotes</samp>’</dt>
-<dd>
-<p>If the corresponding value is true, the result is
-enclosed in quotes <a name="index-_0024OPEN_005fQUOTE_005fSYMBOL"></a>
-<code>$OPEN_QUOTE_SYMBOL</code> and
-<a name="index-_0024CLOSE_005fQUOTE_005fSYMBOL"></a>
-<code>$CLOSE_QUOTE_SYMBOL</code>, with defaults
-‘<samp>`</samp>’ and ‘<samp>'</samp>’.
-</p>
-</dd>
-<dt> ‘<samp>function</samp>’ </dt>
-<dd>
-<p>The corresponding value should be a function reference. The corresponding
-function is called with the following arguments:
-</p>
-<dl compact="compact">
-<dt> <code>$command</code></dt>
-<dd><p>The @-command name
-</p></dd>
-<dt> <code>$args</code></dt>
-<dd><p>A reference on an array containing the arguments of the @-command.
-</p></dd>
-<dt> <code>$command_stack</code></dt>
-<dd><p>A reference on an array containing the name of the @-commands
containing
-the @-command being formatted, latest on top.
-</p></dd>
-<dt> <code>$state</code></dt>
-<dd><p>A reference on a hash containing a lot of informations about the context
-of the @-command.
-</p></dd>
-<dt> <code>$line_nr</code></dt>
-<dd><p>An opaque structure containing the information about the line number of
the
address@hidden It can be used to call <code>main::echo_error</code> or
-<code>main::echo_warning</code> with first argument a message, and second
argument
-<code>$line_nr</code>.
-</p></dd>
-</dl>
-</dd>
-</dl>
-
-<hr size="6">
-<a name="String-interface"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Hash-reference-interface"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Define-your-own-interface"
title="Next section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Beginning
of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Style-and-accent-commands"
title="Up section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Internationalization" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="An-interface-for-commands-formatting-with-a-string"></a>
-<h3 class="subsection">7.5.2 An interface for commands formatting with a
string</h3>
-
-<p>The keys of the hashes are the command names. The value determine
-how the command argument
-is formatted. If the value begins with ‘<samp>"</samp>’, the
result is
-enclosed in quotes <a name="index-_0024OPEN_005fQUOTE_005fSYMBOL-1"></a>
-<code>$OPEN_QUOTE_SYMBOL</code> and
-<a name="index-_0024CLOSE_005fQUOTE_005fSYMBOL-1"></a>
-<code>$CLOSE_QUOTE_SYMBOL</code>, with defaults
-‘<samp>`</samp>’ and ‘<samp>'</samp>’.
-</p>
-<p>The command argument is allready formatted as <acronym>HTML</acronym>.
-The remaining of the value text
-(or the value text if there were no ‘<samp>"</samp>’) is
interpreted as follow:
-</p>
-<ul>
-<li>
-If the text is empty the argument of the command is left as is.
-</li><li>
-If the text is a ‘<samp>&</samp>’ followed by a name,
-like ‘<samp>&function</samp>’, the name is considered to be a
function name,
-and this function is called to format the argument of the command. The
-first argument of the function is the command name, the second is
-the command argument. For example, if the value associated with the
-(fictituous) command <code>@foo</code> is <code>&my_func</code>
-and we have:
-
-<table><tr><td> </td><td><pre class="example">sub my_func
-{
- my @args = split /,\s*/ $_[1];
- return "$_[0]: $args[0]" if ($args[1] = 1);
- return "$args[0]";
-}
-</pre></td></tr></table>
-
-<p>The result of
-</p><table><tr><td> </td><td><pre class="example">@foo{truc, 1}
address@hidden, bidule}
-</pre></td></tr></table>
-
-<p>will be
-</p><table><tr><td> </td><td><pre class="example">foo: truc
-truc
-</pre></td></tr></table>
-</li><li>
-If the text is a word, it is considered to be an <acronym>HTML</acronym>
element
-name, and the argument is enclosed between the element opening
-and the element closing. For example, if the value is <code>elem</code>, the
-resulting <acronym>HTML</acronym> is
<code><elem><var>arg</var></elem></code>.
-Similarly <code>"quoted</code> leads to
-<code>`<quoted><var>arg</var></quoted>'</code>.
-</li><li>
-If the text is a word followed by some text,
-the word and is interpreted as above, and the
-text is considered to be the attributes text of the element.
-Thus <code>elem class="elem"</code> leads to
-<code><elem class="elem"><var>arg</var></elem></code>.
-</li></ul>
-
-<hr size="6">
-<a name="Define-your-own-interface"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#String-interface"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Anchors-images-and-spaces"
title="Next section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Beginning
of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Style-and-accent-commands"
title="Up section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Internationalization" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Defining-the-style-and-indicatric-commands-interface"></a>
-<h3 class="subsection">7.5.3 Defining the style and indicatric commands
interface</h3>
-
-<p>If you don’t like this scheme, it is possible to change how those
commands
-are processed by redefining the following function reference:
-</p>
-<dl>
-<dt><a name="index-style"></a><u>Function Reference:</u> $resulting_text
<b>style</b><i> $style $command $text $args $no_close $no_open $line_nr $state
$command_stack</i></dt>
-<dd><p><var>$command</var> is the @-command, <var>$style</var> is the value
associated with
-the <var>$command</var> in the <code>%style_map</code>,
<code>%style_map_pre</code>
-or <code>%style_map_texi</code> hashes.
-The <var>$text</var> is the text appearing within the @-command braces.
-<var>args</var> is a reference on an array contening the command arguments
-formatted according to the same conventions than with the reference hash style
-(provided the value associated with the @-command is a hash reference with a
-<var>$arg</var> key as described in <a href="#Reference-hash-args">Reference
hash args</a>).
-If <var>$text</var> is split in paragraphs each paragraph is passed through
-the function, and <var>$no_close</var> is true if it is not the last paragraph,
-while <var>$no_open</var> is true if it is not the first paragraph.
-<var>$line_nr</var>
-is an opaque structure containing the information about the line number of the
address@hidden It can be used to call <code>main::echo_error</code> or
-<code>main::echo_warning</code> with first argument a message, and second
argument
-<code>$line_nr</code>.
-<var>$state</var>
-is a reference on a hash containing a lot of informations about the context
-of the @-command.
-<var>$command_stack</var>
-is a reference on an array containing the name of the @-commands containing
-the @-command being formatted.
-</p>
-</dd></dl>
-
-<hr size="6">
-<a name="Anchors-images-and-spaces"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Define-your-own-interface"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Text" title="Next section in
reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Beginning
of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Internationalization" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Formatting-of-special-simple-commands"></a>
-<h2 class="section">7.6 Formatting of special simple commands</h2>
-
-<p>The formatting of special simple commands is controlled by functions. To
-customize the output, the corresponding function references should be
-redefined. All these functions return a formatted text.
-</p>
-<p>The formatting of anchors is controlled by <a
name="index-_0024anchor_005flabel"></a>
-<code>$anchor_label</code>.
-</p>
-<dl>
-<dt><a name="index-anchor_005flabel"></a><u>Function Reference:</u>
$anchor_label <b>anchor_label</b><i> $identifier $anchor</i></dt>
-<dd><p><var>$identifier</var> is the anchor identifier, <var>$anchor</var>is
the <code>@anchor</code>
-argument.
-</p></dd></dl>
-
-<p>In the default case, it uses a function reference, <a
name="index-_0024anchor"></a>
-<code>$anchor</code>
- that can do
-a reference target or link. It is especially relevant for
<acronym>HTML</acronym>
-but can be used in other formats, it is a rather common element
-of different formats.
-</p><dl>
-<dt><a name="index-anchor"></a><u>Function Reference:</u> $anchor
<b>anchor</b><i> $identifier $href $text $attributes</i></dt>
-<dd><p>If <var>$identifier</var> is not empty, this value should be used to
create
-a target for links (typically associated with a name or id
-attribute in <acronym>HTML</acronym>).
-The <var>$href</var> argument specifies a hpertextual reference which should be
-used to link to a target.
-In case both <var>$identifier</var> and <var>$href</var> are given the text
produced
-should be both a target for <var>$identifier</var> and a link to
<var>$href</var>.
-<var>$text</var> is the text to be displayed.
-<var>$attributes</var> are additional attributes.
-It should be reasonable to assume that the attributes are for a
<code><a></code>
-<acronym>HTML</acronym> element.
-</p></dd></dl>
-
-<p>To customize the images produced by <code>@image</code>, the first
possibility
-is to modify the <a name="index-_0040IMAGE_005fEXTENSIONS"></a>
-<code>@IMAGE_EXTENSIONS</code>, which holds a list of
-filename extensions for image files. It is also possible to redefine
-the function used to determine the filename of the image:
-</p>
-<blockquote><p><b> Warning:</b> This description is wrong. The API is still
moving, so don’t count on it.
-</p></blockquote>
-
-<dl>
-<dt><a name="index-image_005ffiles"></a><u>Function Reference:</u> $filename
<b>image_files</b><i> $basename $extension</i></dt>
-<dd><p><var>$basename</var> is the first <code>@image</code> argument,
<var>$extension</var>
-is the corresponding <code>@image</code> argument. This function reference
-should return an array of image filenames without path that the main
-program should look for.
-</p></dd></dl>
-
-<p>Last, it is possible to control
-the formatting of <code>@image</code> by redefining:
-</p><dl>
-<dt><a name="index-image"></a><u>Function Reference:</u> $image
<b>image</b><i> $file_path $basename $preformatted $file_name $alt_text $width
$height $raw_alt $extension $working_dir $file_relative_path</i></dt>
-<dd><p><var>$file_path</var> is the image file name with the path from the
output directory
-to the source manual directory prepended, <var>$basename</var>
-the file name without extension (the first <code>@image</code> argument).
-<var>$preformatted</var> is true if the image
-appears in preformatted text. <var>$file_name</var> is the file name without
path
-but with extension. <var>$alt_text</var> is the alternate text, it may be
-undefined. <var>$width</var> and <var>$height</var> are the corresponding
arguments
-of <code>@image</code>, <var>$raw_alt</var> is the unmodified alt argument of
-<code>@image</code> and <var>$extension</var> holds the corresponding
-<code>@image</code> argument.
-<var>$working_dir</var> is the path to working dir relative to the output
-directory. <var>$file_relative_path</var> is the file name relative to the
-<var>$working_dir</var>.
-</p></dd></dl>
-
-<p>The formatting of <code>@sp</code> is controlled by:
-</p><dl>
-<dt><a name="index-sp"></a><u>Function Reference:</u> $sp <b>sp</b><i> $number
$preformatted</i></dt>
-<dd><p><var>$number</var> is the numeric argument of <code>@sp</code>.
-<var>$preformatted</var> is true if the <code>@sp</code> appears in
preformatted text.
-</p></dd></dl>
-
-<p>The formatting of <code>@acronym</code> and <code>@abbr</code> is
controlled by:
-</p><dl>
-<dt><a name="index-acronym_005flike"></a><u>Function Reference:</u> $acronym
<b>acronym_like</b><i> $acronym_texi $acronym_text $with_explanation
address@hidden $explanation_text $explanation_simply_formatted</i></dt>
-<dd><p><var>$acronym_texi</var> is the acronym argument with texinfo
@-commands,
-<var>$acronym_text</var> is formatted.
-</p>
-<p>The other arguments are related with
-the explanation, the second arg of the acronym. <var>$with_explanation</var>
is
-true if the second argument of the acronym command is present. If an
-explanation exists, coming from previous <code>@acronym</code> or as an arg of
-this command, the other args are defined: <var>address@hidden</var> is a
-reference on an array containing the simply fomatted explanation lines,
-<var>$explanation_text</var> is the explanation text formatted,
-<var>$explanation_simply_formatted</var> is the explanation with a light
-formatting, unabling in <acronym>HTML</acronym> (or <acronym>XML</acronym>)
the explanation
-to be in an attribute.
-</p></dd></dl>
-
-<hr size="6">
-<a name="Text"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Anchors-images-and-spaces"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Strings" title="Next section in
reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Beginning
of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Internationalization" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Processing-special-characters-in-text"></a>
-<h2 class="section">7.7 Processing special characters in text</h2>
-
-<p>Some characters are processed especially in text:
‘<samp>---</samp>’, ‘<samp>--</samp>’,
-‘<samp>``</samp>’ and ‘<samp>''</samp>’. This is done
only if in normal text and not in
-some commands (<code>@code</code>, <code>@env</code>…). A function
reference
-is called to process the text and should take care of those constructs.
-It may also be used to transform the text, for example set it in upper
-case if it is in <code>@sc</code>. This function should also take care
-of protecting special characters
-</p>
-
-<dl>
-<dt><a name="index-normal_005ftext"></a><u>Function Reference:</u>
$processed_text <b>normal_text</b><i> $text $in_raw_text $in_preformatted
$in_code $in_simple $command_stack</i></dt>
-<dd><p>The function processes <var>$text</var> and returns
<var>$processed_text</var>.
-The other arguments give some information about the context of the text.
-<var>$in_raw_text</var> is true if the text appears in special place where
-there is no formatting, typically in comments. <var>$in_preformatted</var>
-is true if in a preformatted environemnt, and <var>$in_code</var> is true
-if in a special command like <code>@code</code>, <code>@env</code> where
-‘<samp>---</samp>’, ‘<samp>--</samp>’,
‘<samp>``</samp>’ and ‘<samp>''</samp>’ should not be
-touched. <var>$in_simple</var> is true if in string context.
- <var>$command_stack</var> is an array containing the name of the
-formatting @-command that enclose the text.
-</p>
-<p>In the default case the ‘<samp>---</samp>’,
‘<samp>--</samp>’, ‘<samp>``</samp>’ and
‘<samp>''</samp>’
-constructs are expanded if needed and the text is upper-cased if in
-<code>@sc</code>. Special characters (‘<samp>&</samp>’,
‘<samp>"</samp>’,
-‘<samp><</samp>’ and ‘<samp>></samp>’ in
<acronym>HTML</acronym>) are protected if needed.
-</p></dd></dl>
-
-<p>Some characters are special, for example we have
‘<samp>&</samp>’, ‘<samp>"</samp>’,
-‘<samp><</samp>’ and ‘<samp>></samp>’ in
<acronym>HTML</acronym>. In some cases some
-pieces of text don’t go through the above function, but still
-needs to be protected to appear in text.
-This is done by the function associated with the function reference
-</p>
-<dl>
-<dt><a name="index-protect_005ftext"></a><u>Function Reference:</u>
$protected_text <b>protect_text</b><i> $text</i></dt>
-<dd><p>The function processes the unprotected text <var>$text</var> and returns
-the resulting protected text <var>$protected_text</var>.
-</p></dd></dl>
-
-<p>Empty lines are processed by the following function reference, which could
-be usefull if empty lines are to be removed for example
-</p>
-<dl>
-<dt><a name="index-empty_005fline"></a><u>Function Reference:</u>
$resulting_text <b>empty_line</b><i> $empty_line $state</i></dt>
-<dd><p>This function processes an <var>$empty_line</var> and returns the
resulting
-text <var>$resulting_text</var>. <var>$state</var> is a structure that holds
informations
-about the state of the parsing.
-Empty lines are left as is by default except right after a definition
address@hidden
-</p></dd></dl>
-
-<hr size="6">
-<a name="Strings"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Text" title="Previous section
in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#References" title="Next section in
reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Beginning
of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Internationalization" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Customizing-strings-written-by-texi2html"></a>
-<h2 class="section">7.8 Customizing strings written by
<code>texi2html</code></h2>
-
-<a name="index-i18n"></a>
-
-<p><code>texi2html</code> writes some strings in the generated document at
-various places, at the page footers, on the help page, for special
-section headings, buttons alt text and so on. These strings are
-customizable. The string chosen depends on the language of the
-document (set by <a name="index-document_002dlanguage-1"></a>
-‘<samp>--document-language</samp>’, <a
name="index-_0024LANG-2"></a>
-<code>$LANG</code> or
-<code>@documentlanguage</code>). This is the basis for internationalization
-as it allows for strings translations.
-</p>
-<p>The strings are found in a hash reference, <a
name="index-_0024LANGUAGES"></a>
-<code>$LANGUAGES</code>.
-Each key is a language code. The associated value is also a hash
-reference. The key is an english string and the associated value
-is the string replacing the english string, if present. For example,
-we have
-</p>
-<table><tr><td> </td><td><pre class="example">$LANGUAGES->{'fr'} = {
- ' Up ' => 'Plus haut',
-};
-</pre></td></tr></table>
-
-<p>It means that whenever the string ‘<samp> Up </samp>’
is to be written
-and the language is ‘<samp>fr</samp>’, ‘<samp>Plus
haut</samp>’ is written. It is possible
-to customize the english strings by redefining the
‘<samp>en</samp>’ language hash.
-</p>
-<p>When a string contains a ‘<samp>%</samp>’ followed by
‘<samp>{</samp>’ <var>name</var> ‘<samp>}</samp>’
-it means that the string will be expanded by <code>texi2html</code>. For
-example, if we have
-</p>
-<table><tr><td> </td><td><pre class="example">$LANGUAGES->{'fr'} = {
- 'See %{node_file_href}' => 'Voir %{node_file_href}',
-};
-</pre></td></tr></table>
-
-<p>‘<samp>%{node_file_href}</samp>’ will be expanded to an href
for a node in a
-file by <code>texi2html</code> in the string. A ‘<samp>%%</samp>’
will be expanded
-as ‘<samp>%</samp>’.
-</p>
-<p>When a <code>@documentlanguage</code> appears in the document and the
language
-wasn’t set on the command line, it may be convenient for the user to
-redefine some variables based on the new language. There is a function
-reference that may be used for that, it is called each time a
-<code>@documentlanguage</code> is encountered:
-</p>
-<dl>
-<dt><a name="index-_0024translate_005fnames"></a><u>Function Reference:</u>
<b>$translate_names</b></dt>
-<dd><p>This function is called each time <code>@documentlanguage</code> is
encountered
-and the language wasn’t seet on the command line. It should be used
-to retranslate some strings based on the new language.
-</p></dd></dl>
-
-
-<p>For more on internationalization, see <a
href="#Internationalization">Internationalization</a>.
-</p>
-<hr size="6">
-<a name="References"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Strings" title="Previous
section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Reference-to-external-manual"
title="Next section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Beginning
of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Internationalization" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="References-1"></a>
-<h2 class="section">7.9 References</h2>
-<a name="index-reference"></a>
-
-<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top"><a
href="#Reference-to-external-manual">7.9.1 Reference to external
manual</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Internal-reference">7.9.2
Reference to an internal node</a></td><td> </td><td align="left"
valign="top">
-</td></tr>
-</table>
-
-<hr size="6">
-<a name="Reference-to-external-manual"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#References" title="Previous
section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Internal-reference" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Beginning
of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#References" title="Up section"> Up
</a>]</td>
-<td valign="middle" align="left">[<a href="#Internationalization" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Reference-to-external-manual-1"></a>
-<h3 class="subsection">7.9.1 Reference to external manual</h3>
-<a name="index-external-manual"></a>
-
-<p>The references are produced with two function references, one for the
-hypertextual reference construction, the other for the full reference to
-external manual.
-</p>
-<dl>
-<dt><a name="index-external_005fhref"></a><u>Function Reference:</u> $href
<b>external_href</b><i> $node $node_identifier $xml_node_identifier
$manual_file_name</i></dt>
-<dd><p><var>$node</var> is the node name, with @-commands.
<var>$node_identifer</var> is the
-node name mapped to an identifier acceptable as a file name.
-<var>$xml_node_identifier</var> is the
-node name mapped to an identifier acceptable as an <acronym>XML</acronym>
identifier.
-Those identifiers are built as explained in <a
href="texinfo.html#HTML-Xref">(texinfo)HTML Xref</a> section ‘HTML
Xref’ in <cite>GNU Texinfo</cite>,
-thus allowing for cross references to external manuals. <var>$file</var> is the
-manual or file name of the external reference. This function should return an
-href leading to the external manual.
-</p>
-<p>The default for this function is to make a reference compatible with
-<code>makeinfo</code> (see <a href="texinfo.html#HTML-Xref">(texinfo)HTML
Xref</a> section ‘HTML Xref’ in <cite>GNU Texinfo</cite>).
-</p></dd></dl>
-
-<dl>
-<dt><a name="index-external_005fref"></a><u>Function Reference:</u> $text
<b>external_ref</b><i> $command $section $book $node_and_file $href
$cross_ref_name address@hidden address@hidden</i></dt>
-<dd><p>This function formats a reference to an external texinfo manual.
-The <var>$command</var> is the ref command (<code>ref</code>,
<code>xref</code> or
-<code>pxref</code>, in text, at sentence beginning or in parenthesis).
-The optionnal <var>$section</var> argument is the section in the book and
- <var>book</var> is the book title.
-<var>$node_and_file</var> is the node and file name formatted according to the
-convention used in info: ‘<samp>(file)node</samp>’.
<var>$href</var> it an hypertextual
-reference to the distant manual constructed using the above function.
-<var>$cross_ref_name</var> is an optionnal cross
-reference name appearing in the reference command.
-<var>address@hidden</var> is a reference on an array containing the @-command
-arguments, not formatted, with <var>address@hidden</var> contains the formatted
address@hidden arguments.
-This function returns
-the text corresponding with the external html manual reference.
-This function returns the full formatted text of the external reference.
-</p></dd></dl>
-
-<hr size="6">
-<a name="Internal-reference"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Reference-to-external-manual"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Alignement-commands" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Beginning
of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#References" title="Up section"> Up
</a>]</td>
-<td valign="middle" align="left">[<a href="#Internationalization" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Reference-to-an-internal-node"></a>
-<h3 class="subsection">7.9.2 Reference to an internal node</h3>
-
-<p>A function reference is available for internal references.
-</p>
-<dl>
-<dt><a name="index-internal_005fref"></a><u>Function Reference:</u> $text
<b>internal_ref</b><i> $command $href $short_name $name $is_section
address@hidden address@hidden</i></dt>
-<dd><p>This function formats a reference to a node in the current manual.
-The <var>$command</var> is the ref command (<code>ref</code>,
<code>xref</code> or
-<code>pxref</code>, in text, at sentence beginning or in parenthesis).
-<var>$href</var> it an hypertextual reference linking to the corresponding
-node or section. <var>$short_name</var> and <var>$name</var> hold the text for
the
-reference but <var>$short_name</var> can be the node name which is assumed to
-be shorter than the section name.
-<var>$is_section</var> is a boolean true if the reference is a reference to a
-section.
-<var>address@hidden</var> is a reference on an array containing the @-command
-arguments, not formatted, with <var>address@hidden</var> contains the formatted
address@hidden arguments.
-This function returns the full formatted text of the internal
-reference.
-</p></dd></dl>
-
-
-<hr size="6">
-<a name="Alignement-commands"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Internal-reference"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Paragraph-and-preformatted-region"
title="Next section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Beginning
of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Internationalization" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Commands-used-for-centering-and-flushing-of-text"></a>
-<h2 class="section">7.10 Commands used for centering and flushing of text</h2>
-
-<a name="index-centering"></a>
-<a name="index-flushing-text"></a>
-<a name="index-text-alignement"></a>
-
-<p>When a command controlling the alignement of text is used
(<code>@center</code>,
-<code>@flushleft</code> and <code>@flushright</code>), the main program takes
-care of opening and closing paragraphs. The alignement commands are the
-key of the <a name="index-_0025paragraph_005fstyle"></a>
-<code>%paragraph_style</code> hash.
-The value is used in the function doing the formatting of the paragraphs.
-See section <a href="#Paragraph-and-preformatted-region">Formatting (or not) a
paragraph and a preformatted region</a>.
-</p>
-<p>A function references allows for a customization of the formatting of the
text
-appearing in the command block.
-</p>
-<dl>
-<dt><a name="index-paragraph_005fstyle_005fcommand"></a><u>Function
Reference:</u> $result <b>paragraph_style_command</b><i> $command $text</i></dt>
-<dd><p><var>$command</var> is the command name, <var>$text</var> is the text
appearing within
-the command. This function returns a formatted text.
-The default is to return the text unmodified.
-</p></dd></dl>
-
-<hr size="6">
-<a name="Paragraph-and-preformatted-region"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Alignement-commands"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a
href="#Paragraph-and-preformatted-formatting" title="Next section in reading
order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Beginning
of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Internationalization" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a
name="Formatting-_0028or-not_0029-a-paragraph-and-a-preformatted-region"></a>
-<h2 class="section">7.11 Formatting (or not) a paragraph and a preformatted
region</h2>
-
-
-<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top"><a
href="#Paragraph-and-preformatted-formatting">7.11.1 Paragraph and preformatted
region formatting</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Avoiding-paragraphs">7.11.2
Avoiding paragraphs in formats</a></td><td> </td><td align="left"
valign="top">
-</td></tr>
-</table>
-
-<hr size="6">
-<a name="Paragraph-and-preformatted-formatting"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a
href="#Paragraph-and-preformatted-region" title="Previous section in reading
order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Avoiding-paragraphs" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Beginning
of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Paragraph-and-preformatted-region"
title="Up section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Internationalization" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Paragraph-and-preformatted-region-formatting"></a>
-<h3 class="subsection">7.11.1 Paragraph and preformatted region formatting</h3>
-
-<a name="index-paragraph"></a>
-<a name="index-preformatted-region"></a>
-
-<p>The formatting of a paragraph region or a preformatted region, is controlled
-by function references:
-</p>
-<dl>
-<dt><a name="index-paragraph-1"></a><u>Function Reference:</u> $paragraph_text
<b>paragraph</b><i> $text $alignement $index $formatting_command
$formatting_command_formatted \$paragraph_number $format $item_number
$enumerate_style $number $command_stack_at_end $command_stack_at_begin</i></dt>
-<dd><p>This function formats a paragraph. <var>$text</var> is the text of the
paragraph,
-<var>$alignement</var> is the empty string when no alignement command has
-been seen, otherwise it is the current alignement command name.
-See section <a href="#Alignement-commands">Commands used for centering and
flushing of text</a>.
-<var>$indent</var> holds ‘<samp>noindent</samp>’ or
‘<samp>indent</samp>’ if the corresponding
address@hidden appeared in the paragraph.
-<var>$command_stack_at_end</var> and <var>$command_stack_at_begin</var> are
arrays
-containing the opened @-commands at end and at beginning of the paragraph,
-latest on top.
-</p>
-<p>The remaining arguments are usefull when the paragraph appears within a
-list or table. It is usefull whenever the paragraph has to be formatted
-differently when appearing in such environments.
-Moreover in that case the format command (<code>@itemize</code>…)
-may have
-an associated formatting command.
-<var>$formatting_command</var> is this formatting command
-(like <code>@minus</code>).
-<var>$formatting_command_formatted</var> is the command formatted in html
-in case the formatting command is a leading command (like <code>@minus</code>)
-which should be leading the first paragraph.
-<var>\$paragraph_number</var> is a reference on the number of
-paragraphs in that format command. The corresponding variable should be
-increased when a paragraph is added. <var>$format</var> is the format command.
-See section <a href="#Table-and-list-items">Formatting individual table and
list items</a>.
-</p>
-<p>If the <var>$format</var> is an enumerate, <var>$item_number</var> is the
number of
-the item in the list, <var>$enumerate_style</var> is the argument of the
enumerate,
-<var>$number</var> is the number or letter corresponding with this item.
-</p></dd></dl>
-
-<dl>
-<dt><a name="index-preformatted"></a><u>Function Reference:</u>
$preformatted_text <b>preformatted</b><i> $text $style $region_name
$formatting_command $formatting_command_formatted \$preformatted_number $format
$item_number $enumerate_style $number $command_stack_at_end
$command_stack_at_begin</i></dt>
-<dd><p>This function formats a preformatted region. <var>$text</var> is the
text of the
-preformatted region, <var>$style</var> is the css style associated with that
-preformatted region (see section <a href="#css">Customizing the
<code>texi2html</code> css lines</a>). <var>$region_name</var> is the
-name of the command opening
-the preformatted region (<code>example</code>…, see <a
href="#Complex-formats">Formatting of complex formats (<code>@example</code>,
<code>@display</code>…)</a>)
-or a identifier for the preformatted context (for example
-<code>menu-comment</code>, see <a href="#Menus">Menu formatting</a>).
-The alignment commands are not taken into account, as the spaces are
-preserved in preformatted regions, you should flush and center by hand.
-<var>$command_stack_at_end</var> and <var>$command_stack_at_begin</var> are
arrays
-containing the opened @-commands at end and at beginning of the preformatted
-region, latest on top.
-</p>
-<p>The remaining arguments are usefull when the preformatted region appears
-within a list or table. It is usefull whenever the preformatted region
-has to be formatted
-differently when appearing in such environments.
-Moreover in that case the format command (<code>@itemize</code>…)
-may have
-an associated formatting command.
-<var>$formatting_command</var> is this formatting command
-(like <code>@minus</code>).
-<var>$formatting_command_formatted</var> is the command formatted in html
-in case the formatting command is a leading command (like <code>@minus</code>)
-which should be leading the first preformatted region.
-<var>\$preformatted_number</var> is a reference on the number of
-preformatted regions in that format command. The corresponding variable
-should be increased when a preformatted region is added. <var>$format</var> is
the
-format command.
-See section <a href="#Table-and-list-items">Formatting individual table and
list items</a>.
-</p>
-<p>If the <var>$format</var> is an enumerate, <var>$item_number</var> is the
number of
-the item in the list, <var>$enumerate_style</var> is the argument of the
enumerate,
-<var>$number</var> is the number or letter corresponding with this item.
-</p></dd></dl>
-
-<hr size="6">
-<a name="Avoiding-paragraphs"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a
href="#Paragraph-and-preformatted-formatting" title="Previous section in
reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Complex-formats" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Beginning
of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Paragraph-and-preformatted-region"
title="Up section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Internationalization" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Avoiding-paragraphs-in-formats"></a>
-<h3 class="subsection">7.11.2 Avoiding paragraphs in formats</h3>
-
-<a name="index-Avoid-paragraph-opening"></a>
-
-<p>It is possible to avoid that a format closes the previous paragraph or
-preformatted region and reopens one, by putting the format command in a
-hash, <a name="index-_0025format_005fin_005fparagraph"></a>
-<code>%format_in_paragraph</code> with a true value. This only
-makes sense for few commands since otherwise the nesting of formats and
-paragraphs could become wrong.
-</p>
-<p>If the value of <a name="index-_0025no_005fparagraph_005fcommands"></a>
-<code>%no_paragraph_commands</code> associated with a command is
-true, no paragraph is started by the command if outside of a paragraph
-(after an empty line, for example). If the value is set to 0, it will start
-a paragraph. If the value is not set, reasonable defaults are
-set.
-</p>
-<p>It is also possible to stop a paragraph when an @-command happens by
-putting the @-command in the <a
name="index-_0025stop_005fparagraph_005fcommand"></a>
-<code>%stop_paragraph_command</code> hash
-associated with a true value.
-</p>
-
-<hr size="6">
-<a name="Complex-formats"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Avoiding-paragraphs"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Lists-tables" title="Next section
in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Beginning
of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Internationalization" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a
name="Formatting-of-complex-formats-_0028_0040example_002c-_0040display_002e_002e_002e_0029"></a>
-<h2 class="section">7.12 Formatting of complex formats (<code>@example</code>,
<code>@display</code>…)</h2>
-
-<a name="index-complex-format"></a>
-
-<p>Here we see how a whole complex format is formatted. For the formatting
-of the text, see <a href="#Paragraph-and-preformatted-region">Formatting (or
not) a paragraph and a preformatted region</a>.
-</p>
-<p>The formatting of the complex formats is ultimately controlled by a
-function, however the default for this function uses a hash reference and
-changing the hash reference values should be enough in most cases. This
-hash reference is called <a name="index-_0024complex_005fformat_005fmap"></a>
-<code>$complex_format_map</code>. It has a key for each
-of the complex format commands (<code>example</code>,
<code>smallexample</code>,
-<code>lisp</code>, <code>smalllisp</code>, <code>display</code>,
<code>smalldisplay</code>,
-<code>format</code>, <code>smallformat</code>).
-</p>
-<p>The associated value is also a reference on a hash. The keys are:
-</p>
-<dl compact="compact">
-<dt> <code>begin</code></dt>
-<dd><p>An eval of <code>begin</code> should lead to the beginning of the
-formatted <acronym>HTML</acronym>.
-</p></dd>
-<dt> <code>end</code></dt>
-<dd><p>An eval of <code>end</code> should lead to the end of the
-formatted <acronym>HTML</acronym>.
-</p></dd>
-<dt> <code>class</code></dt>
-<dd><p>The <acronym>HTML</acronym> class. If not defined, the command name.
-</p></dd>
-<dt> <code>pre_style</code></dt>
-<dd><p>The preformatted style. If not defined the corresponding
<acronym>CSS</acronym> style
-is used.
-</p></dd>
-<dt> <code>style</code></dt>
-<dd><p>If the associated value is <code>code</code>, the format is assumed to
be in
-code style, where
-with ‘<samp>---</samp>’, ‘<samp>--</samp>’,
‘<samp>''</samp>’ and ‘<samp>``</samp>’ kept as is.
-If the key is absent the format inherits the code style
-and the font from the enclosing context.
-</p></dd>
-</dl>
-
-<p>The enclosed text will be formatted as described in
-<a href="#Paragraph-and-preformatted-region">Formatting (or not) a paragraph
and a preformatted region</a>, and the name of the complex
-format will be available to the function formatting the text.
-</p>
-<p>If you aren’t satisfied with this scheme, you can redefine the
following
-function reference for a better control over the complex format formatting:
-</p>
-<dl>
-<dt><a name="index-complex_005fformat"></a><u>Function Reference:</u>
$complex_format_text <b>complex_format</b><i> $format_name
$preformatted_text</i></dt>
-<dd>
-<p><var>$format_name</var> is the complex format name,
<var>$preformatted_text</var> is the
-text allready formatted as described in <a
href="#Paragraph-and-preformatted-region">Formatting (or not) a paragraph and a
preformatted region</a>.
-This function returns the whole complex format.
-</p></dd></dl>
-
-<hr size="6">
-<a name="Lists-tables"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Complex-formats"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Table-and-list-items" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Beginning
of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Internationalization" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Customizing-the-formatting-of-lists-and-tables"></a>
-<h2 class="section">7.13 Customizing the formatting of lists and tables</h2>
-
-<p>The formatting of lists and tables is done at two levels:
-</p><ul>
-<li>
-At the level of the whole region (table or list),
-</li><li>
-At the level of the individual items, rows or cells of the list or table.
-</li></ul>
-
-<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top"><a href="#Table-and-list-items">7.13.1
Formatting individual table and list items</a></td><td> </td><td
align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Whole-table-list">7.13.2
Formatting of a whole table or list</a></td><td> </td><td
align="left" valign="top">
-</td></tr>
-</table>
-
-<hr size="6">
-<a name="Table-and-list-items"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Lists-tables" title="Previous
section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Whole-table-list" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Beginning
of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Lists-tables" title="Up section">
Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Internationalization" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Formatting-individual-table-and-list-items"></a>
-<h3 class="subsection">7.13.1 Formatting individual table and list items</h3>
-
-<p>In texinfo it is possible to give <code>@itemize</code> or table command
(hereafter
-called a <em>format command</em>) a <em>formatting command</em>.
-For example <code>@minus</code> is the formatting command here:
-</p><table><tr><td> </td><td><pre class="example">@table @minus
-</pre></td></tr></table>
-
-<p>The default is to apply the command to the text item, however it is possible
-to avoid it.
-The hash <a name="index-_0025special_005flist_005fcommands"></a>
-<code>%special_list_commands</code> has an entry for each of the
-format command. Each of these entries is a hash reference. If a formatting
-command is a key of the hash reference, then the formatting command is not
-applied to the text item for that format command. For example, if we have:
-</p>
-<table><tr><td> </td><td><pre
class="example">$special_list_commands{'itemize'} = { 'bullet' => '' };
-</pre></td></tr></table>
-
-<p>and we have the following <code>@itemize</code>:
-</p><table><tr><td> </td><td><pre class="example">@itemize @bullet
address@hidden an item
address@hidden itemize
-</pre></td></tr></table>
-
-<p>then <code>@bullet</code> will not be applied to <code>an item</code>.
-</p>
-<p>More control of the text before formatting of the line or the item is
-achieved with the following function reference:
-</p>
-<dl>
-<dt><a name="index-_0024result_005fline"></a><u>Function Reference:</u> (
<b>$result_line</b><i>, $open_command) format_list_item_texi $format $line
$prepended $command</i></dt>
-<dd><p>The <var>$format</var> is the list or table @-command,
-<var>$line</var> is the item line, <var>$command</var> is the <em>format
command</em>,
-<var>$prepended</var> is set to the text folllowing the <em>format command</em>
-on the format argumlent line.
-The <var>$result_line</var> replaces the item argument, and if
<var>$open_command</var>
-is true, the <em>format command</em> is opened for the line.
-</p></dd></dl>
-
-<dl compact="compact">
-<dt> <em>lists</em></dt>
-<dd><p>The items of lists are formatted using the following function reference:
-</p><dl>
-<dt><a name="index-list_005fitem"></a><u>Function Reference:</u> $list_item
<b>list_item</b><i> $text $format $command $formatted_command $item_number
$enumerate_style $number $prepended_texi $prepended_formatted</i></dt>
-<dd><p>This function formats the text between <code>@item</code> commands.
<var>$text</var>
-is the text corresponding with the item. <var>$format</var> is the type of
format,
-‘<samp>itemize</samp>’ or ‘<samp>enumerate</samp>’.
<var>$command</var> is the formatting command
-given in argument to <code>@itemize</code>, <var>$formatted_command</var> is
this command
-formatted if it is a leading command, like <code>@minus</code>.
-</p>
-<p>If the <var>$format</var> is an enumerate, <var>$item_number</var> is the
number of
-the item in the list, <var>$enumerate_style</var> is the argument of the
enumerate,
-<var>$number</var> is the number or letter corresponding with this item.
-</p>
-<p>If the <var>$format</var> is an itemize, <var>$prepended_texi</var> is the
text that
-appeared on the itemize line, maybe after the formatting command
-(if any), and <var>$prepended_formatted</var> is the corresponding text,
-formatted.
-</p></dd></dl>
-
-</dd>
-<dt> <em>two column tables</em></dt>
-<dd><p>The two columns tables (<code>@table</code>, <code>@ftable</code> and
<code>@vtable</code>),
-items are formatted using two function references,
-one for the first line located on the <code>@item</code> line corresponding
-with the first column, the other for the text appearing on the
-following lines, corresponding with the second column text.
-</p>
-<dl>
-<dt><a name="index-table_005fitem"></a><u>Function Reference:</u> $table_item
<b>table_item</b><i> $item_text $index_label_text $format $command
$formatted_command $command_stack $text_formatted
$text_formatted_leading_spaces $text_formatted_trailing_spaces
$item_command</i></dt>
-<dd><p>This function is used to format the text on the <code>@item</code> line.
-<var>$text_item</var> is the text line. In case there is an index entry
-associated with the <code>@item</code> (as with <code>@ftable</code> and
-<code>@vtable</code>), <var>$index_label_text</var> is the text inserted at
-the place where an index entry appears. See section <a
href="#Index-entry-place">Formatting of index entries</a>.
-<var>$format</var> is the type of format,
-‘<samp>table</samp>’, ‘<samp>ftable</samp>’ or
‘<samp>vtable</samp>’. <var>$command</var> is the formatting command
-given in argument to the table format command, <var>$formatted_command</var>
is
-this command formatted if it is a leading command, like <code>@minus</code>.
-<var>$command_stack</var> is an array with all the @-commands opened, latest
-on top.
-<var>$text_formatted</var> is the text formatted by the formatting command if
-the command is a command with braces like <code>@code</code>.
-<var>$text_formatted_leading_spaces</var> and
<var>$text_formatted_trailing_spaces</var>
-are the spaces removed before closing the format.
-<var>$item_command</var> is the item command, ‘<samp>@item</samp>’
or ‘<samp>@itemx</samp>’.
-</p></dd></dl>
-
-<dl>
-<dt><a name="index-table_005fline"></a><u>Function Reference:</u> $table_line
<b>table_line</b><i> $text</i></dt>
-<dd><p>This function is used to format the text on the lines following
-the <code>@item</code> line. <var>$text</var> is the corresponding text.
-</p></dd></dl>
-
-</dd>
-<dt> <em>multitable</em></dt>
-<dd><p><a name="Multitable-formatting"></a>
-The multitable elements formatting is controlled by the functions associated
-with two function references. One for a cell, and the other for a row.
-</p>
-<dl>
-<dt><a name="index-cell"></a><u>Function Reference:</u> $multitable_cell
<b>cell</b><i> $text $item_command address@hidden address@hidden address@hidden
$column_number</i></dt>
-<dd><p>This function is used to format the text of a multitable cell, the text
-following a <code>@item</code> or a <code>@tab</code>.
-<var>$text</var> is the corresponding text. <var>$item_command</var> is the
command
-used to introduce the row, such that it is possible to distinguish
-between <code>@item</code> and <code>@headitem</code>.
-<var>address@hidden</var> is a reference on an array
-containing the <code>@columnfraction</code> arguments, if any, and
-<var>address@hidden</var> is a reference on an array containing the row
prototypes
-given on the <code>@multitable</code> line, if any.
-<var>address@hidden</var> array contains the lengths of the row prototypes
-formatted.
-<var>$column_number</var> is the maximal number of columns.
-</p></dd></dl>
-
-<dl>
-<dt><a name="index-row"></a><u>Function Reference:</u> $multitable_row
<b>row</b><i> $text $item_command address@hidden address@hidden address@hidden
$column_number</i></dt>
-<dd><p>This function is used to format a multitable row. <var>$text</var> is
-the row text, with cells allready formatted with the <a
name="index-_0024cell"></a>
-<code>$cell</code>
-function reference. <var>$item_command</var>, <var>address@hidden</var>,
-<var>address@hidden</var>, <var>address@hidden</var>
-and <var>$column_number</var> are the same than in the function reference
above.
-</p>
-</dd></dl>
-</dd>
-</dl>
-
-<p>In the default case, this function is interlinked with
-<code>$begin_format_texi</code> (see section <a
href="#Customizing-format-opening">Customizing format opening</a>)
-and <code>@multitable</code> formatting
-since a stack of possible nested
-multitables is kept to know the cell number.
-</p>
-<hr size="6">
-<a name="Whole-table-list"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Table-and-list-items"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Definitions" title="Next section
in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Beginning
of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Lists-tables" title="Up section">
Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Internationalization" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Formatting-of-a-whole-table-or-list"></a>
-<h3 class="subsection">7.13.2 Formatting of a whole table or list</h3>
-
-<p>If the Texinfo command is a key of the <a
name="index-_0025format_005fmap"></a>
-<code>%format_map</code>, the associated
-value is used to specify the formatting of the construct, otherwise a function
-is called.
-The value in <code>%format_map</code> associated with a command is interpreted
-similarly with values associated with more simpler commands:
-</p>
-<ul>
-<li>
-If the text is a word, it is considered to be an <acronym>HTML</acronym>
element
-name, and the whole table or list is enclosed between the element opening
-and the element closing.
-</li><li>
-If the text is a word followed by some text,
-the word and is interpreted as above, and the
-text is considered to be the attributes text of the element.
-</li><li>
-If the text is empty nothing is added to the text.
-</li></ul>
-
-<p>In case the <code>%format_map</code> isn’t used, a function reference
called
-<code>$table_list</code>
-should be redefined, the associated function will be called each time
-a command isn’t found in <code>%format_map</code>.
-</p>
-<dl>
-<dt><a name="index-table_005flist"></a><u>Function Reference:</u>
$whole_table_list <b>table_list</b><i> $format_command $text $command
$formatted_command $item_nr $enumerate_style $prepended_texi
$prepended_formatted address@hidden address@hidden address@hidden
$column_number</i></dt>
-<dd><p><var>$format_command</var> is the Texinfo command name,
<var>$text</var> is the
-formatted items. <var>$command</var> is the <em>format command</em> given in
argument
-to the format command, <var>$formatted_command</var> is the same, but
formatted.
-<var>$prepended_texi</var> is the remaining text on the format command line,
-<var>$prepended_formatted</var> is the same, but formatted.
-Only relevant in <code>@enumerate</code>, <var>$item_nr</var> is the item
number, and
-<var>$enumerate_style</var> is the <code>@enumerate</code> style. Only
relevant in
-<code>@multitable</code>
-<var>address@hidden</var> is a reference on an array
-containing the <code>@columnfraction</code> arguments, if any,
-<var>address@hidden</var> is a reference on an array containing the row
prototypes
-given on the <code>@multitable</code> line, if any,
-<var>address@hidden</var> array contains the lengths of the row prototypes
-formatted and
-<var>$column_number</var> is the maximal number of columns.
-</p></dd></dl>
-
-<p>If you still want to use <a name="index-_0025format_005fmap-1"></a>
-<code>%format_map</code> but differently from
-the default, it is possible to redefine the following function reference:
-</p>
-<dl>
-<dt><a name="index-format"></a><u>Function Reference:</u> $whole_table_list
<b>format</b><i> $command $format $text</i></dt>
-<dd><p><var>$command</var> is the @-command, <var>$format</var> is the entry
associated with
-<var>$command</var> in <code>%format_map</code>. <var>$text</var> is the
formatted items.
-</p></dd></dl>
-
-<hr size="6">
-<a name="Definitions"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Whole-table-list"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Definition-line" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Beginning
of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Internationalization" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Definition-commands-formatting"></a>
-<h2 class="section">7.14 Definition commands formatting</h2>
-
-<p>The formatting of definition commands is controlled by a main hash,
-3 strings and another hash, and and five
-functions. The mainhash describes how the text on the definition line is
-interpreted, the functions control the formatting of the definition line
-and the definition function text.
-</p>
-<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top"><a href="#Definition-line">7.14.1
Customizing the interpretation of a definition
line</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Definition-formatting">7.14.2
Customization of the definition formatting</a></td><td> </td><td
align="left" valign="top">
-</td></tr>
-</table>
-
-<hr size="6">
-<a name="Definition-line"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Definitions" title="Previous
section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Definition-formatting" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Beginning
of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Definitions" title="Up section">
Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Internationalization" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Customizing-the-interpretation-of-a-definition-line"></a>
-<h3 class="subsection">7.14.1 Customizing the interpretation of a definition
line</h3>
-
-<p>The keys of the hash <a name="index-_0025def_005fmap"></a>
-<code>%def_map</code> are definition command names.
-There are two types of entries:
-</p>
-<ul>
-<li> If the command is a shortcut for
-another definition command the value is a text and the definition
-command is replaced by the text.
-
-<p>For example if we have:
-</p><table><tr><td> </td><td><pre class="example">$def_map{'deftruc'} =
'@defvr {A truc}';
-</pre></td></tr></table>
-
-<p>and a line like
-</p><table><tr><td> </td><td><pre class="example">@deftruc var
-</pre></td></tr></table>
-
-<p>the line will be transformed in
-</p><table><tr><td> </td><td><pre class="example">@defvr {A truc} var
-</pre></td></tr></table>
-
-</li><li>
-If the command isn’t a shortcut, it is associated with an array
-reference. The first element is ‘<samp>f</samp>’,
‘<samp>v</samp>’ or ‘<samp>t</samp>’ corresponding
-with the index type (‘<samp>f</samp>’ for function,
‘<samp>v</samp>’ for variable,
-‘<samp>t</samp>’ for type).
-
-<p>The remaining of the array describes how to interpret the text following
-the definition command on the definition command line.
-The entry item specify what corresponds
-with the next bracketed item or word. Currently the possibilities are
-‘<samp>category</samp>’, ‘<samp>name</samp>’,
‘<samp>type</samp>’, ‘<samp>class</samp>’,
‘<samp>arg</samp>’
-and ‘<samp>argtype</samp>’. ‘<samp>arg</samp>’ means
that the arguments are not mixed
-with type definitions, with ‘<samp>argtype</samp>’ types are mixed
with
-definitions. When there is no ‘<samp>arg</samp>’ nor
‘<samp>argtype</samp>’ it is
-the same than ‘<samp>argtype</samp>’ (like makeinfo).
-</p>
-<p>For example if we have
-</p><table><tr><td> </td><td><pre class="example">def_map{'defvr'} = [
'v', 'category', 'name' ];
-</pre></td></tr></table>
-
-<p>The first bracketed item following <code>@defvr</code> is considered
-to be the category and the next one is the name. The index associated
-with the definition line is the variables index.
-</p></li></ul>
-
-<p>Some characters are special with regard with definition parsing, they
-are delimiters, the can have a role in definition argument determination,
-and also hae a special meaning in arguments parsing.
-This is not very well documented in the texinfo manual,
-so it is subject to change. Strings allow to determine the delimiters:
-</p>
-<dl compact="compact">
-<dt> <code>$def_argument_separator_delimiters</code>
-<a name="index-_0024def_005fargument_005fseparator_005fdelimiters"></a>
-</dt>
-<dd><p>Characters that separate arguments, currently <code>()[],</code>.
-</p></dd>
-<dt> <code>$def_always_delimiters</code>
-<a name="index-_0024def_005falways_005fdelimiters"></a>
-</dt>
-<dd><p>Character that are always delimiters, if they appear in a type or a
-parameter,
-<code>()[]</code>.
-</p></dd>
-<dt> <code>$def_in_type_delimiters</code>
-<a name="index-_0024def_005fin_005ftype_005fdelimiters"></a>
-</dt>
-<dd><p>Character that are considered as delimiters only if in a type. In
-a parameter they are part of the parameter.
-</p></dd>
-</dl>
-
-
-<hr size="6">
-<a name="Definition-formatting"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Definition-line"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Headings" title="Next section in
reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Beginning
of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Definitions" title="Up section">
Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Internationalization" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Customization-of-the-definition-formatting"></a>
-<h3 class="subsection">7.14.2 Customization of the definition formatting</h3>
-
-<p>Five functions are used when formatting a definition command:
-</p>
-<dl compact="compact">
-<dt> <strong>category name</strong></dt>
-<dd><dl>
-<dt><a name="index-definition_005fcategory"></a><u>Function Reference:</u>
$category <b>definition_category</b><i> $category $class $style
$command</i></dt>
-<dd><p>This function precise a category name associating a class
-<var>$class</var> (if given) with <var>$category</var>. The <var>$style</var>
of the
-definition may be ‘<samp>f</samp>’, for function,
‘<samp>v</samp>’, for variable or ‘<samp>t</samp>’,
-for type. The <var>$command</var> is the definition @-command.
-</p></dd></dl>
-
-<dl>
-<dt><a name="index-definition_005findex_005fentry"></a><u>Function
Reference:</u> $entry <b>definition_index_entry</b><i> $name $class $style
$command</i></dt>
-<dd><p>This function precise a name associating a class
-<var>$class</var> (if given) with <var>$name</var>. This is used to do an index
-enntry associated with th edefinition command. The <var>$style</var> of the
-definition may be ‘<samp>f</samp>’, for function,
‘<samp>v</samp>’, for variable or ‘<samp>t</samp>’,
-for type. The <var>$command</var> is the definition @-command.
-</p></dd></dl>
-
-</dd>
-<dt> <strong>formatting of the definition line</strong></dt>
-<dd><dl>
-<dt><a name="index-def_005fline"></a><u>Function Reference:</u> $line
<b>def_line</b><i> $class_category_class $name $type $arguments $index_label
address@hidden address@hidden address@hidden $command $class_name $category
$class $style $original_command</i></dt>
-<dd><p>This function formats the definition line. <var>$class_category</var>
is the category
-formatted with <a name="index-_0024definition_005fcategory"></a>
-<code>$definition_category</code>, <var>$name</var>, <var>$type</var> and
-<var>arguments</var> are the element of the definition line.
<var>$index_label</var> is
-the text inserted at the place where an index entry appears.
-See section <a href="#Index-entry-place">Formatting of index entries</a>.
-<var>address@hidden</var> is an array holding the definition arguments,
-formatted. <var>address@hidden</var> holds the type of the definition
-arguments, like ‘<samp>name</samp>’,
‘<samp>type</samp>’ and similar arguments,
-‘<samp>paramtype</samp>’.
-‘<samp>delimiter</samp>’ and ‘<samp>param</samp>’.
<var>address@hidden</var>
-holds the arguments without @-command substitution. <var>$command</var> is the
-definition command, after substitution.
-<var>$class_name</var> is the class applied on name, formatted
-as specified in <code>definition_index_entry</code>. <var>$category</var> and
-<var>$class</var> are the corresponding arguments. <var>$style</var>
corresponds with the
-index style, as explained above. <var>$original_command</var> is the unmodified
-definition @-command.
-</p></dd></dl>
-
-</dd>
-<dt> <strong>definition text</strong></dt>
-<dd><dl>
-<dt><a name="index-def_005fitem"></a><u>Function Reference:</u>
$definition_text <b>def_item</b><i> $text</i></dt>
-<dd><p>This function formats the definition text, <var>$text</var>.
-</p></dd></dl>
-
-</dd>
-<dt> <strong>the whole definition</strong></dt>
-<dd><dl>
-<dt><a name="index-def"></a><u>Function Reference:</u> $definition
<b>def</b><i> $text</i></dt>
-<dd><p>This function formats the whole definition. The definition line and
text
-formatted by the above functions are in <var>$text</var>.
-</p></dd></dl>
-
-</dd>
-</dl>
-
-<hr size="6">
-<a name="Headings"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Definition-formatting"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Special-regions" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Beginning
of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Internationalization" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Customizing-headings-formatting"></a>
-<h2 class="section">7.15 Customizing headings formatting</h2>
-
-<p>A function controls the formatting of sectioning element headings,
-with the corresponding function reference:
-</p><dl>
-<dt><a name="index-heading"></a><u>Function Reference:</u> $heading_text
<b>heading</b><i> \%element_reference</i></dt>
-<dd><p>The <var>\%element_reference</var> is a reference on a hash
corresponding
-with the sectioning element. The following keys are of interest:
-</p><dl compact="compact">
-<dt> <code>text</code></dt>
-<dd><p>The heading text
-</p></dd>
-<dt> <code>name</code></dt>
-<dd><p>The heading text without section number
-</p></dd>
-<dt> <code>node</code></dt>
-<dd><p>true if the sectioning element is a node without associated structuring
command
-</p></dd>
-<dt> <code>level</code></dt>
-<dd><p>The level of the element in the document tree.
‘<samp>0</samp>’ is for <code>@top</code>,
-‘<samp>1</samp>’ for <code>@chapter</code> and so on
-</p></dd>
-<dt> <code>tag_level</code></dt>
-<dd><p>the sectioning element name, with <code>@raisesections</code> and
-<code>@lowersections</code> taken into account
-</p></dd>
-<dt> <code>top</code></dt>
-<dd><p>true if it is the top element
-</p></dd>
-</dl>
-</dd></dl>
-
-<p>It is also possible to customize the heading text with section number
-with the following function reference (called for headings and nodes):
-</p><dl>
-<dt><a name="index-heading_005ftexi"></a><u>Function Reference:</u>
$result_texi <b>heading_texi</b><i> $heading_command $heading $number</i></dt>
-<dd><p><var>$heading_command</var> is the sectioning @-command of that
heading.
-<var>$heading</var> is the texinfo for that heading. <var>$number</var> is the
-heading number classicaly computed with dots between numbers, and
-letters for top level appendix numbering. This function should return the
-texinfo text corresponding with the numbered heading.
-</p></dd></dl>
-
-<p>The label associated with the heading that can appear before the
-heading itself and even before the navigation panel is customized with the
-following function reference:
-</p><dl>
-<dt><a name="index-element_005flabel"></a><u>Function Reference:</u>
$element_label <b>element_label</b><i> $identifier \%element_reference $command
$unformatted_line</i></dt>
-<dd><p><var>$identifier</var> is the identifier associated with the heading.
-<var>\%element_reference</var> is the same as above. <var>$command</var> is
the @-command
-appearing on the line, and <var>$unformatted_line</var> is the line,
-unformatted.
-</p></dd></dl>
-
-<p>Additionally, for <code>@node</code> and sectionning @-commands the
formatting
-of the label, navigation panel and heading is controlled by:
-</p><dl>
-<dt><a name="index-element_005fheading"></a><u>Function Reference:</u>
$element_heagin_text <b>element_heading</b><i> \%element_reference $command
$command_texi_arg $formatted_arg $in_preformatted $one_section $element_heading
$first_in_page $is_top $previous_is_top $unformatted_line $element_id
$new_element</i></dt>
-<dd><p><var>\%element_reference</var> is the same as above.
<var>$command</var> is the heading @-command.
-<var>$command_texi_arg</var> is the argument of the @-command, unformatted.
<var>$formatted_arg</var>
-is is the argument of the @-command, formatted. <var>$in_preformatted</var> is
true
-if in preformatted environment. <var>$one_section</var> is true if there is
only one
-section. <var>$first_in_page</var> is true if this is the first heading in a
page.
-<var>$is_top</var> is true if the heading is considered as a top element
heading.
-<var>$previous_is_top</var> is true if the previous helement was a top element.
-<var>$unformatted_line</var> holds the whole line, unformatted.
<var>$element_id</var>
-is the id of the heading. <var>$new_element</var> is true if the heading is
the first
-of an element block.
-</p></dd></dl>
-
-<hr size="6">
-<a name="Special-regions"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Headings" title="Previous
section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Menus" title="Next section in
reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Beginning
of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Internationalization" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a
name="Formatting-of-special-regions-_0028_0040verbatim_002c-_0040cartouche_002c-_0040quotation_0029"></a>
-<h2 class="section">7.16 Formatting of special regions
(<code>@verbatim</code>, <code>@cartouche</code>, <code>@quotation</code>)</h2>
-
-<p>Regions corresponding with raw text, like <code>@verbatim</code>,
<code>@html</code>
-or <code>@tex</code> are formatted according to the following function
reference:
-</p>
-<dl>
-<dt><a name="index-raw"></a><u>Function Reference:</u> $raw_region
<b>raw</b><i> $command $text</i></dt>
-<dd><p><var>$command</var> is the command name, <var>$text</var> is the raw
text.
-</p></dd></dl>
-
-<p>If LaTeX2HTML is used, <code>@tex</code> regions are handled differently,
-(see section <a href="#Bypassing-normal-formatting">Bypassing normal
formatting</a>).
-</p>
-<p>The <code>@cartouche</code> command formatting is controlled by the
-function reference:
-</p>
-<dl>
-<dt><a name="index-cartouche"></a><u>Function Reference:</u> $cartouche
<b>cartouche</b><i> $text</i></dt>
-<dd><p><var>$text</var> is the text appearing within the cartouche.
-</p></dd></dl>
-
-<p>The formatting of <code>@quotation</code> and <code>@smallquotation</code>
-is controlled by two function references.
-The first one is usefull in case the <code>@quotation</code> has an argument,
as
-it allows to prepend a string to the quotation text:
-</p>
-<dl>
-<dt><a name="index-quotation_005fprepend_005ftext"></a><u>Function
Reference:</u> $prepended_string <b>quotation_prepend_text</b><i> $command
$text</i></dt>
-<dd><p><var>$command</var> is the @-command.
-<var>$text</var> is the argument of the quotation with @-commands not
-interpreted. This function
-can return a string which will be prepended to the quotation text.
-</p></dd></dl>
-
-
-<p>The whole quotation is formatted by:
-</p>
-<dl>
-<dt><a name="index-quotation"></a><u>Function Reference:</u> $quotation
<b>quotation</b><i> $command $quotation_text $argument_text
$argument_text_texi</i></dt>
-<dd><p><var>$command</var> is the @-command.
-<var>$quotation_text</var> is the quotation text, formatted, with the text
-prepended by the function above. <var>$argument_text</var> is the argument
-of the <code>@quotation</code>, formatted. <var>$argument_text_texi</var> is
the argument
-of the <code>@quotation</code>, simply formatted.
-</p></dd></dl>
-
-
-<hr size="6">
-<a name="Menus"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Special-regions"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Menu-parts" title="Next section in
reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Beginning
of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Internationalization" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Menu-formatting"></a>
-<h2 class="section">7.17 Menu formatting</h2>
-
-<p>There are two possibilities for menu formatting:
-</p>
-<ul>
-<li> format the whole menu in a preformatted environment, like
-in <a href="#Complex-formats">Formatting of complex formats
(<code>@example</code>, <code>@display</code>…)</a>;
-</li><li> format the menu in table with more specialized formatting for each
-part of the menu;
-</li></ul>
-
-<p>The simple formatting in a preformatted is used if
-<a name="index-_0024SIMPLE_005fMENU"></a>
-<code>$SIMPLE_MENU</code> is true,
-otherwise the format with tables is used (this is the default).
-</p>
-<p>If <a name="index-_0024USE_005fACCESSKEY-1"></a>
-<code>$USE_ACCESSKEY</code> is set, the <code>accesskey</code> attribute
-is used in anchors. In that case the <a
name="index-_0025BUTTONS_005fACCESSKEY-1"></a>
-<code>%BUTTONS_ACCESSKEY</code>
-hash is used for the access key.
-</p>
-<p>To understand how the formatting of menus is controlled, the different
-parts of a menu are first described, then how to control the formatting
-of each of these parts, for each possible formatting.
-</p>
-<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top"><a href="#Menu-parts">7.17.1 The structure
of a menu</a></td><td> </td><td align="left" valign="top">
A menu consists in menu entry and menu
- comments
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Menu-components-formatting">7.17.2
The formatting of the different menu
components</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Simple-menu-formatting">7.17.3
Simple menu formatting in a preformatted
environment</a></td><td> </td><td align="left" valign="top">
formatting of a whole menu in a simple
- preformatted environement
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Table-menu-formatting">7.17.4 The
formatting of the menu in a table</a></td><td> </td><td align="left"
valign="top"> formatting of a whole menu in a
- table environment
-</td></tr>
-</table>
-
-<hr size="6">
-<a name="Menu-parts"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Menus" title="Previous section
in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Menu-components-formatting"
title="Next section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Beginning
of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Menus" title="Up section"> Up
</a>]</td>
-<td valign="middle" align="left">[<a href="#Internationalization" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="The-structure-of-a-menu"></a>
-<h3 class="subsection">7.17.1 The structure of a menu</h3>
-
-<p>In <code>texi2html</code>, a menu is considered to be composed of 2 parts,
the
-<em>menu entries</em> and the <em>menu comments</em>. Menu entries are further
-divided in an <em>entry link</em> and optionnaly an <em>entry description</em>.
-The entry link consists in a node name and an optionnal menu entry
-name.
-</p>
-<p>A menu entry begins with ‘<samp>*</samp>’ at the beginning of
the line. It begins
-with the entry link, followed by the description. The description spans until
-the next menu entry,
-or an empty line not contained within a command block which begun in the
-description. An empty line or
-starts a menu comment, which spans until the next menu entry.
-</p>
-<p>Here is an illustration of these rules:
-</p>
-<table><tr><td> </td><td><pre class="example">@menu
-* entry name: node name. description begins
- description continues
-* another menu entry::
- description begins
- description continues
-
- A menu comment, after an empty line
-
-* node:: description begins
-still in description.
-
-* last entry:: description begins @emph{text
-
-of the description, even if there is an empty line,
-because we are in @emph}.
address@hidden menu
-</pre></td></tr></table>
-
-<hr size="6">
-<a name="Menu-components-formatting"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Menu-parts" title="Previous
section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Simple-menu-formatting"
title="Next section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Beginning
of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Menus" title="Up section"> Up
</a>]</td>
-<td valign="middle" align="left">[<a href="#Internationalization" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="The-formatting-of-the-different-menu-components"></a>
-<h3 class="subsection">7.17.2 The formatting of the different menu
components</h3>
-
-<p>If in a preformatted context (and <code>$SIMPLE_MENU</code> isn’t
set), the
-menu link and description are put in the same preformatted environment.
-This can be avoided with <a name="index-_0024SEPARATE_005fDESCRIPTION"></a>
-<code>$SEPARATE_DESCRIPTION</code>.
-</p>
-<p>Two function references are associated with the formatting of the
-different parts of a menu:
-</p><dl>
-<dt><a name="index-menu_005flink"></a><u>Function Reference:</u> $link
<b>menu_link</b><i> $section \%state $href $node $name $ending $has_name
$command_stack $preformatted</i></dt>
-<dd><p><var>$section</var> is the section name corresponding with the link,
<var>$href</var>
-is the link hypertextual reference. <var>$href</var> may be absent.
<var>\%state</var>
-holds informations about the current context.
-<var>$node</var> is the node name, <var>$name</var> is the
-name of the node. <var>$ending</var> is the text ending the link entry,
-in general ‘<samp>::</samp>’ followed by some spaces.
-<var>$has_name</var> is true if the entry has an explicit name, otherwise
-<var>$name</var> has been constructed using the formatted node name.
-<var>$command_stack</var> is an array containing the commands enclosing
-the menu link. It is used in the default case to detect if the
-menu link is right in the <code>@menu</code> or not, since if it is not
-right below the menu the formatting is simpler.
-<var>$preformatted</var> is true if in preformatted context.
-See section <a href="#Three-contexts">Three contexts for expansions:
preformatted, normal and string</a>.
-</p></dd></dl>
-
-<p>This command is not called if <code>$SIMPLE_MENU</code> is set.
-</p>
-<dl>
-<dt><a name="index-menu_005fdescription"></a><u>Function Reference:</u>
$description <b>menu_description</b><i> $description_text \%state
$element_text</i></dt>
-<dd><p><var>$description_text</var> is the text of the menu description.
-The formatted link is also here if in preformatted context and
-<code>$SEPARATE_DESCRIPTION</code> is not set.
-<var>\%state</var>
-should be used similarly than for the menu link. <var>$element_text</var>
-is the heading of the element associated with the node.
-<var>$command_stack</var> and <var>$preformatted</var> are the same than for
the
-menu link.
-</p></dd></dl>
-
-<p>The <em>menu comment</em> part is formatted like a normal command,
-called <code>menu_comment</code>. It is only used if not in preformatted
-environment and if just below a <code>@menu</code> since otherwise one
-cannot tell if it is a menu commment or normal text.
-The default is to have it be formatted
-like a <a href="#Complex-formats">Formatting of complex formats
(<code>@example</code>, <code>@display</code>…)</a>, with
-</p><table><tr><td> </td><td><pre
class="example">$complex_format_map->{'menu_comment'} =
-{
- 'begin' => q{"<tr><th colspan=\"3\"
align=\"left\" valign=\"top\">"},
- 'end' => q{"</th></tr>"}, 'pre_style' =>
"$MENU_PRE_STYLE", 'class' => 'menu-comment',
-}
-</pre></td></tr></table>
-
-
-
-<hr size="6">
-<a name="Simple-menu-formatting"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Menu-components-formatting"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Table-menu-formatting" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Beginning
of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Menus" title="Up section"> Up
</a>]</td>
-<td valign="middle" align="left">[<a href="#Internationalization" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Simple-menu-formatting-in-a-preformatted-environment"></a>
-<h3 class="subsection">7.17.3 Simple menu formatting in a preformatted
environment</h3>
-
-<p>If the menu is to be formatted in a single preformatted environment,
-an entry for ‘<samp>menu</samp>’ and
‘<samp>detailmenu</samp>’
-should be added to the <code>$complex_format_map</code>
-hash reference (see section <a href="#Complex-formats">Formatting of complex
formats (<code>@example</code>, <code>@display</code>…)</a>).
-In the default case, if the user didn’t add an entry himself, a very
simple
-entry is used, with:
-</p>
-<table><tr><td> </td><td><pre
class="example">$complex_format_map->{'menu'} = { 'begin' => q{''} ,
'end' => q{''},
- 'pre_style' => "$MENU_PRE_STYLE", 'class' =>
'menu-preformatted' };
-</pre></td></tr></table>
-
-<hr size="6">
-<a name="Table-menu-formatting"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Simple-menu-formatting"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Indices" title="Next section in
reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Beginning
of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Menus" title="Up section"> Up
</a>]</td>
-<td valign="middle" align="left">[<a href="#Internationalization" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="The-formatting-of-the-menu-in-a-table"></a>
-<h3 class="subsection">7.17.4 The formatting of the menu in a table</h3>
-
-<p>In the default case, the name of the section corresponding with the
-node is used instead of the node name. If <a
name="index-_0024NODE_005fNAME_005fIN_005fMENU"></a>
-<code>$NODE_NAME_IN_MENU</code> is
-true, however, node names are used. If <a
name="index-_0024AVOID_005fMENU_005fREDUNDANCY"></a>
-<code>$AVOID_MENU_REDUNDANCY</code>
-is true and menu entry equal menu description the description isn’t
printed.
-This is the default. Likewise, if node or section name equal entry name,
-do not print entry name.
-</p>
-<p>A symbol, <a name="index-_0024MENU_005fSYMBOL"></a>
-<code>$MENU_SYMBOL</code> is put at the beginning of menu entries
-when the node name is used. The default is
‘<samp>&bull;</samp>’.
-If <a name="index-_0024UNNUMBERED_005fSYMBOL_005fIN_005fMENU"></a>
-<code>$UNNUMBERED_SYMBOL_IN_MENU</code> is true it is
-also put at the beginning of unnumbered section names. This is not
-done by default.
-</p>
-<p>The menu comments are considered to be preformatted text. The style
-associated with this preformatted text is determined by
-<a name="index-_0024MENU_005fPRE_005fSTYLE"></a>
-<code>$MENU_PRE_STYLE</code>. Default is ‘<samp>font-family:
serif</samp>’.
-The entry similar with an entry in <code>$complex_format_map</code>
-(see section <a href="#Complex-formats">Formatting of complex formats
(<code>@example</code>, <code>@display</code>…)</a>) used when the menu
appears in a preformatted
-enviroment is in
-<a name="index-_0024MENU_005fPRE_005fCOMPLEX_005fFORMAT"></a>
-<code>$MENU_PRE_COMPLEX_FORMAT</code>, and, in the default case is:
-</p><table><tr><td> </td><td><pre
class="example">$MENU_PRE_COMPLEX_FORMAT = {
- 'pre_style' => $MENU_PRE_STYLE,
- 'class' => 'menu-preformatted'
- };
-</pre></td></tr></table>
-
-<p>The css class associated with menu comments is <code>menu-comments</code>.
-</p>
-<p>The following function reference controls the formatting of a wole menu
-or a detailmenu in that case:
-</p>
-<dl>
-<dt><a name="index-menu_005fcommand"></a><u>Function Reference:</u> $menu
<b>menu_command</b><i> $command $menu_components_text</i></dt>
-<dd><p><var>$command</var> is the menu command, currently
‘<samp>menu</samp>’ or ‘<samp>detailmenu</samp>’.
-<var>$menu_components_text</var> is the formatted menu components text,
obtained
-as explained above.
-</p></dd></dl>
-
-<hr size="6">
-<a name="Indices"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Table-menu-formatting"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Index-entry-place" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Beginning
of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Internationalization" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Indices-formatting"></a>
-<h2 class="section">7.18 Indices formatting</h2>
-
-<p>Two different things needs to be handled for indices formatting, the place
-where the index term appears, the index entry, and the index list itself.
-The indexing commands like <code>@cindex</code> determines where index entries
-appear, and the index list is printed with a <code>@printindex</code> command.
-</p>
-<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top"><a href="#Index-entry-place">7.18.1
Formatting of index entries</a></td><td> </td><td align="left"
valign="top"> Index entries in the main document are
- targets for hypertext references
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Index-list">7.18.2 Customizing the
formatting of index lists</a></td><td> </td><td align="left"
valign="top"> Customizing the formatting of the index list
-</td></tr>
-</table>
-
-<hr size="6">
-<a name="Index-entry-place"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Indices" title="Previous
section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Index-list" title="Next section in
reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Beginning
of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Indices" title="Up section"> Up
</a>]</td>
-<td valign="middle" align="left">[<a href="#Internationalization" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Formatting-of-index-entries"></a>
-<h3 class="subsection">7.18.1 Formatting of index entries</h3>
-
-<p>Index entry places in the main text may be the target for hypertext
-references. Their formatting
-is controlled by the function associated with the following function
-reference:
-</p>
-<dl>
-<dt><a name="index-index_005fentry_005flabel"></a><u>Function Reference:</u>
$target <b>index_entry_label</b><i> $identifier $preformatted $entry
$index_name $index_command $texi_entry $formatted_entry</i></dt>
-<dd><p><var>$identifier</var> should be used to create
-a target for links (typically associated with a name or id
-attribute in <acronym>HTML</acronym>).
-<var>$preformatted</var> is true if the index entry appeared in preformatted
text.
-<var>$entry</var> is the index entry with all the @-commands removed.
-<var>$index_name</var> is the index name, <var>$command</var> is the index
command which
-may be a index command like <code>@cindex</code>, but also a definition or
-a table. <var>$texi_entry</var> is th eindex entry with @-commands, and
-<var>$formatted_entry</var> the entry formatted.
-</p></dd></dl>
-
-<p>Regular index entries are (like <code>@cindex</code>) are
-formatted using the following function reference:
-</p><dl>
-<dt><a name="index-index_005fentry_005fcommand"></a><u>Function Reference:</u>
$index_entry <b>index_entry_command</b><i> $command $index_name $label
$entry_texi $entry_formatted</i></dt>
-<dd><p><var>$command</var>, <var>$index_name</var>, <var>$entry_texi</var> and
<var>$entry_formatted</var>
-are the same as above, and <var>$label</var> is what could be used as a label,
-formatted using the function above.
-</p></dd></dl>
-
-<hr size="6">
-<a name="Index-list"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Index-entry-place"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Floats-and-lists-of-floats"
title="Next section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Beginning
of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Indices" title="Up section"> Up
</a>]</td>
-<td valign="middle" align="left">[<a href="#Internationalization" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Customizing-the-formatting-of-index-lists"></a>
-<h3 class="subsection">7.18.2 Customizing the formatting of index lists</h3>
-
-<p>There is an elaborate default index formatting in texi2html, with
-index summary by letter linking to index entries grouped by letters too,
-with the possibility of index pages split accross files. This system may be
-completly bypassed by redefining the function reference that is called when
-<code>@printindex</code> is encountered:
-</p>
-<dl>
-<dt><a name="index-printindex"></a><u>Function Reference:</u> $index_text
<b>printindex</b><i> $index_name</i></dt>
-<dd><p><var>$index_name</var> is the index name appearing on the
-<code>@printindex</code> line. The index formatted should be returned
-by this function reference.
-</p></dd></dl>
-
-<p>If the default index formatting is used, there are still possibilities
-to customize part of the formatting.
-The index entries are sorted alphabetically. A whole index list is
-considered to be composed of letter entries. A letter entry is composed
-by all the index entries beginning with that letter. A letter may
-be a non alphabetical character, but we call it letter here.
-</p>
-<p>An index summary appears at the beginning and at the end of an index list,
-and should be used to jump directly to a letter entry. Indices lists
-may be split across pages, thus the different letters may appear on different
-files. The number of index entries appearing on each page is determined
-by a variable <a name="index-_0024SPLIT_005fINDEX"></a>
-<code>$SPLIT_INDEX</code> if set. The default is to split
-indices after 100 entries.
-</p>
-<p>The formatting of all these elements is controlled by the following
-function references:
-</p>
-<dl compact="compact">
-<dt> <em>formatting of a letter in a summary</em></dt>
-<dd><dl>
-<dt><a name="index-summary_005fletter"></a><u>Function Reference:</u> $letter
<b>summary_letter</b><i> $letter $file $identifier</i></dt>
-<dd><p>This function is used to format a letter appearing in a summary,
refering
-to a letter entry in the index list.
-<var>$letter</var> is the letter. <var>$file</var> is the file name where the
letter
-entry appears. More precisely, it is empty when the letter entry is on the
-same page than the summary, it contains the file name when the index page
-is split accross page. <var>$identifier</var> is an identifier for the target
-letter entry.
-</p></dd></dl>
-
-</dd>
-<dt> <em>formatting of a summary</em></dt>
-<dd><dl>
-<dt><a name="index-index_005fsummary"></a><u>Function Reference:</u> $summary
<b>index_summary</b><i> address@hidden address@hidden</i></dt>
-<dd><p><var>address@hidden</var> and <var>address@hidden</var> contain the
-formatted summary letters, formatted with the above function.
-</p></dd></dl>
-
-</dd>
-<dt> <em>formatting of an index entry</em></dt>
-<dd><dl>
-<dt><a name="index-index_005fentry"></a><u>Function Reference:</u> $entry
<b>index_entry</b><i> $entry_href $entry_text $section_href
$section_heading</i></dt>
-<dd><p><var>$entry_href</var> is a reference to the place where the index
entry
-appeared, <var>$entry_text</var> is the corresponding text.
<var>$section_href</var>
-is a reference to the beginning of the sectioning element containing
-the index entry, <var>$section_heading</var> is the heading of the element.
-</p></dd></dl>
-
-</dd>
-<dt> <em>formatting of letter entry</em></dt>
-<dd><dl>
-<dt><a name="index-index_005fletter"></a><u>Function Reference:</u>
$letter_entry <b>index_letter</b><i> $letter $identifier
$index_entries_text</i></dt>
-<dd><p>This function formats a letter entry, consisting in all the index
entries
-beginning with this letter. <var>$letter</var> is the letter,
<var>$identifier</var>
-should be used to create a target for links (typically links from summaries),
-and <var>$index_entries_text</var> is the text of the index entries formatted
as
-described above.
-</p></dd></dl>
-
-</dd>
-<dt> <em>formatting of whole index</em></dt>
-<dd><dl>
-<dt><a name="index-print_005findex"></a><u>Function Reference:</u> $index
<b>print_index</b><i> $index_text $index_name</i></dt>
-<dd><p><var>$index_text</var> is the text of all the index entries grouped by
letter
-appearing in that page formatted as above. It is undef if there are
-no entries or theindex name isn’t known. <var>index_name</var> is the
name of
-the index, the argument of <code>@printindex</code>.
-</p></dd></dl>
-</dd>
-</dl>
-
-<hr size="6">
-<a name="Floats-and-lists-of-floats"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Index-list" title="Previous
section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Floats" title="Next section in
reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Beginning
of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Internationalization" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Floats-and-lists-of-floats-1"></a>
-<h2 class="section">7.19 Floats and lists of floats</h2>
-
-<p>Floats appear in the <code>@float</code> environment, optionaly with a style
-and a label, and with optionnal <code>@caption</code> and
<code>@shortcaption</code>.
-Their list appear after a <code>@listoffloats</code>.
-</p>
-<p>A hash reference is associated with each float, it is available in some
-formatting functions. The keys are:
-</p><dl compact="compact">
-<dt> <code>caption_texi</code></dt>
-<dt> <code>shortcaption_texi</code></dt>
-<dd><p>A reference on an array containing the caption or shortcaption lines,
-with texi @-commands.
-</p></dd>
-<dt> <code>style_texi</code></dt>
-<dd><p>The style with texi @-commands.
-</p></dd>
-<dt> <code>style_id</code></dt>
-<dd><p>The unique identifier associated with the style.
-</p></dd>
-<dt> <code>style</code></dt>
-<dd><p>The style formatted.
-</p></dd>
-<dt> <code>nr</code></dt>
-<dd><p>The number with the same conventions than makeinfo (use the chapter
number a
-dot and then the number of the float of that style in the chapter, or an
-absolute number if in unnumbered).
-</p></dd>
-<dt> <code>chapter_nr</code></dt>
-<dd><p>The number of the chapter containing the float.
-</p></dd>
-<dt> <code>nr_in_chapter</code></dt>
-<dd><p>The number of the float in the chapter.
-</p></dd>
-<dt> <code>absolut_nr</code></dt>
-<dd><p>The number of the float in the document.
-</p></dd>
-<dt> <code>texi</code></dt>
-<dd><p>The label with @-commands.
-</p></dd>
-<dt> <code>name</code></dt>
-<dd><p>The label formatted.
-</p></dd>
-<dt> <code>id</code></dt>
-<dd><p>The unique identifier associated with the label. Usefull to make an
anchor
-or a reference.
-</p></dd>
-<dt> <code>target</code></dt>
-<dd><p>The target that can be used to refer to that float.
-</p></dd>
-<dt> <code>element</code></dt>
-<dd><p>A reference on a structure representing the element the float appear in.
-</p></dd>
-</dl>
-
-<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top"><a href="#Floats">7.19.1 Formatting a
float</a></td><td> </td><td align="left" valign="top">
Formatting of floats
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Lists-of-floats">7.19.2 Formatting
lists of floats</a></td><td> </td><td align="left" valign="top">
Formatting the lists of floats
-</td></tr>
-</table>
-
-<hr size="6">
-<a name="Floats"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Floats-and-lists-of-floats"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Lists-of-floats" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Beginning
of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Floats-and-lists-of-floats"
title="Up section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Internationalization" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Formatting-a-float"></a>
-<h3 class="subsection">7.19.1 Formatting a float</h3>
-
-<p>First there is an occasion to construct a texinfo text for the caption,
using
-the caption texinfo lines and the informations in the float structure.
-The returned lines will be formatted in the main program. A function reference
-is used here:
-</p>
-<dl>
-<dt><a name="index-caption_005fshortcaption"></a><u>Function Reference:</u>
(address@hidden, address@hidden) <b>caption_shortcaption</b><i> \%float
address@hidden address@hidden</i></dt>
-<dd><p><var>\%float</var> is the structure defined above.
<var>address@hidden</var> and
-<var>address@hidden</var> are references on arrays containing the
-texinfo lines for caption and short caption. <var>address@hidden</var>
-and <var>address@hidden</var> are references on an array
-containing the texinfo lines for the caption and shortcaption.
-</p></dd></dl>
-
-<p>Then the float is formatted with the following function reference:
-</p>
-<dl>
-<dt><a name="index-float"></a><u>Function Reference:</u> $text <b>float</b><i>
$float_text \%float $caption_text $shortcaption_text</i></dt>
-<dd><p><var>$float_text</var> is the text appearing within the
<code>@float</code>, formatted.
-<var>\%float</var> is still the structure defined above.
<var>$caption_text</var> and
-<var>$shortcaption_text</var> are the caption and short caption build with the
-above function and formatted.
-</p></dd></dl>
-
-<p>It is also possible to do something when a caption or a shortcaption appear
-with t hefollowing function reference:
-</p>
-<dl>
-<dt><a name="index-caption_005fshortcaption_005fcommand"></a><u>Function
Reference:</u> $text <b>caption_shortcaption_command</b><i> $command
$formatted_caption address@hidden \%float</i></dt>
-<dd><p><var>$command</var> is the @-command,
‘<samp>caption</samp>’ or ‘<samp>shortcaption</samp>’.
-<var>$formatted_caption</var> is the caption text, formatted, while
-<var>address@hidden</var> is a reference on an array containing the caption
lines,
-this time without any formatting.
-<var>\%float</var> is still the structure defined above.
-</p>
-<p>In the default case this function reference returns an empty string.
-</p></dd></dl>
-
-
-<hr size="6">
-<a name="Lists-of-floats"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Floats" title="Previous
section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Footnotes" title="Next section in
reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Beginning
of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Floats-and-lists-of-floats"
title="Up section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Internationalization" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Formatting-lists-of-floats"></a>
-<h3 class="subsection">7.19.2 Formatting lists of floats</h3>
-
-<p>A list of floats is introduced by <code>@listoffloats</code>. The argument
of
-<code>@listoffloats</code> is the <em>style</em>. First the style texinfo can
be
-modified with the following function reference:
-</p>
-<dl>
-<dt><a name="index-listoffloats_005fstyle"></a><u>Function Reference:</u>
$style_texi_returned <b>listoffloats_style</b><i> $style_texi</i></dt>
-<dd><p><var>$style_texi</var> is the <code>@listoffloats</code> argument with
texinfo
address@hidden kept. It is possible to make changes to the
<var>$style_texi</var> and
-return a modified string, still with @-commands. The modified string
-is formatted in the main program.
-</p></dd></dl>
-
-<p>After that, for each of the floats with that style, first there is a
-possibility to modify the float style and the float caption before they
-are formatted in the main program, with the following function references:
-</p>
-<dl>
-<dt><a name="index-listoffloats_005ffloat_005fstyle"></a><u>Function
Reference:</u> $float_style_texi_returned <b>listoffloats_float_style</b><i>
$style_texi \%float</i></dt>
-<dd><p><var>$style_texi</var> is the style, and <var>\%float</var> is the
structure described
-above. This function reference returns a style to be formatted in the
-main program.
-</p></dd></dl>
-
-<dl>
-<dt><a name="index-listoffloats_005fcaption"></a><u>Function Reference:</u>
$caption_texi_returned <b>listoffloats_caption</b><i> \%float</i></dt>
-<dd><p><var>\%float</var> is the structure described
-above. This function reference returns a caption to be formatted in the
-main program.
-</p></dd></dl>
-
-<p>Each entry is formatted by:
-</p>
-<dl>
-<dt><a name="index-listoffloats_005fentry"></a><u>Function Reference:</u>
$listoffloats_entry <b>listoffloats_entry</b><i> $style_texi \%float
$float_style $caption $href</i></dt>
-<dd><p><var>$style_texi</var> is the style with @-commands,
<var>$float_style</var> is the
-style returned by the above function and formatted. <var>$caption</var> is the
-caption returned by the above function formatted. <var>\%float</var> is the
-structure corresponding with the float, and <var>$href</var> is an href
pointing to
-the float location.
-</p></dd></dl>
-
-<p>Lastly, the whole <code>@listoffloats</code> is formatted by:
-</p>
-<dl>
-<dt><a name="index-listoffloats"></a><u>Function Reference:</u> $listoffloats
<b>listoffloats</b><i> $style_texi $style address@hidden</i></dt>
-<dd><p><var>$style_texi</var> is the style with @-commands, <var>$style</var>
is the
-style returned by the above function and formatted. The array reference
-<var>address@hidden</var> holds the entries formatted by the above
-function.
-</p></dd></dl>
-
-<hr size="6">
-<a name="Footnotes"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Lists-of-floats"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-format-opening"
title="Next section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Beginning
of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Internationalization" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Customizing-the-footnotes-formatting"></a>
-<h2 class="section">7.20 Customizing the footnotes formatting</h2>
-
-<p>Each footnote is associated with a footnote entry. Several footnote entries
-are grouped in a footnote section. When a footnote appears, two things must
-be formatted: in the main text the place where the footnote appear
-and the footnote text.
-</p>
-<p>Two functions, with corresponding function references control the formatting
-of the footnotes:
-</p>
-<dl>
-<dt><a name="index-foot_005fline_005fand_005fref"></a><u>Function
Reference:</u> (address@hidden $text_for_document) <b>foot_line_and_ref</b><i>
$number_in_doc $number_in_page $footnote_id $place_id $document_file
$footnote_file address@hidden \%state</i></dt>
-<dd><p><var>$number_in_doc</var> is the footnote number in the whole document,
-<var>$number_in_page</var> is the footnote number in the current page.
-<var>$footnote_id</var> is an identifier for the footnote in the footnote text
-which should be used to make target for references to that footnote,
-while <var>$place_id</var> is an identifier for the location of the footnote
-in the main document. Similarly, <var>$document_file</var> is the file name
-of the file containing the text where the footnote appears in the main
-document, while <var>$footnote_file</var> is the file name of the file where
-the footnote text appears.
-</p>
-<p><var>address@hidden</var> is a reference on an array containing the
footnote text
-lines, allready formatted.
-And <var>\%state</var> holds informations about the context at the footnote
-place in the main document. As usual the most usefull entry is
-<code>preformatted</code> which is true if the footnote appears in a
preformatted
-context.
-</p>
-<p>This function returns a reference on an array, <var>address@hidden</var>
containing
-the updated footnote text for the footnote entry, and
<var>$text_for_document</var>,
-the text appearing at the footnote place in the main document, linking
-to the footnote entry.
-</p></dd></dl>
-
-<p>The following function is only used when footnotes are at the bottom
-of a page and the document is split.
-For customization of the footnotes page in case they are on a separated
-page or section, <a href="#Special-pages-layout">Customizing the layout of the
special pages</a>. For
-the determination of the footnote locations, <a
href="#Page-layout-options">Page layout related command line options</a>.
-</p>
-<dl>
-<dt><a name="index-foot_005fsection"></a><u>Function Reference:</u>
<b>foot_section</b><i> address@hidden</i></dt>
-<dd><p>This function formats a group of footnotes. <var>address@hidden</var>
is a
-reference on an array holding the lines of all the footnote entries
-formatted as explained above. This function modifies the reference.
-</p></dd></dl>
-
-<hr size="6">
-<a name="Customizing-format-opening"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Footnotes" title="Previous
section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Bypassing-normal-formatting"
title="Next section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Beginning
of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Internationalization" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Customizing-format-opening-1"></a>
-<h2 class="section">7.21 Customizing format opening</h2>
-
-<p>The following function reference is called when a format is opened.
-A format is any @-command that ends with a <code>@end</code> except
address@hidden that only select if the input is processed (like
-<code>@ignore</code> or <code>@ifhtml</code>) or raw @-commands (like
<code>@verbatim</code>
-and <code>@html</code>).
-</p>
-<dl>
-<dt><a name="index-begin_005fformat_005ftexi"></a><u>Function Reference:</u>
$line <b>begin_format_texi</b><i> $command $line \%state</i></dt>
-<dd><p>The <var>$command</var> is the format command, the <var>$line</var> is
the
-line following the @-command, <var>\%state</var> is a reference on
-a hash containing many formatting information. It can modify the
-line and return something else.
-</p>
-<p>In the default case, it is used to keep track of the multitable nesting.
-As a consequence, it is linked with the multitable formating.
-See <a href="#Multitable-formatting">Multitable formatting</a>.
-</p></dd></dl>
-
-<hr size="6">
-<a name="Bypassing-normal-formatting"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Customizing-format-opening"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Handling-special-regions"
title="Next section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Beginning
of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Internationalization" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Bypassing-normal-formatting-1"></a>
-<h2 class="section">7.22 Bypassing normal formatting</h2>
-
-<p>It is possible to bypass completely the normal formatting of @-commands
-with braces and raw regions
-(<code>@html</code>, <code>@tex</code>, <code>@xml</code>… regions).
-In that case the @-commands and the text within
-are passed to a user defined function early, in a pass when no expansion
-of output takes place, called the collecting pass. Another user defined
-function is called during the output expansion phase.
-</p>
-<p>Moreover, arbitrary user defined functions may be called between the
-different texinfo parsing and outputting passes. This could be used, for
-example to initialize some things before collecting the @-commands and their
-text, expanding them between the collecting and expansion phase and doing
-some cleaning after the expansion pass. These possibilities are used for
-the interface to LaTeX2HTML
-(see section <a href="#Expanding-TeX-regions">Expanding <code>@tex</code> and
<code>@math</code> regions using LaTeX2HTML</a>), and the examples are taken
from that use.
-</p>
-<p>The @-commands that are keys of the <a
name="index-_0025command_005fhandler"></a>
-<code>%command_handler</code> hash
-are collected in the collecting pass and expanded in the expansion
-pass using user defined functions. The associated value is a reference on
-a hash used to specify the user defined function references.
-The key of the hash reference are <code>'init'</code> for the function
-reference called during the collecting pass, and <code>'expand'</code>
-during the expansion pass. Here is an example for an @-command with
-braces:
-</p>
-<table><tr><td> </td><td><pre class="example">$command_handler{'math'} =
- { 'init' => \&Texi2HTML::LaTeX2HTML::to_latex,
- 'expand' => \&Texi2HTML::LaTeX2HTML::do_tex
- };
-</pre></td></tr></table>
-
-<p>And an example for a raw region @-command:
-</p>
-<table><tr><td> </td><td><pre class="example">$command_handler{'tex'} =
- { 'init' => \&Texi2HTML::LaTeX2HTML::to_latex,
- 'expand' => \&Texi2HTML::LaTeX2HTML::do_tex
- };
-</pre></td></tr></table>
-
-<p>The function references are called like:
-</p>
-<dl>
-<dt><a name="index-_0024command_005fhandler"></a><u>Function Reference:</u>
$status <b>$command_handler</b><i>{'$command'}->{'init'} $command $text
$count</i></dt>
-<dd><p><var>$command</var> is the @-command name, <var>$text</var> is the text
appearing
-within the @-command. <var>$count</var> is a counter counting how many times
-this @-command appeared. <var>$status</var> is a boolean which should be true
if
-the collecting was succesfull. If false the @-command and the text is
-discarded.
-</p></dd></dl>
-
-<dl>
-<dt><a name="index-_0024command_005fhandler-1"></a><u>Function Reference:</u>
$result <b>$command_handler</b><i>{'$command'}->{'expand'} $command $count
$state $text</i></dt>
-<dd><p><var>$command</var> is the @-command name, <var>$count</var> is a
counter counting
-how many times this @-command appeared. <var>$state</var> is a reference on a
-hash containing many informations about the context. <var>$text</var> should be
-empty. <var>$result</var> is the expanded resulting text.
-</p></dd></dl>
-
-<p>There are three places for user defined functions, associated with arrays:
-</p><dl compact="compact">
-<dt> <code>@command_handler_init</code>
-<a name="index-_0040command_005fhandler_005finit"></a>
-</dt>
-<dd><p>The function references in that array are called before the collecting
pass.
-At that time the information available is essentially the file names.
-</p></dd>
-<dt> <code>@command_handler_process</code>
-<a name="index-_0040command_005fhandler_005fprocess"></a>
-</dt>
-<dd><p>The function references in that array are called between the collecting
-pass and the expansion pass. At that time all the special @-commands
-have been collected as explained above but no output has been produced.
-</p></dd>
-<dt> <code>@command_handler_finish</code>
-<a name="index-_0040command_005fhandler_005ffinish"></a>
-</dt>
-<dd><p>he function references in that array are called after the end of the
-output generation.
-</p></dd>
-</dl>
-
-
-<p>Here is an example of these arrays use:
-</p>
-<table><tr><td> </td><td><pre class="example">push @command_handler_init,
\&Texi2HTML::LaTeX2HTML::init;
-push @command_handler_process, \&Texi2HTML::LaTeX2HTML::latex2html;
-push @command_handler_finish, \&Texi2HTML::LaTeX2HTML::finish;
-</pre></td></tr></table>
-
-<hr size="6">
-<a name="Handling-special-regions"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Bypassing-normal-formatting"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Other-and-unknown-commands"
title="Next section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Beginning
of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Internationalization" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Handling-special-regions-1"></a>
-<h2 class="section">7.23 Handling special regions</h2>
-
-<p>Special regions <code>@titlepage</code>, <code>@documentdescription</code>
and
- <code>@copying</code> are removed from the document before the last pass in
the
-default case. They can be kept if the value associated with the @-command
-in the <a name="index-_0025region_005fformats_005fkept"></a>
-<code>%region_formats_kept</code> hash is true.
-</p>
-<p>The <code>@insertcopying</code> @-command is formatted by
-</p><dl>
-<dt><a name="index-insertcopying"></a><u>Function Reference:</u>
$insertcopying <b>insertcopying</b><i> $text $comment $simple_text</i></dt>
-<dd><p><var>$text</var> is the text appearing in <code>@copying</code>,
formatted.
-<var>$comment</var> is the text with texi removed, should be very simple
-text. <var>$simple_text</var> is the text formatted in string context.
-</p></dd></dl>
-
-<p>The title page handling is described in <a href="#Title-page">Formatting of
title page</a>.
-</p>
-
-<hr size="6">
-<a name="Other-and-unknown-commands"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Handling-special-regions"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Internationalization" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Beginning
of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Internationalization" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Customizing-other-commands_002c-and-unknown-commands"></a>
-<h2 class="section">7.24 Customizing other commands, and unknown commands</h2>
-
-
-
-<a name="index-skipped-command"></a>
-<a name="index-unknown-command"></a>
-
-<p>Many commands without braces are available in texinfo, sometimes with
-a specific syntax. For example we have <code>@sp</code>,
<code>@noindent</code>,
-<code>@documentlanguage</code>, <code>@oddheading</code>,
<code>@headings</code>,
-<code>@shortcontents</code>, <code>@shorttitlepage</code> or
<code>@comment</code>.
-<code>texi2html</code> interprets
-some of these commands and some functions or variables are used for
-their formatting or to access their information.
-In the default case, however, most of these constructs are ignored.
-</p>
-<p>It is possible to change how the things following these commands
-on the line are handled, what is considered to be an arg for those
-commands and it is also possible to keep them instead of discarding
-them such that it is possible to handle them specially, with the
-same function than the one used for unknown commands.
-</p>
-<p>Those special commands without braces are the key of a hash:
-<a name="index-_0025misc_005fcommand"></a>
-<code>%misc_command</code>. The associated value is a reference on a
-hash enabling to set the properties of these commands. The
-keys of this hash reference is the name of a property, the value
-is the value of the property. For example here we have <code>line</code>
-for the <code>arg</code> property for the <code>command</code> @-command.
-</p>
-<table><tr><td> </td><td><pre class="example">$misc_command{'command'} =
{'arg' => 'line', 'skip' => 'space'};
-</pre></td></tr></table>
-
-<p>The properties and possible values are:
-</p>
-<dl compact="compact">
-<dt> <code>skip</code></dt>
-<dd><p>This property enables to set what is skipped after the command
arguments.
-Here are the possible values:
-</p><dl compact="compact">
-<dt> <code>line</code></dt>
-<dd><p>The remaining of the line is skipped.
-</p></dd>
-<dt> <code>space</code> </dt>
-<dd><p>Spaces are skipped but not newline.
-</p></dd>
-<dt> <code>whitespace</code> </dt>
-<dd><p>Spaces are skipped
-</p></dd>
-<dt> <code>linewhitespace</code></dt>
-<dd><p>Spaces are skipped if there are only spaces remaining on the line.
-</p></dd>
-<dt> <code>linespace</code></dt>
-<dd><p>Spaces are skipped, but not newline if
-there are only spaces remaining on the line
-</p></dd>
-</dl>
-
-</dd>
-<dt> <code>arg</code></dt>
-<dd><p>If the associated value is <code>line</code> the line is considered to
be the
-argument. If it is a number it is the number of args (separated by spaces).
-</p></dd>
-<dt> <code>keep</code></dt>
-<dd><p>If true the args and the macro are kept, otherwise they are discarded.
-The defaut is to have <code>keep</code> undef for all the commands.
-If <code>keep</code> is true for <code>@verbatiminclude</code> the default
-action for this macro isn’t done.
-</p></dd>
-</dl>
-
-
-<p>Commands which don’t appear in the hashes
-<a name="index-_0025simple_005fmap-1"></a>
-<code>%simple_map</code>, <a name="index-_0025simple_005fmap_005fpre-1"></a>
-<code>%simple_map_pre</code>,
-<a name="index-_0025simple_005fmap_005ftexi-1"></a>
-<code>%simple_map_texi</code> and <code>%misc_command</code>, or that appear in
-<code>%misc_command</code> but with <code>keep</code> true are processed by
the
-following function reference:
-</p>
-<dl>
-<dt><a name="index-unknown"></a><u>Function Reference:</u> ($result_line,
$result, $result_text, $message) <b>unknown</b><i> $command $line $pass</i></dt>
-<dd><p><var>$command</var> is the @-command, <var>$line</var> is the line
following the
-<var>$command</var>. <var>$pass</var> is the pass of texi2html (see section <a
href="#Three-passes">Three passes: macro expansion, document structure and
output</a>).
-<var>$result</var> is a boolean. If it is true then the other return
-values are taken into account otherwise the default actions are
-used. In case <var>$result</var> is true, <var>$result_line</var> is the new
line
-to be processed further, <var>$result_text</var> is the resulting formatted
text
-and <var>$message</var>, if defined is a message outputted to the output
-with line number added by <code>texi2html</code>.
-</p></dd></dl>
-
-<p>Commands with braces not specified above
-nor in <a name="index-_0025style_005fmap-1"></a>
-<code>%style_map</code>, <a name="index-_0025style_005fmap_005fpre-1"></a>
-<code>%style_map_pre</code> and
-<a name="index-_0025style_005fmap_005ftexi-1"></a>
-<code>%style_map_texi</code> are processed
-by the following function reference
-</p>
-<dl>
-<dt><a name="index-unknown_005fstyle"></a><u>Function Reference:</u> ($result,
$result_text, $message) <b>unknown_style</b><i> $command $text</i></dt>
-<dd><p><var>$command</var> is the @-command, <var>$text</var> is the text
appearing within
-the braces (allready formatted). <var>$result</var> is a boolean. If it is
true then
-the other return
-values are taken into account otherwise the default actions are
-used. In case <var>$result</var> is true, <var>$result_text</var> is the
resulting
-formatted text
-and <var>$message</var>, if defined is a message outputted to the output
-with line number added by <code>texi2html</code>.
-</p></dd></dl>
-
-
-
-<hr size="6">
-<a name="Internationalization"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Other-and-unknown-commands"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Translating-strings" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Customizing-HTML" title="Beginning
of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Top" title="Up section"> Up
</a>]</td>
-<td valign="middle" align="left">[<a href="#Incompatibilities" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Internationalization-1"></a>
-<h1 class="appendix">A. Internationalization</h1>
-
-<p>The strings written in the document are selected based on the
-document language. This can be used to customize the strings,
-as described in <a href="#Strings">Customizing strings written by
<code>texi2html</code></a>. This also enables translation of the
-strings.
-</p>
-<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top"><a href="#Translating-strings">A.1
Translating strings</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Adding-new-strings">A.2 Adding new
strings written to document</a></td><td> </td><td align="left"
valign="top">
-</td></tr>
-</table>
-
-<hr size="6">
-<a name="Translating-strings"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Internationalization"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Supported-language" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Internationalization"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Internationalization" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Incompatibilities" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Translating-strings-1"></a>
-<h2 class="appendixsec">A.1 Translating strings</h2>
-
-<a name="index-Translation"></a>
-<a name="index-i18n-1"></a>
-<a name="index-_0024LANGUAGES-1"></a>
-<a name="index-_0024T2H_005fOBSOLETE_005fSTRINGS"></a>
-
-
-<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top"><a href="#Supported-language">A.1.1
Contributing to existing translations</a></td><td> </td><td
align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top"><a href="#New-language">A.1.2 Contributing
translations to another language</a></td><td> </td><td align="left"
valign="top">
-</td></tr>
-</table>
-
-<hr size="6">
-<a name="Supported-language"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Translating-strings"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#New-language" title="Next section
in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Internationalization"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Translating-strings" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Incompatibilities" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Contributing-to-existing-translations"></a>
-<h3 class="appendixsubsec">A.1.1 Contributing to existing translations</h3>
-
-<p>If the language is allready supported, then there will be a file
-in the ‘<tt>i18n</tt>’ directory with name the two-letter
-ISO-639 language code. In that case you can enhance the translations by
-editing this file. There is a
<code>$LANGUAGES->{'<var>language</var>'}</code>
-hash in that file. The keys are the english strings, in <code>''</code>, the
-values (in <code>''</code> after <code>=></code>) are the translations.
-When a string contains a ‘<samp>%</samp>’ followed by
‘<samp>{</samp>’ <var>name</var> ‘<samp>}</samp>’
-it means that the string will be expanded by <code>texi2html</code>. For
-an example, see <a href="#Strings">Customizing strings written by
<code>texi2html</code></a>.
-</p>
-<p>After that you should run the command <code>./manage_i18n.pl merge</code> in
-the top directory, it should merge your file with the existing files in
-‘<tt>translations.pl</tt>’, which is incorporated to the
‘<tt>texi2html</tt>’ script
-by <code>make</code>.
-</p>
-<hr size="6">
-<a name="New-language"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Supported-language"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Adding-new-strings" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Internationalization"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Translating-strings" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Incompatibilities" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Contributing-translations-to-another-language"></a>
-<h3 class="appendixsubsec">A.1.2 Contributing translations to another
language</h3>
-
-<p>If the language isn’t currently supported, copy the
‘<tt>en</tt>’ file in
-‘<tt>i18n</tt>’ to a file with name the two-letter ISO-639
-language code of your language
- and then add your translations to the strings. You could also add your
-two-letter language code in the ‘<tt>manage_i18n.pl</tt>’ file in
the
-<code>@known_languages</code> array.
-</p>
-<p>After that you should run the command
-<code>./manage_i18n.pl update <var>lang</var></code> and
-<code>./manage_i18n.pl merge</code> in
-the top directory.
-</p>
-<p>Obsoleted strings are not removed from the files, they are still present
-in the <code>$T2H_OBSOLETE_STRINGS->{'<var>language</var>'}</code> hash in
case
-the string is reused later.
-</p>
-<p>If you made change to strings specified in installed files
-(see section <a href="#Installation">Installation of
<code>texi2html</code></a>)
-you will have to reinstall them otherwise the installated files will
-take precedence (see section <a href="#Using-init-files">Use initialization
files for fine tuning</a>).
-</p>
-<hr size="6">
-<a name="Adding-new-strings"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#New-language" title="Previous
section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Incompatibilities" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Internationalization"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Internationalization" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Incompatibilities" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Adding-new-strings-written-to-document"></a>
-<h2 class="appendixsec">A.2 Adding new strings written to document</h2>
-
-<a name="index-internationalized-strings"></a>
-<a name="index-manage_005fi18n_002epl"></a>
-
-<p>If you need to write strings, for example the new string <var>a
string</var>
-to the resulting document, call <code>&$I('a string')</code>. Use simple
quotes.
-If you want to substitute a value in the string put
-<code>%{<var>string_value</var>}</code>, in the string, and give a second
argument
-to <code>&$I</code>, a hash reference with key <var>string_value</var> and
value
-the what you want to substitute.
-Here is an example:
-</p>
-<table><tr><td> </td><td><pre class="example">return &$I('%{name} of
%{class}',
- { 'name' => $name, 'class' => $class });
-</pre></td></tr></table>
-
-<p>In that case <code>%{name}</code> is substituted by <code>$name</code> in
the translated
-string.
-</p>
-<p>After that you should run the command <code>./manage_i18n.pl</code> in the
top
-directory, to add your new strings to the template file, that is the
-file for english and to all the files in the ‘<tt>i18n</tt>’
-directory. This is achieved with
-</p>
-<table><tr><td> </td><td><pre class="example">./manage_i18n.pl template
-./manage_i18n.pl update
-</pre></td></tr></table>
-
-<p>These two commands won’t work if you don’t have the
-<code>Data::Dumper</code> module installed.
-And to merge the new translation files in
‘<tt>translations.pl</tt>’, do
-</p>
-<table><tr><td> </td><td><pre class="example">./manage_i18n.pl merge
-</pre></td></tr></table>
-
-<p>All these steps may be performed by <code>make</code>, once the language
file
-is added to ‘<tt>Makefile.am</tt>’ in the <code>i18n_files</code>
variable.
-</p>
-<hr size="6">
-<a name="Incompatibilities"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Adding-new-strings"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Specificities" title="Next section
in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Internationalization"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Top" title="Up section"> Up
</a>]</td>
-<td valign="middle" align="left">[<a href="#Specificities" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Incompatibilities-with-previous-versions"></a>
-<h1 class="chapter">B. Incompatibilities with previous versions</h1>
-
-<p><code>texi2html</code> has accumulated a lot of incompatibilities with
previous
-versions. They are documented in the ‘<tt>NEWS</tt>’ file, we
discuss them
-here nevertheless. Most of the incompatibilities were introduced in
-version 1.68. API changed also a lot between 1.78 and 1.80.
-</p>
-<ul>
-<li> API changes between 1.78 and 1.80:
-<ul>
-<li> what was done in the beginning of the $print_section
-function reference is now done in $print_element_header.
-</li><li> there is a new argument for $normal_text.
-</li><li> there is a new argument for $menu_link and $simple_menu_link, and
the
-name argument is always set, even if there is no explicit name. The new
-argument is true if there really was an explicit name.
-</li><li> $internal_ref and $external_ref don’t change inforef to xref
anymore.
-</li><li> in $table_item the text is not formatted with the format command,
- the text_formatted argument is.
-</li><li> definition index entries are now formatted with
$definition_index_entry,
- not with $definition_category anymore.
-</li><li> $printindex is called if an index appears, even if the index is not
-defined or there are no index entries.
-</li><li> new argument (@-command name) for $quotation and
$quotation_prepend_text.
-</li><li> change in the heading API. THIS_HEADER is not used anymore.
- New function reference, element_heading to format a node or a section
- heading, including navigation and label. Accordingly, print_Top and
- one_section don’t print the element header anymore. Also it is
- reported if the element is a new element, is the main element and
- more arguments, and top element heading is always done in heading.
-</li><li> print_element_header and print_navigation now return their result.
-</li><li> the <code>copying</code> key of %Texi2HTML::THISDOC is now called
-<code>copying_comment</code>.
-</li><li> TOC_LIST_ATTRIBUTE is now called NO_BULLET_LIST_ATTRIBUTE.
-</li><li> TOC_LIST_STYLE is now called NO_BULLET_LIST_STYLE.
-</li><li> the $unknown function reference has a new argument, the pass number.
-</li><li> ‘<samp>--sec-nav</samp>’ is replaced by
‘<samp>--headers</samp>’.
-</li><li> ‘<samp>--Verbose</samp>’ is replaced by
‘<samp>--verbose</samp>’.
-</li><li> ‘<samp>--lang</samp>’ is replaced by
‘<samp>--document-language</samp>’.
-</li><li> ‘<samp>--separated-footnotes</samp>’ is replaced by
‘<samp>--footnote-style</samp>’.
-</li><li> ‘<samp>--lang</samp>’ is replaced by
‘<samp>--document-language</samp>’.
-</li><li> <code>&$menu_comment</code> is removed,
<code>menu_comment</code> is now handled
- like an @-command.
-</li><li> <code>@detailmenu</code> is now formatted more like
<code>@menu</code>, and
-the <code>&$menu</code> function reference is replaced by
<code>&$menu_command</code>.
-<code>&$menu</code> is kept for backward compatibility. If
<code>&$menu</code> is defined,
-<code>@detailmenu</code> is ignored.
-</li><li> the API for the formatting of menus completly changed.
$simple_menu_link
- is removed, everything should be done in $menu_link.
-</li><li> image API changed, and is unstable, so not documented.
-</li><li> image file paths are not completed anymore in the default case.
- The previous
- behaviour can be restored with <code>$COMPLETE_IMAGE_PATHS</code> set to
true.
-</li><li> in %misc_command ‘<samp>texi</samp>’ is not used
anymore. The value and macros
-are expanded as they should be unconditionnally.
-</li><li> there is a new ’style’ key in $complex_format_map, to be
able to
- differentiate complex formats inheriting fonts and code_style (like
- @format, @display).
-</li><li> $EXTENSION should be undef if one doesn’t want an extension to
be added.
-</li><li> THISDOC{’title’} and similar are now for @title since
only one @title
- should appear in the document. @settitle is tried first to set fulltitle.
-</li><li> Configuration variables are modified anymore, instead the variable
- value is put in $Texi2HTML::THISDOC{’VAR’}. This is the case for
- DO_CONTENTS, DO_SCONTENTS, CSS_LINES, BODYTEXT, DOCUMENT_DESCRIPTION,
- DOCUMENT_ENCODING, IN_ENCODING, ENCODING_NAME, OUT_ENCODING.
-
-<p> For example, if $CSS_LINES is defined, the value is put in
- $Texi2HTML::THISDOC{’CSS_LINES’} which is used for formatting,
and if
- $CSS_LINES is not defined, $Texi2HTML::THISDOC{’CSS_LINES’} is
- autodetected.
-</p></li><li> When there is no section and $USE_NODES is not set don’t
split by node.
-This behaviour and the previous aren’t documented, so it could change
-in the future.
-</li></ul>
-</li><li> API changes between 1.76 and 1.78:
-<ul>
-<li> paragraph has new arguments
-with indentation information, added as the third argument, and
-other context information. The formatting linked with commands
-opened before the paragraph and closed after the paragraph are done
-in the formatting function. Similar
-things are done for preformatted.
-</li><li> normal_text
-changed completely. There
-are much more arguments to give informations about the context, and
-normal_text now does more text manipulation.
-</li><li> New arguments for image the alt text, the height and width,
-the path to working dir and the path to image file relative
-to working dir. More image formatting is
-done in the formatting function.
-</li><li> New argument for empty_line.
-</li><li> End of line removal is done in formatting function of definition line
-formatting.
-</li><li> node_file_name now should only returns the node file, since the
-redirection file isn’t used anymore. element_file_name only is used for
-file names, whatever NODES_FILES is.
-</li></ul>
-</li><li> changes between 1.66 and 1.68:
-<ul>
-<li> When the manual is split the default is to put resulting files in
-a directory with name the manual file basename (previously they were left in
- the current directory). To avoid that, call texi2html with
-‘<samp>-output .</samp>’. This has been changed to be compatible
with
-<code>makeinfo</code> and also because it fits better with the cross
-manuals reference scheme.
-</li><li> The option ‘<samp>--output</samp>’ signification
changed. It now
-has the same meaning than for <code>makeinfo</code>. It seems
-that in 1.66 it was the same than ‘<samp>-out-file</samp>’.
-‘<samp>--output</samp>’ new meaning allows to replace
‘<samp>-out-file</samp>’ and
-‘<samp>-subdir</samp>’ with a unique option.
-
-<p>More precisely ‘<samp>-out-file</samp>’ forces the output to be
unsplit
-while ‘<samp>--output</samp>’ behaves differently when split (it
specifies
-the directory
-where the manual files should be outputted) and unsplit (it specifies
-the output file). ‘<samp>-subdir</samp>’ is retained for backward
compatibility.
-</p>
-<p>If you want a backward compatibility you can use
‘<samp>-subdir</samp>’
-for the output directory if the document is split, and
‘<samp>-out-file</samp>’
-if the document isn’t split. This hasn’t been tested extensively
though.
-</p></li><li> Many options has been obsoleted but they are retained for
-backward compatibility.
-</li><li> The init files are searched in new directories, however they
-are still searched for in the old directories for backward
-compatibility.
-</li><li> the option ‘<samp>--glossary</samp>’ doesn’t do
anything. Likely
-nothing specific is done regarding bibliographies. This has been
-decided because this added some semantics to the texinfo formatting
-language that weren’t part of texinfo.
-
-<p>It should be possible to do
-something similar with macros. See for example
‘<tt>glossary.texi</tt>’
-for glossary and ‘<tt>my-bib-macros.texi</tt>’ for bibliography
-in the directory ‘<tt>examples</tt>’. In the web2c package there is
-an example of use of BibTeX, see <a
href="http://tug.org/texlive/devsrc/Build/source/TeX/texk/web2c/doc/";>http://tug.org/texlive/devsrc/Build/source/TeX/texk/web2c/doc/</a>
(the examples for bibliography are taken from the
-texinfo home page <a
href="http://www.gnu.org/software/texinfo/texinfo.html";>http://www.gnu.org/software/texinfo/texinfo.html</a>).
-</p></li><li> don’t use <code>T2H_CENTER_IMAGE</code>.
<code>@center</code> should be used
-insead, it will give the right output for all the formats.
-</li><li> If a directory creation fails the program aborts. This is much safer.
-</li><li> The interface for internationalisation changed, although
-the previous wasn’t documented a lot.
-</li><li> the API described in this manual changed a lot. A important
-change was to use the <code>Texi2HTML::Config</code> names space instead of
-variables prefixed with ‘<samp>T2H_</samp>’ or
‘<samp>t2h_</samp>’. To cope with
-the change the prefix should be removed from variables in init files.
-Some variables are now in <code>%Texi2HTML::THISDOC</code>.
-</li><li> <code>@ifinfo</code> regions are not expanded by default. This may
lead
-to warnings or errors especially if the Top node is enclosed in
-<code>@ifinfo</code>, as some node won’t appear in menus. The quick fix
-is to call <code>texi2html</code> with the option
‘<samp>--ifinfo</samp>’ and
-the right way should be to make more use of <code>@ifnottex</code>.
-</li><li> The code appearing before the first node is now outputted, it was
-ignored before. ‘<samp>--ignore-preamble-text</samp>’ revert to
the previous
-behaviour. Enclosing in <code>@ifnothtml</code> would be much cleaner.
-
-</li></ul>
-</li></ul>
-
-<hr size="6">
-<a name="Specificities"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Incompatibilities"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop" title="Next section in
reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Incompatibilities"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Top" title="Up section"> Up
</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop" title="Next chapter">
>> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="How-little-texi2html-texinfo-differs-from-GNU-texinfo"></a>
-<h1 class="chapter">C. How little texi2html texinfo differs from GNU
texinfo</h1>
-
-<p>For features documented in the texinfo manual, the texinfo interpretation
-by <code>texi2html</code> shouldn’t differ from the interpretation of
-<code>makeinfo</code> or <code>texi2dvi</code>. However for constructs with
-unspecified behaviour <code>texi2html</code> often doesn’t lead to the
-same result than <code>makeinfo</code> or <code>texi2dvi</code>.
<code>makeinfo</code>
-and <code>texi2dvi</code> are also inconsistent in most of these cases (or
-broken). You are urged not to use these features unless absolutely necessary.
-This information is only here to help understand why <code>texi2html</code>
-differ from other texinfo interpreters, it may be inacurate and the
-<code>texi2html</code> behaviour may change in the future and was different
-in the past.
-</p>
-<dl compact="compact">
-<dt> @-commands with text on the line</dt>
-<dd><p>In the texinfo manual it is specified that block @-commands should
appear
-on a line without text and the closing <code>@end</code> should also be on a
-line by himself. With <code>texi2html</code> it is possible to add
-text before and after the command, so the following is right:
-</p>
-<table><tr><td> </td><td><pre class="example">something @example the
example @end example after the example
-</pre></td></tr></table>
-
-<p><code>makeinfo</code> and <code>texi2dvi</code> may also accept text before
-the command and text after the <code>@end</code> command, sometimes ignoring
-it after the <code>@end</code>.
-</p>
-<p>This is a feature you should especially not rely on.
-</p>
-</dd>
-<dt> special @-commands handling</dt>
-<dd><p>The special @-commands are commands like <code>@pagesizes</code>,
<code>@sp</code>,
-<code>@evenheading</code>, <code>@raisesections</code>, <code>@defindex</code>
and a lot
-more. In many cases <code>makeinfo</code> and <code>texi2dvi</code>
-don’t parse those commands the same way too. <code>texi2html</code> may
also
-show some differences in parsing of the arguments of these commands,
-in case there are wrong arguments, and also ignore differently things
-following those commands. How user defined macros, set and values
-are expanded in those commands may also be different.
-Part of the specification of how these commands are handled is
-configureable (see section <a href="#Other-and-unknown-commands">Customizing
other commands, and unknown commands</a>), but not what
-happens during the beginning of the parsing for some of those commands.
-</p>
-</dd>
-<dt> features different between <code>makeinfo</code> and
<code>texi2dvi</code></dt>
-<dd><p>When <code>makeinfo</code> or <code>texi2dvi</code> use a feature which
-is reserved for one or the other translator, <code>texi2html</code> uses that
-feature. So for example <code>@definfoenclose</code> which is ignored by
-<code>texi2dvi</code> is taken into account and <code>@kbdinputstyle</code>
which
-is ignored by <code>makeinfo</code> is taken into account.
-</p>
-</dd>
-<dt> user defined macros and values</dt>
-<dd><p>In this area <code>makeinfo</code> and <code>texi2dvi</code> also
differ a lot.
-The reference implementation is the <code>makeinfo</code> implementation as
-<code>texi2dvi</code> is easily broken when macros are not used simply.
-</p>
-<ul>
-<li> <code>@rmacro</code> and <code>@macro</code> behave exactly the same. In
fact
-this goes against a documented behaviour, however if a user don’t
-want a recursive macro he can simply avoid reusing the macro in the
-definition. If somebody report that the feature is usefull we could try
-to implement it.
-</li><li> It is possible to escape the end of a macro definition with
-<table><tr><td> </td><td><pre class="example">address@hidden macro
-</pre></td></tr></table>
-<p>with the ‘<samp>\</samp>’ being removed after the first
expansion. Otherwise
-it is not possible to produce a <code>address@hidden macro</code> in a macro.
-</p></li><li> <code>@unmacro</code> is interpreted during the macro argument
expansion.
-Don’t know what <code>makeinfo</code> exactly do.
-</li><li> Some <code>@value</code> may be expanded later than the others, those
-that are in special commands, like <code>@node</code>.
-</li></ul>
-
-</dd>
-<dt> <code>@,</code> in <code>@node</code></dt>
-<dd><p>Like <code>texi2dvi</code> but unlike <code>makeinfo</code>
<code>@,</code> don’t
-break <code>@node</code> arguments like a regular ‘<samp>,</samp>’.
-</p></dd>
-<dt> Things before first node or preamble</dt>
-<dd><p>Things before the first node or before the preamble may not be exactly
-interpreted or discarded as <code>makeinfo</code> or <code>texi2dvi</code> do.
-</p></dd>
-<dt> encodings</dt>
-<dd><p><code>texi2html</code> knows more encodings, in fact all encodings
<code>perl</code>
-knows about.
-</p></dd>
-<dt> commands in <code>@ifset</code> and <code>@ifclear</code></dt>
-<dd><p><code>texi2html</code> doesn’t need a proper nesting of internal
<code>@ifset</code>
-or <code>@ifclear</code> if they are in ignored or raw regions (like
<code>@html</code>
-or <code>@verbatim</code>). For example the following is accepted by
-<code>texi2html</code> and not by <code>makeinfo</code>:
-</p>
-<table><tr><td> </td><td><pre class="example">@ifset notset
address@hidden
address@hidden
address@hidden ignore
address@hidden ifset
-</pre></td></tr></table>
-
-<p>In <code>@ifset</code> and <code>@ifclear</code> texi2html also accepts
-a lot more of invalid constructs. For example the following is accepted
-by <code>texi2html</code> but not by <code>makeinfo</code>:
-</p>
-<table><tr><td> </td><td><pre class="example">@set flag
address@hidden flag
address@hidden
address@hidden my item
address@hidden ifset
-text
address@hidden flag
address@hidden itemize
address@hidden ifset
-</pre></td></tr></table>
-</dd>
-</dl>
-
-<hr size="6">
-<a name="Indexop"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Specificities" title="Previous
section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Indexvr" title="Next section in
reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Specificities" title="Beginning of
this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Top" title="Up section"> Up
</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexvr" title="Next chapter">
>> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Command-Line-Option-Index"></a>
-<h1 class="appendix">D. Command Line Option Index</h1>
-<table><tr><th valign="top">Jump to: </th><td><a
href="#Command-Line-Option-Index_op_letter-C"
class="summary-letter"><b>C</b></a>
-
-<a href="#Command-Line-Option-Index_op_letter-D"
class="summary-letter"><b>D</b></a>
-
-<a href="#Command-Line-Option-Index_op_letter-E"
class="summary-letter"><b>E</b></a>
-
-<a href="#Command-Line-Option-Index_op_letter-F"
class="summary-letter"><b>F</b></a>
-
-<a href="#Command-Line-Option-Index_op_letter-H"
class="summary-letter"><b>H</b></a>
-
-<a href="#Command-Line-Option-Index_op_letter-I"
class="summary-letter"><b>I</b></a>
-
-<a href="#Command-Line-Option-Index_op_letter-L"
class="summary-letter"><b>L</b></a>
-
-<a href="#Command-Line-Option-Index_op_letter-M"
class="summary-letter"><b>M</b></a>
-
-<a href="#Command-Line-Option-Index_op_letter-N"
class="summary-letter"><b>N</b></a>
-
-<a href="#Command-Line-Option-Index_op_letter-O"
class="summary-letter"><b>O</b></a>
-
-<a href="#Command-Line-Option-Index_op_letter-P"
class="summary-letter"><b>P</b></a>
-
-<a href="#Command-Line-Option-Index_op_letter-S"
class="summary-letter"><b>S</b></a>
-
-<a href="#Command-Line-Option-Index_op_letter-T"
class="summary-letter"><b>T</b></a>
-
-<a href="#Command-Line-Option-Index_op_letter-U"
class="summary-letter"><b>U</b></a>
-
-<a href="#Command-Line-Option-Index_op_letter-V"
class="summary-letter"><b>V</b></a>
-
-<a href="#Command-Line-Option-Index_op_letter-W"
class="summary-letter"><b>W</b></a>
-
-</td></tr></table>
-<table border="0" class="index-op">
-<tr><td></td><th align="left">Index Entry</th><th align="left">
Section</th></tr>
-<tr><td colspan="3"> <hr></td></tr>
-<tr><th><a
name="Command-Line-Option-Index_op_letter-C">C</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-css_002dinclude_003dfile">css-include=<var>file</var></a></td><td
valign="top"><a href="#Style-options">4.7 Customizing the
<acronym>HTML</acronym> and text style</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-css_002dref_003dURL">css-ref=<var>URL</var></a></td><td
valign="top"><a href="#Style-options">4.7 Customizing the
<acronym>HTML</acronym> and text style</a></td></tr>
-<tr><td colspan="3"> <hr></td></tr>
-<tr><th><a
name="Command-Line-Option-Index_op_letter-D">D</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-def_002dtable">def-table</a></td><td valign="top"><a
href="#Style-options">4.7 Customizing the <acronym>HTML</acronym> and text
style</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-doctype_003dDTD">doctype=<var>DTD</var></a></td><td
valign="top"><a href="#Style-options">4.7 Customizing the
<acronym>HTML</acronym> and text style</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-document_002dlanguage">document-language</a></td><td
valign="top"><a href="#Using-init-files">4.9 Use initialization files for fine
tuning</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-document_002dlanguage-1">document-language</a></td><td
valign="top"><a href="#Strings">7.8 Customizing strings written by
<code>texi2html</code></a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-Dvar">D<var>var</var></a></td><td valign="top"><a
href="#Texinfo-related-options">4.5 Command line options related to Texinfo
language features</a></td></tr>
-<tr><td colspan="3"> <hr></td></tr>
-<tr><th><a
name="Command-Line-Option-Index_op_letter-E">E</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-enable_002dtranslations">enable-translations</a></td><td
valign="top"><a href="#Advanced-build-features">3.4 Advanced build
features</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-error_002dlimit_003dnum">error-limit=<var>num</var></a></td><td
valign="top"><a href="#General-options">4.1 General options</a></td></tr>
-<tr><td colspan="3"> <hr></td></tr>
-<tr><th><a
name="Command-Line-Option-Index_op_letter-F">F</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-footnote_002dstyle">footnote-style</a></td><td valign="top"><a
href="#Page-layout-options">4.6 Page layout related command line
options</a></td></tr>
-<tr><td></td><td valign="top"><a href="#index-frames">frames</a></td><td
valign="top"><a href="#Page-layout-options">4.6 Page layout related command
line options</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-frameset_002ddoctype">frameset-doctype</a></td><td valign="top"><a
href="#Style-options">4.7 Customizing the <acronym>HTML</acronym> and text
style</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-frameset_002ddoctype_003dDTD">frameset-doctype=<var>DTD</var></a></td><td
valign="top"><a href="#Style-options">4.7 Customizing the
<acronym>HTML</acronym> and text style</a></td></tr>
-<tr><td colspan="3"> <hr></td></tr>
-<tr><th><a
name="Command-Line-Option-Index_op_letter-H">H</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a href="#index-help">help</a></td><td
valign="top"><a href="#General-options">4.1 General options</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-html_002dxref_002dprefix_003dpath">html-xref-prefix=<var>path</var></a></td><td
valign="top"><a href="#Style-options">4.7 Customizing the
<acronym>HTML</acronym> and text style</a></td></tr>
-<tr><td colspan="3"> <hr></td></tr>
-<tr><th><a
name="Command-Line-Option-Index_op_letter-I">I</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-Idir">I<var>dir</var></a></td><td valign="top"><a
href="#Texinfo-related-options">4.5 Command line options related to Texinfo
language features</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-if_003cregion_003e">if<region></a></td><td valign="top"><a
href="#Expansion">4.4 Specifying which regions get expanded</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-include_002dcss">include-css</a></td><td valign="top"><a
href="#css">6.7 Customizing the <code>texi2html</code> css lines</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-init_002dfile">init-file</a></td><td valign="top"><a
href="#Using-init-files">4.9 Use initialization files for fine
tuning</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-init_002dfile-1">init-file</a></td><td valign="top"><a
href="#Using-init-files">4.9 Use initialization files for fine
tuning</a></td></tr>
-<tr><td></td><td valign="top"><a href="#index-iso">iso</a></td><td
valign="top"><a href="#Style-options">4.7 Customizing the
<acronym>HTML</acronym> and text style</a></td></tr>
-<tr><td colspan="3"> <hr></td></tr>
-<tr><th><a
name="Command-Line-Option-Index_op_letter-L">L</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a href="#index-l2h">l2h</a></td><td
valign="top"><a href="#Expanding-TeX-regions">4.8 Expanding <code>@tex</code>
and <code>@math</code> regions using LaTeX2HTML</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-l2h_002dfile">l2h-file</a></td><td valign="top"><a
href="#Expanding-TeX-regions">4.8 Expanding <code>@tex</code> and
<code>@math</code> regions using LaTeX2HTML</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-l2h_002dl2h_003dprogram">l2h-l2h=<var>program</var></a></td><td
valign="top"><a href="#Expanding-TeX-regions">4.8 Expanding <code>@tex</code>
and <code>@math</code> regions using LaTeX2HTML</a></td></tr>
-<tr><td></td><td valign="top"><a href="#index-l2h_002dtmp">l2h-tmp</a></td><td
valign="top"><a href="#Expanding-TeX-regions">4.8 Expanding <code>@tex</code>
and <code>@math</code> regions using LaTeX2HTML</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-lang_003dlang">lang=<var>lang</var></a></td><td valign="top"><a
href="#Texinfo-related-options">4.5 Command line options related to Texinfo
language features</a></td></tr>
-<tr><td colspan="3"> <hr></td></tr>
-<tr><th><a
name="Command-Line-Option-Index_op_letter-M">M</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a href="#index-menu">menu</a></td><td
valign="top"><a href="#Invoking-texi2html">4. Invoking
<code>texi2html</code></a></td></tr>
-<tr><td colspan="3"> <hr></td></tr>
-<tr><th><a
name="Command-Line-Option-Index_op_letter-N">N</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-no_002dheaders">no-headers</a></td><td valign="top"><a
href="#Page-layout-options">4.6 Page layout related command line
options</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-no_002dif_003cregion_003e">no-if<region></a></td><td
valign="top"><a href="#Expansion">4.4 Specifying which regions get
expanded</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-node_002dfiles">node-files</a></td><td valign="top"><a
href="#Output-files">4.3 Setting output file and directory names</a></td></tr>
-<tr><td></td><td valign="top"><a href="#index-nomenu">nomenu</a></td><td
valign="top"><a href="#Invoking-texi2html">4. Invoking
<code>texi2html</code></a></td></tr>
-<tr><td></td><td valign="top"><a href="#index-nomenu-1">nomenu</a></td><td
valign="top"><a href="#Expansion">4.4 Specifying which regions get
expanded</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-number_002dsections">number-sections</a></td><td valign="top"><a
href="#Style-options">4.7 Customizing the <acronym>HTML</acronym> and text
style</a></td></tr>
-<tr><td colspan="3"> <hr></td></tr>
-<tr><th><a
name="Command-Line-Option-Index_op_letter-O">O</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a href="#index-output">output</a></td><td
valign="top"><a href="#Output-files">4.3 Setting output file and directory
names</a></td></tr>
-<tr><td></td><td valign="top"><a href="#index-output-1">output</a></td><td
valign="top"><a href="#Output-files">4.3 Setting output file and directory
names</a></td></tr>
-<tr><td colspan="3"> <hr></td></tr>
-<tr><th><a
name="Command-Line-Option-Index_op_letter-P">P</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-Pdir">P<var>dir</var></a></td><td valign="top"><a
href="#Texinfo-related-options">4.5 Command line options related to Texinfo
language features</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-pkgdatadir_003ddir">pkgdatadir=<var>dir</var></a></td><td
valign="top"><a href="#Installing">3.3 Installing</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-pkgdatadir_003ddir-1">pkgdatadir=dir</a></td><td valign="top"><a
href="#Using-init-files">4.9 Use initialization files for fine
tuning</a></td></tr>
-<tr><td></td><td valign="top"><a href="#index-prefix">prefix</a></td><td
valign="top"><a href="#Output-files">4.3 Setting output file and directory
names</a></td></tr>
-<tr><td colspan="3"> <hr></td></tr>
-<tr><th><a
name="Command-Line-Option-Index_op_letter-S">S</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-short_002dext">short-ext</a></td><td valign="top"><a
href="#Output-files">4.3 Setting output file and directory names</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-short_002dref">short-ref</a></td><td valign="top"><a
href="#Style-options">4.7 Customizing the <acronym>HTML</acronym> and text
style</a></td></tr>
-<tr><td></td><td valign="top"><a href="#index-split">split</a></td><td
valign="top"><a href="#Splitting-output">4.2 Specifying where to split the
generated document</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-sysconfdir_003ddir">sysconfdir=dir</a></td><td valign="top"><a
href="#Using-init-files">4.9 Use initialization files for fine
tuning</a></td></tr>
-<tr><td colspan="3"> <hr></td></tr>
-<tr><th><a
name="Command-Line-Option-Index_op_letter-T">T</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-toc_002dfile">toc-file</a></td><td valign="top"><a
href="#Output-files">4.3 Setting output file and directory names</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-toc_002dlinks">toc-links</a></td><td valign="top"><a
href="#Style-options">4.7 Customizing the <acronym>HTML</acronym> and text
style</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-top_002dfile">top-file</a></td><td valign="top"><a
href="#Output-files">4.3 Setting output file and directory names</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-transliterate_002dfile_002dnames">transliterate-file-names</a></td><td
valign="top"><a href="#Output-files">4.3 Setting output file and directory
names</a></td></tr>
-<tr><td colspan="3"> <hr></td></tr>
-<tr><th><a
name="Command-Line-Option-Index_op_letter-U">U</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-use_002dnodes">use-nodes</a></td><td valign="top"><a
href="#Splitting-output">4.2 Specifying where to split the generated
document</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-use_002dnodes-1">use-nodes</a></td><td valign="top"><a
href="#Splitting-output">4.2 Specifying where to split the generated
document</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-use_002dnodes-2">use-nodes</a></td><td valign="top"><a
href="#Splitting-output">4.2 Specifying where to split the generated
document</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-Uvar">U<var>var</var></a></td><td valign="top"><a
href="#Texinfo-related-options">4.5 Command line options related to Texinfo
language features</a></td></tr>
-<tr><td colspan="3"> <hr></td></tr>
-<tr><th><a
name="Command-Line-Option-Index_op_letter-V">V</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a href="#index-verbose">verbose</a></td><td
valign="top"><a href="#General-options">4.1 General options</a></td></tr>
-<tr><td></td><td valign="top"><a href="#index-version">version</a></td><td
valign="top"><a href="#General-options">4.1 General options</a></td></tr>
-<tr><td colspan="3"> <hr></td></tr>
-<tr><th><a
name="Command-Line-Option-Index_op_letter-W">W</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-with_002dunicode">with-unicode</a></td><td valign="top"><a
href="#Advanced-build-features">3.4 Advanced build features</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-with_002dunidecode">with-unidecode</a></td><td valign="top"><a
href="#Advanced-build-features">3.4 Advanced build features</a></td></tr>
-<tr><td colspan="3"> <hr></td></tr>
-</table>
-<table><tr><th valign="top">Jump to: </th><td><a
href="#Command-Line-Option-Index_op_letter-C"
class="summary-letter"><b>C</b></a>
-
-<a href="#Command-Line-Option-Index_op_letter-D"
class="summary-letter"><b>D</b></a>
-
-<a href="#Command-Line-Option-Index_op_letter-E"
class="summary-letter"><b>E</b></a>
-
-<a href="#Command-Line-Option-Index_op_letter-F"
class="summary-letter"><b>F</b></a>
-
-<a href="#Command-Line-Option-Index_op_letter-H"
class="summary-letter"><b>H</b></a>
-
-<a href="#Command-Line-Option-Index_op_letter-I"
class="summary-letter"><b>I</b></a>
-
-<a href="#Command-Line-Option-Index_op_letter-L"
class="summary-letter"><b>L</b></a>
-
-<a href="#Command-Line-Option-Index_op_letter-M"
class="summary-letter"><b>M</b></a>
-
-<a href="#Command-Line-Option-Index_op_letter-N"
class="summary-letter"><b>N</b></a>
-
-<a href="#Command-Line-Option-Index_op_letter-O"
class="summary-letter"><b>O</b></a>
-
-<a href="#Command-Line-Option-Index_op_letter-P"
class="summary-letter"><b>P</b></a>
-
-<a href="#Command-Line-Option-Index_op_letter-S"
class="summary-letter"><b>S</b></a>
-
-<a href="#Command-Line-Option-Index_op_letter-T"
class="summary-letter"><b>T</b></a>
-
-<a href="#Command-Line-Option-Index_op_letter-U"
class="summary-letter"><b>U</b></a>
-
-<a href="#Command-Line-Option-Index_op_letter-V"
class="summary-letter"><b>V</b></a>
-
-<a href="#Command-Line-Option-Index_op_letter-W"
class="summary-letter"><b>W</b></a>
-
-</td></tr></table>
-<hr size="6">
-<a name="Indexvr"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Indexop" title="Previous
section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Indexcp" title="Next section in
reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Indexop" title="Beginning of this
chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Top" title="Up section"> Up
</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexcp" title="Next chapter">
>> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Variable-Index"></a>
-<h1 class="appendix">E. Variable Index</h1>
-<table><tr><th valign="top">Jump to: </th><td><a
href="#Variable-Index_vr_symbol-1" class="summary-letter"><b>$</b></a>
-
-<a href="#Variable-Index_vr_symbol-2" class="summary-letter"><b>%</b></a>
-
-<a href="#Variable-Index_vr_symbol-3" class="summary-letter"><b>@</b></a>
-</td></tr></table>
-<table border="0" class="index-vr">
-<tr><td></td><th align="left">Index Entry</th><th align="left">
Section</th></tr>
-<tr><td colspan="3"> <hr></td></tr>
-<tr><th><a name="Variable-Index_vr_symbol-1">$</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024AFTER_005fBODY_005fOPEN"><code>$AFTER_BODY_OPEN</code></a></td><td
valign="top"><a href="#Customizing-header">6.8 Customizing the page
header</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024AFTER_005fOVERVIEW"><code>$AFTER_OVERVIEW</code></a></td><td
valign="top"><a href="#Contents-and-Overview-text">6.11.1.2 Table of contents
and Short table of contents</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024AFTER_005fTOC_005fLINES"><code>$AFTER_TOC_LINES</code></a></td><td
valign="top"><a href="#Contents-and-Overview-text">6.11.1.2 Table of contents
and Short table of contents</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024anchor"><code>$anchor</code></a></td><td valign="top"><a
href="#Anchors-images-and-spaces">7.6 Formatting of special simple
commands</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024anchor_005flabel"><code>$anchor_label</code></a></td><td
valign="top"><a href="#Anchors-images-and-spaces">7.6 Formatting of special
simple commands</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024AVOID_005fMENU_005fREDUNDANCY"><code>$AVOID_MENU_REDUNDANCY</code></a></td><td
valign="top"><a href="#Table-menu-formatting">7.17.4 The formatting of the
menu in a table</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024BEFORE_005fOVERVIEW"><code>$BEFORE_OVERVIEW</code></a></td><td
valign="top"><a href="#Contents-and-Overview-text">6.11.1.2 Table of contents
and Short table of contents</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024BEFORE_005fTOC_005fLINES"><code>$BEFORE_TOC_LINES</code></a></td><td
valign="top"><a href="#Contents-and-Overview-text">6.11.1.2 Table of contents
and Short table of contents</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024BIG_005fRULE"><code>$BIG_RULE</code></a></td><td
valign="top"><a href="#The-page-layout">6.2 Page layout and navigation panel
overview</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024BODYTEXT"><code>$BODYTEXT</code></a></td><td valign="top"><a
href="#Output-initialization">6.5 Preparing the output</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024BODYTEXT-1"><code>$BODYTEXT</code></a></td><td
valign="top"><a href="#Customizing-header">6.8 Customizing the page
header</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024cell"><code>$cell</code></a></td><td valign="top"><a
href="#Table-and-list-items">7.13.1 Formatting individual table and list
items</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024CLOSE_005fQUOTE_005fSYMBOL"><code>$CLOSE_QUOTE_SYMBOL</code></a></td><td
valign="top"><a href="#Hash-reference-interface">7.5.1 An interface for
commands formatting with a hash reference</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024CLOSE_005fQUOTE_005fSYMBOL-1"><code>$CLOSE_QUOTE_SYMBOL</code></a></td><td
valign="top"><a href="#String-interface">7.5.2 An interface for commands
formatting with a string</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024complex_005fformat_005fmap"><code>$complex_format_map</code></a></td><td
valign="top"><a href="#Complex-formats">7.12 Formatting of complex formats
(<code>@example</code>, <code>@display</code>…)</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024CSS_005fLINES"><code>$CSS_LINES</code></a></td><td
valign="top"><a href="#css">6.7 Customizing the <code>texi2html</code> css
lines</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024DATE"><code>$DATE</code></a></td><td valign="top"><a
href="#Customizing-footer">6.10 Customizing the page footer</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024DEFAULT_005fENCODING"><code>$DEFAULT_ENCODING</code></a></td><td
valign="top"><a href="#Encodings">5.1 Setting the encodings</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024DEFAULT_005fRULE"><code>$DEFAULT_RULE</code></a></td><td
valign="top"><a href="#The-page-layout">6.2 Page layout and navigation panel
overview</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024definition_005fcategory"><code>$definition_category</code></a></td><td
valign="top"><a href="#Definition-formatting">7.14.2 Customization of the
definition formatting</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024def_005falways_005fdelimiters"><code>$def_always_delimiters</code></a></td><td
valign="top"><a href="#Definition-line">7.14.1 Customizing the interpretation
of a definition line</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024def_005fargument_005fseparator_005fdelimiters"><code>$def_argument_separator_delimiters</code></a></td><td
valign="top"><a href="#Definition-line">7.14.1 Customizing the interpretation
of a definition line</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024def_005fin_005ftype_005fdelimiters"><code>$def_in_type_delimiters</code></a></td><td
valign="top"><a href="#Definition-line">7.14.1 Customizing the interpretation
of a definition line</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024DEF_005fTABLE"><code>$DEF_TABLE</code></a></td><td
valign="top"><a href="#Style-options">4.7 Customizing the
<acronym>HTML</acronym> and text style</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024DOCTYPE"><code>$DOCTYPE</code></a></td><td valign="top"><a
href="#Style-options">4.7 Customizing the <acronym>HTML</acronym> and text
style</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024DOCUMENT_005fDESCRIPTION"><code>$DOCUMENT_DESCRIPTION</code></a></td><td
valign="top"><a href="#Customizing-header">6.8 Customizing the page
header</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024DOCUMENT_005fENCODING"><code>$DOCUMENT_ENCODING</code></a></td><td
valign="top"><a href="#Encodings">5.1 Setting the encodings</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024DO_005fCONTENTS"><code>$DO_CONTENTS</code></a></td><td
valign="top"><a href="#Contents-and-Overview-text">6.11.1.2 Table of contents
and Short table of contents</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024DO_005fSCONTENTS"><code>$DO_SCONTENTS</code></a></td><td
valign="top"><a href="#Contents-and-Overview-text">6.11.1.2 Table of contents
and Short table of contents</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024ENCODING_005fNAME"><code>$ENCODING_NAME</code></a></td><td
valign="top"><a href="#Encodings">5.1 Setting the encodings</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024ENCODING_005fNAME-1"><code>$ENCODING_NAME</code></a></td><td
valign="top"><a href="#Customizing-header">6.8 Customizing the page
header</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024ERROR_005fLIMIT"><code>$ERROR_LIMIT</code></a></td><td
valign="top"><a href="#General-options">4.1 General options</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024EXTENSION"><code>$EXTENSION</code></a></td><td
valign="top"><a href="#File-names">File names</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024EXTERNAL_005fDIR"><code>$EXTERNAL_DIR</code></a></td><td
valign="top"><a href="#Style-options">4.7 Customizing the
<acronym>HTML</acronym> and text style</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024EXTRA_005fHEAD"><code>$EXTRA_HEAD</code></a></td><td
valign="top"><a href="#Customizing-header">6.8 Customizing the page
header</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024FRAMES"><code>$FRAMES</code></a></td><td valign="top"><a
href="#Page-layout-options">4.6 Page layout related command line
options</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024FRAMESET_005fDOCTYPE"><code>$FRAMESET_DOCTYPE</code></a></td><td
valign="top"><a href="#Style-options">4.7 Customizing the
<acronym>HTML</acronym> and text style</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024ICONS"><code>$ICONS</code></a></td><td valign="top"><a
href="#General-purpose-variables">6.3.1 Controlling the navigation panel panel
at a high level</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024IDX_005fSUMMARY"><code>$IDX_SUMMARY</code></a></td><td
valign="top"><a href="#External-index-files">6.13 Generation of external files
for index entries</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024INDEX_005fCHAPTER"><code>$INDEX_CHAPTER</code></a></td><td
valign="top"><a href="#Element-labels-1">Element labels</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024INLINE_005fCONTENTS"><code>$INLINE_CONTENTS</code></a></td><td
valign="top"><a href="#Contents-and-Overview-text">6.11.1.2 Table of contents
and Short table of contents</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024IN_005fENCODING"><code>$IN_ENCODING</code></a></td><td
valign="top"><a href="#Encodings">5.1 Setting the encodings</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024L2H_005fL2H"><code>$L2H_L2H</code></a></td><td
valign="top"><a href="#Expanding-TeX-regions">4.8 Expanding <code>@tex</code>
and <code>@math</code> regions using LaTeX2HTML</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024L2H_005fTMP"><code>$L2H_TMP</code></a></td><td
valign="top"><a href="#Expanding-TeX-regions">4.8 Expanding <code>@tex</code>
and <code>@math</code> regions using LaTeX2HTML</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024LANG"><code>$LANG</code></a></td><td valign="top"><a
href="#Texinfo-related-options">4.5 Command line options related to Texinfo
language features</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024LANG-1"><code>$LANG</code></a></td><td valign="top"><a
href="#Using-init-files">4.9 Use initialization files for fine
tuning</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024LANG-2"><code>$LANG</code></a></td><td valign="top"><a
href="#Strings">7.8 Customizing strings written by
<code>texi2html</code></a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024LANGUAGES"><code>$LANGUAGES</code></a></td><td
valign="top"><a href="#Strings">7.8 Customizing strings written by
<code>texi2html</code></a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024LANGUAGES-1"><code>$LANGUAGES</code></a></td><td
valign="top"><a href="#Translating-strings">A.1 Translating
strings</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024MENU_005fPRE_005fCOMPLEX_005fFORMAT"><code>$MENU_PRE_COMPLEX_FORMAT</code></a></td><td
valign="top"><a href="#Table-menu-formatting">7.17.4 The formatting of the
menu in a table</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024MENU_005fPRE_005fSTYLE"><code>$MENU_PRE_STYLE</code></a></td><td
valign="top"><a href="#Table-menu-formatting">7.17.4 The formatting of the
menu in a table</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024MENU_005fSYMBOL"><code>$MENU_SYMBOL</code></a></td><td
valign="top"><a href="#Table-menu-formatting">7.17.4 The formatting of the menu
in a table</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024MIDDLE_005fRULE"><code>$MIDDLE_RULE</code></a></td><td
valign="top"><a href="#The-page-layout">6.2 Page layout and navigation panel
overview</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024misc_005felement_005flabel"><code>$misc_element_label</code></a></td><td
valign="top"><a href="#Special-pages-content">6.11.1 Customizing the content
of the special pages</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024NODE_005fFILES"><code>$NODE_FILES</code></a></td><td
valign="top"><a href="#Output-files">4.3 Setting output file and directory
names</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024NODE_005fFILES-1"><code>$NODE_FILES</code></a></td><td
valign="top"><a href="#File-names">File names</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024NODE_005fNAME_005fIN_005fMENU"><code>$NODE_NAME_IN_MENU</code></a></td><td
valign="top"><a href="#Table-menu-formatting">7.17.4 The formatting of the
menu in a table</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024NO_005fBULLET_005fLIST_005fATTRIBUTE"><code>$NO_BULLET_LIST_ATTRIBUTE</code></a></td><td
valign="top"><a href="#Contents-and-Overview-text">6.11.1.2 Table of contents
and Short table of contents</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024NO_005fBULLET_005fLIST_005fSTYLE"><code>$NO_BULLET_LIST_STYLE</code></a></td><td
valign="top"><a href="#Contents-and-Overview-text">6.11.1.2 Table of contents
and Short table of contents</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024NUMBER_005fSECTIONS"><code>$NUMBER_SECTIONS</code></a></td><td
valign="top"><a href="#Style-options">4.7 Customizing the
<acronym>HTML</acronym> and text style</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024OPEN_005fQUOTE_005fSYMBOL"><code>$OPEN_QUOTE_SYMBOL</code></a></td><td
valign="top"><a href="#Hash-reference-interface">7.5.1 An interface for
commands formatting with a hash reference</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024OPEN_005fQUOTE_005fSYMBOL-1"><code>$OPEN_QUOTE_SYMBOL</code></a></td><td
valign="top"><a href="#String-interface">7.5.2 An interface for commands
formatting with a string</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024OUT"><code>$OUT</code></a></td><td valign="top"><a
href="#Output-files">4.3 Setting output file and directory names</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024OUT_005fENCODING"><code>$OUT_ENCODING</code></a></td><td
valign="top"><a href="#Encodings">5.1 Setting the encodings</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024OUT_005fENCODING-1"><code>$OUT_ENCODING</code></a></td><td
valign="top"><a href="#Customizing-header">6.8 Customizing the page
header</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024PREFIX"><code>$PREFIX</code></a></td><td valign="top"><a
href="#Output-files">4.3 Setting output file and directory names</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024PRE_005fBODY_005fCLOSE"><code>$PRE_BODY_CLOSE</code></a></td><td
valign="top"><a href="#Customizing-footer">6.10 Customizing the page
footer</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024print_005fchapter_005ffooter"><code>$print_chapter_footer</code></a></td><td
valign="top"><a href="#Customizing-footer">6.10 Customizing the page
footer</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024print_005fchapter_005fheader"><code>$print_chapter_header</code></a></td><td
valign="top"><a href="#Customizing-header">6.8 Customizing the page
header</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024print_005ffoot_005fnavigation"><code>$print_foot_navigation</code></a></td><td
valign="top"><a href="#Customizing-footer">6.10 Customizing the page
footer</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024print_005fhead_005fnavigation"><code>$print_head_navigation</code></a></td><td
valign="top"><a href="#Customizing-header">6.8 Customizing the page
header</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024print_005fmisc"><code>$print_misc</code></a></td><td
valign="top"><a href="#Special-pages-layout">6.11.2 Customizing the layout of
the special pages</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024print_005fmisc_005ffooter"><code>$print_misc_footer</code></a></td><td
valign="top"><a href="#Special-pages-layout">6.11.2 Customizing the layout of
the special pages</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024print_005fmisc_005fheader"><code>$print_misc_header</code></a></td><td
valign="top"><a href="#Special-pages-layout">6.11.2 Customizing the layout of
the special pages</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024print_005fpage_005ffoot"><code>$print_page_foot</code></a></td><td
valign="top"><a href="#Customizing-footer">6.10 Customizing the page
footer</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024print_005fpage_005fhead"><code>$print_page_head</code></a></td><td
valign="top"><a href="#Customizing-header">6.8 Customizing the page
header</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024print_005fsection_005ffooter"><code>$print_section_footer</code></a></td><td
valign="top"><a href="#Customizing-footer">6.10 Customizing the page
footer</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024print_005fsection_005fheader"><code>$print_section_header</code></a></td><td
valign="top"><a href="#Customizing-header">6.8 Customizing the page
header</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024print_005fTop"><code>$print_Top</code></a></td><td
valign="top"><a href="#Special-pages-layout">6.11.2 Customizing the layout of
the special pages</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024print_005fTop_005ffooter"><code>$print_Top_footer</code></a></td><td
valign="top"><a href="#Special-pages-layout">6.11.2 Customizing the layout of
the special pages</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024print_005fTop_005fheader"><code>$print_Top_header</code></a></td><td
valign="top"><a href="#Special-pages-layout">6.11.2 Customizing the layout of
the special pages</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024SECTION_005fNAVIGATION"><code>$SECTION_NAVIGATION</code></a></td><td
valign="top"><a href="#Page-layout-options">4.6 Page layout related command
line options</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024SECTION_005fNAVIGATION-1"><code>$SECTION_NAVIGATION</code></a></td><td
valign="top"><a href="#General-purpose-variables">6.3.1 Controlling the
navigation panel panel at a high level</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024SEPARATED_005fFOOTNOTES"><code>$SEPARATED_FOOTNOTES</code></a></td><td
valign="top"><a href="#Page-layout-options">4.6 Page layout related command
line options</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024SEPARATE_005fDESCRIPTION"><code>$SEPARATE_DESCRIPTION</code></a></td><td
valign="top"><a href="#Menu-components-formatting">7.17.2 The formatting of
the different menu components</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024SHORTEXTN"><code>$SHORTEXTN</code></a></td><td
valign="top"><a href="#Output-files">4.3 Setting output file and directory
names</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024SHORT_005fREF"><code>$SHORT_REF</code></a></td><td
valign="top"><a href="#Style-options">4.7 Customizing the
<acronym>HTML</acronym> and text style</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024SHOW_005fMENU"><code>$SHOW_MENU</code></a></td><td
valign="top"><a href="#Expansion">4.4 Specifying which regions get
expanded</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024SIMPLE_005fMENU"><code>$SIMPLE_MENU</code></a></td><td
valign="top"><a href="#Menus">7.17 Menu formatting</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024SMALL_005fRULE"><code>$SMALL_RULE</code></a></td><td
valign="top"><a href="#The-page-layout">6.2 Page layout and navigation panel
overview</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024SPLIT"><code>$SPLIT</code></a></td><td valign="top"><a
href="#Splitting-output">4.2 Specifying where to split the generated
document</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024SPLIT_005fINDEX"><code>$SPLIT_INDEX</code></a></td><td
valign="top"><a href="#Index-list">7.18.2 Customizing the formatting of index
lists</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024T2H_005fOBSOLETE_005fSTRINGS"><code>$T2H_OBSOLETE_STRINGS</code></a></td><td
valign="top"><a href="#Translating-strings">A.1 Translating
strings</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024Texi2HTML_003a_003aNODE_007bNext_007d"><code>$Texi2HTML::NODE{Next}</code></a></td><td
valign="top"><a href="#Button-specifications">6.3.2 Specifying the buttons
formatting</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024Texi2HTML_003a_003aOVERVIEW"><code>$Texi2HTML::OVERVIEW</code></a></td><td
valign="top"><a href="#Section-lines">Section lines</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024Texi2HTML_003a_003aOVERVIEW-1"><code>$Texi2HTML::OVERVIEW</code></a></td><td
valign="top"><a href="#Contents-and-Overview-text">6.11.1.2 Table of contents
and Short table of contents</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024Texi2HTML_003a_003aTHISDOC_007b_0027BODYTEXT_0027_007d"><code>$Texi2HTML::THISDOC{'BODYTEXT'}</code></a></td><td
valign="top"><a href="#Customizing-header">6.8 Customizing the page
header</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024Texi2html_003a_003aTHISDOC_007b_0027CSS_005fLINES_0027_007d"><code>$Texi2html::THISDOC{'CSS_LINES'}</code></a></td><td
valign="top"><a href="#css">6.7 Customizing the <code>texi2html</code> css
lines</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024Texi2HTML_003a_003aTHISDOC_007b_0027documentencoding_0027_007d"><code>$Texi2HTML::THISDOC{'documentencoding'}</code></a></td><td
valign="top"><a href="#Encodings">5.1 Setting the encodings</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024Texi2HTML_003a_003aTHISDOC_007b_0027DOCUMENT_005fDESCRIPTION_0027_007d"><code>$Texi2HTML::THISDOC{'DOCUMENT_DESCRIPTION'}</code></a></td><td
valign="top"><a href="#Customizing-header">6.8 Customizing the page
header</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024Texi2HTML_003a_003aTHISDOC_007b_0027DOCUMENT_005fENCODING_0027_007d"><code>$Texi2HTML::THISDOC{'DOCUMENT_ENCODING'}</code></a></td><td
valign="top"><a href="#Encodings">5.1 Setting the encodings</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024Texi2HTML_003a_003aTHISDOC_007b_0027DOCUMENT_005fENCODING_0027_007d-1"><code>$Texi2HTML::THISDOC{'DOCUMENT_ENCODING'}</code></a></td><td
valign="top"><a href="#Encodings">5.1 Setting the encodings</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024Texi2HTML_003a_003aTHISDOC_007b_0027ENCODING_005fNAME_0027_007d"><code>$Texi2HTML::THISDOC{'ENCODING_NAME'}</code></a></td><td
valign="top"><a href="#Encodings">5.1 Setting the encodings</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024Texi2HTML_003a_003aTHISDOC_007b_0027IN_005fENCODING_0027_007d"><code>$Texi2HTML::THISDOC{'IN_ENCODING'}</code></a></td><td
valign="top"><a href="#Encodings">5.1 Setting the encodings</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024Texi2HTML_003a_003aTHISDOC_007b_0027OUT_005fENCODING_0027_007d"><code>$Texi2HTML::THISDOC{'OUT_ENCODING'}</code></a></td><td
valign="top"><a href="#Encodings">5.1 Setting the encodings</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024Texi2HTML_003a_003aTHIS_005fSECTION"><code>$Texi2HTML::THIS_SECTION</code></a></td><td
valign="top"><a href="#Section-lines">Section lines</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024Texi2HTML_003a_003aTHIS_005fSECTION-1"><code>$Texi2HTML::THIS_SECTION</code></a></td><td
valign="top"><a href="#Global-functions">6.4.3 Function usefull in page
formatting</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024Texi2HTML_003a_003aTITLEPAGE"><code>$Texi2HTML::TITLEPAGE</code></a></td><td
valign="top"><a href="#Section-lines">Section lines</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024Texi2HTML_003a_003aTITLEPAGE-1"><code>$Texi2HTML::TITLEPAGE</code></a></td><td
valign="top"><a href="#Title-page">6.11.1.5 Formatting of title
page</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024Texi2HTML_003a_003aTOC_005fLINES"><code>$Texi2HTML::TOC_LINES</code></a></td><td
valign="top"><a href="#Section-lines">Section lines</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024Texi2HTML_003a_003aTOC_005fLINES-1"><code>$Texi2HTML::TOC_LINES</code></a></td><td
valign="top"><a href="#Contents-and-Overview-text">6.11.1.2 Table of contents
and Short table of contents</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024TOC_005fFILE"><code>$TOC_FILE</code></a></td><td
valign="top"><a href="#Output-files">4.3 Setting output file and directory
names</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024TOC_005fLINKS"><code>$TOC_LINKS</code></a></td><td
valign="top"><a href="#Style-options">4.7 Customizing the
<acronym>HTML</acronym> and text style</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024TOP_005fFILE"><code>$TOP_FILE</code></a></td><td
valign="top"><a href="#Output-files">4.3 Setting output file and directory
names</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024TOP_005fHEADING"><code>$TOP_HEADING</code></a></td><td
valign="top"><a href="#Element-labels-1">Element labels</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024TRANSLITERATE_005fNODE"><code>$TRANSLITERATE_NODE</code></a></td><td
valign="top"><a href="#Output-files">4.3 Setting output file and directory
names</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024UNNUMBERED_005fSYMBOL_005fIN_005fMENU"><code>$UNNUMBERED_SYMBOL_IN_MENU</code></a></td><td
valign="top"><a href="#Table-menu-formatting">7.17.4 The formatting of the
menu in a table</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024USER"><code>$USER</code></a></td><td valign="top"><a
href="#Customizing-footer">6.10 Customizing the page footer</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024USE_005fACCESSKEY"><code>$USE_ACCESSKEY</code></a></td><td
valign="top"><a href="#Button-specifications">6.3.2 Specifying the buttons
formatting</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024USE_005fACCESSKEY-1"><code>$USE_ACCESSKEY</code></a></td><td
valign="top"><a href="#Menus">7.17 Menu formatting</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024USE_005fISO"><code>$USE_ISO</code></a></td><td
valign="top"><a href="#Style-options">4.7 Customizing the
<acronym>HTML</acronym> and text style</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024USE_005fLINKS"><code>$USE_LINKS</code></a></td><td
valign="top"><a href="#Customizing-header">6.8 Customizing the page
header</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024USE_005fNODES"><code>$USE_NODES</code></a></td><td
valign="top"><a href="#Splitting-output">4.2 Specifying where to split the
generated document</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024USE_005fNODE_005fTARGET"><code>$USE_NODE_TARGET</code></a></td><td
valign="top"><a href="#Elements-hashes">6.4.1 Accessing elements
informations</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024USE_005fREL_005fREV"><code>$USE_REL_REV</code></a></td><td
valign="top"><a href="#Button-specifications">6.3.2 Specifying the buttons
formatting</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024USE_005fSETFILENAME"><code>$USE_SETFILENAME</code></a></td><td
valign="top"><a href="#SEC_Foot"></a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024VERTICAL_005fHEAD_005fNAVIGATION"><code>$VERTICAL_HEAD_NAVIGATION</code></a></td><td
valign="top"><a href="#General-purpose-variables">6.3.1 Controlling the
navigation panel panel at a high level</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024WORDS_005fIN_005fPAGE"><code>$WORDS_IN_PAGE</code></a></td><td
valign="top"><a href="#Button-specifications">6.3.2 Specifying the buttons
formatting</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024WORDS_005fIN_005fPAGE-1"><code>$WORDS_IN_PAGE</code></a></td><td
valign="top"><a href="#Button-specifications">6.3.2 Specifying the buttons
formatting</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0024WORDS_005fIN_005fPAGE-2"><code>$WORDS_IN_PAGE</code></a></td><td
valign="top"><a href="#Global-functions">6.4.3 Function usefull in page
formatting</a></td></tr>
-<tr><td colspan="3"> <hr></td></tr>
-<tr><th><a name="Variable-Index_vr_symbol-2">%</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0025accent_005fmap"><code>%accent_map</code></a></td><td
valign="top"><a href="#Style-and-accent-commands">7.5 Customizing accent, style
and other simple commands</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0025ACTIVE_005fICONS"><code>%ACTIVE_ICONS</code></a></td><td
valign="top"><a href="#Button-specifications">6.3.2 Specifying the buttons
formatting</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0025BUTTONS_005fACCESSKEY"><code>%BUTTONS_ACCESSKEY</code></a></td><td
valign="top"><a href="#Button-specifications">6.3.2 Specifying the buttons
formatting</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0025BUTTONS_005fACCESSKEY-1"><code>%BUTTONS_ACCESSKEY</code></a></td><td
valign="top"><a href="#Menus">7.17 Menu formatting</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0025BUTTONS_005fGOTO"><code>%BUTTONS_GOTO</code></a></td><td
valign="top"><a href="#Output-initialization">6.5 Preparing the
output</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0025BUTTONS_005fNAME"><code>%BUTTONS_NAME</code></a></td><td
valign="top"><a href="#Button-specifications">6.3.2 Specifying the buttons
formatting</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0025BUTTONS_005fNAME-1"><code>%BUTTONS_NAME</code></a></td><td
valign="top"><a href="#Output-initialization">6.5 Preparing the
output</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0025BUTTONS_005fREL"><code>%BUTTONS_REL</code></a></td><td
valign="top"><a href="#Button-specifications">6.3.2 Specifying the buttons
formatting</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0025BUTTONS_005fREL-1"><code>%BUTTONS_REL</code></a></td><td
valign="top"><a href="#Customizing-header">6.8 Customizing the page
header</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0025colon_005fcommand_005fpunctuation_005fcharacters"><code>%colon_command_punctuation_characters</code></a></td><td
valign="top"><a href="#Punctuation-commands">7.4 Punctuation
commands</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0025command_005fhandler"><code>%command_handler</code></a></td><td
valign="top"><a href="#Bypassing-normal-formatting">7.22 Bypassing normal
formatting</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0025css_005fmap"><code>%css_map</code></a></td><td
valign="top"><a href="#css">6.7 Customizing the <code>texi2html</code> css
lines</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0025def_005fmap"><code>%def_map</code></a></td><td
valign="top"><a href="#Definition-line">7.14.1 Customizing the interpretation
of a definition line</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0025format_005fin_005fparagraph"><code>%format_in_paragraph</code></a></td><td
valign="top"><a href="#Avoiding-paragraphs">7.11.2 Avoiding paragraphs in
formats</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0025format_005fmap"><code>%format_map</code></a></td><td
valign="top"><a href="#Whole-table-list">7.13.2 Formatting of a whole table or
list</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0025format_005fmap-1"><code>%format_map</code></a></td><td
valign="top"><a href="#Whole-table-list">7.13.2 Formatting of a whole table or
list</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0025main_003a_003avalue"><code>%main::value</code></a></td><td
valign="top"><a href="#Flags">Flags</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0025main_003a_003avalue-1"><code>%main::value</code></a></td><td
valign="top"><a href="#Flags">Flags</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0025misc_005fcommand"><code>%misc_command</code></a></td><td
valign="top"><a href="#Other-and-unknown-commands">7.24 Customizing other
commands, and unknown commands</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0025misc_005fpages_005ftargets"><code>%misc_pages_targets</code></a></td><td
valign="top"><a href="#target-names">target names</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0025NAVIGATION_005fTEXT"><code>%NAVIGATION_TEXT</code></a></td><td
valign="top"><a href="#Button-specifications">6.3.2 Specifying the buttons
formatting</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0025NAVIGATION_005fTEXT-1"><code>%NAVIGATION_TEXT</code></a></td><td
valign="top"><a href="#Output-initialization">6.5 Preparing the
output</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0025no_005fparagraph_005fcommands"><code>%no_paragraph_commands</code></a></td><td
valign="top"><a href="#Avoiding-paragraphs">7.11.2 Avoiding paragraphs in
formats</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0025paragraph_005fstyle"><code>%paragraph_style</code></a></td><td
valign="top"><a href="#Alignement-commands">7.10 Commands used for centering
and flushing of text</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0025PASSIVE_005fICONS"><code>%PASSIVE_ICONS</code></a></td><td
valign="top"><a href="#Button-specifications">6.3.2 Specifying the buttons
formatting</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0025pre_005fmap"><code>%pre_map</code></a></td><td
valign="top"><a href="#Commands-without-argument">7.3 Customizing the
formatting of commands without argument</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0025region_005fformats_005fkept"><code>%region_formats_kept</code></a></td><td
valign="top"><a href="#Handling-special-regions">7.23 Handling special
regions</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0025simple_005fmap"><code>%simple_map</code></a></td><td
valign="top"><a href="#Commands-without-argument">7.3 Customizing the
formatting of commands without argument</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0025simple_005fmap-1"><code>%simple_map</code></a></td><td
valign="top"><a href="#Other-and-unknown-commands">7.24 Customizing other
commands, and unknown commands</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0025simple_005fmap_005fpre"><code>%simple_map_pre</code></a></td><td
valign="top"><a href="#Commands-without-argument">7.3 Customizing the
formatting of commands without argument</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0025simple_005fmap_005fpre-1"><code>%simple_map_pre</code></a></td><td
valign="top"><a href="#Other-and-unknown-commands">7.24 Customizing other
commands, and unknown commands</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0025simple_005fmap_005ftexi"><code>%simple_map_texi</code></a></td><td
valign="top"><a href="#Commands-without-argument">7.3 Customizing the
formatting of commands without argument</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0025simple_005fmap_005ftexi-1"><code>%simple_map_texi</code></a></td><td
valign="top"><a href="#Other-and-unknown-commands">7.24 Customizing other
commands, and unknown commands</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0025special_005flist_005fcommands"><code>%special_list_commands</code></a></td><td
valign="top"><a href="#Table-and-list-items">7.13.1 Formatting individual
table and list items</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0025stop_005fparagraph_005fcommand"><code>%stop_paragraph_command</code></a></td><td
valign="top"><a href="#Avoiding-paragraphs">7.11.2 Avoiding paragraphs in
formats</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0025style_005fmap"><code>%style_map</code></a></td><td
valign="top"><a href="#Style-and-accent-commands">7.5 Customizing accent, style
and other simple commands</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0025style_005fmap-1"><code>%style_map</code></a></td><td
valign="top"><a href="#Other-and-unknown-commands">7.24 Customizing other
commands, and unknown commands</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0025style_005fmap_005fpre"><code>%style_map_pre</code></a></td><td
valign="top"><a href="#Style-and-accent-commands">7.5 Customizing accent,
style and other simple commands</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0025style_005fmap_005fpre-1"><code>%style_map_pre</code></a></td><td
valign="top"><a href="#Other-and-unknown-commands">7.24 Customizing other
commands, and unknown commands</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0025style_005fmap_005ftexi"><code>%style_map_texi</code></a></td><td
valign="top"><a href="#Style-and-accent-commands">7.5 Customizing accent,
style and other simple commands</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0025style_005fmap_005ftexi-1"><code>%style_map_texi</code></a></td><td
valign="top"><a href="#Other-and-unknown-commands">7.24 Customizing other
commands, and unknown commands</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0025Texi2HTML_003a_003aHREF"><code>%Texi2HTML::HREF</code></a></td><td
valign="top"><a href="#Elements-hashes">6.4.1 Accessing elements
informations</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0025Texi2HTML_003a_003aNAME"><code>%Texi2HTML::NAME</code></a></td><td
valign="top"><a href="#Elements-hashes">6.4.1 Accessing elements
informations</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0025Texi2HTML_003a_003aNODE"><code>%Texi2HTML::NODE</code></a></td><td
valign="top"><a href="#Elements-hashes">6.4.1 Accessing elements
informations</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0025Texi2HTML_003a_003aNO_005fTEXI"><code>%Texi2HTML::NO_TEXI</code></a></td><td
valign="top"><a href="#Elements-hashes">6.4.1 Accessing elements
informations</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0025Texi2HTML_003a_003aTHISDOC"><code>%Texi2HTML::THISDOC</code></a></td><td
valign="top"><a href="#Global-strings">Global strings</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0025texi_005fmap"><code>%texi_map</code></a></td><td
valign="top"><a href="#Commands-without-argument">7.3 Customizing the
formatting of commands without argument</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0025things_005fmap"><code>%things_map</code></a></td><td
valign="top"><a href="#Commands-without-argument">7.3 Customizing the
formatting of commands without argument</a></td></tr>
-<tr><td colspan="3"> <hr></td></tr>
-<tr><th><a name="Variable-Index_vr_symbol-3">@</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0040CHAPTER_005fBUTTONS"><code>@CHAPTER_BUTTONS</code></a></td><td
valign="top"><a href="#Button-specifications">6.3.2 Specifying the buttons
formatting</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0040command_005fhandler_005ffinish"><code>@command_handler_finish</code></a></td><td
valign="top"><a href="#Bypassing-normal-formatting">7.22 Bypassing normal
formatting</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0040command_005fhandler_005finit"><code>@command_handler_init</code></a></td><td
valign="top"><a href="#Bypassing-normal-formatting">7.22 Bypassing normal
formatting</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0040command_005fhandler_005fprocess"><code>@command_handler_process</code></a></td><td
valign="top"><a href="#Bypassing-normal-formatting">7.22 Bypassing normal
formatting</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0040CSS_005fFILES"><code>@CSS_FILES</code></a></td><td
valign="top"><a href="#Style-options">4.7 Customizing the
<acronym>HTML</acronym> and text style</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0040CSS_005fREFS"><code>@CSS_REFS</code></a></td><td
valign="top"><a href="#Style-options">4.7 Customizing the
<acronym>HTML</acronym> and text style</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0040EXPAND"><code>@EXPAND</code></a></td><td valign="top"><a
href="#Expansion">4.4 Specifying which regions get expanded</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0040IMAGE_005fEXTENSIONS"><code>@IMAGE_EXTENSIONS</code></a></td><td
valign="top"><a href="#Anchors-images-and-spaces">7.6 Formatting of special
simple commands</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0040INCLUDE_005fDIRS"><code>@INCLUDE_DIRS</code></a></td><td
valign="top"><a href="#Texinfo-related-options">4.5 Command line options
related to Texinfo language features</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0040LINKS_005fBUTTONS"><code>@LINKS_BUTTONS</code></a></td><td
valign="top"><a href="#Button-specifications">6.3.2 Specifying the buttons
formatting</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0040LINKS_005fBUTTONS-1"><code>@LINKS_BUTTONS</code></a></td><td
valign="top"><a href="#Customizing-header">6.8 Customizing the page
header</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0040MISC_005fBUTTONS"><code>@MISC_BUTTONS</code></a></td><td
valign="top"><a href="#Button-specifications">6.3.2 Specifying the buttons
formatting</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0040NODE_005fFOOTER_005fBUTTONS"><code>@NODE_FOOTER_BUTTONS</code></a></td><td
valign="top"><a href="#Button-specifications">6.3.2 Specifying the buttons
formatting</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0040PREPEND_005fDIRS"><code>@PREPEND_DIRS</code></a></td><td
valign="top"><a href="#Texinfo-related-options">4.5 Command line options
related to Texinfo language features</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0040SECTION_005fBUTTONS"><code>@SECTION_BUTTONS</code></a></td><td
valign="top"><a href="#Button-specifications">6.3.2 Specifying the buttons
formatting</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0040SECTION_005fFOOTER_005fBUTTONS"><code>@SECTION_FOOTER_BUTTONS</code></a></td><td
valign="top"><a href="#Button-specifications">6.3.2 Specifying the buttons
formatting</a></td></tr>
-<tr><td colspan="3"> <hr></td></tr>
-</table>
-<table><tr><th valign="top">Jump to: </th><td><a
href="#Variable-Index_vr_symbol-1" class="summary-letter"><b>$</b></a>
-
-<a href="#Variable-Index_vr_symbol-2" class="summary-letter"><b>%</b></a>
-
-<a href="#Variable-Index_vr_symbol-3" class="summary-letter"><b>@</b></a>
-</td></tr></table>
-<hr size="6">
-<a name="Indexcp"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Indexvr" title="Previous
section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[ > ]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Indexvr" title="Beginning of this
chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Top" title="Up section"> Up
</a>]</td>
-<td valign="middle" align="left">[ >> ]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Concept-Index"></a>
-<h1 class="appendix">F. Concept Index</h1>
-<table><tr><th valign="top">Jump to: </th><td><a
href="#Concept-Index_cp_letter-A" class="summary-letter"><b>A</b></a>
-
-<a href="#Concept-Index_cp_letter-B" class="summary-letter"><b>B</b></a>
-
-<a href="#Concept-Index_cp_letter-C" class="summary-letter"><b>C</b></a>
-
-<a href="#Concept-Index_cp_letter-D" class="summary-letter"><b>D</b></a>
-
-<a href="#Concept-Index_cp_letter-E" class="summary-letter"><b>E</b></a>
-
-<a href="#Concept-Index_cp_letter-F" class="summary-letter"><b>F</b></a>
-
-<a href="#Concept-Index_cp_letter-I" class="summary-letter"><b>I</b></a>
-
-<a href="#Concept-Index_cp_letter-M" class="summary-letter"><b>M</b></a>
-
-<a href="#Concept-Index_cp_letter-P" class="summary-letter"><b>P</b></a>
-
-<a href="#Concept-Index_cp_letter-R" class="summary-letter"><b>R</b></a>
-
-<a href="#Concept-Index_cp_letter-S" class="summary-letter"><b>S</b></a>
-
-<a href="#Concept-Index_cp_letter-T" class="summary-letter"><b>T</b></a>
-
-<a href="#Concept-Index_cp_letter-U" class="summary-letter"><b>U</b></a>
-
-</td></tr></table>
-<table border="0" class="index-cp">
-<tr><td></td><th align="left">Index Entry</th><th align="left">
Section</th></tr>
-<tr><td colspan="3"> <hr></td></tr>
-<tr><th><a name="Concept-Index_cp_letter-A">A</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a href="#index-Avoid-paragraph-opening">Avoid
paragraph opening</a></td><td valign="top"><a
href="#Avoiding-paragraphs">7.11.2 Avoiding paragraphs in formats</a></td></tr>
-<tr><td colspan="3"> <hr></td></tr>
-<tr><th><a name="Concept-Index_cp_letter-B">B</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a href="#index-bug-report">bug
report</a></td><td valign="top"><a href="#Top">Texi2HTML</a></td></tr>
-<tr><td colspan="3"> <hr></td></tr>
-<tr><th><a name="Concept-Index_cp_letter-C">C</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a href="#index-centering">centering</a></td><td
valign="top"><a href="#Alignement-commands">7.10 Commands used for centering
and flushing of text</a></td></tr>
-<tr><td></td><td valign="top"><a href="#index-complex-format">complex
format</a></td><td valign="top"><a href="#Complex-formats">7.12 Formatting of
complex formats (<code>@example</code>,
<code>@display</code>…)</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-Config">‘<tt>Config</tt>’</a></td><td valign="top"><a
href="#Using-init-files">4.9 Use initialization files for fine
tuning</a></td></tr>
-<tr><td></td><td valign="top"><a href="#index-configure">configure</a></td><td
valign="top"><a href="#Installation">3. Installation of
<code>texi2html</code></a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-CSS"><acronym>CSS</acronym></a></td><td valign="top"><a
href="#Style-options">4.7 Customizing the <acronym>HTML</acronym> and text
style</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-CSS-1"><acronym>CSS</acronym></a></td><td valign="top"><a
href="#css">6.7 Customizing the <code>texi2html</code> css lines</a></td></tr>
-<tr><td colspan="3"> <hr></td></tr>
-<tr><th><a name="Concept-Index_cp_letter-D">D</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-downloading-texi2html-source">downloading <code>texi2html</code>
source</a></td><td valign="top"><a href="#Obtaining-texi2html">2. Obtaining
<code>texi2html</code></a></td></tr>
-<tr><td colspan="3"> <hr></td></tr>
-<tr><th><a name="Concept-Index_cp_letter-E">E</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a href="#index-examples-of-manuals">examples of
manuals</a></td><td valign="top"><a href="#Overview">1. Overview</a></td></tr>
-<tr><td></td><td valign="top"><a href="#index-external-manual">external
manual</a></td><td valign="top"><a href="#Reference-to-external-manual">7.9.1
Reference to external manual</a></td></tr>
-<tr><td colspan="3"> <hr></td></tr>
-<tr><th><a name="Concept-Index_cp_letter-F">F</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a href="#index-flushing-text">flushing
text</a></td><td valign="top"><a href="#Alignement-commands">7.10 Commands used
for centering and flushing of text</a></td></tr>
-<tr><td colspan="3"> <hr></td></tr>
-<tr><th><a name="Concept-Index_cp_letter-I">I</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a href="#index-i18n">i18n</a></td><td
valign="top"><a href="#Strings">7.8 Customizing strings written by
<code>texi2html</code></a></td></tr>
-<tr><td></td><td valign="top"><a href="#index-i18n-1">i18n</a></td><td
valign="top"><a href="#Translating-strings">A.1 Translating
strings</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-Installation">Installation</a></td><td valign="top"><a
href="#Installation">3. Installation of <code>texi2html</code></a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-internationalization">internationalization</a></td><td
valign="top"><a href="#Using-init-files">4.9 Use initialization files for fine
tuning</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-internationalized-strings">internationalized strings</a></td><td
valign="top"><a href="#Adding-new-strings">A.2 Adding new strings written to
document</a></td></tr>
-<tr><td colspan="3"> <hr></td></tr>
-<tr><th><a name="Concept-Index_cp_letter-M">M</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a href="#index-makeinfo">makeinfo</a></td><td
valign="top"><a href="#whytexi2html">1.1 Why <code>texi2html</code> and not
<code>makeinfo</code>?</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-manage_005fi18n_002epl"><code>manage_i18n.pl</code></a></td><td
valign="top"><a href="#Adding-new-strings">A.2 Adding new strings written to
document</a></td></tr>
-<tr><td colspan="3"> <hr></td></tr>
-<tr><th><a name="Concept-Index_cp_letter-P">P</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a href="#index-paragraph">paragraph</a></td><td
valign="top"><a href="#Paragraph-and-preformatted-formatting">7.11.1 Paragraph
and preformatted region formatting</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-preformatted-region">preformatted region</a></td><td
valign="top"><a href="#Paragraph-and-preformatted-formatting">7.11.1 Paragraph
and preformatted region formatting</a></td></tr>
-<tr><td colspan="3"> <hr></td></tr>
-<tr><th><a name="Concept-Index_cp_letter-R">R</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a href="#index-reference">reference</a></td><td
valign="top"><a href="#References">7.9 References</a></td></tr>
-<tr><td colspan="3"> <hr></td></tr>
-<tr><th><a name="Concept-Index_cp_letter-S">S</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a href="#index-skipped-command">skipped
command</a></td><td valign="top"><a href="#Other-and-unknown-commands">7.24
Customizing other commands, and unknown commands</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-source-code-for-texi2html_002c-downloading">source code for
<code>texi2html</code>, downloading</a></td><td valign="top"><a
href="#Obtaining-texi2html">2. Obtaining <code>texi2html</code></a></td></tr>
-<tr><td colspan="3"> <hr></td></tr>
-<tr><th><a name="Concept-Index_cp_letter-T">T</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-texi2html-source_002c-downloading"><code>texi2html</code> source,
downloading</a></td><td valign="top"><a href="#Obtaining-texi2html">2.
Obtaining <code>texi2html</code></a></td></tr>
-<tr><td></td><td valign="top"><a href="#index-Texinfo">Texinfo</a></td><td
valign="top"><a href="#Overview">1. Overview</a></td></tr>
-<tr><td></td><td valign="top"><a href="#index-text-alignement">text
alignement</a></td><td valign="top"><a href="#Alignement-commands">7.10
Commands used for centering and flushing of text</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-Translation">Translation</a></td><td valign="top"><a
href="#Translating-strings">A.1 Translating strings</a></td></tr>
-<tr><td colspan="3"> <hr></td></tr>
-<tr><th><a name="Concept-Index_cp_letter-U">U</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a href="#index-unknown-command">unknown
command</a></td><td valign="top"><a href="#Other-and-unknown-commands">7.24
Customizing other commands, and unknown commands</a></td></tr>
-<tr><td colspan="3"> <hr></td></tr>
-</table>
-<table><tr><th valign="top">Jump to: </th><td><a
href="#Concept-Index_cp_letter-A" class="summary-letter"><b>A</b></a>
-
-<a href="#Concept-Index_cp_letter-B" class="summary-letter"><b>B</b></a>
-
-<a href="#Concept-Index_cp_letter-C" class="summary-letter"><b>C</b></a>
-
-<a href="#Concept-Index_cp_letter-D" class="summary-letter"><b>D</b></a>
-
-<a href="#Concept-Index_cp_letter-E" class="summary-letter"><b>E</b></a>
-
-<a href="#Concept-Index_cp_letter-F" class="summary-letter"><b>F</b></a>
-
-<a href="#Concept-Index_cp_letter-I" class="summary-letter"><b>I</b></a>
-
-<a href="#Concept-Index_cp_letter-M" class="summary-letter"><b>M</b></a>
-
-<a href="#Concept-Index_cp_letter-P" class="summary-letter"><b>P</b></a>
-
-<a href="#Concept-Index_cp_letter-R" class="summary-letter"><b>R</b></a>
-
-<a href="#Concept-Index_cp_letter-S" class="summary-letter"><b>S</b></a>
-
-<a href="#Concept-Index_cp_letter-T" class="summary-letter"><b>T</b></a>
-
-<a href="#Concept-Index_cp_letter-U" class="summary-letter"><b>U</b></a>
-
-</td></tr></table>
-<hr size="6">
-<a name="SEC_Foot"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<h1>Footnotes</h1>
-<h3><a name="FOOT1" href="#DOCF1">(1)</a></h3>
-<p>This behaviour is triggered only by a
-variable set in an init file, <a name="index-_0024USE_005fSETFILENAME"></a>
-<code>$USE_SETFILENAME</code>
-(see section <a href="#Using-init-files">Use initialization files for fine
tuning</a>).
-</p><hr size="1">
-<a name="SEC_Contents"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<h1>Table of Contents</h1>
-<div class="contents">
-
-<ul class="toc">
- <li><a name="toc-Overview-1" href="#Overview">1. Overview</a>
- <ul class="toc">
- <li><a name="toc-Why-texi2html-and-not-makeinfo_003f"
href="#whytexi2html">1.1 Why <code>texi2html</code> and not
<code>makeinfo</code>?</a></li>
- </ul></li>
- <li><a name="toc-Obtaining-texi2html-1" href="#Obtaining-texi2html">2.
Obtaining <code>texi2html</code></a></li>
- <li><a name="toc-Installation-of-texi2html" href="#Installation">3.
Installation of <code>texi2html</code></a>
- <ul class="toc">
- <li><a name="toc-Requirements-1" href="#Requirements">3.1
Requirements</a></li>
- <li><a name="toc-Configuring-the-source-and-rebuilding"
href="#Configuring-and-rebuilding">3.2 Configuring the source and
rebuilding</a></li>
- <li><a name="toc-Installing-1" href="#Installing">3.3 Installing</a></li>
- <li><a name="toc-Advanced-build-features-1"
href="#Advanced-build-features">3.4 Advanced build features</a></li>
- </ul></li>
- <li><a name="toc-Invoking-texi2html-1" href="#Invoking-texi2html">4.
Invoking <code>texi2html</code></a>
- <ul class="toc">
- <li><a name="toc-General-options-1" href="#General-options">4.1 General
options</a></li>
- <li><a name="toc-Specifying-where-to-split-the-generated-document"
href="#Splitting-output">4.2 Specifying where to split the generated
document</a></li>
- <li><a name="toc-Setting-output-file-and-directory-names"
href="#Output-files">4.3 Setting output file and directory names</a></li>
- <li><a name="toc-Specifying-which-regions-get-expanded"
href="#Expansion">4.4 Specifying which regions get expanded</a></li>
- <li><a
name="toc-Command-line-options-related-to-Texinfo-language-features"
href="#Texinfo-related-options">4.5 Command line options related to Texinfo
language features</a></li>
- <li><a name="toc-Page-layout-related-command-line-options"
href="#Page-layout-options">4.6 Page layout related command line
options</a></li>
- <li><a name="toc-Customizing-the-HTML-and-text-style"
href="#Style-options">4.7 Customizing the <acronym>HTML</acronym> and text
style</a></li>
- <li><a
name="toc-Expanding-_0040tex-and-_0040math-regions-using-LaTeX2HTML"
href="#Expanding-TeX-regions">4.8 Expanding <code>@tex</code> and
<code>@math</code> regions using LaTeX2HTML</a></li>
- <li><a name="toc-Use-initialization-files-for-fine-tuning"
href="#Using-init-files">4.9 Use initialization files for fine tuning</a></li>
- </ul></li>
- <li><a name="toc-Overview-of-initialization-files-content-and-loading"
href="#Initialization-files">5. Overview of initialization files content and
loading</a>
- <ul class="toc">
- <li><a name="toc-Setting-the-encodings" href="#Encodings">5.1 Setting the
encodings</a></li>
- <li><a name="toc-Redefining-functions-in-initialization-files"
href="#Redefining-functions">5.2 Redefining functions in initialization
files</a></li>
- <li><a name="toc-Conventions-used-for-function-prototypes"
href="#Function-prototypes">5.3 Conventions used for function
prototypes</a></li>
- </ul></li>
- <li><a name="toc-Fine-tuning-of-the-page-layout"
href="#Changing-the-page-layout">6. Fine tuning of the page layout</a>
- <ul class="toc">
- <li><a
name="toc-The-different-categories-of-pages-and-sectioning-elements"
href="#The-different-pages">6.1 The different categories of pages and
sectioning elements</a></li>
- <li><a name="toc-Page-layout-and-navigation-panel-overview"
href="#The-page-layout">6.2 Page layout and navigation panel overview</a></li>
- <li><a name="toc-Customization-of-the-navigation-panels-buttons"
href="#Navigation-panel">6.3 Customization of the navigation panels buttons</a>
- <ul class="toc">
- <li><a name="toc-Controlling-the-navigation-panel-panel-at-a-high-level"
href="#General-purpose-variables">6.3.1 Controlling the navigation panel panel
at a high level</a></li>
- <li><a name="toc-Specifying-the-buttons-formatting"
href="#Button-specifications">6.3.2 Specifying the buttons formatting</a></li>
- <li><a name="toc-Changing-the-navigation-panel-formatting"
href="#Panel-formatting-function">6.3.3 Changing the navigation panel
formatting</a></li>
- </ul></li>
- <li><a name="toc-Main-program-variables-and-usefull-functions"
href="#Program-variables">6.4 Main program variables and usefull functions</a>
- <ul class="toc">
- <li><a name="toc-Accessing-elements-informations"
href="#Elements-hashes">6.4.1 Accessing elements informations</a></li>
- <li><a name="toc-Accessing-global-informations"
href="#Global-informations">6.4.2 Accessing global informations</a></li>
- <li><a name="toc-Function-usefull-in-page-formatting"
href="#Global-functions">6.4.3 Function usefull in page formatting</a></li>
- </ul></li>
- <li><a name="toc-Preparing-the-output" href="#Output-initialization">6.5
Preparing the output</a></li>
- <li><a name="toc-Finalizing-the-output" href="#Output-finalization">6.6
Finalizing the output</a></li>
- <li><a name="toc-Customizing-the-texi2html-css-lines" href="#css">6.7
Customizing the <code>texi2html</code> css lines</a></li>
- <li><a name="toc-Customizing-the-page-header"
href="#Customizing-header">6.8 Customizing the page header</a></li>
- <li><a name="toc-Customizing-the-sections" href="#Customizing-section">6.9
Customizing the sections</a></li>
- <li><a name="toc-Customizing-the-page-footer"
href="#Customizing-footer">6.10 Customizing the page footer</a></li>
- <li><a name="toc-Special-pages-formatting" href="#Special-pages">6.11
Special pages formatting</a>
- <ul class="toc">
- <li><a name="toc-Customizing-the-content-of-the-special-pages"
href="#Special-pages-content">6.11.1 Customizing the content of the special
pages</a>
- <ul class="toc">
- <li><a name="toc-Top-element-text-formatting"
href="#Top-element-text">6.11.1.1 Top element text formatting</a></li>
- <li><a name="toc-Table-of-contents-and-Short-table-of-contents"
href="#Contents-and-Overview-text">6.11.1.2 Table of contents and Short table
of contents</a></li>
- <li><a name="toc-Formatting-of-footnotes-text"
href="#Footnotes-text">6.11.1.3 Formatting of footnotes text</a></li>
- <li><a name="toc-Formatting-of-about-text" href="#About-text">6.11.1.4
Formatting of about text</a></li>
- <li><a name="toc-Formatting-of-title-page" href="#Title-page">6.11.1.5
Formatting of title page</a></li>
- </ul></li>
- <li><a name="toc-Customizing-the-layout-of-the-special-pages"
href="#Special-pages-layout">6.11.2 Customizing the layout of the special
pages</a></li>
- </ul></li>
- <li><a name="toc-Customizing-the-file-and-target-names"
href="#File-and-target-names">6.12 Customizing the file and target
names</a></li>
- <li><a name="toc-Generation-of-external-files-for-index-entries"
href="#External-index-files">6.13 Generation of external files for index
entries</a></li>
- </ul></li>
- <li><a name="toc-Customizing-HTML-and-text-style-in-init-files"
href="#Customizing-HTML">7. Customizing <acronym>HTML</acronym> and text style
in init files</a>
- <ul class="toc">
- <li><a
name="toc-Three-contexts-for-expansions_003a-preformatted_002c-normal-and-string"
href="#Three-contexts">7.1 Three contexts for expansions: preformatted, normal
and string</a></li>
- <li><a
name="toc-Three-passes_003a-macro-expansion_002c-document-structure-and-output"
href="#Three-passes">7.2 Three passes: macro expansion, document structure and
output</a></li>
- <li><a name="toc-Customizing-the-formatting-of-commands-without-argument"
href="#Commands-without-argument">7.3 Customizing the formatting of commands
without argument</a></li>
- <li><a name="toc-Punctuation-commands-1" href="#Punctuation-commands">7.4
Punctuation commands</a></li>
- <li><a name="toc-Customizing-accent_002c-style-and-other-simple-commands"
href="#Style-and-accent-commands">7.5 Customizing accent, style and other
simple commands</a>
- <ul class="toc">
- <li><a
name="toc-An-interface-for-commands-formatting-with-a-hash-reference"
href="#Hash-reference-interface">7.5.1 An interface for commands formatting
with a hash reference</a></li>
- <li><a name="toc-An-interface-for-commands-formatting-with-a-string"
href="#String-interface">7.5.2 An interface for commands formatting with a
string</a></li>
- <li><a name="toc-Defining-the-style-and-indicatric-commands-interface"
href="#Define-your-own-interface">7.5.3 Defining the style and indicatric
commands interface</a></li>
- </ul></li>
- <li><a name="toc-Formatting-of-special-simple-commands"
href="#Anchors-images-and-spaces">7.6 Formatting of special simple
commands</a></li>
- <li><a name="toc-Processing-special-characters-in-text" href="#Text">7.7
Processing special characters in text</a></li>
- <li><a name="toc-Customizing-strings-written-by-texi2html"
href="#Strings">7.8 Customizing strings written by
<code>texi2html</code></a></li>
- <li><a name="toc-References-1" href="#References">7.9 References</a>
- <ul class="toc">
- <li><a name="toc-Reference-to-external-manual-1"
href="#Reference-to-external-manual">7.9.1 Reference to external manual</a></li>
- <li><a name="toc-Reference-to-an-internal-node"
href="#Internal-reference">7.9.2 Reference to an internal node</a></li>
- </ul></li>
- <li><a name="toc-Commands-used-for-centering-and-flushing-of-text"
href="#Alignement-commands">7.10 Commands used for centering and flushing of
text</a></li>
- <li><a
name="toc-Formatting-_0028or-not_0029-a-paragraph-and-a-preformatted-region"
href="#Paragraph-and-preformatted-region">7.11 Formatting (or not) a paragraph
and a preformatted region</a>
- <ul class="toc">
- <li><a name="toc-Paragraph-and-preformatted-region-formatting"
href="#Paragraph-and-preformatted-formatting">7.11.1 Paragraph and preformatted
region formatting</a></li>
- <li><a name="toc-Avoiding-paragraphs-in-formats"
href="#Avoiding-paragraphs">7.11.2 Avoiding paragraphs in formats</a></li>
- </ul></li>
- <li><a
name="toc-Formatting-of-complex-formats-_0028_0040example_002c-_0040display_002e_002e_002e_0029"
href="#Complex-formats">7.12 Formatting of complex formats
(<code>@example</code>, <code>@display</code>…)</a></li>
- <li><a name="toc-Customizing-the-formatting-of-lists-and-tables"
href="#Lists-tables">7.13 Customizing the formatting of lists and tables</a>
- <ul class="toc">
- <li><a name="toc-Formatting-individual-table-and-list-items"
href="#Table-and-list-items">7.13.1 Formatting individual table and list
items</a></li>
- <li><a name="toc-Formatting-of-a-whole-table-or-list"
href="#Whole-table-list">7.13.2 Formatting of a whole table or list</a></li>
- </ul></li>
- <li><a name="toc-Definition-commands-formatting" href="#Definitions">7.14
Definition commands formatting</a>
- <ul class="toc">
- <li><a name="toc-Customizing-the-interpretation-of-a-definition-line"
href="#Definition-line">7.14.1 Customizing the interpretation of a definition
line</a></li>
- <li><a name="toc-Customization-of-the-definition-formatting"
href="#Definition-formatting">7.14.2 Customization of the definition
formatting</a></li>
- </ul></li>
- <li><a name="toc-Customizing-headings-formatting" href="#Headings">7.15
Customizing headings formatting</a></li>
- <li><a
name="toc-Formatting-of-special-regions-_0028_0040verbatim_002c-_0040cartouche_002c-_0040quotation_0029"
href="#Special-regions">7.16 Formatting of special regions
(<code>@verbatim</code>, <code>@cartouche</code>,
<code>@quotation</code>)</a></li>
- <li><a name="toc-Menu-formatting" href="#Menus">7.17 Menu formatting</a>
- <ul class="toc">
- <li><a name="toc-The-structure-of-a-menu" href="#Menu-parts">7.17.1 The
structure of a menu</a></li>
- <li><a name="toc-The-formatting-of-the-different-menu-components"
href="#Menu-components-formatting">7.17.2 The formatting of the different menu
components</a></li>
- <li><a name="toc-Simple-menu-formatting-in-a-preformatted-environment"
href="#Simple-menu-formatting">7.17.3 Simple menu formatting in a preformatted
environment</a></li>
- <li><a name="toc-The-formatting-of-the-menu-in-a-table"
href="#Table-menu-formatting">7.17.4 The formatting of the menu in a
table</a></li>
- </ul></li>
- <li><a name="toc-Indices-formatting" href="#Indices">7.18 Indices
formatting</a>
- <ul class="toc">
- <li><a name="toc-Formatting-of-index-entries"
href="#Index-entry-place">7.18.1 Formatting of index entries</a></li>
- <li><a name="toc-Customizing-the-formatting-of-index-lists"
href="#Index-list">7.18.2 Customizing the formatting of index lists</a></li>
- </ul></li>
- <li><a name="toc-Floats-and-lists-of-floats-1"
href="#Floats-and-lists-of-floats">7.19 Floats and lists of floats</a>
- <ul class="toc">
- <li><a name="toc-Formatting-a-float" href="#Floats">7.19.1 Formatting a
float</a></li>
- <li><a name="toc-Formatting-lists-of-floats"
href="#Lists-of-floats">7.19.2 Formatting lists of floats</a></li>
- </ul></li>
- <li><a name="toc-Customizing-the-footnotes-formatting"
href="#Footnotes">7.20 Customizing the footnotes formatting</a></li>
- <li><a name="toc-Customizing-format-opening-1"
href="#Customizing-format-opening">7.21 Customizing format opening</a></li>
- <li><a name="toc-Bypassing-normal-formatting-1"
href="#Bypassing-normal-formatting">7.22 Bypassing normal formatting</a></li>
- <li><a name="toc-Handling-special-regions-1"
href="#Handling-special-regions">7.23 Handling special regions</a></li>
- <li><a name="toc-Customizing-other-commands_002c-and-unknown-commands"
href="#Other-and-unknown-commands">7.24 Customizing other commands, and unknown
commands</a></li>
- </ul></li>
- <li><a name="toc-Internationalization-1" href="#Internationalization">A.
Internationalization</a>
- <ul class="toc">
- <li><a name="toc-Translating-strings-1" href="#Translating-strings">A.1
Translating strings</a>
- <ul class="toc">
- <li><a name="toc-Contributing-to-existing-translations"
href="#Supported-language">A.1.1 Contributing to existing translations</a></li>
- <li><a name="toc-Contributing-translations-to-another-language"
href="#New-language">A.1.2 Contributing translations to another
language</a></li>
- </ul></li>
- <li><a name="toc-Adding-new-strings-written-to-document"
href="#Adding-new-strings">A.2 Adding new strings written to document</a></li>
- </ul></li>
- <li><a name="toc-Incompatibilities-with-previous-versions"
href="#Incompatibilities">B. Incompatibilities with previous versions</a></li>
- <li><a name="toc-How-little-texi2html-texinfo-differs-from-GNU-texinfo"
href="#Specificities">C. How little texi2html texinfo differs from GNU
texinfo</a></li>
- <li><a name="toc-Command-Line-Option-Index" href="#Indexop">D. Command Line
Option Index</a></li>
- <li><a name="toc-Variable-Index" href="#Indexvr">E. Variable Index</a></li>
- <li><a name="toc-Concept-Index" href="#Indexcp">F. Concept Index</a></li>
-</ul>
-</div>
-<hr size="1">
-<a name="SEC_Overview"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<h1>Short Table of Contents</h1>
-<div class="shortcontents">
-<ul class="toc">
-<li><a name="stoc-Overview-1" href="#Overview">1. Overview</a></li>
-<li><a name="stoc-Obtaining-texi2html-1" href="#Obtaining-texi2html">2.
Obtaining <code>texi2html</code></a></li>
-<li><a name="stoc-Installation-of-texi2html" href="#Installation">3.
Installation of <code>texi2html</code></a></li>
-<li><a name="stoc-Invoking-texi2html-1" href="#Invoking-texi2html">4. Invoking
<code>texi2html</code></a></li>
-<li><a name="stoc-Overview-of-initialization-files-content-and-loading"
href="#Initialization-files">5. Overview of initialization files content and
loading</a></li>
-<li><a name="stoc-Fine-tuning-of-the-page-layout"
href="#Changing-the-page-layout">6. Fine tuning of the page layout</a></li>
-<li><a name="stoc-Customizing-HTML-and-text-style-in-init-files"
href="#Customizing-HTML">7. Customizing <acronym>HTML</acronym> and text style
in init files</a></li>
-<li><a name="stoc-Internationalization-1" href="#Internationalization">A.
Internationalization</a></li>
-<li><a name="stoc-Incompatibilities-with-previous-versions"
href="#Incompatibilities">B. Incompatibilities with previous versions</a></li>
-<li><a name="stoc-How-little-texi2html-texinfo-differs-from-GNU-texinfo"
href="#Specificities">C. How little texi2html texinfo differs from GNU
texinfo</a></li>
-<li><a name="stoc-Command-Line-Option-Index" href="#Indexop">D. Command Line
Option Index</a></li>
-<li><a name="stoc-Variable-Index" href="#Indexvr">E. Variable Index</a></li>
-<li><a name="stoc-Concept-Index" href="#Indexcp">F. Concept Index</a></li>
-</ul>
-</div>
-<hr size="1">
-<a name="SEC_About"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Indexop"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<h1>About This Document</h1>
-<p>
- This document was generated by <em>Patrice Dumas</em> on <em>December 16,
2008</em> using <a href="http://www.nongnu.org/texi2html/";><em>texi2html
1.79</em></a>.
-</p>
-<p>
- The buttons in the navigation panels have the following meaning:
-</p>
-<table border="1">
- <tr>
- <th> Button </th>
- <th> Name </th>
- <th> Go to </th>
- <th> From 1.2.3 go to</th>
- </tr>
- <tr>
- <td align="center"> [ < ] </td>
- <td align="center">Back</td>
- <td>Previous section in reading order</td>
- <td>1.2.2</td>
- </tr>
- <tr>
- <td align="center"> [ > ] </td>
- <td align="center">Forward</td>
- <td>Next section in reading order</td>
- <td>1.2.4</td>
- </tr>
- <tr>
- <td align="center"> [ << ] </td>
- <td align="center">FastBack</td>
- <td>Beginning of this chapter or previous chapter</td>
- <td>1</td>
- </tr>
- <tr>
- <td align="center"> [ Up ] </td>
- <td align="center">Up</td>
- <td>Up section</td>
- <td>1.2</td>
- </tr>
- <tr>
- <td align="center"> [ >> ] </td>
- <td align="center">FastForward</td>
- <td>Next chapter</td>
- <td>2</td>
- </tr>
- <tr>
- <td align="center"> [Top] </td>
- <td align="center">Top</td>
- <td>Cover (top) of document</td>
- <td> </td>
- </tr>
- <tr>
- <td align="center"> [Contents] </td>
- <td align="center">Contents</td>
- <td>Table of contents</td>
- <td> </td>
- </tr>
- <tr>
- <td align="center"> [Index] </td>
- <td align="center">Index</td>
- <td>Index</td>
- <td> </td>
- </tr>
- <tr>
- <td align="center"> [ ? ] </td>
- <td align="center">About</td>
- <td>About (help)</td>
- <td> </td>
- </tr>
-</table>
-
-<p>
- where the <strong> Example </strong> assumes that the current position is at
<strong> Subsubsection One-Two-Three </strong> of a document of the following
structure:
-</p>
-
-<ul>
- <li> 1. Section One
- <ul>
- <li>1.1 Subsection One-One
- <ul>
- <li>...</li>
- </ul>
- </li>
- <li>1.2 Subsection One-Two
- <ul>
- <li>1.2.1 Subsubsection One-Two-One</li>
- <li>1.2.2 Subsubsection One-Two-Two</li>
- <li>1.2.3 Subsubsection One-Two-Three
- <strong><== Current Position </strong></li>
- <li>1.2.4 Subsubsection One-Two-Four</li>
- </ul>
- </li>
- <li>1.3 Subsection One-Three
- <ul>
- <li>...</li>
- </ul>
- </li>
- <li>1.4 Subsection One-Four</li>
- </ul>
- </li>
-</ul>
-
-<hr size="1">
-<p>
- <font size="-1">
- This document was generated by <em>Patrice Dumas</em> on <em>December 16,
2008</em> using <a href="http://www.nongnu.org/texi2html/";><em>texi2html
1.79</em></a>.
- </font>
- <br>
-
-</p>
-</body>
-</html>
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Texi2html-cvs] texi2html ChangeLog doc/.cvsignore doc/texi2htm...,
Derek Robert Price <=