diff options
| author | Vladimir Volovich <vvv@vsu.ru> | 2008-06-03 01:24:59 +0000 |
|---|---|---|
| committer | Vladimir Volovich <vvv@vsu.ru> | 2008-06-03 01:24:59 +0000 |
| commit | 6eac29b50be3e6b9daef5af984fd89f4ecb816b3 (patch) | |
| tree | c63d29d59e05f48a2227698a04e0c18972ec7d6a /Master/texmf/doc | |
| parent | 4c3b7fe376b690fc44d2cfc015b8114d8b822580 (diff) | |
remove texi2html remnants
git-svn-id: svn://tug.org/texlive/trunk@8503 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf/doc')
| -rw-r--r-- | Master/texmf/doc/info/texi2html.info | 3637 | ||||
| -rw-r--r-- | Master/texmf/doc/man/man1/texi2html.1 | 164 | ||||
| -rw-r--r-- | Master/texmf/doc/texi2html/texi2html.html | 6072 |
3 files changed, 0 insertions, 9873 deletions
diff --git a/Master/texmf/doc/info/texi2html.info b/Master/texmf/doc/info/texi2html.info deleted file mode 100644 index 4e32884ec48..00000000000 --- a/Master/texmf/doc/info/texi2html.info +++ /dev/null @@ -1,3637 +0,0 @@ -This is texi2html.info, produced by makeinfo version 4.8 from -texi2html.texi. - - Copyright (C) 1999, 2000, 2001, 2002, 2003 -Free Software Foundation, Inc. - -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 Patrice Dumas - Copyright (C) 2001, 2002, 2003 Derek Price - Copyright (C) many others. - - -Portions -of this -manual - Copyright (C) 1999, 2000 Karl Heinz Marbaise (manual) - Copyright (C) 2003 Patrice Dumas (manual) - Copyright (C) 2003 Derek Price (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. - -INFO-DIR-SECTION Texinfo documentation system -START-INFO-DIR-ENTRY -* Texi2HTML: (texi2html). Texinfo to HTML Converter. -END-INFO-DIR-ENTRY - - This file, last updated 1 February 2005, documents the `texi2html' -script which converts Texinfo (http://www.texinfo.org) into HTML -(http://w3c.org). This edition is for `texi2html' version 1.76. - - Copyright (C) 1999, 2000, 2001, 2002, 2003 -Free Software Foundation, Inc. - -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 Patrice Dumas - Copyright (C) 2001, 2002, 2003 Derek Price - Copyright (C) many others. - - -Portions -of this -manual - Copyright (C) 1999, 2000 Karl Heinz Marbaise (manual) - Copyright (C) 2003 Patrice Dumas (manual) - Copyright (C) 2003 Derek Price (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. - - -File: texi2html.info, Node: Top, Next: Overview, Up: (dir) - -Texi2HTML -********* - -This manual, last updated 1 February 2005, describes version 1.76 of -the `texi2html' Perl script which converts Texinfo (*note Texinfo: -(Texinfo)Top.) into HTML. - - Please send bug reports concerning this manual to the Texi2HTML user -discussion list <user@texi2html.cvshome.org>. Please state the exact -version of the manual which contains the bug, as given above. - - Copyright (C) 1999, 2000, 2001, 2002, 2003 -Free Software Foundation, Inc. - -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 Patrice Dumas - Copyright (C) 2001, 2002, 2003 Derek Price - Copyright (C) many others. - - -Portions -of this -manual - Copyright (C) 1999, 2000 Karl Heinz Marbaise (manual) - Copyright (C) 2003 Patrice Dumas (manual) - Copyright (C) 2003 Derek Price (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. - - *This manual is currently under construction and of course incomplete. ;-)* - -* Menu: - -* Overview:: -* Obtaining texi2html:: - Obtaining a copy of the `texi2html' - source code distribution -* Installation:: Installing `texi2html' -* Invoking texi2html:: Description of the command line options -* Initialization files:: What kind of variables and subroutines appear - in init files and how they are called -* Changing the page layout:: Fine tuning of the page layout -* Customizing HTML:: Fine tuning of the HTML elements - associated with the texinfo constructs -* Internationalization:: Help translating ! -* Indexop:: Command Line Option Index -* Indexvr:: Variable Index -* Indexcp:: Concept Index - - -File: texi2html.info, Node: Overview, Next: Obtaining texi2html, Prev: Top, Up: Top - -1 Overview -********** - -Texinfo (http://www.texinfo.org) is the official documentation format -of the GNU (http://www.gnu.org) project. It uses a single source file -to produce both online information and printed output. - - It is often desirable to have a way to produce HTML 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 HTML, -especially considering that there is so much Texinfo documentation in -the world. - - Some time ago `makeinfo' wasn't able to produce HTML output format, -but people still wanted documentation in HTML. This was the birthing -hour for `texi2html'. The basic purpose of `texi2html' is to convert -Texinfo documents into HTML. - - Since then, HTML support in `makeinfo' has improved, but `texi2html' -is still stronger in many areas, including the degree to which it -allows customization. With `texi2html', some important aspects of the -resulting HTML 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 `perl', like the main program, and anything which -may be specified on the command line may also be specified within a -configuration file. - - For an example of the kind of pages `texi2html' is capable of -producing, have a look at the following sites: the Singular Manual -(http://www.singular.uni-kl.de/Manual/html/), the Cederqvist (CVS -Manual) (http://ccvs.cvshome.org/docs/manual). - -* Menu: - -* whytexi2html:: Why `texi2html' and not `makeinfo'?. - - -File: texi2html.info, Node: whytexi2html, Up: Overview - -1.1 Why `texi2html' and not `makeinfo'? -======================================= - -You would like to produce HTML files from your existing Texinfo files? -There are two programs you can use to do this. The first is `makeinfo' -(*note Generating HTML: (texinfo)Generating HTML.). The second is -`texi2html'. - - The design goal of `makeinfo''s HTML output was to produce readable -HTML output. It is now possible to use CSS for HTML customization. -Another possibility is to use intermediate formats, like docbook or -`mekeinfo' XML and XSL stylesheets to customize the resulting document. -Still the output produced by `makeinfo' isn't customizable. - - The current development of `texi2html' tries to provide for -producing the more interesting and sophisticated HTML pages that -today's Internet users have come to expect. The goal behind -`texi2html' is to generate attractive HTML by default but also to allow -users considerable freedom to affect the final style and design of the -output HTML pages. This is achieved via command line options and -flexible configuration files. - - In contrast to the HTML produced by `makeinfo --html' (the -`makeinfo' program is part of the Texinfo distribution), the -`texi2html' 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 HTML -formatting, provides for splitting documents at various levels, and -provides for using the `latex2html' program to convert `@tex' sections -of the Texinfo source. - - The focus on HTML is still present but with the help of the -customization files it is now possible to use `texi2html' to produce -other formats as well. `texi2html' may for example be turned into a -texinfo to roff translator with the help of a customization file -provided with the distribution. - - `texi2html' should reasonably convert all Texinfo 4.8 constructs. -If you find it does not, please send a bug report to the -<users@texi2html.cvshome.org> email list. - - -File: texi2html.info, Node: Obtaining texi2html, Next: Installation, Prev: Overview, Up: Top - -2 Obtaining `texi2html' -*********************** - -The latest version of the source code for `texi2html' should be -available from texi2html.cvshome.org (http://texi2html.cvshome.org). - - -File: texi2html.info, Node: Installation, Next: Invoking texi2html, Prev: Obtaining texi2html, Up: Top - -3 Installation of `texi2html' -***************************** - -To install `texi2html', you must first obtain a copy of the source -distribution. *Note Obtaining texi2html::. - - `texi2html' also requires `perl' version 5.004 or above. The -current version has not been tested extensively on versions of `perl' -below 5.6, however. - - `texi2html' is a standard Automake-based distribution. If you have -a source version, you should run `./configure' to regenerate the -executable `texi2html' file. `./configure' accepts options to select -the installation directory for the `texi2html' file, the default -directories `texi2html' will use to look for configuration files, and -other details. Run `./configure --help' for more information. - - Running `./configure' combines four files into the final `texi2html' -program file: - * `texi2html.pl' contains the base program, - - * `MySimple.pm' handles the command line options, - - * `texi2html.init' is the default configuration file, and - - * `T2h_i18n.pm' is used for internationalization. - - * `translations.pl' contains the translations of the strings used in - documents. - - Running `./configure' also builds the `make' configuration files -(`Makefile's). To make the documentation run `make'. - - `make install' performs the installation to the locations specified -to the `./configure' script. This usually involves placing the actual -`texi2html' file someplace in your path, such as `/usr/local/bin' or -`/usr/bin'. - - Installing `texi2html' in your path should be sufficient to run it. -To use default initialization files, or a configuration file for -LaTeX2HTML when using `latex2html' to convert `@tex' sections (*note -Expanding TeX regions::), install them in the package data directory -specified to configure. This is `/usr/local/share/texi2html/' by -default, but depends on the value of the `--pkgdatadir=DIR' option -passed to the `./configure' script. Files used for strings -customization and internationalization are also searched for in the -`i18n' directory of this directory. *Note Using init files:: for more. - - -File: texi2html.info, Node: Invoking texi2html, Next: Initialization files, Prev: Installation, Up: Top - -4 Invoking `texi2html' -********************** - -To produce an HTML manual, run `texi2html' with a Texinfo file as an -argument. For example, this manual is created with: - - $ texi2html texi2html.texi - - The behaviour of `texi2html' may be changed with command line -options. These command line options are always associated with -corresponding `perl' variables which may appear in init files, and these -variables are presented in this chapter each time a switch is described. - - Boolean command line switches always have a corresponding negated -switch, obtained by prepending `no' or `no-' to the switch name. For -example `--nomenu' does the reverse of `--menu'. - -* Menu: - -* Splitting output:: The HTML output may be split at - different levels -* Output files:: -* Expansion:: -* Texinfo related options:: -* Page layout options:: Customizing page layout -* Style options:: Customizing the HTML and text style -* Expanding TeX regions:: -* Using init files:: Specifying initialization files for fine tuning - - -File: texi2html.info, Node: Splitting output, Next: Output files, Up: Invoking texi2html - -4.1 Specifying where to split the generated document -==================================================== - -The HTML manual resulting from the processing of the Texinfo source may -be split into files at different levels. This is specified with the -option `--split' which takes an argument, namely the level of splitting -(variable: `$SPLIT'). This level may be: - -`chapter' - The document is split at `@chapter', `@appendix', or `@unnumbered'. - -`section' - The document is split at the same places as it is using the - `chapter' argument, and also at `@section', `@appendixsec' or - `@unnumberedsec'. - -`node' - The document is split at every sectioning command. It is not - necessarily split at each node, if the `@node' structure doesn't - correspond with the sectioning command structure (see below). - -`none' - The document isn't split. This is the default. - - There are two kinds of commands which may be used to define -sectioning elements in Texinfo: `@node' and the structuring commands -(`@top', `@section', `@appendixsubsec', 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 `@node Top' isn't -associated with a structuring command it also defines a sectioning -element. - - 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 `--use-nodes' -option (variable `$USE_NODES'). In this case, nodes not associated -with structuring commands are also considered to be sectioning commands -defining a sectioning element. - - This default behaviour mimics `texi2dvi' behaviour, which ignores -`@node' commands for the purprose of sectioning, while the second looks -like `makeinfo' behaviour (*note Two Paths: (texinfo)Two Paths.). - - As an illustration, the following table shows how a sample Texinfo -document is divided into sectioning elements when `--use-nodes' is used -and not: - -Texinfo code default case with - `--use-nodes' - @node node1 first element: first element: - @chapter node 1 - node1 text @node node1 @node node1 - @chapter node 1 @chapter node 1 - @node node2 node1 text node1 text - node2 text second - @node node2 element: - @node node3 node2 text - node3 text second @node node2 - @chapter node 3 element: node2 text - chapter text third - @node node3 element: - node3 text - @chapter node 3 @node node3 - chapter text node3 text - @chapter node 3 - chapter text - - -File: texi2html.info, Node: Output files, Next: Expansion, Prev: Splitting output, Up: Invoking texi2html - -4.2 Setting output file and directory names -=========================================== - -The manual name is constructed by stripping the `.texi', `.txi', -`.texinfo', or `.txinfo' extension from the Texinfo file name. - - By default, `texi2html' generates the manual file in the current -directory if the manual isn't split. A `.html' file extension is -appended to the manual name. - - 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 nothing -appended. The files containing special elements pages have an -underscore and a 3 letter code corresponding to their content (`toc' -for table of contents, `abt' for about, `ovr' for overview) appended. -Lastly, an `.html' file extension is appended. - - Thus, if the texinfo file `afile.texi' is processed and split at -chapters into 3 files, the generated files (in directory `afile') will -be: - - afile.html --> `@node Top' or `@top' section - afile_1.html --> Chapter 1 - afile_2.html --> Chapter 2 - afile_toc.html --> Table of Contents - afile_abt.html --> About Page - - 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 `--output' command line option (variable `$OUT'). If -the output is split, and `--output' is set, the files are placed in the -directory specified by the argument to the option. - - The basename may be overridden with `--prefix' (variable `$PREFIX'). -If `--short-ext' is given, `.htm' is appended instead of `.html' in -the final step (variable `$SHORTEXTN'). The `--top-file' option -overrides the top element file name (variable `$TOP_FILE'). This can -be used to name the top element file `index.html'. Similarly, `--toc-file' -changes the name of the table of contents file (variable `$TOC_FILE'). - - Reusing the example above, but this time calling `texi2html' like so: - - $ texi2html -split chapter -prefix manual -short-ext -top-file index.htm -toc-file contents.htm afile.texi - - we get, in `manual': - - index.htm --> `@node Top' or `@top' section - manual_1.htm --> Chapter 1 - manual_2.htm --> Chapter 2 - contents.htm --> Table of Contents - manual_abt.htm --> About Page - - The file names generated by `texi2html' differ from those generated -by `makeinfo'. `makeinfo' uses the node name to construct the file -names while splitting at nodes. It is possible to get the same -behaviour out of `texi2html' by specifying the `--node-files' option -(variable `$NODE_FILES'). If the output isn't split at nodes, -`texi2html' will still output files named after the nodes, without real -content but redirecting to the right file. The default is false for -this option. This trick enables the generated HTML manual to be a -target for the cross-references of other manuals generated by -`makeinfo' or `texi2html'. - - -File: texi2html.info, Node: Expansion, Next: Texinfo related options, Prev: Output files, Up: Invoking texi2html - -4.3 Specifying which regions get expanded -========================================= - -The default for `texi2html' is to expand the `@ifhtml', `@html', and -`@menu' regions, all the `@ifnot' regions except `@ifnothtml', and no -other `@if' regions. - - It is possible to expand other regions by setting `--if<region>', -where `<region>' is replaced by the literal name of the region (for -example, `--iftex'). Symetrically, if `--no-if<region>' is specified, -the `<region>' region is ignored. The configuration file array, `@EXPAND', -holds the names of regions which should be expanded. The only region -name present in `@EXPAND' in the default case is `html'. - - If `--nomenu' is set, the `@menu' sections are not expanded -(variable `$SHOW_MENU'). The default is to expand `@menu' sections. - - -File: texi2html.info, Node: Texinfo related options, Next: Page layout options, Prev: Expansion, Up: Invoking texi2html - -4.4 Command line options related to Texinfo language features -============================================================= - -Miscalleneous Texinfo related things may be specified via command line -options. - -`--lang=LANG' - Sets the document language similar to the Texinfo directive, - `@documentlanguage LANG' (variable `$LANG'). The default is `en', - that is, use the english language strings. - -`-DVAR' - Sets VAR. Equivalent to, `@set VAR 1', in Texinfo. - -`-UVAR' - Clears VAR. Equivalent to, `@clear VAR', in Texinfo. - -`-PDIR' - Prepend DIR to the list of directories to search for `@include' - files (the associated array is `@PREPEND_DIRS', empty in the - default case). - -`-IDIR' - Append DIR to the list of directories to search for `@include' - files (the associated array is `@INCLUDE_DIRS', empty in the - default case). - - The include files are always searched for in the current directory. - - -File: texi2html.info, Node: Page layout options, Next: Style options, Prev: Texinfo related options, Up: Invoking texi2html - -4.5 Page layout related command line options -============================================ - -If the `--frames' option is specified, HTML 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 `$FRAMES'). The default is not to use frames. - - It is also possible to suppress the section navigation panel with `--nosec-nav' -(variable `$SECTION_NAVIGATION', 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 or -on a separate page with `--separated-footnotes' (variable `$SEPARATED_FOOTNOTES'). -The default is to have separated footnotes. - - -File: texi2html.info, Node: Style options, Next: Expanding TeX regions, Prev: Page layout options, Up: Invoking texi2html - -4.6 Customizing the HTML and text style -======================================= - -Miscalleneous style changes may be achieved with command line options. - -`--doctype=DTD' -`--frameset-doctype=DTD' - You can specify the document DTD by setting these options. `--frameset-doctype' - applies to the file describing the frames when frames are used - (corresponding variables are `$DOCTYPE' and `$FRAMESET_DOCTYPE'). - - The default for the document doctype is: - <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html401/loose.dtd"> - And for the frameset doctype: - <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html401/frameset.dtd"> - -`--iso' - If this option is set, ISO8859 entities are used for some special - symbols, like Copyright (C) (variable `$USE_ISO'). It is the - default. - -`--css-include=FILE' - This command line switch provides for the inclusion of an external - Cascading Style Sheet (CSS) file. More than one file may be - specified, and `-' stands for the standard input (array `@CSS_FILES'). - - The option use is the same than for `makeinfo' and is described - extensively in *Note HTML CSS: (texinfo)HTML CSS. Briefly, the - CSS `@import' lines from the external file CSS file are pasted - before the `texi2html' CSS rules, and the external file CSS rules - are pasted after the `texi2html' CSS rules. - -`--html-xref-prefix=PATH' - This option sets the base directory for external HTML texinfo - manuals (variable `$EXTERNAL_DIR'). Defaults to `../'. - -`--def-table' - If this option is set, HTML tables are used to format definition - commands, rather than HTML definition tables (variable `$DEF_TABLE'). - Default is false. - -`--short-ref' - If this option is set, cross-references are given without section - numbers (variable `$SHORT_REF'). Default is false. - -`--number' - If this option is set, sections are numbered (variable `$NUMBER_SECTIONS'). - This is the default. - -`--toc-links' - If this option is set, links from headings to TOC entries are - created (variable `$TOC_LINKS'). Default is false. - - -File: texi2html.info, Node: Expanding TeX regions, Next: Using init files, Prev: Style options, Up: Invoking texi2html - -4.7 Expanding `@tex' and `@math' regions using LaTeX2HTML -========================================================= - -It is possible to use LaTeX2HTML (http://www.latex2html.org/) to -process `@tex' regions and `@math{}' commands. This is an attractive -way to display mathematical constructs in the HTML manual. The `--l2h' -option activates this feature (variable $L2H). It is usually desirable -to expand `@tex' sections when this option is specified (*note -Expansion::). The default is not to use this feature. - - The `--l2h-l2h=PROGRAM' option enables changing the name/location of -the LaTeX2HTML program processing TeX regions (variable `$L2H_L2H'). -The default is `latex2html'. - - `--l2h-tmp' sets the directory used for temporary files, this name -shouldn't contain a dot `.' (variable is `$L2H_TMP'). Defaults to the -current dir. - - The file specified by `--l2h-file' is used as LaTeX2HTML init file. -It is searched at the same places than init files (*note Using init -files::), and the default is `l2h.init'. - - -File: texi2html.info, Node: Using init files, Prev: Expanding TeX regions, Up: Invoking texi2html - -4.8 Use initialization files for fine tuning -============================================ - -Initialization variables are read first from -`/usr/local/share/texi2html/Config' (the exact location being -changeable with the `--pkgdatadir=dir' option of the `configure' -script, see *Note Installation::), `/usr/local/etc/texi2html/Config' -(the exact location being changeable with the `--sysconfdir=dir' option -of the `configure' script, see *Note Installation::), from `./Config' -then from `$HOME/.texi2html/Config'. Any command-line option can -override the corresponding option set in init file, and the option `--init-file' -specifies an init file to be loaded, with later settings overriding -earlier ones. - - The init files specified with `--init-file' are searched first in -the current directory, then in the `$HOME/.texi2html/' directory, in -the `/usr/local/etc/texi2html/' directory and lastly in the -`/usr/local/share/texi2html/' directory. - - A file is also included based on the language selected, by `$LANG', `--lang' -or `@documentlanguage'. If no language was selected `en' is considered -to be the language. All the files with name the language name in -`/usr/local/share/texi2html/i18n/', `/usr/local/etc/texi2html/i18n/', -`$HOME/.texi2html/i18n/' and then `./i18n/' are included. - - The default initialization options are defined in the -`texi2html.init' file contained in the `texi2html' distribution (which -gets included near the beginning of the `texi2html' script that gets -installed). - - To customize `texi2html' it is best if you copy the appropriate -sections from the `texi2html.init' contents into an appropriate local -initialization file, make the necessary changes there, and then have -`texi2html' read this initialization file by one of the means described -above. - - -File: texi2html.info, Node: Initialization files, Next: Changing the page layout, Prev: Invoking texi2html, Up: Top - -5 Overview of initialization files content and loading -****************************************************** - -The initialization files are `perl' files, read as explained in *Note -Using init files::. You don't need to know much of `perl' 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 `perl' is required. - - 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 HTML manual. You should be able to change the value of some normal -variables without a deep knowledge of `perl', by looking at the -existing examples. The possible mistakes in that case could be omitted -`;', and bad quoting. - - Initialization file are loaded from the main program by the mean of -a `require', while in the `Texi2HTML::Config' namespace. This means -that the namespace of the main program and the namespace of -inititalization files are distinct, which ensures that no name clash -should happen. The variables are declared with the `our' specifier, -such that it should be possible to use the `use strict' pragma in the -initialization file code. - - To avoid messing with the variables in the `main' namespace all the -global variables which could be of use in the init files are in the -`Texi2HTML' namespace. Notice that the functions of the main program -are still in the `main' namespace. - -* Menu: - -* Redefining functions:: Function redefinition is achieved with - redefinition of references on functions. -* Function prototypes:: Conventions used in that manual for function - reference prototypes display. - - -File: texi2html.info, Node: Redefining functions, Next: Function prototypes, Up: Initialization files - -5.1 Redefining functions in initialization files -================================================ - -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 -`Texi2HTML::Config' 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. - - For example the function reference corresponding with the function -called when doing an anchor is called `$anchor'. Thus if you want to -override the corresponding function you could write: - - # 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 - } - - -File: texi2html.info, Node: Function prototypes, Prev: Redefining functions, Up: Initialization files - -5.2 Conventions used for function prototypes -============================================ - -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 `\@array' for a reference on an array and similarly -`\%hash' for a reference on a hash. - - Thus, the prototype for the function associated with the function -reference `$formatting_function' will be: - - -- Function Reference: $text formatting_function $arg1 \@arg2 - `formatting_function' takes as first argument $ARG2, as second - argument a reference on an array \@ARG2 and returns the formatted - text $TEXT. - - To redefined the corresponding function, you should write: - - $formatting_function = \&my_formatting_function - - sub my_formatting_function($ $) - { - my $arg1 = shift; - my $arg2 = shift; - # prepare $formatted_text - ..... - return $formatted_text - } - - -File: texi2html.info, Node: Changing the page layout, Next: Customizing HTML, Prev: Initialization files, Up: Top - -6 Fine tuning of the page layout -******************************** - -Some features of the page layout might be specified with command line -options, the corresponding variables are described in *Note Page layout -options::. Fine tuning of the page layout may be achieved with -redefinition of other variables and function references in the -initialization files. - -* Menu: - -* The different pages:: The different categories of pages. -* The page layout:: The elements of a page. -* Navigation panel:: How to change the navigation panel. -* Program variables:: The available main program variables and some - usefull functions from the main program. -* Output initialization:: Setting variables before the document - production but after the texinfo parsing. -* Output finalization:: Cleaning after document generation. -* css:: Customizing css lines. -* Customizing header:: -* Customizing section:: -* Customizing footer:: -* Special pages:: Customizing table of contents, top, about page. -* File names:: Customizing the file names. -* External index files:: Putting index entries in external files. - - -File: texi2html.info, Node: The different pages, Next: The page layout, Up: Changing the page layout - -6.1 The different categories of pages and sectioning elements -============================================================= - -The following sectioning elements can be associated with pages: - -_Normal elements_ - These are normal sections or nodes. Their association with pages is - determined by the splitting of the document. *Note Splitting - output::. - -_Top element_ - The top element is the higher element in the document structure. - If there is a `@top' section it is the element associated with - that section. Otherwise it is the element associated with the - `@node Top'. If there is no `@node Top' the first element is the - top element. - - The top element is formatted differently than a normal element if - there is a `@top' section or the `@node Top' isn't associated with - a sectioning command. - -_Misc elements_ - These elements are associated with pages if the document is split. - There are four misc elements: - 1. Table of contents - - 2. Short table of contents, also called Overview - - 3. Footnotes page - - 4. About page - - The _About page_ shouldn't be present for documents consisting in - only one sectioning element. The _Footnote page_ should only be - present if the footnotes appear on a separated page (*note Page - layout options::), however a footnote element is present if the - document isn't split. The _Table of contents_ should only be - formatted if `@contents' is present in the document. Similarly - the _Overview_ should only appear if `@shortcontents' or - `@summarycontents' is present. - - -File: texi2html.info, Node: The page layout, Next: Navigation panel, Prev: The different pages, Up: Changing the page layout - -6.2 Page layout and navigation panel overview -============================================= - -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 `$SMALL_RULE', `$DEFAULT_RULE', `$MIDDLE_RULE' -and `$BIG_RULE' for rules of different sizes. The defaults are - $SMALL_RULE = '<hr size="1">'; - $DEFAULT_RULE = '<hr>'; - $MIDDLE_RULE = '<hr size="2">'; - $BIG_RULE = '<hr size="6">'; - - 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 HTML, -though. - - 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. - -Element labels --------------- - -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 (`@chapter', `@unnumbered'...) or by the nodes (in -that case the node directions are specified on node line or in menu -organization). These items are called "element labels". They may be -associated with a button (*note Button specifications::), and used in -the formatting functions (*note Program variables::). - - Here is the list: - -_` '_ - An empty button - -_Top_ - Top element. The associated name is `$TOP_HEADING' if that - variable is defined. This variable is not set by default. - -_Contents_ - Table of contents - -_About_ - About (help) page - -_Overview_ - Overview, short table of contents - -_First_ - First element in reading order - -_Last_ - Last element in reading order - -_Index_ - The first chapter with `@printindex'. The associated name is `$INDEX_CHAPTER', - if the variable is set. This variable is not set by default. - -_This_ - The current element - -_Back_ - Preceding element in reading order - -_FastBack_ - Beginning of this chapter or previous chapter if the element is a - chapter - -_Prev_ - Previous section on the same level - -_NodePrev_ - Previous node - -_Forward_ - Next element in reading order - -_FastForward_ - Next chapter - -_Next_ - Next section on the same level - -_NodeNext_ - Next node - -_Following_ - Next node in node reading order - -_Up_ - Up section - -_NodeUp_ - Up node - - -File: texi2html.info, Node: Navigation panel, Next: Program variables, Prev: The page layout, Up: Changing the page layout - -6.3 Customization of the navigation panels buttons -================================================== - -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. - -* Menu: - -* General purpose variables:: Variables controlling the navigation panel - at a global level -* Button specifications:: -* Panel formatting function:: - - -File: texi2html.info, Node: General purpose variables, Next: Button specifications, Up: Navigation panel - -6.3.1 Controlling the navigation panel panel at a high level ------------------------------------------------------------- - -The global formatting of the navigation panels may be changed with the -following variables: - -`$VERTICAL_HEAD_NAVIGATION' - A vertical navigation panel will be used for the header navigation - panel if this variable is true. - -`$ICONS' - Icons are used instead of textual buttons if this variable is true. - -`$SECTION_NAVIGATION' - 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 (*note Page layout options::). - - -File: texi2html.info, Node: Button specifications, Next: Panel formatting function, Prev: General purpose variables, Up: Navigation panel - -6.3.2 Specifying the buttons formatting ---------------------------------------- - -Several arrays and hashes enable a precise control on the buttons and -their display. The following arrays determine the buttons present in -navigation panels: - -`@SECTION_BUTTONS' - 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. - -`@SECTION_FOOTER_BUTTONS' -`@NODE_FOOTER_BUTTONS' - This array is used for the navigation panel buttons present at the - footer of pages when split at node or at section. - - If `$WORDS_IN_PAGE' is set and the output is split at nodes, these - buttons are only present if there are more than `$WORDS_IN_PAGE' - 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. - -`@CHAPTER_BUTTONS' - 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. - -`@MISC_BUTTONS' - These buttons appear at the beginning of special and sections and - at the end of these section pages if the output is split. - - 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: - -_reference on a function_ - The function is called with first argument a filehandle reference - on the current file and second argument a boolean true if the - navigation panel should be vertical. - -_reference on a scalar_ - The scalar value is printed. For some possibly usefull scalars, - *Note Elements hashes::. - -_reference on an array_ - 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. - - For example if the buttons array element is - [ 'Next', \$Texi2HTML::NODE{Next} ] - - The button will be a link to the next section with text `$Texi2HTML::NODE{Next}'. - -_element label_ - 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 `%NAVIGATION_TEXT' hash, surrounded by `[' - and `]'. If the element label is ` ', there is no `[' and `]'. - The element of the `%NAVIGATION_TEXT' hash are defined - dynamically, in the `init_out' function reference (*note Output - initialization::). - - If icons are used, the button is an image with file determined by - the value associated with the element label in the `%ACTIVE_ICONS' - hash if the the link really leads to an element, or in the `%PASSIVE_ICONS' - 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. - - -File: texi2html.info, Node: Panel formatting function, Prev: Button specifications, Up: Navigation panel - -6.3.3 Changing the navigation panel formatting ----------------------------------------------- - -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: - - -- Function Reference: print_navigation $filehandle \@buttons $vertical - $FILEHANDLE is the opened filehandle the function should write to. - \@BUTTONS is an array reference which should hold the - specification of the buttons for that navigation panel. $VERTICAL - is true if the navigation panel should be vertical. - - -File: texi2html.info, Node: Program variables, Next: Output initialization, Prev: Navigation panel, Up: Changing the page layout - -6.4 Main program variables and usefull functions -================================================ - -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. - -* Menu: - -* Elements hashes:: Accessing information related with the - different elements -* Global informations:: Accessing global informations, like date, - title... -* Global functions:: main program usefull functions - - -File: texi2html.info, Node: Elements hashes, Next: Global informations, Up: Program variables - -6.4.1 Accessing elements informations -------------------------------------- - -Four hashes are available, with key the elements labels (as described -in *Note Element labels::) and values: - -`%Texi2HTML::NAME' - The formatted element name - -`%Texi2HTML::HREF' - The element hypertext reference - -`%Texi2HTML::NODE' - The element node name - -`%Texi2HTML::NO_TEXI' - The element name after removal of texi commands - - -File: texi2html.info, Node: Global informations, Next: Global functions, Prev: Elements hashes, Up: Program variables - -6.4.2 Accessing global informations ------------------------------------ - -Three kinds of global informations are available, miscalleneous global -strings, flags set by `@set' and special flags and section lines. - -Global strings -.............. - -The `%Texi2HTML::THISDOC' hash holds some global informations: - -`fulltitle' - title set by `@title'. If there is no `@title' other possibilities - are tried (`@settitle', `@shorttitlepage'...). - -`title' - title set by `@settitle', or `fulltitle'. - -`title_no_texi' - title without texi formatting - -`title_texi' - title with texi commands - -`author' - Authors list set by `@author'. - -`authors' - A reference on an array containing each author set by `@author'. - -`copying' - Text appearing in `@copying' with all the texinfo commands removed, - put in comments. - -`program' - The name and version of `texi2html'. - -`program_homepage' - Homepage for `texi2html'. - -`program_authors' - Authors of `texi2html'. - -`file_base_name' - base name of the texinfo manual file. - -`destination_directory' - Destination directory for the resulting files. - -`toc_file' - The file name of the table of contents. - -`today' - The date. - - 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. - -Flags -..... - -Flags defined by `@set' may be accessed through the `%main::value' -hash. The key is the flag name, the value is the flag value at the end -of the document. - - Special flags are set by the main program. They correspond with a -texinfo command, like `@setfilename', or `@settitle', `@author'... The -corresponding flag is the command name with `_' appended, for example, -`_titlefont' corresponds with `@titlefont'. Like other flags they are -available in `%main::value'. - -Section lines -............. - -The following array references or arrays holds formatted lines: - -`$Texi2HTML::THIS_SECTION' - Lines of the current element. - -`$Texi2HTML::THIS_HEADER' - Lines of the current element appearing before the element label - (anchors). - -`$Texi2HTML::OVERVIEW' - Lines of short table of contents. *Note Special pages::. - -`$Texi2HTML::TOC_LINES' - Lines of table of contents. *Note Special pages::. - - -File: texi2html.info, Node: Global functions, Prev: Global informations, Up: Program variables - -6.4.3 Function usefull in page formatting ------------------------------------------ - -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. - - -- Function: $words_number main::print_lines $filehandle \@lines_array - $FILEHANDLE is the opened filehandle the function should write to. - \@LINES_ARRAY is the array line the function should write to the - file. If this argument is omitted, the function uses `$Texi2HTML::THIS_SECTION'. - $WORDS_NUMBER is the number of words in the array, only defined if - split at nodes and `$WORDS_IN_PAGE' is defined. - - -File: texi2html.info, Node: Output initialization, Next: Output finalization, Prev: Program variables, Up: Changing the page layout - -6.5 Preparing the output -======================== - -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 `@set' or `@setfilename' and other similar @-commands are not -known before the texinfo parsing. - - The following function reference may be redefined to be called after -texinfo processing and before document generation: - - -- Function Reference: $encoding init_out - This function perform the initialization of variables and any other - task before document outputting. It returns the encoding used for - the output files. - - In the default case the `$BODYTEXT' (*note Customizing header::) and -the hashes `%NAVIGATION_TEXT' (*note Button specifications::) and `%BUTTONS_GOTO' -(*note About text::) are initialized. - - 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) : - - my $default_init_out = $init_out; - $init_out = \&makeinfo_like_init_out; - sub makeinfo_like_init_out() - { - my $encoding = &$default_init_out(); - $NAVIGATION_TEXT{'Following'} = ' > '; - return $encoding; - } - - -File: texi2html.info, Node: Output finalization, Next: css, Prev: Output initialization, Up: Changing the page layout - -6.6 Finalizing the output -========================= - -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: - - -- Function Reference: finish_out - This function is called after the document generation. - - The default is to do nothing. - - -File: texi2html.info, Node: css, Next: Customizing header, Prev: Output finalization, Up: Changing the page layout - -6.7 Customizing the `texi2html' css lines -========================================= - -It is possible to modify the `texi2html' css lines by modifying the -entries or adding to the `%css_map' hash. Each key is a css selector, -the corresponding value is a style string. - - The whole css text is in the variable `$CSS_LINES'. If this variable -is defined the variable value is used instead of being constructed -using the `%css_map' entries. For example if you don't want any css -entries, set - - $CSS_LINES = ''; - - It is also possible to change completely the way `$CSS_LINES' are -generated by redefining the following function reference: - - -- Function Reference: css_lines \@import_lines \@rule_lines - This function should be used to construct the `$CSS_LINES'. - \@IMPORT_LINES are the `@import' lines of the files specified with `--include-css', - and \@RULE_LINES are the css commands lines of these files. *Note - Style options::. - - -File: texi2html.info, Node: Customizing header, Next: Customizing section, Prev: css, Up: Changing the page layout - -6.8 Customizing the page header -=============================== - -It is possible to add lines to the text within the `<head>' HTML -elements, by defining the variable `$EXTRA_HEAD'. Similarly it is -possible to add text just after the `<body>' element with the variable `$AFTER_BODY_OPEN'. -These variables are empty by default. - - The encoding of the texinfo file is defined by `$DOCUMENT_ENCODING' -if no `@documentencoding' appears in the document. The default is a -`en-ascii' encoding. The encoding of the resulting document is defined -by `$ENCODING'. The default is the `$DOCUMENT_ENCODING'. - - The description of the document may be specified in `$DOCUMENT_DESCRIPTION'. -If this variable is undef, the text associated with -`@documentdescription' 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 `<body>' element attributes may be set by defining the variable `$BODYTEXT'. -If you want to define that variable dynamically, you should use the -`init_out' function reference (*note Output initialization::). - - The default functions call the function associated with `$print_head_navigation' -to format the navigation panel for the page header. Thus you can -control parts of the formatting by redefining the function reference. - - -- Function Reference: print_head_navigation $filehandle \@buttons - $FILEHANDLE is the opened filehandle the function should write to. - \@BUTTONS is an array reference which should hold the - specification of the buttons for the navigation panel. - - 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 `$print_page_head' is called for all the -pages, and after that, the function associated with `$print_chapter_header' -is called if the document is split at chapters, or the function -associated with `$print_section_header' is called if the document is -split at sections. - - -- Function Reference: print_page_head $filehandle - $FILEHANDLE is the opened filehandle the function should write to. - This function should print the page head, including the `<body>' - element. - - -- Function Reference: print_chapter_header $filehandle - $FILEHANDLE is the opened filehandle the function should write to. - This function is called if the document is split at chapters, after - `print_page_head'. - - -- Function Reference: print_section_header $filehandle - $FILEHANDLE is the opened filehandle the function should write to. - This function is called if the document is split at sections, after - `print_page_head'. - - -File: texi2html.info, Node: Customizing section, Next: Customizing footer, Prev: Customizing header, Up: Changing the page layout - -6.9 Customizing the sections -============================ - -The functions associated with the following function references are -used for the formatting of sections: - - -- Function Reference: print_section $filehandle $first_in_page - $previous_is_top - $FILEHANDLE is the opened filehandle the function should write to. - $FIRST_IN_PAGE is true if this section is the first section in the - page. $PREVIOUS_IS_TOP is true if this section is the section - following the Top section. This function should print the current - section. - - -- Function Reference: end_section $filehandle - $last_element_or_before_top - $FILEHANDLE is the opened filehandle the function should write to. - $LAST_ELEMENT_OR_BEFORE_TOP is true if this section precedes the - top element or is the last one in page, or before the special - elements. - - -File: texi2html.info, Node: Customizing footer, Next: Special pages, Prev: Customizing section, Up: Changing the page layout - -6.10 Customizing the page footer -================================ - -It is possible to add text just before the `</body>' element with the -variable `$PRE_BODY_CLOSE'. Nothing is added by default. - - The default functions call the function associated with `$print_foot_navigation' -to format the navigation panel for the page footer. Thus you can -control parts of the formatting by redefining the function reference. - - -- Function Reference: print_foot_navigation $filehandle \@buttons - $FILEHANDLE is the opened filehandle the function should write to. - \@BUTTONS is an array reference which should hold the - specification of the buttons for the navigation panel. - - If you want even more control, you can have full control the page -footer formatting by redefining three function references. The -function associated with `$print_chapter_footer' is called if the -document is split at chapters, or the function associated with `$print_section_footer' -is called if the document is split at sections. After that the -function associated with `$print_page_foot' is called. - - -- Function Reference: print_page_foot $filehandle - $FILEHANDLE is the opened filehandle the function should write to. - This function should print the page foot, including the `</body>' - element. - - -- Function Reference: print_chapter_footer $filehandle - $FILEHANDLE is the opened filehandle the function should write to. - This function is called if the document is split at chapters, - before `print_page_foot'. - - -- Function Reference: print_section_footer $filehandle - $FILEHANDLE is the opened filehandle the function should write to. - This function is called if the document is split at sections, - before `print_page_foot'. - - -File: texi2html.info, Node: Special pages, Next: File names, Prev: Customizing footer, Up: Changing the page layout - -6.11 Special pages formatting -============================= - -For the special elements, two things must be formatted: the content and -the page layout - -* Menu: - -* Special pages content:: -* Special pages layout:: - - -File: texi2html.info, Node: Special pages content, Next: Special pages layout, Up: Special pages - -6.11.1 Customizing the content of the special pages ---------------------------------------------------- - -* Menu: - -* Top element text:: -* Contents and Overview text:: -* Footnotes text:: -* About text:: - - -File: texi2html.info, Node: Top element text, Next: Contents and Overview text, Up: Special pages content - -6.11.1.1 Top element text formatting -.................................... - -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: - - -- Function Reference: print_Top_header $filehandle $begin_page - $FILEHANDLE is the opened filehandle the function should write to. - $BEGIN_PAGE 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. - - -- Function Reference: print_Top $filehandle $has_top_heading - $FILEHANDLE is the opened filehandle the function should write to. - $HAS_TOP_HEADING is true if there is a `@heading' command or - `@titlefont' command appearing in the Top element text. This - function should be used to format the Top element text and - navigation panel. - - -- Function Reference: print_Top_footer $filehandle $end_page - $FILEHANDLE is the opened filehandle the function should write to. - $END_PAGE is true if the element is the last in a page. This - function should end the Top element. - - -File: texi2html.info, Node: Contents and Overview text, Next: Footnotes text, Prev: Top element text, Up: Special pages content - -6.11.1.2 Table of contents and Short table of contents -...................................................... - -Several variables may be used to control the formatting of table of -contents and short table of contents: - -`$DO_CONTENTS' - If the variable is true a table of contents is done even if there - is no `@contents' command. - -`$DO_SCONTENTS' - If the variable is true a short table of contents is done even if - there is no `@summarycontents' command. - -`$BEFORE_OVERVIEW' - The variable value is inserted before the short table of contents - text. - -`$AFTER_OVERVIEW' - The variable value is inserted after the short table of contents - text. - -`$BEFORE_TOC_LINES' - The variable value is inserted before the table of contents text. - -`$AFTER_TOC_LINES' - The variable value is inserted after the table of contents text. - -`$TOC_LIST_STYLE' - This should contain a css style used for the list style if the - tables of content are formatted with a list. - -`$TOC_LIST_ATTRIBUTE' - This should contain an attribute text used for the list element if - the tables of content are formatted with a list. - - 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: - - -- Function Reference: toc_body \@elements - \@ELEMENTS 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: - - `top' - true if the element is the top element, - - `index_page' - true if the element is an index page added because of index - splitting, - - `toc_level' - 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... - - `tocid' - label used for reference linking to the element in table of - contents, - - `file' - the file containing the element, usefull to do href to that - file in case the document is split, - - `text' - text of the element, with section number, - - `name' - text of the element, without section number. - - This function doesn't return anything but should fill the array - corresponding with the `$Texi2HTML::TOC_LINES' and `$Texi2HTML::OVERVIEW' - references with the table of contents and short table of contents. - - - -File: texi2html.info, Node: Footnotes text, Next: About text, Prev: Contents and Overview text, Up: Special pages content - -6.11.1.3 Formatting of footnotes text -..................................... - -The footnotes text is allready formatting when `@footnote' commands are -expanded. *Note Footnotes::. - - -File: texi2html.info, Node: About text, Prev: Footnotes text, Up: Special pages content - -6.11.1.4 Formatting of about text -................................. - -The default about element contains an explaination of the buttons used -in the document (`@SECTION_BUTTONS', *Note Button specifications::) and -an example locating the buttons targets in an example. The formatting -of this text may be influenced by the following hashes and variables: - -`$PRE_ABOUT' -`$AFTER_ABOUT' - 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. - -`%BUTTONS_GOTO' - The keys of this hash are element labels (*note Element labels::). - 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 `init_out' function reference (*note Output - initialization::). - -`%BUTTONS_EXAMPLE' - The keys of this hash are element labels (*note Element - labels::). The value is the text associated with the element label - in the about example, typically a section number. - - - 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: - - -- Function Reference: $about_text print_about - This function should return the about text. - - -File: texi2html.info, Node: Special pages layout, Prev: Special pages content, Up: Special pages - -6.11.2 Customizing the layout of the special pages --------------------------------------------------- - -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: - -`print_Top' - -`print_Top_header' - -`print_Top_footer' - Formatting of top element page or section. It is also used for the - formatting of the top element text (*note Top element text::). - -`print_Toc' - Formatting of table of contents page or section - -`print_Overview' - Formatting of short table of contents page or section - -`print_About' - Formatting of about (help) page or section - -`print_Footnotes' - Formatting of footnotes section or page in case footnotes are on a - separated page or the document isn't split. - - In the default case, `$print_Top' calls `$print_Top_header' for the -header and `$print_Top_footer' for the footer of top element. All the -other function call `$print_misc' which in turn calls `$print_misc_header' -for the headers and `$print_misc_footer' for the footers. - - -File: texi2html.info, Node: File names, Next: External index files, Prev: Special pages, Up: Changing the page layout - -6.12 Customizing the file names -=============================== - -It is possible to specify the file names with more control than with the -command line options (*note Output files::). First the extension may -be overrided by the variable `$EXTENSION' value. Two function -references enable further customization. One is usefull in case `$NODE_FILES' -is true and it is used to customize the node file name itself and is -also used to produce a file name with a redirection leading to the node -file. - - -- Function Reference: ($node_file $redirection_node_file) -node_file_name $node - $NODE is a hash reference with the following interesting keys - (there are much more keys): - `texi' - The texinfo node name. - - `with_section' - True if associated with a section. - The result is the node file name $NODE_FILE, and the file - containing a redirection to the node $REDIRECTION_NODE_FILE. - - The other is usefull if `$NODE_FILES' isn't true. It is used to -customize the file associated with each element. - - -- Function Reference: $file element_file_name $element $is_top - $docu_name - $ELEMENT is a hash reference with the following interesting keys - (there are much more keys): - `texi' - The texinfo element name. - - `number' - The number associated with a section. - - `doc_nr' - A number incremented whenever a new file should begin, based - on how the document is split (*note Splitting output::). - - `text' - The element text. - - `name' - The element text without section number. - $IS_TOP is true if the element is considered as the top element. - $DOCU_NAME is the basename of the texinfo manual. The result is - the element file name. - - -File: texi2html.info, Node: External index files, Prev: File names, Up: Changing the page layout - -6.13 Generation of external files for index entries -=================================================== - -Within the document, `@printindex' commands are expanded as explained -in *Note Index list::. In case you want to do something special with -index entries, outside of the document, you should first set the -variable `$IDX_SUMMARY' 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 finalazation. - - -- Function Reference: index_summary_file_begin $index_name $is_printed - $INDEX_NAME is the two letters name for the index. This function - is called for each index appearing in the document, before - `index_summary_file_entry'. $IS_PRINTED is true if there is a - `@printindex' for that index. - - -- Function Reference: index_summary_file_entry $index_name - $entry_text $entry_reference $formatted_entry $texi_entry - $entry_element_reference $entry_element_header $is_printed - This function is called for each entry of an index. INDEX_NAME is - the name of the index. $ENTRY_TEXT is the entry in plain text, - $FORMATTED_ENTRY is the index entry formatted, $TEXI_ENTRY is the - entry with texinfo commands. $ENTRY_REFERENCE is the reference - placed at the index entry place, in the form `file#id'. - $ENTRY_ELEMENT_HEADER is the formatted header of the element - containing the index entry. ENTRY_ELEMENT_HEADER is the reference - to the beginning of the element containing the index entry, in the - form `file#id'. $IS_PRINTED is true if there is a `@printindex' - for that index. - - -- Function Reference: index_summary_file_end $index_name $is_printed - $INDEX_NAME is the two letters name for the index. This function - is called for each index appearing in the document, after - `index_summary_file_entry'. $IS_PRINTED is true if there is a - `@printindex' for that index. - - -File: texi2html.info, Node: Customizing HTML, Next: Internationalization, Prev: Changing the page layout, Up: Top - -7 Customizing HTML and text style in init files -*********************************************** - -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, *Note Style -options::. - - 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. - -* Menu: - -* Three contexts:: there are three different contexts for command - expansion: normal text, preformatted text and - strings. -* Commands without argument:: -* Style and accent commands:: -* Anchors images and spaces:: Formatting of `@anchor', `@image', `@sp', `@acronym', `@abbr' -* Text:: Some characters are processed specially -* Strings:: `texi2html' write some strings in the output - different for each languages -* References:: -* Alignement commands:: `@center', `@flushleft'... -* Paragraph and preformatted region:: -* Complex formats:: `@example', `@display'... -* Lists tables:: -* Definitions:: -* Headings:: -* Special regions:: `@verbatim', `@cartouche', `@quotation' -* Menus:: -* Indices:: -* Floats and lists of floats:: `@float' and `@listoffloats' -* Footnotes:: -* Other and unknown commands:: You can handle specifically other commands - - -File: texi2html.info, Node: Three contexts, Next: Commands without argument, Up: Customizing HTML - -7.1 Three contexts for expansions: preformatted, normal and string -================================================================== - -There are three contexts of interest, one is the normal context, the -other is a special context, called the "preformatted" 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 -`@display' or `@example' regions, and in menu comments (*note Menus::). -The preformatted regions are usually rendered in `<pre>' elements in -HTML. The string context occurs when rendering strings without -formatting elements, in comments or titles for example. - - -File: texi2html.info, Node: Commands without argument, Next: Style and accent commands, Prev: Three contexts, Up: Customizing HTML - -7.2 Customizing the formatting of commands without argument -=========================================================== - -This includes the commands whose name is a nonletter character like -`@@', the commands with lettered characters and braces but whose braces -should be empty, like `@TeX{}', or some commands associated with -accentted letters like `@AA{}'. If there happens to be something within -the braces, it is put after the command, thus - @TeX{something} - leads to the same than - @TeX{} something - - 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. - - The hashes are: -command type normal text preformatted text string -one nonlettered character `%simple_map' `%simple_map_pre' `%simple_map_texi' -nothing in braces `%things_map' `%pre_map' `%texi_map' - - To change the HTML resulting from these constructs, just change the -value. For example, if you want `­' to be outputted for `@-' in -normal and preformatted context, write in your init file: - - $simple_map{'-'} = '­'; - $simple_map_pre{'-'} = '­'; - - -File: texi2html.info, Node: Style and accent commands, Next: Anchors images and spaces, Prev: Commands without argument, Up: Customizing HTML - -7.3 Customizing accent, style and other simple commands -======================================================= - -The formatting of the HTML produced by style and indicatric commands -(`@tt', `@code', `@email', `@titlefont'), the accentuation related -commands taking argument (`@'', `@udotaccent', `@dotless') and -miscalleneous commands (`@email', `@verb', `@w', `@uref', `@math', -`@asis') is controlled by two hash in the default case, `%style_map' -for normal context, `%style_map_pre' for preformatted context and `%style_map_texi' -in string context. - - 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. - - Some remarks are in order: - - * The nonlettered accent commands which following character is - considered to be the argument (like in `@`a') should be keys of the - hash `%accent_map' hash, even if no value is associated. - - * `@math' is handled differently if LaTeX2HTML is used. - -* Menu: - -* Hash reference interface:: -* String interface:: -* Define your own interface:: - - -File: texi2html.info, Node: Hash reference interface, Next: String interface, Up: Style and accent commands - -7.3.1 An interface for commands formatting with a hash reference ----------------------------------------------------------------- - -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 - - $style_map{'command'} = { 'args' => ['code'], 'attribute' => 'code'}; - - the arguments for `@command' are interpreted as specified by the -values associated with the `args' key while the attribute associated -with that command is `code'. - - The following keys in the hashes associated with each command have -the following meaning: - -`args' - The value associated is a reference on an array. Each element of - the array defines how the arguments (separated by `,' in the - texinfo code) for the @-command should be formatted. The - possibilities are - `normal' - for normal text, - - `code' - for text with `---', `--', `''' and ```' kept as is, - - `keep' - if the texinfo should be kept as is, without interpretation - of the @-commands. - - For example, we have - $style_map{'email'}->{'args'} = ['code', 'normal']; - - because `---', `--', `''' and ```' should be kept as is in the - first argument of `@email'. - - The default is `['normal']'. - -`attribute' - If the associated value is a word, it is considered to be an HTML - element name, and the argument is enclosed between the element - opening and the element closing. For example, if the value is - `elem', the resulting HTML is `<elem>ARG</elem>'. - - 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 `elem class="elem"' leads to - `<elem class="elem">ARG</elem>'. - - This works only if there is only one argument. - -`begin' - The associated value is added in front of the text. - -`begin' - The associated value is added after the text. - -`quotes' - If the corresponding value is true, the result is enclosed in - quotes `$OPEN_QUOTE_SYMBOL' and `$CLOSE_QUOTE_SYMBOL', with - defaults ``' and `''. - -`function' - The corresponding value should be a function reference. The - corresponding function is called with the following arguments: - - `$command' - The @-command name - - `$args' - A reference on an array containing the arguments of the - @-command. - - `$style_stack' - A reference on an array containing the name of the @-commands - containing the @-command being formatted. - - `$state' - A reference on a hash containing a lot of informations about - the context of the @-command. - - `$line_nr' - An opaque structure containing the information about the line - number of the @-command. It can be used to call - `main::echo_error' or `main::echo_warning' with first - argument a message, and second argument `$line_nr'. - - -File: texi2html.info, Node: String interface, Next: Define your own interface, Prev: Hash reference interface, Up: Style and accent commands - -7.3.2 An interface for commands formatting with a string --------------------------------------------------------- - -The keys of the hashes are the command names. The value determine how -the command argument is formatted. If the value begins with `"', the -result is enclosed in quotes `$OPEN_QUOTE_SYMBOL' and `$CLOSE_QUOTE_SYMBOL', -with defaults ``' and `''. - - The command argument is allready formatted as HTML. The remaining -of the value text (or the value text if there were no `"') is -interpreted as follow: - - * If the text is empty the argument of the command is left as is. - - * If the text is a `&' followed by a name, like `&function', 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 `@foo' is `&my_func' and we have: - - sub my_func - { - my @args = split /,\s*/ $_[1]; - return "$_[0]: $args[0]" if ($args[1] = 1); - return "$args[0]"; - } - - The result of - @foo{truc, 1} - @foo{truc, bidule} - will be - foo: truc - truc - - * If the text is a word, it is considered to be an HTML element - name, and the argument is enclosed between the element opening and - the element closing. For example, if the value is `elem', the - resulting HTML is `<elem>ARG</elem>'. Similarly `"quoted' leads to - ``<quoted>ARG</quoted>''. - - * 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 `elem class="elem"' leads to - `<elem class="elem">ARG</elem>'. - - -File: texi2html.info, Node: Define your own interface, Prev: String interface, Up: Style and accent commands - -7.3.3 Defining the style and indicatric commands interface ----------------------------------------------------------- - -If you don't like this scheme, it is possible to change how those -commands are processed by redefining the following function reference: - - -- Function Reference: $resulting_text style $style $command $text - $args $no_close $no_open $line_nr $state $style_stack - $COMMAND is the @-command, $STYLE is the value associated with the - $COMMAND in the `%style_map', `%style_map_pre' or - `%style_map_texi' hashes. The $TEXT is the text appearing within - the @-command braces. ARGS 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 $ARG key as - described in *Note Reference hash args::). If $TEXT is split in - paragraphs each paragraph is passed through the function, and - $NO_CLOSE is true if it is not the last paragraph, while $NO_OPEN - is true if it is not the first paragraph. $LINE_NR is an opaque - structure containing the information about the line number of the - @-command. It can be used to call `main::echo_error' or - `main::echo_warning' with first argument a message, and second - argument `$line_nr'. $STATE is a reference on a hash containing a - lot of informations about the context of the @-command. - $STYLE_STACK is a reference on an array containing the name of the - @-commands containing the @-command being formatted. - - - -File: texi2html.info, Node: Anchors images and spaces, Next: Text, Prev: Style and accent commands, Up: Customizing HTML - -7.4 Formatting of special simple commands -========================================= - -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. - - The formatting of anchors is controlled by `$anchor', but the -function associated with the function reference does more, it is usefull -to produce a reference target or link. - - -- Function Reference: $anchor anchor $identifier $href $text - $attributes - If $IDENTIFIER is not empty, this value should be used to create a - target for links (typically associated with a name or id attribute - in HTML). The $HREF argument specifies a hpertextual reference - which should be used to link to a target. In case both - $IDENTIFIER and $HREF are given the text produced should be both - a target for $IDENTIFIER and a link to $HREF. $TEXT is the text - to be displayed. $ATTRIBUTES are additional attributes. It - should be reasonable to assume that the attributes are for a `<a>' - HTML element. - - The formatting of `@image' is controlled by: - - -- Function Reference: $image image $file_path $basename $preformatted - $file_name - $FILE_PATH is the image file name with the path, $BASENAME is the - alternate text or the file name without extension if no alternate - text is given. $PREFORMATTED is true if the image appears in - preformatted text. $FILE_NAME is the file name without path but - with extension. - - The formatting of `@sp' is controlled by: - - -- Function Reference: $sp sp $number $preformatted - $NUMBER is the numeric argument of `@sp'. $PREFORMATTED is true - if the `@sp' appears in preformatted text. - - The formatting of `@acronym' and `@abbr' is controlled by: - - -- Function Reference: $acronym acronym_like $acronym_texi - $acronym_text $with_explanation \@explanation_lines - $explanation_text $explanation_simply_formatted - $ACRONYM_TEXI is the acronym argument with texinfo @-commands, - $ACRONYM_TEXT is formatted. - - The other arguments are related with the explanation, the second - arg of the acronym. $WITH_EXPLANATION is true if the second - argument of the acronym command is present. If an explanation - exists, coming from previous `@acronym' or as an arg of this - command, the other args are defined: \@EXPLANATION_LINES is a - reference on an array containing the unformatted explanation lines, - $EXPLANATION_TEXT is the explanation text formatted, - $EXPLANATION_SIMPLY_FORMATTED is the explanation with a light - formatting, unabling in HTML (or XML) the explanation to be in an - attribute. - - -File: texi2html.info, Node: Text, Next: Strings, Prev: Anchors images and spaces, Up: Customizing HTML - -7.5 Processing special characters in text -========================================= - -Some characters are processed especially in text: `---', `--', ```' and -`'''. This is done only if in normal text and not in some commands -(`@code', `@env'...). A function reference is called to process those -characters in text - - -- Function Reference: $processed_text normal_text $text - The function processes `---', `--', ```' and `''' in $TEXT and - returns $PROCESSED_TEXT. The default is to change `---' to `--', - `--' to `-', and ```' and `''' to `"'. - - Some characters are special in HTML (`&', `"', `<' and `>') and -should be protected. This is done by the function associated with the -function reference - - -- Function Reference: $protected_text protect_text $text - The function processes the unprotected text $TEXT and returns the - resulting protected text $PROTECTED_TEXT. - - Empty lines are processed by the following function reference, which -could be usefull if empty lines are to be removed for example - - -- Function Reference: $resulting_text empty_line $empty_line - This function processes an $EMPTY_LINE and returns the resulting - text $RESULTING_TEXT. Empty lines are left as is by default. - - -File: texi2html.info, Node: Strings, Next: References, Prev: Text, Up: Customizing HTML - -7.6 Customizing strings written by `texi2html' -============================================== - -`texi2html' 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 `--lang', `$LANG' -or `@documentlanguage'). This is the basis for internationalization as -it allows for strings translations. - - The strings are found in a hash reference, `$LANGUAGES'. 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 - - $LANGUAGES->{'fr'} = { - ' Up ' => 'Plus haut', - }; - - It means that whenever the string ` Up ' is to be written and the -language is `fr', `Plus haut' is written. It is possible to customize -the english strings by redefining the `en' language hash. - - When a string contains a `%' followed by `{' NAME `}' it means that -the string will be expanded by `texi2html'. For example, if we have - - $LANGUAGES->{'fr'} = { - 'See %{node_file_href}' => 'Voir %{node_file_href}', - }; - - `%{node_file_href}' will be expanded to an href for a node in a file -by `texi2html' in the string. A `%%' will be expanded as `%'. - - For more on internationalization, see *Note Internationalization::. - - -File: texi2html.info, Node: References, Next: Alignement commands, Prev: Strings, Up: Customizing HTML - -7.7 References -============== - -* Menu: - -* Reference to external manual:: -* Internal reference:: - - -File: texi2html.info, Node: Reference to external manual, Next: Internal reference, Up: References - -7.7.1 Reference to external manual ----------------------------------- - -The references are produced with two function references, one for the -hypertextual reference construction, the other for the full reference to -external manual. - - -- Function Reference: $href external_href $node $node_identifier - $xml_node_identifier $manual_file_name - $NODE is the node name, with @-commands. $NODE_IDENTIFER is the - node name mapped to an identifier acceptable as a file name. - $XML_NODE_IDENTIFIER is the node name mapped to an identifier - acceptable as an XML identifier. Those identifiers are built as - explained in *Note HTML Xref: (texinfo)HTML Xref, thus allowing - for cross references to external manuals. $FILE is the manual or - file name of the external reference. This function should return an - href leading to the external manual. - - The default for this function is to make a reference compatible - with `makeinfo' (*note HTML Xref: (texinfo)HTML Xref.). - - -- Function Reference: $text external_ref $command $section $book - $node_and_file $href $cross_ref_name - This function formats a reference to an external texinfo manual. - The $COMMAND is the ref command (`ref', `xref' or `pxref', in - text, at sentence beginning or in parenthesis). The optionnal - $SECTION argument is the section in the book and BOOK is the book - title. $NODE_AND_FILE is the node and file name formatted - according to the convention used in info: `(file)node'. $HREF it - an hypertextual reference to the distant manual constructed using - the above function. $CROSS_REF_NAME is an optionnal cross - reference name appearing in the reference command. This function - returns the text corresponding with the external html manual - reference. This function returns the full formatted text of the - external reference. - - -File: texi2html.info, Node: Internal reference, Prev: Reference to external manual, Up: References - -7.7.2 Reference to an internal node ------------------------------------ - -A function reference is available for internal references. - - -- Function Reference: $text internal_ref $command $href $short_name - $name $is_section - This function formats a reference to a node in the current manual. - The $COMMAND is the ref command (`ref', `xref' or `pxref', in - text, at sentence beginning or in parenthesis). $HREF it an - hypertextual reference linking to the corresponding node or - section. $SHORT_NAME and $NAME hold the text for the reference but - $SHORT_NAME can be the node name which is assumed to be shorter - than the section name. $IS_SECTION is a boolean true if the - reference is a reference to a section. This function returns the - full formatted text of the internal reference. - - -File: texi2html.info, Node: Alignement commands, Next: Paragraph and preformatted region, Prev: References, Up: Customizing HTML - -7.8 Commands used for centering and flushing of text -==================================================== - -When a command controlling the alignement of text is used (`@center', -`@flushleft' and `@flushright'), the main program takes care of opening -and closing paragraphs. The alignement commands are the key of the `%paragraph_style' -hash. The value is used in the function doing the formatting of the -paragraphs. *Note Paragraph and preformatted region::. - - A function references allows for a customization of the formatting -of the text appearing in the command block. - - -- Function Reference: $result paragraph_style_command $command $text - $COMMAND is the command name, $TEXT is the text appearing within - the command. This function returns a formatted text. The default - is to return the text unmodified. - - -File: texi2html.info, Node: Paragraph and preformatted region, Next: Complex formats, Prev: Alignement commands, Up: Customizing HTML - -7.9 Formatting or not a paragraph or a preformatted region -========================================================== - -* Menu: - -* Paragraph and preformatted formatting:: -* Avoiding paragraphs:: - - -File: texi2html.info, Node: Paragraph and preformatted formatting, Next: Avoiding paragraphs, Up: Paragraph and preformatted region - -7.9.1 Paragraph and preformatted region formatting --------------------------------------------------- - -The formatting of a paragraph region or a preformatted region, is -controlled by function references: - - -- Function Reference: $paragraph_text paragraph $text $alignement - $formatting_command $formatting_command_formatted - \$paragraph_number $format $item_number $enumerate_style - $number - This function formats a paragraph. $TEXT is the text of the - paragraph, $ALIGNEMENT is the empty string when no alignement - command has been seen, otherwise it is the current alignement - command name. *Note Alignement commands::. - - 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 (`@itemize'...) may have - an associated formatting command. $FORMATTING_COMMAND is this - formatting command (like `@minus'). $FORMATTING_COMMAND_FORMATTED - is the command formatted in html in case the formatting command is - a leading command (like `@minus') which should be leading the - first paragraph. \$PARAGRAPH_NUMBER is a reference on the number - of paragraphs in that format command. The corresponding variable - should be increased when a paragraph is added. $FORMAT is the - format command. *Note Table and list items::. - - If the $FORMAT is an enumerate, $ITEM_NUMBER is the number of the - item in the list, $ENUMERATE_STYLE is the argument of the - enumerate, $NUMBER is the number or letter corresponding with this - item. - - -- Function Reference: $preformatted_text preformatted $text $style - $region_name $formatting_command - $formatting_command_formatted \$preformatted_number $format - $item_number $enumerate_style $number - This function formats a preformatted region. $TEXT is the text of - the preformatted region, $STYLE is the css style associated with - that preformatted region (*Note css::). $REGION_NAME is the name - of the command opening the preformatted region (`example'..., see - *Note Complex formats::) or a identifier for the preformatted - context (for example `menu-comment', see *Note Menus::). The - alignment commands are not taken into account, as the spaces are - preserved in preformatted regions, you should flush and center by - hand. - - 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 - (`@itemize'...) may have an associated formatting command. - $FORMATTING_COMMAND is this formatting command (like `@minus'). - $FORMATTING_COMMAND_FORMATTED is the command formatted in html in - case the formatting command is a leading command (like `@minus') - which should be leading the first preformatted region. - \$PREFORMATTED_NUMBER 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. $FORMAT is the - format command. *Note Table and list items::. - - If the $FORMAT is an enumerate, $ITEM_NUMBER is the number of the - item in the list, $ENUMERATE_STYLE is the argument of the - enumerate, $NUMBER is the number or letter corresponding with this - item. - - -File: texi2html.info, Node: Avoiding paragraphs, Prev: Paragraph and preformatted formatting, Up: Paragraph and preformatted region - -7.9.2 Avoiding paragraphs in formats ------------------------------------- - -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, `%format_in_paragraph' with a true value. - - -File: texi2html.info, Node: Complex formats, Next: Lists tables, Prev: Paragraph and preformatted region, Up: Customizing HTML - -7.10 Formatting of complex formats (`@example', `@display'...) -============================================================== - -Here we see how a whole complex format is formatted. For the formatting -of the text, see *Note Paragraph and preformatted region::. - - 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 `$complex_format_map'. It has a key for -each of the complex format commands (`example', `smallexample', `lisp', -`smalllisp', `display', `smalldisplay', `format', `smallformat'). - - The associated value is also a reference on a hash. The keys are -`begin' and `end'. An eval of `begin' should lead to the beginning of -the formatted HTML, an eval of `end' should lead to the end of the -formatted HTML. The enclosed text will be formatted as described in -*Note Paragraph and preformatted region::, and the name of the complex -format will be available to the function formatting the text. - - If you aren't satisfied with this scheme, you can redefine the -following function reference for a better control over the complex -format formatting: - - -- Function Reference: $complex_format_text complex_format - $format_name $preformatted_text - $FORMAT_NAME is the complex format name, $PREFORMATTED_TEXT is the - text allready formatted as described in *Note Paragraph and - preformatted region::. This function returns the whole complex - format. - - -File: texi2html.info, Node: Lists tables, Next: Definitions, Prev: Complex formats, Up: Customizing HTML - -7.11 Customizing the formatting of lists and tables -=================================================== - -The formatting of lists and tables is done at two levels: - * At the level of the whole region (table or list), - - * At the level of the individual items, rows or cells of the list or - table. - -* Menu: - -* Table and list items:: -* Whole table list:: - - -File: texi2html.info, Node: Table and list items, Next: Whole table list, Up: Lists tables - -7.11.1 Formatting individual table and list items -------------------------------------------------- - -In texinfo it is possible to give `@itemize' or table command (hereafter -called a "format command") a "formatting command". For example -`@minus' is the formatting command here: - @table @minus - - The default is to apply the command to the text item, however it is -possible to avoid it. The hash `%special_list_commands' 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: - - $special_list_commands{'itemize'} = { 'bullet' => '' }; - - and we have the following `@itemize': - @itemize @bullet - @item an item - @end itemize - - then `@bullet' will not be applied to `an item'. - -_lists_ - The items of lists are formatted using the following function - reference: - - -- Function Reference: $list_item list_item $text $format - $command $formatted_command $item_number - $enumerate_style $number - This function formats the text between `@item' commands. $TEXT - is the text corresponding with the item. $FORMAT is the type - of format, `itemize' or `enumerate'. $COMMAND is the - formatting command given in argument to `@itemize', - $FORMATTED_COMMAND is this command formatted if it is a - leading command, like `@minus'. - - If the $FORMAT is an enumerate, $ITEM_NUMBER is the number of - the item in the list, $ENUMERATE_STYLE is the argument of the - enumerate, $NUMBER is the number or letter corresponding with - this item. - -_two column tables_ - The two columns tables (`@table', `@ftable' and `@vtable'), items - are formatted using two function references, one for the first - line located on the `@item' line corresponding with the first - column, the other for the text appearing on the following lines, - corresponding with the second column text. - - -- Function Reference: $table_item table_item $item_text - $index_label_text $format $command $formatted_command - This function is used to format the text on the `@item' line. - $TEXT_ITEM is the text line. In case there is an index entry - associated with the `@item' (as with `@ftable' and - `@vtable'), $INDEX_LABEL_TEXT is the text inserted at the - place where an index entry appears. *Note Index entry place::. - $FORMAT is the type of format, `table', `ftable' or `vtable'. - $COMMAND is the formatting command given in argument to the - table format command, $FORMATTED_COMMAND is this command - formatted if it is a leading command, like `@minus'. - - -- Function Reference: $table_line table_line $text - This function is used to format the text on the lines - following the `@item' line. $TEXT is the corresponding text. - -_multitable_ - The multitable elements formatting is controlled by the functions - associated with two function references. One for a cell, and the - other for a row. - - -- Function Reference: $multitable_cell cell $text - This function is used to format the text of a multitable - cell, the text following a `@item' or a `@tab'. $TEXT is the - corresponding text. - - -- Function Reference: $multitable_row row $text $item_command - This function is used to format a multitable row. $TEXT is - the row text, with cells allready formatted with the `$cell' - function reference. $ITEM_COMMAND is the command used to - introduce the row, such that it is possible to distinguish - between `@item' and `@headitem'. - - -File: texi2html.info, Node: Whole table list, Prev: Table and list items, Up: Lists tables - -7.11.2 Formatting of a whole table or list ------------------------------------------- - -If the Texinfo command is a key of the `%format_map', the associated -value is used to specify the formatting of the construct, otherwise a -function is called. The value in `%format_map' associated with a -command is interpreted similarly with values associated with more -simpler commands: - - * If the text is a word, it is considered to be an HTML element - name, and the whole table or list is enclosed between the element - opening and the element closing. - - * 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. - - * If the text is empty nothing is added to the text. - - In case the `%format_map' isn't used, a function reference called -`$table_list' should be redefined, the associated function will be -called each time a command isn't found in `%format_map'. - - -- Function Reference: $whole_table_list table_list $command $text - $COMMAND is the Texinfo command name, $TEXT is the formatted items. - - If you still want to use `%format_map' but differently from the -default, it is possible to redefine the following function reference: - - -- Function Reference: $whole_table_list format $command $format $text - $COMMAND is the @-command, $FORMAT is the entry associated with - $COMMAND in `%format_map'. $TEXT is the formatted items. - - -File: texi2html.info, Node: Definitions, Next: Headings, Prev: Lists tables, Up: Customizing HTML - -7.12 Definition commands formatting -=================================== - -The formatting of definition commands is controlled by a hash and four -functions. The hash describes how the text on the definition line is -interpreted, the functions control the formatting of the definition line -and the definition function text. - -* Menu: - -* Definition line:: -* Definition formatting:: - - -File: texi2html.info, Node: Definition line, Next: Definition formatting, Up: Definitions - -7.12.1 Customizing the interpretation of a definition line ----------------------------------------------------------- - -The keys of the hash `%def_map' are definition command names. There -are two types of entries: - - * If the command is a shortcut for another definition command the - value is a text and the definition command is replaced by the text. - - For example if we have: - $def_map{'deftruc'} = '@defvr {A truc}'; - - and a line like - @deftruc var - - the line will be transformed in - @defvr {A truc} var - - * If the command isn't a shortcut, it is associated with an array - reference. The first element is `f', `v' or `t' corresponding with - the index type (`f' for function, `v' for variable, `t' for type). - - 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 `category', `name', - `type', `class' and `arg'. - - For example if we have - def_map{'defvr'} = [ 'v', 'category', 'name' ]; - - The first bracketed item following `@defvr' is considered to be - the category and the next one is the name. The index associated - with the definition line is the variables index. - - -File: texi2html.info, Node: Definition formatting, Prev: Definition line, Up: Definitions - -7.12.2 Customization of the definition formatting -------------------------------------------------- - -Four functions are used when formatting a definition command: - -category name - -- Function Reference: $category definition_category - $category_or_name $class $style - This function precise a category or an index entry name - associating a class $CLASS (if given) with $CATEGORY_OR_NAME. - The $STYLE of the definition may be `f', for function, `v', - for variable or `t', for type. - -formatting of the definition line - -- Function Reference: $line def_line $category $name $type - $arguments $index_label - This function formats the definition line. $CATEGORY is the - category formatted with `$definition_category', $NAME, $TYPE - and ARGUMENTS are the element of the definition line. - $INDEX_LABEL is the text inserted at the place where an index - entry appears. *Note Index entry place::. - -definition text - -- Function Reference: $definition_text def_item $text - This function formats the definition text, $TEXT. - -the whole definition - -- Function Reference: $definition def $text - This function formats the whole definition. The definition - line and text formatted by the above functions are in $TEXT. - - - -File: texi2html.info, Node: Headings, Next: Special regions, Prev: Definitions, Up: Customizing HTML - -7.13 Customizing headings formatting -==================================== - -A function controls the formatting of sectioning element headings, with -the corresponding function reference: - - -- Function Reference: $heading_text heading \%element_reference - The \%ELEMENT_REFERENCE is a reference on a hash corresponding - with the sectioning element. The following keys are of interest: - `text' - The heading text - - `name' - The heading text without section number - - `node' - true if the sectioning element is a node without associated - structuring command - - `level' - The level of the element in the document tree. `0' is for - `@top', `1' for `@chapter' and so on - - `tag_level' - the sectioning element name, with `@raisesections' and - `@lowersections' taken into account - - -File: texi2html.info, Node: Special regions, Next: Menus, Prev: Headings, Up: Customizing HTML - -7.14 Formatting of special regions (`@verbatim', `@cartouche', `@quotation') -============================================================================ - -Regions corresponding with raw text, like `@verbatim', `@html' or -`@tex' are formatted according to the following function reference: - - -- Function Reference: $raw_region raw $command $text - $COMMAND is the command name, $TEXT is the raw text. - - If LaTeX2HTML is used, `@tex' regions are handled differently, from -within the main program. - - The `@cartouche' command formatting is controlled by the function -reference: - - -- Function Reference: $cartouche cartouche $text - $TEXT is the text appearing within the cartouche. - - The formatting of `@quotation' is controlled by two function -references. The first one is usefull in case the `@quotation' has an -argument, as it allows to prepend a string to the quotation text: - - -- Function Reference: $prepended_string quotation_prepend_text $style - $text - $STYLE is the first argument of the `@quotation' if there are two - arguments. $TEXT is the second argument or the first if there is - one argument. There are still @-commands in these strings. This - function can return a string which will be prepended to the - quotation text. - - The whole quotation is formatted by: - - -- Function Reference: $quotation quotation $quotation_text - $argument_text $argument_style_texi $argument_style_id - $QUOTATION_TEXT is the quotation text, formatted, with the text - prepended by the function above. $ARGUMENT_TEXT is the second - argument of the `@quotation' or the first if there is one - argument, formatted. The other arguments are defiend if there are - two arguments for the `@quotation', $ARGUMENT_STYLE_TEXI is this - argument, with @-commands, and $ARGUMENT_STYLE_ID is this - argument transformed in an identifier which can be used as an XML - identifier. - - -File: texi2html.info, Node: Menus, Next: Indices, Prev: Special regions, Up: Customizing HTML - -7.15 Menu formatting -==================== - -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. - -* Menu: - -* Menu parts:: A menu consists in menu entry and menu - comments -* Menu formatting:: - - -File: texi2html.info, Node: Menu parts, Next: Menu formatting, Up: Menus - -7.15.1 The structure of a menu ------------------------------- - -In `texi2html', a menu is considered to be composed of 2 parts, the -"menu entries" and the "menu comments". Menu entries are further -divided in an "entry link" and optionnaly an "entry description". The -entry link consists in a node name and an optionnal menu entry name. - - A menu entry begins with `*' 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 some text begining at the first character -of a line or an empty line, not contained within a command block which -begun in the description. An empty line or a line with text at the -first character starts a menu comment, which spans until the next menu -entry. - - Here is an illustration of these rules: - - @menu - * node name: entry name. description begins - description continues - * another menu entry:: - description begins - description continues - - A menu comment, after an empty line - - * node:: description begins - A menu comment. The line starts at the first character - - * last entry:: description begins _text - of the description, even if the line begins at the first character, - because we are in @emph_. - @end menu - - -File: texi2html.info, Node: Menu formatting, Prev: Menu parts, Up: Menus - -7.15.2 The formatting of the different menu components ------------------------------------------------------- - -In the default case, the name of the section corresponding with the -node is used instead of the node name. If `$NODE_NAME_IN_MENU' is true, -however, node names are used. If `$AVOID_MENU_REDUNDANCY' 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. - - A symbol, `$MENU_SYMBOL' is put at the beginning of menu entries -when the node name is used. The default is `•'. If `$UNNUMBERED_SYMBOL_IN_MENU' -is true it is also put at the beginning of unnumbered section names. -This is not done by default. - - The menu comments are considered to be preformatted text. The style -associated with this preformatted text is determined by `$MENU_PRE_STYLE'. -Default is `font-family: serif'. The css class associated with menu -comments is `menu-comments'. - - Three function references are associated with the formatting of the -different parts of a menu: - - -- Function Reference: $link menu_link $section \%state $href $node - $name $ending - $SECTION is the section name corresponding with the link, $HREF is - the link hypertextual reference. $HREF may be absent. \%STATE - holds informations about the current context. The only key which - could be of interest is `preformatted', true if the context is a - preformatted context. *Note Three contexts::. $NODE is the node - name, $NAME is the name of the node, and $ENDING is the text - ending the link entry. - - -- Function Reference: $description menu_description $description_text - \%state - $DESCRIPTION_TEXT is the text of the menu description. \%STATE - should be used similarly than for the menu link. - - -- Function Reference: $menu_comment menu_comment $text - $TEXT is the text of the menu comment. It is in a preformatted - environment. - - The following function reference controls the formatting of a wole -menu: - - -- Function Reference: $menu menu $menu_components_text - $MENU_COMPONENTS_TEXT is the formatted menu components text, - obtained as explained above. - - The last function reference corresponds with a special case. It is -used when a menu entry appears within another block command, to avoid -the possibilities of invalid HTML production. In that case the menu -description and menu comments are not formatted specially, but treated -like normal text. - - -- Function Reference: $link simple_menu_link $link_text $href $node - $name $ending - $LINK_TEXT is the text corresponding with the link name, $HREF is - the link hypertextual reference. $NODE is the node name, $NAME is - the name of the node, and $ENDING is the text ending the link - entry. - - -File: texi2html.info, Node: Indices, Next: Floats and lists of floats, Prev: Menus, Up: Customizing HTML - -7.16 Indices formatting -======================= - -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 `@cindex' determines where index -entries appear, and the index list is printed with a `@printindex' -command. - -* Menu: - -* Index entry place:: Index entries in the main document are - targets for hypertext references -* Index list:: Customizing the formatting of the index list - - -File: texi2html.info, Node: Index entry place, Next: Index list, Up: Indices - -7.16.1 Formatting of index entries ----------------------------------- - -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: - - -- Function Reference: $target index_entry_label $identifier - $preformatted - $IDENTIFIER should be used to create a target for links (typically - associated with a name or id attribute in HTML). $PREFORMATTED is - true if the index entry appeared in preformatted text. - - -File: texi2html.info, Node: Index list, Prev: Index entry place, Up: Indices - -7.16.2 Customizing the formatting of index lists ------------------------------------------------- - -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. - - 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 `$SPLIT_INDEX' if set. The default is to -split indices after 100 entries. - - The formatting of all these elements is controlled by the following -function references: - -_formatting of a letter in a summary_ - -- Function Reference: $letter summary_letter $letter $file - $identifier - This function is used to format a letter appearing in a - summary, refering to a letter entry in the index list. - $LETTER is the letter. $FILE 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. - $IDENTIFIER is an identifier for the target letter entry. - -_formatting of a summary_ - -- Function Reference: $summary index_summary - \@alphabetical_letters \@nonalphabetical_letters - \@ALPHABETICAL_LETTERS and \@NONALPHABETICAL_LETTERS contain - the formatted summary letters, formatted with the above - function. - -_formatting of an index entry_ - -- Function Reference: $entry index_entry $entry_href $entry_text - $section_href $section_heading - $ENTRY_HREF is a reference to the place where the index entry - appeared, $ENTRY_TEXT is the corresponding text. $SECTION_HREF - is a reference to the beginning of the sectioning element - containing the index entry, $SECTION_HEADING is the heading - of the element. - -_formatting of letter entry_ - -- Function Reference: $letter_entry index_letter $letter - $identifier $index_entries_text - This function formats a letter entry, consisting in all the - index entries beginning with this letter. $LETTER is the - letter, $IDENTIFIER should be used to create a target for - links (typically links from summaries), and - $INDEX_ENTRIES_TEXT is the text of the index entries - formatted as described above. - -_formatting of whole index_ - -- Function Reference: $index print_index $index_text $index_name - $INDEX_TEXT is the text of all the index entries grouped by - letter appearing in that page formatted as above. INDEX_NAME - is the name of the index, the argument of `@printindex'. - - -File: texi2html.info, Node: Floats and lists of floats, Next: Footnotes, Prev: Indices, Up: Customizing HTML - -7.17 Floats and lists of floats -=============================== - -Floats appear in the `@float' environment, optionaly with a style and a -label, and with optionnal `@caption' and `@shortcaption'. Their list -appear after a `@listoffloats'. - - A hash reference is associated with each float, it is available in -some formatting functions. The keys are: -`caption_texi' -`shortcaption_texi' - A reference on an array containing the caption or shortcaption - lines, unformatted. - -`style_texi' - The style with texi @-commands. - -`style_id' - The unique identifier associated with the style. - -`nr' - 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). - -`chapter_nr' - The number of the chapter containing the float. - -`nr_in_chapter' - The number of the float in the chapter. - -`absolut_nr' - The number of the float in the document. - -`texi' - The label with @-commands. - -`id' - The unique identifier associated with the label. Usefull to make - an anchor or a reference. - -`element' - A reference on a structure representing the element the float - appear in. - -* Menu: - -* Floats:: Formatting of floats -* Lists of floats:: Formatting the lists of floats - - -File: texi2html.info, Node: Floats, Next: Lists of floats, Up: Floats and lists of floats - -7.17.1 Formatting a float -------------------------- - -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: - - -- Function Reference: (\@caption_lines_returned, -\@shortcaption_lines_returned) caption_shortcaption \%float - \@caption_lines \@shortcaption_lines - \%FLOAT is the structure defined above. \@CAPTION_LINES and - \@SHORTCAPTION_LINES are references on arrays containing the - texinfo lines for caption and short caption. - \@CAPTION_LINES_RETURNED and \@SHORTCAPTION_LINES_RETURNED are - references on an array containing the texinfo lines for the - caption and shortcaption. - - Then the float is formatted with the following function reference: - - -- Function Reference: $text float $float_text \%float $caption_text - $shortcaption_text - $FLOAT_TEXT is the text appearing within the `@float', formatted. - \%FLOAT is still the structure defined above. $CAPTION_TEXT and - $SHORTCAPTION_TEXT are the caption and short caption build with the - above function and formatted. - - -File: texi2html.info, Node: Lists of floats, Prev: Floats, Up: Floats and lists of floats - -7.17.2 Formatting lists of floats ---------------------------------- - -A list of floats is introduced by `@listoffloats'. The argument of -`@listoffloats' is the "style". First the style texinfo can be modified -with the following function reference: - - -- Function Reference: $style_texi_returned listoffloats_style - $style_texi - $STYLE_TEXI is the `@listoffloats' argument with texinfo - @-commands kept. It is possible to make changes to the $STYLE_TEXI - and return a modified string, still with @-commands. The modified - string is formatted in the main program. - - 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: - - -- Function Reference: $float_style_texi_returned -listoffloats_float_style $style_texi \%float - $STYLE_TEXI is the style, and \%FLOAT is the structure described - above. This function reference returns a style to be formatted in - the main program. - - -- Function Reference: $caption_texi_returned listoffloats_caption - \%float - \%FLOAT is the structure described above. This function reference - returns a caption to be formatted in the main program. - - Each entry is formatted by: - - -- Function Reference: $listoffloats_entry listoffloats_entry - $style_texi \%float $float_style $caption $href - $STYLE_TEXI is the style with @-commands, $FLOAT_STYLE is the - style returned by the above function and formatted. $CAPTION is the - caption returned by the above function formatted. \%FLOAT is the - structure corresponding with the float, and $HREF is an href - pointing to the float location. - - Lastly, the whole `@listoffloats' is formatted by: - - -- Function Reference: $listoffloats listoffloats $style_texi $style - \@listoffloats_entries - $STYLE_TEXI is the style with @-commands, $STYLE is the style - returned by the above function and formatted. The array reference - \@LISTOFFLOATS_ENTRIES holds the entries formatted by the above - function. - - -File: texi2html.info, Node: Footnotes, Next: Other and unknown commands, Prev: Floats and lists of floats, Up: Customizing HTML - -7.18 Customizing the footnotes formatting -========================================= - -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. - - Two functions, with corresponding function references control the -formatting of the footnotes: - - -- Function Reference: (\@lines $text_for_document) foot_line_and_ref - $number_in_doc $number_in_page $footnote_id $place_id - $document_file $footnote_file \@lines \%state - $NUMBER_IN_DOC is the footnote number in the whole document, - $NUMBER_IN_PAGE is the footnote number in the current page. - $FOOTNOTE_ID is an identifier for the footnote in the footnote text - which should be used to make target for references to that - footnote, while $PLACE_ID is an identifier for the location of the - footnote in the main document. Similarly, $DOCUMENT_FILE is the - file name of the file containing the text where the footnote - appears in the main document, while $FOOTNOTE_FILE is the file - name of the file where the footnote text appears. - - \@LINES is a reference on an array containing the footnote text - lines, allready formatted. And \%STATE holds informations about - the context at the footnote place in the main document. As usual - the most usefull entry is `preformatted' which is true if the - footnote appears in a preformatted context. - - This function returns a reference on an array, \@LINES containing - the updated footnote text for the footnote entry, and - $TEXT_FOR_DOCUMENT, the text appearing at the footnote place in - the main document, linking to the footnote entry. - - 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, *Note -Special pages layout::. For the determination of the footnote -locations, *Note Page layout options::. - - -- Function Reference: foot_section \@footnotes_lines - This function formats a group of footnotes. \@FOOTNOTES_LINES is a - reference on an array holding the lines of all the footnote entries - formatted as explained above. This function modifies the reference. - - -File: texi2html.info, Node: Other and unknown commands, Prev: Footnotes, Up: Customizing HTML - -7.19 Customizing other commands, and unknown commands -===================================================== - -Many commands without braces are available in texinfo, sometimes with a -specific syntax. For example we have `@sp', `@noindent', -`@documentlanguage', `@oddheading', `@headings', `@shortcontents', -`@shorttitlepage' or `@comment'. `texi2html' 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. - - 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. - - Those special commands without braces are the key of a hash: `%misc_command'. -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 `line' for the `arg' property for the `command' @-command. - - $misc_command{'command'} = {'arg' => 'line', 'skip' => 'space'}; - - The properties and possible values are: - -`skip' - This property enables to set what is skipped after the command - arguments. Here are the possible values: - `line' - The remaining of the line is skipped. - - `space' - Spaces are skipped but not newline. - - `whitespace' - Spaces are skipped - - `linewhitespace' - Spaces are skipped if there are only spaces remaining on the - line. - - `linespace' - Spaces are skipped, but not newline if there are only spaces - remaining on the line - -`arg' - If the associated value is `line' the line is considered to be the - argument. If it is a number it is the number of args (separated by - spaces). - -`texi' - If true the arguments are considered to real texinfo, therefore - `@value' and `@macro' are expanded. - -`keep' - If true the args and the macro are kept, otherwise they are - discarded. The defaut is to have `keep' undef for all the - commands. If `keep' is true for `@verbatiminclude' the default - action for this macro isn't done. - - Commands which don't appear in the hashes `%simple_map', `%simple_map_pre', `%simple_map_texi' -and `%misc_command', or that appear in `%misc_command' but with `keep' -true are processed by the following function reference: - - -- Function Reference: ($result_line, $result, $result_text, $message) -unknown $command $line - $COMMAND is the @-command, $LINE is the line following the - $COMMAND. $RESULT is a boolean. If it is true then the other return - values are taken into account otherwise the default actions are - used. In case $RESULT is true, $RESULT_LINE is the new line to be - processed further, $RESULT_TEXT is the resulting formatted text - and $MESSAGE, if defined is a message outputted to the output with - line number added by `texi2html'. - - Commands with braces not specified above nor in `%style_map', `%style_map_pre' -and `%style_map_texi' are processed by the following function reference - - -- Function Reference: ($result, $result_text, $message) unknown_style - $command $text - $COMMAND is the @-command, $TEXT is the text appearing within the - braces (allready formatted). $RESULT is a boolean. If it is true - then the other return values are taken into account otherwise the - default actions are used. In case $RESULT is true, $RESULT_TEXT is - the resulting formatted text and $MESSAGE, if defined is a message - outputted to the output with line number added by `texi2html'. - - -File: texi2html.info, Node: Internationalization, Next: Indexop, Prev: Customizing HTML, Up: Top - -Appendix A Internationalization -******************************* - -The strings written in the document are selected based on the document -language. This can be used to customize the strings, as described in -*Note Strings::. This also enables translation of the strings. - -* Menu: - -* Translating strings:: -* Adding new strings:: - - -File: texi2html.info, Node: Translating strings, Next: Adding new strings, Up: Internationalization - -A.1 Translating strings -======================= - -If the language is allready supported, then there will be a file in the -`i18n' 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 `$LANGUAGES->{'LANGUAGE'}' hash in that file. The keys are the -english strings, in `''', the values (in `''' after `=>') are the -translations. When a string contains a `%' followed by `{' NAME `}' it -means that the string will be expanded by `texi2html'. For an example, -see *Note Strings::. - - After that you should run the command `./manage_i18n.pl all' in the -top directory, it should merge your file with the existing files in -`translations.pl', which is incorporated to the `texi2html' script by -`./configure'. - - If the language isn't currently supported, copy the `en' file in -`i18n' 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 `manage_i18n.pl' file in the -`@known_languages' array. - - After that you should similarly run the command `./manage_i18n.pl -all' in the top directory. - - Obsoleted strings are not removed from the files, they are still -present in the `$T2H_OBSOLETE_STRINGS->{'LANGUAGE'}' hash in case the -string is reused later. - - If you made change to strings specified in installed files (*note -Installation::) you will have to reinstall them otherwise the -installated files will take precedence (*note Using init files::). - - -File: texi2html.info, Node: Adding new strings, Prev: Translating strings, Up: Internationalization - -A.2 Adding new strings written to document -========================================== - -If you need to write strings, for example the new string A STRING to -the resulting document, call `&$I('a string')'. Use simple quotes. If -you want to substitute a value in the string put `%{STRING_VALUE}', in -the string, and give a second argument to `&$I', a hash reference with -key STRING_VALUE and value the what you want to substitute. Here is an -example: - - return &$I('%{name} of %{class}', { 'name' => $name, 'class' => $class }); - - In that case `%{name}' is substituted by `$name' in the translated -string. - - After that you should run the command `./manage_i18n.pl all' in the -top directory, it should add your new strings to all the files in the -`i18n' directory. - - -File: texi2html.info, Node: Indexop, Next: Indexvr, Prev: Internationalization, Up: Top - -Appendix B Command Line Option Index -************************************ - - -* Menu: - -* css-include=FILE: Style options. (line 24) -* def-table: Style options. (line 39) -* doctype=DTD: Style options. (line 8) -* DVAR: Texinfo related options. - (line 14) -* frames: Page layout options. (line 6) -* frameset-doctype: Style options. (line 10) -* frameset-doctype=DTD: Style options. (line 9) -* html-xref-prefix=PATH: Style options. (line 35) -* IDIR: Texinfo related options. - (line 25) -* if<region>: Expansion. (line 10) -* include-css: css. (line 22) -* init-file: Using init files. (line 13) -* iso: Style options. (line 19) -* l2h: Expanding TeX regions. - (line 8) -* l2h-file: Expanding TeX regions. - (line 21) -* l2h-l2h=PROGRAM: Expanding TeX regions. - (line 13) -* l2h-tmp: Expanding TeX regions. - (line 17) -* lang <1>: Strings. (line 9) -* lang: Using init files. (line 22) -* lang=LANG: Texinfo related options. - (line 9) -* menu: Invoking texi2html. (line 18) -* no-if<region>: Expansion. (line 12) -* node-files: Output files. (line 61) -* nomenu <1>: Expansion. (line 17) -* nomenu: Invoking texi2html. (line 18) -* nosec-nav: Page layout options. (line 11) -* number: Style options. (line 48) -* output: Output files. (line 35) -* PDIR: Texinfo related options. - (line 20) -* pkgdatadir=dir: Using init files. (line 8) -* pkgdatadir=DIR: Installation. (line 46) -* prefix: Output files. (line 39) -* separated-footnotes: Page layout options. (line 15) -* short-ext: Output files. (line 40) -* short-ref: Style options. (line 44) -* split: Splitting output. (line 8) -* sysconfdir=dir: Using init files. (line 10) -* toc-file: Output files. (line 43) -* toc-links: Style options. (line 52) -* top-file: Output files. (line 41) -* use-nodes: Splitting output. (line 38) -* UVAR: Texinfo related options. - (line 17) - - -File: texi2html.info, Node: Indexvr, Next: Indexcp, Prev: Indexop, Up: Top - -Appendix C Variable Index -************************* - - -* Menu: - -* $AFTER_BODY_OPEN: Customizing header. (line 8) -* $AFTER_OVERVIEW: Contents and Overview text. - (line 21) -* $AFTER_TOC_LINES: Contents and Overview text. - (line 28) -* $anchor <1>: Anchors images and spaces. - (line 10) -* $anchor: Redefining functions. (line 15) -* $AVOID_MENU_REDUNDANCY: Menu formatting. (line 8) -* $BEFORE_OVERVIEW: Contents and Overview text. - (line 17) -* $BEFORE_TOC_LINES: Contents and Overview text. - (line 25) -* $BIG_RULE: The page layout. (line 12) -* $BODYTEXT <1>: Customizing header. (line 22) -* $BODYTEXT: Output initialization. - (line 20) -* $cell: Table and list items. (line 81) -* $CLOSE_QUOTE_SYMBOL <1>: String interface. (line 8) -* $CLOSE_QUOTE_SYMBOL: Hash reference interface. - (line 65) -* $complex_format_map: Complex formats. (line 12) -* $CSS_LINES: css. (line 10) -* $DEF_TABLE: Style options. (line 41) -* $DEFAULT_RULE: The page layout. (line 11) -* $definition_category: Definition formatting. - (line 20) -* $DO_CONTENTS: Contents and Overview text. - (line 9) -* $DO_SCONTENTS: Contents and Overview text. - (line 13) -* $DOCTYPE: Style options. (line 12) -* $DOCUMENT_DESCRIPTION: Customizing header. (line 16) -* $DOCUMENT_ENCODING: Customizing header. (line 11) -* $ENCODING: Customizing header. (line 14) -* $EXTENSION: File names. (line 8) -* $EXTERNAL_DIR: Style options. (line 37) -* $EXTRA_HEAD: Customizing header. (line 7) -* $FRAMES: Page layout options. (line 9) -* $FRAMESET_DOCTYPE: Style options. (line 12) -* $ICONS: General purpose variables. - (line 13) -* $IDX_SUMMARY: External index files. (line 9) -* $INDEX_CHAPTER: The page layout. (line 66) -* $L2H_L2H: Expanding TeX regions. - (line 14) -* $L2H_TMP: Expanding TeX regions. - (line 18) -* $LANG <1>: Strings. (line 9) -* $LANG <2>: Using init files. (line 22) -* $LANG: Texinfo related options. - (line 11) -* $LANGUAGES <1>: Translating strings. (line 6) -* $LANGUAGES: Strings. (line 13) -* $MENU_PRE_STYLE: Menu formatting. (line 19) -* $MENU_SYMBOL: Menu formatting. (line 13) -* $MIDDLE_RULE: The page layout. (line 11) -* $NODE_FILES <1>: File names. (line 9) -* $NODE_FILES: Output files. (line 62) -* $NODE_NAME_IN_MENU: Menu formatting. (line 7) -* $NUMBER_SECTIONS: Style options. (line 49) -* $OPEN_QUOTE_SYMBOL <1>: String interface. (line 8) -* $OPEN_QUOTE_SYMBOL: Hash reference interface. - (line 65) -* $OUT: Output files. (line 35) -* $PRE_BODY_CLOSE: Customizing footer. (line 7) -* $PREFIX: Output files. (line 39) -* $print_chapter_footer: Customizing footer. (line 20) -* $print_chapter_header: Customizing header. (line 38) -* $print_foot_navigation: Customizing footer. (line 9) -* $print_head_navigation: Customizing header. (line 26) -* $print_misc: Special pages layout. (line 33) -* $print_misc_footer: Special pages layout. (line 34) -* $print_misc_header: Special pages layout. (line 33) -* $print_page_foot: Customizing footer. (line 23) -* $print_page_head: Customizing header. (line 37) -* $print_section_footer: Customizing footer. (line 21) -* $print_section_header: Customizing header. (line 40) -* $print_Top: Special pages layout. (line 31) -* $print_Top_footer: Special pages layout. (line 32) -* $print_Top_header: Special pages layout. (line 31) -* $SECTION_NAVIGATION <1>: General purpose variables. - (line 16) -* $SECTION_NAVIGATION: Page layout options. (line 12) -* $SEPARATED_FOOTNOTES: Page layout options. (line 15) -* $SHORT_REF: Style options. (line 46) -* $SHORTEXTN: Output files. (line 41) -* $SHOW_MENU: Expansion. (line 18) -* $SMALL_RULE: The page layout. (line 11) -* $SPLIT: Splitting output. (line 9) -* $SPLIT_INDEX: Index list. (line 15) -* $T2H_OBSOLETE_STRINGS: Translating strings. (line 6) -* $Texi2HTML::NODE{Next}: Button specifications. - (line 59) -* $Texi2HTML::OVERVIEW <1>: Contents and Overview text. - (line 77) -* $Texi2HTML::OVERVIEW: Global informations. (line 89) -* $Texi2HTML::THIS_HEADER: Global informations. (line 85) -* $Texi2HTML::THIS_SECTION <1>: Global functions. (line 12) -* $Texi2HTML::THIS_SECTION: Global informations. (line 82) -* $Texi2HTML::TOC_LINES <1>: Contents and Overview text. - (line 77) -* $Texi2HTML::TOC_LINES: Global informations. (line 92) -* $TOC_FILE: Output files. (line 44) -* $TOC_LINKS: Style options. (line 54) -* $TOC_LIST_ATTRIBUTE: Contents and Overview text. - (line 35) -* $TOC_LIST_STYLE: Contents and Overview text. - (line 31) -* $TOP_FILE: Output files. (line 42) -* $TOP_HEADING: The page layout. (line 47) -* $UNNUMBERED_SYMBOL_IN_MENU: Menu formatting. (line 14) -* $USE_ISO: Style options. (line 21) -* $USE_NODES: Splitting output. (line 39) -* $VERTICAL_HEAD_NAVIGATION: General purpose variables. - (line 9) -* $WORDS_IN_PAGE <1>: Global functions. (line 14) -* $WORDS_IN_PAGE: Button specifications. - (line 21) -* %accent_map: Style and accent commands. - (line 26) -* %ACTIVE_ICONS: Button specifications. - (line 71) -* %BUTTONS_GOTO: Output initialization. - (line 21) -* %css_map: css. (line 7) -* %def_map: Definition line. (line 6) -* %format_in_paragraph: Avoiding paragraphs. (line 8) -* %format_map: Whole table list. (line 6) -* %main::value: Global informations. (line 67) -* %misc_command: Other and unknown commands. - (line 20) -* %NAVIGATION_TEXT <1>: Output initialization. - (line 21) -* %NAVIGATION_TEXT: Button specifications. - (line 64) -* %paragraph_style: Alignement commands. (line 8) -* %PASSIVE_ICONS: Button specifications. - (line 72) -* %pre_map: Commands without argument. - (line 23) -* %simple_map <1>: Other and unknown commands. - (line 65) -* %simple_map: Commands without argument. - (line 22) -* %simple_map_pre <1>: Other and unknown commands. - (line 65) -* %simple_map_pre: Commands without argument. - (line 22) -* %simple_map_texi <1>: Other and unknown commands. - (line 65) -* %simple_map_texi: Commands without argument. - (line 22) -* %special_list_commands: Table and list items. (line 12) -* %style_map <1>: Other and unknown commands. - (line 79) -* %style_map: Style and accent commands. - (line 10) -* %style_map_pre <1>: Other and unknown commands. - (line 79) -* %style_map_pre: Style and accent commands. - (line 11) -* %style_map_texi <1>: Other and unknown commands. - (line 80) -* %style_map_texi: Style and accent commands. - (line 11) -* %Texi2HTML::HREF: Elements hashes. (line 12) -* %Texi2HTML::NAME: Elements hashes. (line 9) -* %Texi2HTML::NO_TEXI: Elements hashes. (line 18) -* %Texi2HTML::NODE: Elements hashes. (line 15) -* %Texi2HTML::THISDOC: Global informations. (line 12) -* %texi_map: Commands without argument. - (line 23) -* %things_map: Commands without argument. - (line 23) -* @CHAPTER_BUTTONS: Button specifications. - (line 27) -* @CSS_FILES: Style options. (line 27) -* @EXPAND: Expansion. (line 13) -* @INCLUDE_DIRS: Texinfo related options. - (line 27) -* @MISC_BUTTONS: Button specifications. - (line 32) -* @NODE_FOOTER_BUTTONS: Button specifications. - (line 17) -* @PREPEND_DIRS: Texinfo related options. - (line 22) -* @SECTION_BUTTONS: Button specifications. - (line 10) -* @SECTION_FOOTER_BUTTONS: Button specifications. - (line 16) - - -File: texi2html.info, Node: Indexcp, Prev: Indexvr, Up: Top - -Appendix D Concept Index -************************ - - -* Menu: - -* Avoid paragraph opening: Avoiding paragraphs. (line 6) -* bug report: Top. (line 6) -* centering: Alignement commands. (line 6) -* complex format: Complex formats. (line 6) -* Config: Using init files. (line 6) -* configure: Installation. (line 6) -* downloading texi2html source: Obtaining texi2html. (line 6) -* examples of manuals: Overview. (line 6) -* external manual: Reference to external manual. - (line 6) -* flushing text: Alignement commands. (line 6) -* i18n <1>: Translating strings. (line 6) -* i18n: Strings. (line 6) -* Installation: Installation. (line 6) -* internationalization: Using init files. (line 6) -* internationalized strings: Adding new strings. (line 6) -* makeinfo: whytexi2html. (line 6) -* manage_i18n.pl: Adding new strings. (line 6) -* paragraph: Paragraph and preformatted formatting. - (line 6) -* preformatted region: Paragraph and preformatted formatting. - (line 6) -* reference: References. (line 6) -* skipped command: Other and unknown commands. - (line 6) -* source code for texi2html, downloading: Obtaining texi2html. (line 6) -* texi2html source, downloading: Obtaining texi2html. (line 6) -* Texinfo: Overview. (line 6) -* text alignement: Alignement commands. (line 6) -* Translation: Translating strings. (line 6) -* unknown command: Other and unknown commands. - (line 6) - - - -Tag Table: -Node: Top2959 -Node: Overview5587 -Node: whytexi2html7377 -Node: Obtaining texi2html9460 -Node: Installation9743 -Node: Invoking texi2html11933 -Node: Splitting output13113 -Node: Output files16447 -Node: Expansion19709 -Node: Texinfo related options20618 -Node: Page layout options21685 -Node: Style options22582 -Node: Expanding TeX regions24902 -Node: Using init files26048 -Node: Initialization files27937 -Node: Redefining functions29884 -Node: Function prototypes30950 -Node: Changing the page layout32026 -Node: The different pages33384 -Node: The page layout35102 -Ref: Element labels36386 -Node: Navigation panel38115 -Node: General purpose variables38778 -Node: Button specifications39555 -Node: Panel formatting function42891 -Node: Program variables43690 -Node: Elements hashes44400 -Node: Global informations44919 -Node: Global functions47439 -Node: Output initialization48184 -Node: Output finalization49647 -Node: css50124 -Node: Customizing header51196 -Node: Customizing section54009 -Node: Customizing footer55013 -Node: Special pages56893 -Node: Special pages content57227 -Node: Top element text57531 -Node: Contents and Overview text58820 -Node: Footnotes text61569 -Node: About text61877 -Node: Special pages layout63397 -Node: File names64598 -Node: External index files66479 -Node: Customizing HTML68609 -Node: Three contexts70331 -Node: Commands without argument71105 -Node: Style and accent commands72527 -Node: Hash reference interface74020 -Ref: Reference hash args74896 -Node: String interface77266 -Node: Define your own interface79251 -Node: Anchors images and spaces80971 -Node: Text83845 -Node: Strings85181 -Node: References86771 -Node: Reference to external manual86978 -Node: Internal reference88982 -Node: Alignement commands89918 -Node: Paragraph and preformatted region90882 -Node: Paragraph and preformatted formatting91218 -Node: Avoiding paragraphs94955 -Node: Complex formats95360 -Node: Lists tables97057 -Node: Table and list items97529 -Node: Whole table list101474 -Node: Definitions103028 -Node: Definition line103510 -Node: Definition formatting104963 -Node: Headings106415 -Node: Special regions107382 -Node: Menus109420 -Node: Menu parts109872 -Node: Menu formatting111301 -Node: Indices114208 -Node: Index entry place114885 -Node: Index list115508 -Node: Floats and lists of floats118613 -Node: Floats120098 -Node: Lists of floats121414 -Node: Footnotes123643 -Node: Other and unknown commands126158 -Node: Internationalization130107 -Node: Translating strings130537 -Node: Adding new strings132195 -Node: Indexop133072 -Node: Indexvr136916 -Node: Indexcp150701 - -End Tag Table diff --git a/Master/texmf/doc/man/man1/texi2html.1 b/Master/texmf/doc/man/man1/texi2html.1 deleted file mode 100644 index da6a8a99c78..00000000000 --- a/Master/texmf/doc/man/man1/texi2html.1 +++ /dev/null @@ -1,164 +0,0 @@ -.TH TEXI2HTML 1 "17 January 2006" -.AT 3 -.SH NAME -texi2html \- a Texinfo to HTML converter -.SH SYNOPSIS -.B texi2html [options] file -.SH DESCRIPTION -.I Texi2html -converts the given Texinfo file to a set of HTML files. It tries to handle -most of the Texinfo commands. It creates hypertext links for cross-references, -footnotes... -.PP -.I Texi2html -may furthermore use latex2html to generate HTML (code and/or images) for @math -and @iftex tags (see the -.B \-\-l2h -option). -.PP -.I Texi2html -creates several files depending on the contents of the Texinfo file and on -the chosen options (see FILES). -.PP -The HTML files created by -.I texi2html -are closer to TeX than to Info. -.SH OPTIONS -Options may be abbreviated to th shortests unique prefix. The -following is only an incomplete list of the available options: -.TP 12 -.B \-\-help [1|2] -Print usage instructions and list the most important, all relevant, -or all recognised (including obsolete) command-line options, and exit. -.TP -.B \-\-ifinfo \-\-iftex \-\-ifxml \-\-ifplaintext \-\-ifhtml -Expand @ifinfo, @iftex and @tex, @ifxml and @xml, @ifplaintext, -@ifhtml and @html regions, and don't expand @ifnot -corresponding regions (default: ifhtml). -.TP -.B \-\-no\-ifinfo \-\-no\-iftex \-\-no\-ifxml \-\-no\-ifplaintext \-\-no\-html -Don't expand @ifinfo, @iftex, @ifxml, @ifplaintext regions and expand -@ifnot corresponding regions. -.TP -.B \-I \fIdir\fP -Append \fIdir\fP to the directory list searched for included files. -.TP -.B \-P \fIdir\fP -Prepend \fIdir\fP to the directory list searched for included files. -.TP -.B \-\-no\-menu -Don't show the Texinfo menus; by default they are shown. -.TP -.B \-\-no\-number -Don't number the sections. -.TP -.B \-\-split chapter|section|node -Split the output into several HTML files (one per main chapter/section or node). -.TP -.B \-\-l2h -Use latex2html for content of @math and @tex tags. Content must be such that -both, latex and tex, can translate it correctly. I.e., no tex-only constructs -must be used. -.TP -.B \-\-l2h\-l2h \fIprog\fP -Use \fIprog\fP as latex2html program (default \fIlatex2html\fP). -Program must be executable. -.TP -.B \-\-l2h\-init \fIfile\fP -Use \fIfile\fP as latex2html init file. \fIfile\fP should be used to specify in which way latex2html handles mathematical expressions and formulas. - -Note that latex2html locates -(and uses) init-files in the following order (provided they exist): -(1) global init file (usually in latex2html source dir) -(2) $HOME/.latex2html_init -(3) ./.latex2html_init -(4) init file given on command line. -.TP -.B \-\-l2h\-tmp \fIdir\fP -Use \fIdir\fP as tmp dir for latex2html. This directory (resp. its path) -must not contain a dot (i.e., a "."). -.TP -.B \-\-l2h\-clean -remove all intermediate files generated by latex2html (prevents caching!) -.TP -.B \-\-l2h\-skip -Do not really run latex2html. Use (kept) files of previous runs, instead. -.TP -.B \-\-Verbose -Give a verbose output. -.TP -.B \-\-version -Print version and exit. -.PP -.SH FILES -Initialisation options are read first from ${prefix}/etc/texi2html/Config -(the exact location being changeable with the -.RI --sysconfdir= dir -option to the configure script), then from $HOME/.texi2html/Config, -then any command-line options including \-\-init\-file options; -with later settings overriding earlier ones. -.P -By default -.I texi2html -my creates the following files (foo being the name of the Texinfo file): -.TP 16 -.B foo_toc.html -The table of contents (if @contents is present). -.TP -.B foo.html -The document's contents or the Top element. -.TP -.B foo_fot.html -The footnotes (if any). -.TP -.B foo_abt.html -An help section. -.TP -.B foo_l2h_img* -Images generated by latex2html (if any). -.PP -When used with the -.B \-\-split -option, it creates several files (one per chapter or node), named -.B foo_n.html -(n being the index of the chapter or node), and the -.B foo.html -file contains the Top element. -.PP -Otherwise it creates only one file: -.B foo.html -.SH VERSION -This is \fItexi2html\fP version 1.76, 17 January 2006. -.SH AUTHOR -Texi2html was originally written by is Lionel Cons, CERN IT/DIS/OSE, -Lionel.Cons@cern.ch. Over time, many other people around the net -contributed to this program. Its current maintainer is Olaf Bachmann, -obachman@mathematik.uni-kl.de. -.SH AVAILABILITY -The latest version of this program, as well as support in the form of mailing -lists with archives, bug tracking, documentation, and other tools can be found -at: - http://texi2html.cvshome.org/ -.SH COPYRIGHT -Copyright \(co 1999, 2000, 2003 Free Software Foundation, Inc. -There is NO warranty. You may redistribute this software -under the terms of the GNU General Public License. -For more information about these matters, see the file named COPYING. -.SH "SEE ALSO" -GNU Texinfo Documentation Format -.br -http://texinfo.org/ -.br -World Wide Web (WWW), -HyperText Markup Language (HTML) -.br -http://www.w3.org -.br -LaTeX2HTML -.br -http://www-dsed.llnl.gov/files/programs/unix/latex2html -.SH BUGS -This man-page is not up-to-date and there exists no up-to-date documentation, yet. -Until it exists, see the beginning of the texi2html.init file for remarks about -command-line options and configurations. -.ex diff --git a/Master/texmf/doc/texi2html/texi2html.html b/Master/texmf/doc/texi2html/texi2html.html deleted file mode 100644 index d55c003b90f..00000000000 --- a/Master/texmf/doc/texi2html/texi2html.html +++ /dev/null @@ -1,6072 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html401/loose.dtd"> -<html> -<!--Copyright C 1999, 2000, 2001, 2002, 2003 - Free Software Foundation, Inc. - - 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 Patrice Dumas - Copyright C 2001, 2002, 2003 Derek Price - Copyright C many others. - - - Portions of this manual - Copyright C 1999, 2000 Karl Heinz Marbaise (manual) - Copyright C 2003 Patrice Dumas (manual) - Copyright C 2003 Derek Price (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 February, 3 2005 by texi2html 1.76 --> -<!-- -Written by: Lionel Cons <Lionel.Cons@cern.ch> (original author) - Karl Berry <karl@freefriends.org> - Olaf Bachmann <obachman@mathematik.uni-kl.de> - and many others. -Maintained by: Many creative people <dev@texi2html.cvshome.org> -Send bugs and suggestions to <users@texi2html.cvshome.org> - ---> -<head> -<title>Texi2HTML - Texinfo to HTML v1.76: Texi2HTML</title> - -<meta name="description" content="Texi2HTML - Texinfo to HTML v1.76: Texi2HTML"> -<meta name="keywords" content="Texi2HTML - Texinfo to HTML v1.76: Texi2HTML"> -<meta name="resource-type" content="document"> -<meta name="distribution" content="global"> -<meta name="Generator" content="texi2html 1.76"> -<meta http-equiv="Content-Type" content="text/html; charset=us-ascii"> -<style type="text/css"> -<!-- -a.summary-letter {text-decoration: none} -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.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 cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h1 class="settitle">Texi2HTML</h1> -<p>Copyright © 1999, 2000, 2001, 2002, 2003 - Free Software Foundation, Inc. -</p> -<table> -<tr><td><p> Portions of <code>texi2html</code> -</p></td></tr> -<tr><td> </td><td><p> Copyright © 1999, 2000 Lionel Cons<br> -</p></td></tr> -<tr><td> </td><td><p> Copyright © 1999, 2000 Karl Berry<br> -</p></td></tr> -<tr><td> </td><td><p> Copyright © 1999, 2000 Olaf Bachmann<br> -</p></td></tr> -<tr><td> </td><td><p> Copyright © 2002, 2003 Patrice Dumas<br> -</p></td></tr> -<tr><td> </td><td><p> Copyright © 2001, 2002, 2003 Derek Price<br> -</p></td></tr> -<tr><td> </td><td><p> Copyright © many others.<br> -</p></td></tr> -<tr><td> </td><td> -</td></tr> -<tr><td> </td><td> -</td></tr> -<tr><td><p> Portions of this manual -</p></td></tr> -<tr><td> </td><td><p> Copyright © 1999, 2000 Karl Heinz Marbaise (manual)<br> -</p></td></tr> -<tr><td> </td><td><p> Copyright © 2003 Patrice Dumas (manual)<br> -</p></td></tr> -<tr><td> </td><td><p> Copyright © 2003 Derek Price (manual)<br> -</p></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> -<a name="SEC_Top"></a> - - -<p>This manual, last updated 1 February 2005, describes version 1.76 -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 user -discussion list <a href="mailto:user@texi2html.cvshome.org">user@texi2html.cvshome.org</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="#SEC1">1. Overview</a></td><td> </td><td align="left" valign="top"> -</td></tr> -<tr><td align="left" valign="top"><a href="#SEC3">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="#SEC4">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="#SEC5">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="#SEC14">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="#SEC17">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="#SEC47">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="#SEC84">A. Internationalization</a></td><td> </td><td align="left" valign="top"> Help translating ! -</td></tr> -<tr><td align="left" valign="top"><a href="#SEC87">B. Command Line Option Index</a></td><td> </td><td align="left" valign="top"></td></tr> -<tr><td align="left" valign="top"><a href="#SEC88">C. Variable Index</a></td><td> </td><td align="left" valign="top"></td></tr> -<tr><td align="left" valign="top"><a href="#SEC89">D. 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> -<a name="SEC1"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC_Top" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC2" title="Next 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="#SEC_Top" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC3" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h1 class="chapter"> 1. Overview </h1> - - -<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="#SEC2">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> -<a name="SEC2"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC1" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC3" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC1" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC3" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h2 class="section"> 1.1 Why <code>texi2html</code> and not <code>makeinfo</code>? </h2> - - -<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>). -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>mekeinfo</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:users@texi2html.cvshome.org">users@texi2html.cvshome.org</a> email list. -</p> -<hr size="6"> -<a name="Obtaining-texi2html"></a> -<a name="SEC3"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC2" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC4" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC_Top" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC4" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h1 class="chapter"> 2. Obtaining <code>texi2html</code> </h1> - -<p>The latest version of the source code for <code>texi2html</code> should be -available from <a href="http://texi2html.cvshome.org">texi2html.cvshome.org</a>. -</p> -<hr size="6"> -<a name="Installation"></a> -<a name="SEC4"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC3" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC5" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC3" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC_Top" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC5" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h1 class="chapter"> 3. Installation of <code>texi2html</code> </h1> - -<p>To install <code>texi2html</code>, you must first obtain a copy of the -source distribution. See section <a href="#SEC3">Obtaining <code>texi2html</code></a>. -</p> -<p><code>texi2html</code> also requires <code>perl</code> version -5.004 or above. The current version has not been tested -extensively on versions of <code>perl</code> below 5.6, however. -</p> -<p><code>texi2html</code> is a standard Automake-based distribution. -If you have a source version, you should run <code>./configure</code> -to regenerate the executable <tt>`texi2html'</tt> file. <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. -</p> -<p>Running <code>./configure</code> combines four files into the final -<tt>`texi2html'</tt> program file: -</p><ul class="toc"> -<li> <tt>`texi2html.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>./configure</code> also builds the <code>make</code> configuration -files (<tt>`Makefile'</tt>s). To make the documentation run <code>make</code>. -</p> -<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="#SEC12">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="IDX1"></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="#SEC13">Use initialization files for fine tuning</a> for more. -</p> -<hr size="6"> -<a name="Invoking-texi2html"></a> -<a name="SEC5"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC4" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC6" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC4" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC_Top" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC14" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<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>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="IDX2"></a> -<samp>`--nomenu'</samp> does the reverse of <a name="IDX3"></a> -<samp>`--menu'</samp>. -</p> -<table class="menu" border="0" cellspacing="0"> -<tr><td align="left" valign="top"><a href="#SEC6">4.1 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="#SEC7">4.2 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="#SEC8">4.3 Specifying which regions get expanded</a></td><td> </td><td align="left" valign="top"> -</td></tr> -<tr><td align="left" valign="top"><a href="#SEC9">4.4 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="#SEC10">4.5 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="#SEC11">4.6 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="#SEC12">4.7 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="#SEC13">4.8 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="Splitting-output"></a> -<a name="SEC6"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC5" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC7" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC5" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC5" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC14" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h2 class="section"> 4.1 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="IDX4"></a> -<samp>`--split'</samp> which takes an argument, namely the level of splitting -(variable: <a name="IDX5"></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="IDX6"></a> -<samp>`--use-nodes'</samp> option (variable -<a name="IDX7"></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>). -</p> -<p>As an illustration, the following table shows how a sample Texinfo document is -divided into sectioning elements when <a name="IDX8"></a> -<samp>`--use-nodes'</samp> is used and not: -</p> -<table> -<tr><td><p> Texinfo code -</p></td><td> -</td><td> -<p>default case -</p></td><td> -</td><td> -<p>with <a name="IDX9"></a> -<samp>`--use-nodes'</samp> -</p></td></tr> -<tr><td> -<br> -<br> -<table><tr><td> </td><td><pre class="example">@node node1 -@chapter node 1 -node1 text - -@node node2 -node2 text - -@node node3 -node3 text -@chapter node 3 -chapter text -</pre></td></tr></table></td><td> -</td><td> -<p>first element: -</p> -<table><tr><td> </td><td><pre class="example">@node node1 -@chapter node 1 -node1 text - -@node node2 -node2 text -</pre></td></tr></table> -<p>second element: -</p> -<table><tr><td> </td><td><pre class="example">@node node3 -node3 text -@chapter node 3 -chapter text -</pre></td></tr></table> -</td><td> -</td><td> -<p>first element: -</p> -<table><tr><td> </td><td><pre class="example">@node node1 -@chapter 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 -@chapter node 3 -chapter text -</pre></td></tr></table> -</td></tr> -</table> - -<hr size="6"> -<a name="Output-files"></a> -<a name="SEC7"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC6" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC8" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC5" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC5" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC14" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h2 class="section"> 4.2 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 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) 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="IDX10"></a> -<samp>`--output'</samp> command line option (variable <a name="IDX11"></a> -<code>$OUT</code>). If the output -is split, and <a name="IDX12"></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="IDX13"></a> -<samp>`--prefix'</samp> (variable -<a name="IDX14"></a> -<code>$PREFIX</code>). If <a name="IDX15"></a> -<samp>`--short-ext'</samp> is given, <samp>`.htm'</samp> is appended -instead of <samp>`.html'</samp> in the final step (variable <a name="IDX16"></a> -<code>$SHORTEXTN</code>). -The <a name="IDX17"></a> -<samp>`--top-file'</samp> option -overrides the top element file name (variable <a name="IDX18"></a> -<code>$TOP_FILE</code>). This can -be used to name the top element file <samp>`index.html'</samp>. Similarly, -<a name="IDX19"></a> -<samp>`--toc-file'</samp> changes the name of the table of contents file (variable -<a name="IDX20"></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 node name to construct -the file names while splitting at nodes. It is possible to get the same -behaviour out of <code>texi2html</code> by specifying the -<a name="IDX21"></a> -<samp>`--node-files'</samp> option (variable <a name="IDX22"></a> -<code>$NODE_FILES</code>). 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. -The default is false for this option. -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> -<hr size="6"> -<a name="Expansion"></a> -<a name="SEC8"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC7" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC9" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC5" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC5" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC14" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h2 class="section"> 4.3 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="IDX23"></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="IDX24"></a> -<samp>`--no-if<region>'</samp> is -specified, the <samp>`<region>'</samp> region is ignored. The configuration file -array, <a name="IDX25"></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="IDX26"></a> -<samp>`--nomenu'</samp> is set, the <code>@menu</code> sections are not expanded -(variable <a name="IDX27"></a> -<code>$SHOW_MENU</code>). The default is to expand <code>@menu</code> -sections. -</p> -<hr size="6"> -<a name="Texinfo-related-options"></a> -<a name="SEC9"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC8" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC10" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC5" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC5" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC14" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h2 class="section"> 4.4 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="IDX28"></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="IDX29"></a> -<code>$LANG</code>). -The default is <samp>`en'</samp>, that is, use the english language strings. -</p></dd> -<dt> <a name="IDX30"></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="IDX31"></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="IDX32"></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="IDX33"></a> -<code>@PREPEND_DIRS</code>, -empty in the default case). -</p></dd> -<dt> <a name="IDX34"></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="IDX35"></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> -<a name="SEC10"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC9" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC11" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC5" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC5" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC14" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h2 class="section"> 4.5 Page layout related command line options </h2> - -<p>If the <a name="IDX36"></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="IDX37"></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="IDX38"></a> -<samp>`--nosec-nav'</samp> (variable <a name="IDX39"></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 or on a separate page with -<a name="IDX40"></a> -<samp>`--separated-footnotes'</samp> (variable <a name="IDX41"></a> -<code>$SEPARATED_FOOTNOTES</code>). -The default is to have separated footnotes. -</p> -<hr size="6"> -<a name="Style-options"></a> -<a name="SEC11"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC10" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC12" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC5" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC5" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC14" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h2 class="section"> 4.6 Customizing the <acronym>HTML</acronym> and text style </h2> - -<p>Miscalleneous style changes may be achieved with command line options. -</p> -<dl compact="compact"> -<dt> <a name="IDX42"></a> -<p><samp>`--doctype=<var>DTD</var>'</samp> -</p></dt> -<dt> <a name="IDX43"></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="IDX44"></a> -<samp>`--frameset-doctype'</samp> applies to the file describing the frames when -frames are used (corresponding variables are <a name="IDX45"></a> -<code>$DOCTYPE</code> and -<a name="IDX46"></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="IDX47"></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="IDX48"></a> -<code>$USE_ISO</code>). It is the default. -</p> -</dd> -<dt> <a name="IDX49"></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="IDX50"></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>. -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="IDX51"></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="IDX52"></a> -<code>$EXTERNAL_DIR</code>). Defaults to <samp>`../'</samp>. -</p> -</dd> -<dt> <a name="IDX53"></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="IDX54"></a> -<code>$DEF_TABLE</code>). Default is false. -</p> -</dd> -<dt> <a name="IDX55"></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="IDX56"></a> -<code>$SHORT_REF</code>). Default is false. -</p> -</dd> -<dt> <a name="IDX57"></a> -<p><samp>`--number'</samp> -</p></dt> -<dd><p>If this option is set, sections are numbered (variable -<a name="IDX58"></a> -<code>$NUMBER_SECTIONS</code>). This is the default. -</p> -</dd> -<dt> <a name="IDX59"></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="IDX60"></a> -<code>$TOC_LINKS</code>). Default is false. -</p></dd> -</dl> - -<hr size="6"> -<a name="Expanding-TeX-regions"></a> -<a name="SEC12"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC11" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC13" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC5" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC5" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC14" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h2 class="section"> 4.7 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="IDX61"></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="#SEC8">Specifying which regions get expanded</a>). The default is not to use this -feature. -</p> -<p>The <a name="IDX62"></a> -<samp>`--l2h-l2h=<var>program</var>'</samp> option enables changing the name/location -of the LaTeX2HTML program processing TeX regions (variable -<a name="IDX63"></a> -<code>$L2H_L2H</code>). The default is <code>latex2html</code>. -</p> -<a name="IDX64"></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="IDX65"></a> -<code>$L2H_TMP</code>). Defaults to the current dir. -</p> -<p>The file specified by <a name="IDX66"></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="#SEC13">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> -<a name="SEC13"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC12" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC14" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC5" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC5" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC14" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h2 class="section"> 4.8 Use initialization files for fine tuning </h2> - - -<p>Initialization variables are read first from -<tt>`/usr/local/share/texi2html/Config'</tt> (the exact location being -changeable with the <a name="IDX67"></a> -<samp>`--pkgdatadir=dir'</samp> option of the -<code>configure</code> script, see <a href="#SEC4">Installation of <code>texi2html</code></a>), -<tt>`/usr/local/etc/texi2html/Config'</tt> (the exact location being -changeable with the <a name="IDX68"></a> -<samp>`--sysconfdir=dir'</samp> option of the -<code>configure</code> script, see <a href="#SEC4">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="IDX69"></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="IDX70"></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="IDX71"></a> -<code>$LANG</code>, <a name="IDX72"></a> -<samp>`--lang'</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> -<hr size="6"> -<a name="Initialization-files"></a> -<a name="SEC14"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC13" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC15" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC5" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC_Top" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC17" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<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="#SEC13">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 inititalization files are distinct, which ensures -that no name clash should happen. The variables are declared with the -<code>our</code> specifier, 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> -<table class="menu" border="0" cellspacing="0"> -<tr><td align="left" valign="top"><a href="#SEC15">5.1 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="#SEC16">5.2 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="Redefining-functions"></a> -<a name="SEC15"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC14" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC16" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC14" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC14" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC17" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h2 class="section"> 5.1 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 <a name="IDX73"></a> -<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> -<a name="SEC16"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC15" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC17" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC14" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC14" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC17" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h2 class="section"> 5.2 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>\@array</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><u>Function Reference:</u> $text <b>formatting_function</b><i> $arg1 \@arg2</i> -<a name="IDX74"></a> -</dt> -<dd><p><code>formatting_function</code> takes as first argument <var>$arg2</var>, -as second argument a reference on an array <var>\@arg2</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> -<a name="SEC17"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC16" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC18" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC14" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC_Top" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC47" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<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="#SEC10">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="#SEC18">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="#SEC19">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="#SEC21">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="#SEC25">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="#SEC32">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="#SEC33">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="#SEC34">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="#SEC35">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="#SEC36">6.9 Customizing the sections</a></td><td> </td><td align="left" valign="top"> -</td></tr> -<tr><td align="left" valign="top"><a href="#SEC37">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="#SEC38">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="#SEC45">6.12 Customizing the file names</a></td><td> </td><td align="left" valign="top"></td></tr> -<tr><td align="left" valign="top"><a href="#SEC46">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> -<a name="SEC18"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC17" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC19" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC17" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC47" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<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="#SEC6">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. The <em>Footnote page</em> should only -be present if the footnotes appear on a separated page -(see section <a href="#SEC10">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. -</p></dd> -</dl> - -<hr size="6"> -<a name="The-page-layout"></a> -<a name="SEC19"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC18" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC21" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC17" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC47" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<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="IDX75"></a> -<code>$SMALL_RULE</code>, -<a name="IDX76"></a> -<code>$DEFAULT_RULE</code>, <a name="IDX77"></a> -<code>$MIDDLE_RULE</code> and <a name="IDX78"></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="SEC20"></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="#SEC23">Specifying the buttons formatting</a>), and used in the formatting functions -(see section <a href="#SEC25">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="IDX79"></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="IDX80"></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> -</dl> - -<hr size="6"> -<a name="Navigation-panel"></a> -<a name="SEC21"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC19" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC22" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC17" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC47" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<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="#SEC22">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="#SEC23">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="#SEC24">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> -<a name="SEC22"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC21" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC23" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC21" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC47" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<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="IDX81"></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="IDX82"></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="IDX83"></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="#SEC10">Page layout related command line options</a>). -</p></dd> -</dl> - -<hr size="6"> -<a name="Button-specifications"></a> -<a name="SEC23"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC22" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC24" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC21" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC47" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<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="IDX84"></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="IDX85"></a> -</dt> -<dt> <code>@NODE_FOOTER_BUTTONS</code> -<a name="IDX86"></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="IDX87"></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="IDX88"></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="IDX89"></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="IDX90"></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> -</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 first argument a filehandle reference on the -current file and second argument a boolean true if the navigation -panel should be vertical. -</p></dd> -<dt> <em>reference on a scalar</em></dt> -<dd><p>The scalar value is printed. For some possibly -usefull scalars, <a href="#SEC26">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="IDX91"></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="IDX92"></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="#SEC32">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="IDX93"></a> -<code>%ACTIVE_ICONS</code> -hash if the the link really leads to an element, or in the <a name="IDX94"></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. -</p></dd> -</dl> - -<hr size="6"> -<a name="Panel-formatting-function"></a> -<a name="SEC24"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC23" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC25" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC21" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC47" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<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><u>Function Reference:</u> <b>print_navigation</b><i> $filehandle \@buttons $vertical</i> -<a name="IDX95"></a> -</dt> -<dd><p><var>$filehandle</var> is the opened filehandle the function should write to. -<var>\@buttons</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. -</p></dd></dl> - -<hr size="6"> -<a name="Program-variables"></a> -<a name="SEC25"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC24" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC26" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC17" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC47" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<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="#SEC26">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="#SEC27">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="#SEC31">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> -<a name="SEC26"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC25" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC27" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC25" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC47" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<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="IDX96"></a> -</dt> -<dd><p>The formatted element name -</p></dd> -<dt> <code>%Texi2HTML::HREF</code> -<a name="IDX97"></a> -</dt> -<dd><p>The element hypertext reference -</p></dd> -<dt> <code>%Texi2HTML::NODE</code> -<a name="IDX98"></a> -</dt> -<dd><p>The element node name -</p></dd> -<dt> <code>%Texi2HTML::NO_TEXI</code> -<a name="IDX99"></a> -</dt> -<dd><p>The element name after removal of texi commands -</p></dd> -</dl> - -<hr size="6"> -<a name="Global-informations"></a> -<a name="SEC27"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC26" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC31" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC25" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC47" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<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="SEC28"></a> -<h4 class="subsubheading"> Global strings </h4> -<p>The <a name="IDX100"></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>@title</code>. If there is no <code>@title</code> other -possibilities are tried (<code>@settitle</code>, <code>@shorttitlepage</code>…). -</p></dd> -<dt> <code>title</code></dt> -<dd><p>title set by <code>@settitle</code>, or <code>fulltitle</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</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>destination_directory</code></dt> -<dd><p>Destination directory for the resulting files. -</p></dd> -<dt> <code>toc_file</code></dt> -<dd><p>The file name of the table of contents. -</p></dd> -<dt> <code>today</code></dt> -<dd><p>The date. -</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. -</p> - -<a name="SEC29"></a> -<h4 class="subsubheading"> Flags </h4> -<p>Flags defined by <code>@set</code> may be accessed through the -<a name="IDX101"></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="IDX102"></a> -<code>%main::value</code>. -</p> - -<a name="SEC30"></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="IDX103"></a> -</dt> -<dd><p>Lines of the current element. -</p></dd> -<dt> <code>$Texi2HTML::THIS_HEADER</code> -<a name="IDX104"></a> -</dt> -<dd><p>Lines of the current element appearing before the element label (anchors). -</p></dd> -<dt> <code>$Texi2HTML::OVERVIEW</code> -<a name="IDX105"></a> -</dt> -<dd><p>Lines of short table of contents. See section <a href="#SEC38">Special pages formatting</a>. -</p></dd> -<dt> <code>$Texi2HTML::TOC_LINES</code> -<a name="IDX106"></a> -</dt> -<dd><p>Lines of table of contents. See section <a href="#SEC38">Special pages formatting</a>. -</p></dd> -</dl> - -<hr size="6"> -<a name="Global-functions"></a> -<a name="SEC31"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC27" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC32" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC25" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC47" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<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><u>Function:</u> $words_number <b>main::print_lines</b><i> $filehandle \@lines_array</i> -<a name="IDX107"></a> -</dt> -<dd><p><var>$filehandle</var> is the opened filehandle the function should write to. -<var>\@lines_array</var> is the array line the function should write to the file. -If this argument is omitted, the function uses <a name="IDX108"></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="IDX109"></a> -<code>$WORDS_IN_PAGE</code> is defined. -</p></dd></dl> - -<hr size="6"> -<a name="Output-initialization"></a> -<a name="SEC32"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC31" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC33" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC17" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC47" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<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 -@-commands 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><u>Function Reference:</u> $encoding <b>init_out</b> -<a name="IDX110"></a> -</dt> -<dd><p>This function perform the initialization of variables and any other -task before document outputting. It returns the encoding used for the -output files. -</p></dd></dl> - -<p>In the default case the <a name="IDX111"></a> -<code>$BODYTEXT</code> (see section <a href="#SEC35">Customizing the page header</a>) -and the hashes <a name="IDX112"></a> -<code>%NAVIGATION_TEXT</code> (see section <a href="#SEC23">Specifying the buttons formatting</a>) and -<a name="IDX113"></a> -<code>%BUTTONS_GOTO</code> (see section <a href="#SEC43">Formatting of about text</a>) are initialized. -</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() -{ - my $encoding = &$default_init_out(); - $NAVIGATION_TEXT{'Following'} = ' &gt; '; - return $encoding; -} -</pre></td></tr></table> -<hr size="6"> -<a name="Output-finalization"></a> -<a name="SEC33"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC32" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC34" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC17" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC47" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<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><u>Function Reference:</u> <b>finish_out</b> -<a name="IDX114"></a> -</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> -<a name="SEC34"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC33" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC35" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC17" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC47" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h2 class="section"> 6.7 Customizing the <code>texi2html</code> css lines </h2> - -<p>It is possible to modify the <code>texi2html</code> css lines by modifying -the entries or adding to the <a name="IDX115"></a> -<code>%css_map</code> hash. Each key is a css -selector, the corresponding value is a style string. -</p> -<p>The whole css text is in the variable <a name="IDX116"></a> -<code>$CSS_LINES</code>. If this -variable is defined the variable value is used instead of being -constructed using the <a name="IDX117"></a> -<code>%css_map</code> 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>It is also possible to change completely the way <a name="IDX118"></a> -<code>$CSS_LINES</code> are -generated by redefining the following function reference: -</p> - -<dl> -<dt><u>Function Reference:</u> <b>css_lines</b><i> \@import_lines \@rule_lines</i> -<a name="IDX119"></a> -</dt> -<dd><p>This function should be used to construct the <a name="IDX120"></a> -<code>$CSS_LINES</code>. -<var>\@import_lines</var> are the <code>@import</code> lines of the -files specified with <a name="IDX121"></a> -<samp>`--include-css'</samp>, -and <var>\@rule_lines</var> are the css commands lines of these files. -See section <a href="#SEC11">Customizing the <acronym>HTML</acronym> and text style</a>. -</p></dd></dl> - -<hr size="6"> -<a name="Customizing-header"></a> -<a name="SEC35"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC34" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC36" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC17" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC47" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<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="IDX122"></a> -<code>$EXTRA_HEAD</code>. -Similarly it is possible to add text just after the <code><body></code> -element with the variable <a name="IDX123"></a> -<code>$AFTER_BODY_OPEN</code>. -These variables are empty by default. -</p> -<p>The encoding of the texinfo file is defined by <a name="IDX124"></a> -<code>$DOCUMENT_ENCODING</code> -if no <code>@documentencoding</code> appears in the document. -The default is a <samp>`en-ascii'</samp> encoding. -The encoding of the resulting document is defined by -<a name="IDX125"></a> -<code>$ENCODING</code>. The default is the <code>$DOCUMENT_ENCODING</code>. -</p> -<p>The description of the document may be specified in -<a name="IDX126"></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. -</p> -<p>The <code><body></code> element attributes may be set by defining the -variable <a name="IDX127"></a> -<code>$BODYTEXT</code>. If you want to define that variable -dynamically, you should use the <code>init_out</code> function reference -(see section <a href="#SEC32">Preparing the output</a>). -</p> -<p>The default functions call the function associated with -<a name="IDX128"></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><u>Function Reference:</u> <b>print_head_navigation</b><i> $filehandle \@buttons</i> -<a name="IDX129"></a> -</dt> -<dd><p><var>$filehandle</var> is the opened filehandle the function should write to. -<var>\@buttons</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="IDX130"></a> -<code>$print_page_head</code> is called for all the pages, and after that, -the function associated with <a name="IDX131"></a> -<code>$print_chapter_header</code> is called -if the document is split at chapters, or the function associated with -<a name="IDX132"></a> -<code>$print_section_header</code> is called if the document is split at sections. -</p> -<dl> -<dt><u>Function Reference:</u> <b>print_page_head</b><i> $filehandle</i> -<a name="IDX133"></a> -</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><u>Function Reference:</u> <b>print_chapter_header</b><i> $filehandle</i> -<a name="IDX134"></a> -</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><u>Function Reference:</u> <b>print_section_header</b><i> $filehandle</i> -<a name="IDX135"></a> -</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> -<a name="SEC36"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC35" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC37" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC17" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC47" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<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><u>Function Reference:</u> <b>print_section</b><i> $filehandle $first_in_page $previous_is_top</i> -<a name="IDX136"></a> -</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. -</p></dd></dl> - -<dl> -<dt><u>Function Reference:</u> <b>end_section</b><i> $filehandle $last_element_or_before_top</i> -<a name="IDX137"></a> -</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> -<a name="SEC37"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC36" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC38" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC17" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC47" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<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="IDX138"></a> -<code>$PRE_BODY_CLOSE</code>. Nothing is added -by default. -</p> - -<p>The default functions call the function associated with -<a name="IDX139"></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><u>Function Reference:</u> <b>print_foot_navigation</b><i> $filehandle \@buttons</i> -<a name="IDX140"></a> -</dt> -<dd><p><var>$filehandle</var> is the opened filehandle the function should write to. -<var>\@buttons</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 the page footer -formatting by redefining three function references. -The function associated with <a name="IDX141"></a> -<code>$print_chapter_footer</code> is called -if the document is split at chapters, or the function associated with -<a name="IDX142"></a> -<code>$print_section_footer</code> is called if the document is split at sections. - After that the function associated -with <a name="IDX143"></a> -<code>$print_page_foot</code> is called. -</p> -<dl> -<dt><u>Function Reference:</u> <b>print_page_foot</b><i> $filehandle</i> -<a name="IDX144"></a> -</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><u>Function Reference:</u> <b>print_chapter_footer</b><i> $filehandle</i> -<a name="IDX145"></a> -</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><u>Function Reference:</u> <b>print_section_footer</b><i> $filehandle</i> -<a name="IDX146"></a> -</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> -<a name="SEC38"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC37" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC39" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC17" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC47" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<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="#SEC39">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="#SEC44">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> -<a name="SEC39"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC38" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC40" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC38" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC47" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h3 class="subsection"> 6.11.1 Customizing the content of the special pages </h3> - -<table class="menu" border="0" cellspacing="0"> -<tr><td align="left" valign="top"><a href="#SEC40">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="#SEC41">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="#SEC42">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="#SEC43">6.11.1.4 Formatting of about text</a></td><td> </td><td align="left" valign="top"> -</td></tr> -</table> - -<hr size="6"> -<a name="Top-element-text"></a> -<a name="SEC40"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC39" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC41" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC39" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC47" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<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><u>Function Reference:</u> <b>print_Top_header</b><i> $filehandle $begin_page</i> -<a name="IDX147"></a> -</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><u>Function Reference:</u> <b>print_Top</b><i> $filehandle $has_top_heading</i> -<a name="IDX148"></a> -</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><u>Function Reference:</u> <b>print_Top_footer</b><i> $filehandle $end_page</i> -<a name="IDX149"></a> -</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> -<a name="SEC41"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC40" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC42" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC39" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC47" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h4 class="subsubsection"> 6.11.1.2 Table of contents and Short table of contents </h4> -<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="IDX150"></a> -</dt> -<dd><p>If the variable is true a table of contents is done even if there is no -<code>@contents</code> command. -</p></dd> -<dt> <code>$DO_SCONTENTS</code> -<a name="IDX151"></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. -</p></dd> -<dt> <code>$BEFORE_OVERVIEW</code> -<a name="IDX152"></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="IDX153"></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="IDX154"></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="IDX155"></a> -</dt> -<dd><p>The variable value is inserted after the table of contents text. -</p></dd> -<dt> <code>$TOC_LIST_STYLE</code> -<a name="IDX156"></a> -</dt> -<dd><p>This should contain a css style used for the list style if the tables of -content are formatted with a list. -</p></dd> -<dt> <code>$TOC_LIST_ATTRIBUTE</code> -<a name="IDX157"></a> -</dt> -<dd><p>This should contain an attribute text used for the list element if the tables of -content 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><u>Function Reference:</u> <b>toc_body</b><i> \@elements </i> -<a name="IDX158"></a> -</dt> -<dd><p><var>\@elements</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="IDX159"></a> -<code>$Texi2HTML::TOC_LINES</code> and -<a name="IDX160"></a> -<code>$Texi2HTML::OVERVIEW</code> references with the table of contents and short -table of contents. -</p> -</dd></dl> - -<hr size="6"> -<a name="Footnotes-text"></a> -<a name="SEC42"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC41" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC43" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC39" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC47" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<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="#SEC82">Customizing the footnotes formatting</a>. -</p> -<hr size="6"> -<a name="About-text"></a> -<a name="SEC43"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC42" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC44" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC39" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC47" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<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="#SEC23">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="#SEC32">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><u>Function Reference:</u> $about_text <b>print_about</b> -<a name="IDX161"></a> -</dt> -<dd><p>This function should return the about text. -</p></dd></dl> - -<hr size="6"> -<a name="Special-pages-layout"></a> -<a name="SEC44"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC43" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC45" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC38" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC47" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<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="IDX162"></a> -</dt> -<dt> <code>print_Top_header</code> -<a name="IDX163"></a> -</dt> -<dt> <code>print_Top_footer</code> -<a name="IDX164"></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="#SEC40">Top element text formatting</a>). -</p></dd> -<dt> <code>print_Toc</code> -<a name="IDX165"></a> -</dt> -<dd><p>Formatting of table of contents page or section -</p></dd> -<dt> <code>print_Overview</code> -<a name="IDX166"></a> -</dt> -<dd><p>Formatting of short table of contents page or section -</p></dd> -<dt> <code>print_About</code> -<a name="IDX167"></a> -</dt> -<dd><p>Formatting of about (help) page or section -</p></dd> -<dt> <code>print_Footnotes</code> -<a name="IDX168"></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="IDX169"></a> -<code>$print_Top</code> calls <a name="IDX170"></a> -<code>$print_Top_header</code> for -the header and <a name="IDX171"></a> -<code>$print_Top_footer</code> for the footer of top element. -All the other function call <a name="IDX172"></a> -<code>$print_misc</code> which in turn calls -<a name="IDX173"></a> -<code>$print_misc_header</code> for the headers and <a name="IDX174"></a> -<code>$print_misc_footer</code> -for the footers. -</p> -<hr size="6"> -<a name="File-names"></a> -<a name="SEC45"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC44" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC46" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC17" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC47" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h2 class="section"> 6.12 Customizing the file names </h2> - -<p>It is possible to specify the file names with more control than with the -command line options (see section <a href="#SEC7">Setting output file and directory names</a>). -First the extension may be overrided by the variable <a name="IDX175"></a> -<code>$EXTENSION</code> -value. -Two function references enable -further customization. One is usefull in case <a name="IDX176"></a> -<code>$NODE_FILES</code> is true -and it is used to customize the node file name itself and is also used -to produce a file name with a redirection leading to the node file. -</p> -<dl> -<dt><u>Function Reference:</u> ($node_file $redirection_node_file) <b>node_file_name</b><i> $node</i> -<a name="IDX177"></a> -</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>, and the file containing -a redirection to the node <var>$redirection_node_file</var>. -</p></dd></dl> - -<p>The other is usefull if <code>$NODE_FILES</code> isn't true. It is used to -customize the file associated with each element. -</p><dl> -<dt><u>Function Reference:</u> $file <b>element_file_name</b><i> $element $is_top $docu_name</i> -<a name="IDX178"></a> -</dt> -<dd><p><var>$element</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 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="#SEC6">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>$is_top</var> is true if the element is considered as the top element. -<var>$docu_name</var> is the basename of the texinfo manual. -The result is the element file name. -</p></dd></dl> - -<hr size="6"> -<a name="External-index-files"></a> -<a name="SEC46"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC45" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC47" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC17" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC47" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<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="#SEC78">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="IDX179"></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 finalazation. -</p> -<dl> -<dt><u>Function Reference:</u> <b>index_summary_file_begin</b><i> $index_name $is_printed</i> -<a name="IDX180"></a> -</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. -</p></dd></dl> - -<dl> -<dt><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</i> -<a name="IDX181"></a> -</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. -</p></dd></dl> - -<dl> -<dt><u>Function Reference:</u> <b>index_summary_file_end</b><i> $index_name $is_printed</i> -<a name="IDX182"></a> -</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. -</p></dd></dl> - -<hr size="6"> -<a name="Customizing-HTML"></a> -<a name="SEC47"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC46" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC48" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC17" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC_Top" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC84" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<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="#SEC11">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="#SEC48">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="#SEC49">7.2 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="#SEC50">7.3 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="#SEC54">7.4 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="#SEC55">7.5 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="#SEC56">7.6 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="#SEC57">7.7 References</a></td><td> </td><td align="left" valign="top"> -</td></tr> -<tr><td align="left" valign="top"><a href="#SEC60">7.8 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="#SEC61">7.9 Formatting or not a paragraph or a preformatted region</a></td><td> </td><td align="left" valign="top"> -</td></tr> -<tr><td align="left" valign="top"><a href="#SEC64">7.10 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="#SEC65">7.11 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="#SEC68">7.12 Definition commands formatting</a></td><td> </td><td align="left" valign="top"> -</td></tr> -<tr><td align="left" valign="top"><a href="#SEC71">7.13 Customizing headings formatting</a></td><td> </td><td align="left" valign="top"> -</td></tr> -<tr><td align="left" valign="top"><a href="#SEC72">7.14 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="#SEC73">7.15 Menu formatting</a></td><td> </td><td align="left" valign="top"> -</td></tr> -<tr><td align="left" valign="top"><a href="#SEC76">7.16 Indices formatting</a></td><td> </td><td align="left" valign="top"> -</td></tr> -<tr><td align="left" valign="top"><a href="#SEC79">7.17 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="#SEC82">7.18 Customizing the footnotes formatting</a></td><td> </td><td align="left" valign="top"> -</td></tr> -<tr><td align="left" valign="top"><a href="#SEC83">7.19 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> -<a name="SEC48"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC47" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC49" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC84" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<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="#SEC73">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="Commands-without-argument"></a> -<a name="SEC49"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC48" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC50" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC84" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h2 class="section"> 7.2 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><p> command type </p></td><td><p> normal text </p></td><td><p> preformatted text </p></td><td><p> string -</p></td></tr> -<tr><td><p> one nonlettered character </p></td><td> <a name="IDX183"></a> -<p><code>%simple_map</code> </p></td><td> <a name="IDX184"></a> -<p><code>%simple_map_pre</code> </p></td><td> <a name="IDX185"></a> -<p><code>%simple_map_texi</code> -</p></td></tr> -<tr><td><p> nothing in braces </p></td><td> <a name="IDX186"></a> -<p><code>%things_map</code> </p></td><td> <a name="IDX187"></a> -<p><code>%pre_map</code> </p></td><td> <a name="IDX188"></a> -<p><code>%texi_map</code> -</p></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="Style-and-accent-commands"></a> -<a name="SEC50"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC49" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC51" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC84" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h2 class="section"> 7.3 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="IDX189"></a> -<code>%style_map</code> for normal context, <a name="IDX190"></a> -<code>%style_map_pre</code> for -preformatted context and <a name="IDX191"></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 class="toc"> -<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="IDX192"></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="#SEC51">7.3.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="#SEC52">7.3.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="#SEC53">7.3.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> -<a name="SEC51"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC50" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC52" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC50" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC84" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h3 class="subsection"> 7.3.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="IDX193"></a> -<code>$OPEN_QUOTE_SYMBOL</code> and -<a name="IDX194"></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>$style_stack</code></dt> -<dd><p>A reference on an array containing the name of the @-commands containing -the @-command being formatted. -</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 -@-command. 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> -<a name="SEC52"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC51" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC53" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC50" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC84" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h3 class="subsection"> 7.3.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="IDX195"></a> -<code>$OPEN_QUOTE_SYMBOL</code> and -<a name="IDX196"></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} -@foo{truc, 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> -<a name="SEC53"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC52" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC54" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC50" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC84" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h3 class="subsection"> 7.3.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><u>Function Reference:</u> $resulting_text <b>style</b><i> $style $command $text $args $no_close $no_open $line_nr $state $style_stack</i> -<a name="IDX197"></a> -</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 -@-command. 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>$style_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> -<a name="SEC54"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC53" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC55" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC84" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h2 class="section"> 7.4 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="IDX198"></a> -<code>$anchor</code>, but the function -associated with the function reference does more, it is usefull -to produce a reference target or link. -</p><dl> -<dt><u>Function Reference:</u> $anchor <b>anchor</b><i> $identifier $href $text $attributes</i> -<a name="IDX199"></a> -</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>The formatting of <code>@image</code> is controlled by: -</p><dl> -<dt><u>Function Reference:</u> $image <b>image</b><i> $file_path $basename $preformatted $file_name</i> -<a name="IDX200"></a> -</dt> -<dd><p><var>$file_path</var> is the image file name with the path, <var>$basename</var> is the -alternate text or the file name without extension if no alternate text is -given. <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. -</p></dd></dl> - -<p>The formatting of <code>@sp</code> is controlled by: -</p><dl> -<dt><u>Function Reference:</u> $sp <b>sp</b><i> $number $preformatted</i> -<a name="IDX201"></a> -</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><u>Function Reference:</u> $acronym <b>acronym_like</b><i> $acronym_texi $acronym_text $with_explanation \@explanation_lines $explanation_text $explanation_simply_formatted</i> -<a name="IDX202"></a> -</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>\@explanation_lines</var> is a -reference on an array containing the unformatted 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> -<a name="SEC55"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC54" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC56" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC84" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h2 class="section"> 7.5 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 those characters in text -</p> -<dl> -<dt><u>Function Reference:</u> $processed_text <b>normal_text</b><i> $text</i> -<a name="IDX203"></a> -</dt> -<dd><p>The function processes <samp>`---'</samp>, <samp>`--'</samp>, <samp>```'</samp> and <samp>`'''</samp> -in <var>$text</var> and returns <var>$processed_text</var>. The default is to -change <samp>`---'</samp> to <samp>`--'</samp>, <samp>`--'</samp> to <samp>`-'</samp>, and <samp>```'</samp> and -<samp>`'''</samp> to <samp>`"'</samp>. -</p></dd></dl> - -<p>Some characters are special in <acronym>HTML</acronym> (<samp>`&'</samp>, <samp>`"'</samp>, -<samp>`<'</samp> and <samp>`>'</samp>) and should be protected. -This is done by the function associated with the function reference -</p> -<dl> -<dt><u>Function Reference:</u> $protected_text <b>protect_text</b><i> $text</i> -<a name="IDX204"></a> -</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><u>Function Reference:</u> $resulting_text <b>empty_line</b><i> $empty_line</i> -<a name="IDX205"></a> -</dt> -<dd><p>This function processes an <var>$empty_line</var> and returns the resulting -text <var>$resulting_text</var>. Empty lines are left as is by default. -</p></dd></dl> - -<hr size="6"> -<a name="Strings"></a> -<a name="SEC56"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC55" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC57" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC84" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h2 class="section"> 7.6 Customizing strings written by <code>texi2html</code> </h2> - - -<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="IDX206"></a> -<samp>`--lang'</samp>, <a name="IDX207"></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="IDX208"></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>For more on internationalization, see <a href="#SEC84">Internationalization</a>. -</p> -<hr size="6"> -<a name="References"></a> -<a name="SEC57"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC56" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC58" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC84" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h2 class="section"> 7.7 References </h2> - -<table class="menu" border="0" cellspacing="0"> -<tr><td align="left" valign="top"><a href="#SEC58">7.7.1 Reference to external manual</a></td><td> </td><td align="left" valign="top"> -</td></tr> -<tr><td align="left" valign="top"><a href="#SEC59">7.7.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> -<a name="SEC58"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC57" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC59" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC57" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC84" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h3 class="subsection"> 7.7.1 Reference to external manual </h3> - -<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><u>Function Reference:</u> $href <b>external_href</b><i> $node $node_identifier $xml_node_identifier $manual_file_name</i> -<a name="IDX209"></a> -</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>, -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>). -</p></dd></dl> - -<dl> -<dt><u>Function Reference:</u> $text <b>external_ref</b><i> $command $section $book $node_and_file $href $cross_ref_name</i> -<a name="IDX210"></a> -</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. 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> -<a name="SEC59"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC58" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC60" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC57" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC84" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h3 class="subsection"> 7.7.2 Reference to an internal node </h3> - -<p>A function reference is available for internal references. -</p> -<dl> -<dt><u>Function Reference:</u> $text <b>internal_ref</b><i> $command $href $short_name $name $is_section</i> -<a name="IDX211"></a> -</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. This function returns the full formatted text of the internal -reference. -</p></dd></dl> - - -<hr size="6"> -<a name="Alignement-commands"></a> -<a name="SEC60"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC59" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC61" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC84" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h2 class="section"> 7.8 Commands used for centering and flushing of text </h2> - - -<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="IDX212"></a> -<code>%paragraph_style</code> hash. -The value is used in the function doing the formatting of the paragraphs. -See section <a href="#SEC61">Formatting or not a paragraph or 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><u>Function Reference:</u> $result <b>paragraph_style_command</b><i> $command $text</i> -<a name="IDX213"></a> -</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> -<a name="SEC61"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC60" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC62" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC84" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h2 class="section"> 7.9 Formatting or not a paragraph or a preformatted region </h2> - - -<table class="menu" border="0" cellspacing="0"> -<tr><td align="left" valign="top"><a href="#SEC62">7.9.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="#SEC63">7.9.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> -<a name="SEC62"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC61" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC63" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC61" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC84" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h3 class="subsection"> 7.9.1 Paragraph and preformatted region formatting </h3> - - -<p>The formatting of a paragraph region or a preformatted region, is controlled -by function references: -</p> -<dl> -<dt><u>Function Reference:</u> $paragraph_text <b>paragraph</b><i> $text $alignement $formatting_command $formatting_command_formatted \$paragraph_number $format $item_number $enumerate_style $number</i> -<a name="IDX214"></a> -</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="#SEC60">Commands used for centering and flushing of text</a>. -</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="#SEC66">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><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</i> -<a name="IDX215"></a> -</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="#SEC34">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="#SEC64">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="#SEC73">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. -</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="#SEC66">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> -<a name="SEC63"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC62" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC64" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC61" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC84" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h3 class="subsection"> 7.9.2 Avoiding paragraphs in formats </h3> - - -<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="IDX216"></a> -<code>%format_in_paragraph</code> with a true value. -</p> -<hr size="6"> -<a name="Complex-formats"></a> -<a name="SEC64"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC63" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC65" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC84" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h2 class="section"> 7.10 Formatting of complex formats (<code>@example</code>, <code>@display</code>…) </h2> - - -<p>Here we see how a whole complex format is formatted. For the formatting -of the text, see <a href="#SEC61">Formatting or not a paragraph or 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="IDX217"></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 <code>begin</code> -and <code>end</code>. An eval of <code>begin</code> should lead to the beginning of the -formatted <acronym>HTML</acronym>, an eval of <code>end</code> should lead to the end of the -formatted <acronym>HTML</acronym>. The enclosed text will be formatted as described in -<a href="#SEC61">Formatting or not a paragraph or 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><u>Function Reference:</u> $complex_format_text <b>complex_format</b><i> $format_name $preformatted_text</i> -<a name="IDX218"></a> -</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="#SEC61">Formatting or not a paragraph or a preformatted region</a>. -This function returns the whole complex format. -</p></dd></dl> - -<hr size="6"> -<a name="Lists-tables"></a> -<a name="SEC65"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC64" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC66" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC84" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h2 class="section"> 7.11 Customizing the formatting of lists and tables </h2> - -<p>The formatting of lists and tables is done at two levels: -</p><ul class="toc"> -<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="#SEC66">7.11.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="#SEC67">7.11.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> -<a name="SEC66"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC65" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC67" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC65" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC84" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h3 class="subsection"> 7.11.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="IDX219"></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 -@item an item -@end itemize -</pre></td></tr></table> -<p>then <code>@bullet</code> will not be applied to <code>an item</code>. -</p> -<dl compact="compact"> -<dt> <em>lists</em></dt> -<dd><p>The items of lists are formatted using the following function reference: -</p><dl> -<dt><u>Function Reference:</u> $list_item <b>list_item</b><i> $text $format $command $formatted_command $item_number $enumerate_style $number</i> -<a name="IDX220"></a> -</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></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><u>Function Reference:</u> $table_item <b>table_item</b><i> $item_text $index_label_text $format $command $formatted_command</i> -<a name="IDX221"></a> -</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="#SEC77">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>. -</p></dd></dl> - -<dl> -<dt><u>Function Reference:</u> $table_line <b>table_line</b><i> $text</i> -<a name="IDX222"></a> -</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>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><u>Function Reference:</u> $multitable_cell <b>cell</b><i> $text</i> -<a name="IDX223"></a> -</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. -</p></dd></dl> - -<dl> -<dt><u>Function Reference:</u> $multitable_row <b>row</b><i> $text $item_command</i> -<a name="IDX224"></a> -</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="IDX225"></a> -<code>$cell</code> -function reference. <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>. -</p></dd></dl> -</dd> -</dl> - -<hr size="6"> -<a name="Whole-table-list"></a> -<a name="SEC67"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC66" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC68" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC65" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC84" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h3 class="subsection"> 7.11.2 Formatting of a whole table or list </h3> - -<p>If the Texinfo command is a key of the <a name="IDX226"></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 class="toc"> -<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><u>Function Reference:</u> $whole_table_list <b>table_list</b><i> $command $text</i> -<a name="IDX227"></a> -</dt> -<dd><p><var>$command</var> is the Texinfo command name, <var>$text</var> is the formatted -items. -</p></dd></dl> - -<p>If you still want to use <a name="IDX228"></a> -<code>%format_map</code> but differently from -the default, it is possible to redefine the following function reference: -</p> -<dl> -<dt><u>Function Reference:</u> $whole_table_list <b>format</b><i> $command $format $text</i> -<a name="IDX229"></a> -</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> -<a name="SEC68"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC67" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC69" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC84" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h2 class="section"> 7.12 Definition commands formatting </h2> - -<p>The formatting of definition commands is controlled by a hash and four -functions. The hash 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="#SEC69">7.12.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="#SEC70">7.12.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> -<a name="SEC69"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC68" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC70" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC68" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC84" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h3 class="subsection"> 7.12.1 Customizing the interpretation of a definition line </h3> - -<p>The keys of the hash <a name="IDX230"></a> -<code>%def_map</code> are definition command names. -There are two types of entries: -</p> -<ul class="toc"> -<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> and <samp>`arg'</samp>. -</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> - -<hr size="6"> -<a name="Definition-formatting"></a> -<a name="SEC70"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC69" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC71" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC68" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC84" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h3 class="subsection"> 7.12.2 Customization of the definition formatting </h3> - -<p>Four functions are used when formatting a definition command: -</p> -<dl compact="compact"> -<dt> category name</dt> -<dd><dl> -<dt><u>Function Reference:</u> $category <b>definition_category</b><i> $category_or_name $class $style</i> -<a name="IDX231"></a> -</dt> -<dd><p>This function precise a category or an index entry name associating a class -<var>$class</var> (if given) with <var>$category_or_name</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. -</p></dd></dl> -</dd> -<dt> formatting of the definition line</dt> -<dd><dl> -<dt><u>Function Reference:</u> $line <b>def_line</b><i> $category $name $type $arguments $index_label</i> -<a name="IDX232"></a> -</dt> -<dd><p>This function formats the definition line. <var>$category</var> is the category -formatted with <a name="IDX233"></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="#SEC77">Formatting of index entries</a>. -</p></dd></dl> - -</dd> -<dt> definition text</dt> -<dd><dl> -<dt><u>Function Reference:</u> $definition_text <b>def_item</b><i> $text</i> -<a name="IDX234"></a> -</dt> -<dd><p>This function formats the definition text, <var>$text</var>. -</p></dd></dl> - -</dd> -<dt> the whole definition</dt> -<dd><dl> -<dt><u>Function Reference:</u> $definition <b>def</b><i> $text</i> -<a name="IDX235"></a> -</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> -<a name="SEC71"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC70" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC72" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC84" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h2 class="section"> 7.13 Customizing headings formatting </h2> - -<p>A function controls the formatting of sectioning element headings, -with the corresponding function reference: -</p><dl> -<dt><u>Function Reference:</u> $heading_text <b>heading</b><i> \%element_reference</i> -<a name="IDX236"></a> -</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> -</dl> -</dd></dl> - -<hr size="6"> -<a name="Special-regions"></a> -<a name="SEC72"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC71" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC73" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC84" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h2 class="section"> 7.14 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><u>Function Reference:</u> $raw_region <b>raw</b><i> $command $text</i> -<a name="IDX237"></a> -</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, -from within the main program. -</p> -<p>The <code>@cartouche</code> command formatting is controlled by the -function reference: -</p> -<dl> -<dt><u>Function Reference:</u> $cartouche <b>cartouche</b><i> $text</i> -<a name="IDX238"></a> -</dt> -<dd><p><var>$text</var> is the text appearing within the cartouche. -</p></dd></dl> - -<p>The formatting of <code>@quotation</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><u>Function Reference:</u> $prepended_string <b>quotation_prepend_text</b><i> $style $text</i> -<a name="IDX239"></a> -</dt> -<dd><p><var>$style</var> is the first argument of the <code>@quotation</code> if there are -two arguments. <var>$text</var> is the second argument or the first if there is -one argument. There are still @-commands in these strings. 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><u>Function Reference:</u> $quotation <b>quotation</b><i> $quotation_text $argument_text $argument_style_texi $argument_style_id</i> -<a name="IDX240"></a> -</dt> -<dd><p><var>$quotation_text</var> is the quotation text, formatted, with the text -prepended by the function above. <var>$argument_text</var> is the second argument -of the <code>@quotation</code> or the first if there is one argument, formatted. -The other arguments are defiend if there are two arguments for the -<code>@quotation</code>, <var>$argument_style_texi</var> is this argument, with -@-commands, and <var>$argument_style_id</var> is this argument transformed in -an identifier which can be used as an <acronym>XML</acronym> identifier. -</p></dd></dl> - - -<hr size="6"> -<a name="Menus"></a> -<a name="SEC73"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC72" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC74" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC84" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h2 class="section"> 7.15 Menu formatting </h2> - -<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. -</p> -<table class="menu" border="0" cellspacing="0"> -<tr><td align="left" valign="top"><a href="#SEC74">7.15.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="#SEC75">7.15.2 The formatting of the different menu components</a></td><td> </td><td align="left" valign="top"> -</td></tr> -</table> - -<hr size="6"> -<a name="Menu-parts"></a> -<a name="SEC74"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC73" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC75" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC73" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC84" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h3 class="subsection"> 7.15.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 some text begining at the first character of a line -or an empty line, not contained within a command block which begun in the -description. An empty line or a line with text at the first character -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 -* node name: entry name. description begins - description continues -* another menu entry:: - description begins - description continues - - A menu comment, after an empty line - -* node:: description begins -A menu comment. The line starts at the first character - -* last entry:: description begins <em>text -of the description, even if the line begins at the first character, -because we are in @emph</em>. -@end menu -</pre></td></tr></table> -<hr size="6"> -<a name="Menu-formatting"></a> -<a name="SEC75"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC74" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC76" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC73" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC84" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h3 class="subsection"> 7.15.2 The formatting of the different menu components </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="IDX241"></a> -<code>$NODE_NAME_IN_MENU</code> is -true, however, node names are used. If <a name="IDX242"></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="IDX243"></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="IDX244"></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="IDX245"></a> -<code>$MENU_PRE_STYLE</code>. Default is <samp>`font-family: serif'</samp>. -The css class associated with menu comments is <code>menu-comments</code>. -</p> -<p>Three function references are associated with the formatting of the -different parts of a menu: -</p><dl> -<dt><u>Function Reference:</u> $link <b>menu_link</b><i> $section \%state $href $node $name $ending</i> -<a name="IDX246"></a> -</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. The only key which could be -of interest is <code>preformatted</code>, true if the context is a preformatted -context. See section <a href="#SEC48">Three contexts for expansions: preformatted, normal and string</a>. -<var>$node</var> is the node name, <var>$name</var> is the -name of the node, and <var>$ending</var> is the text ending the link entry. -</p></dd></dl> - -<dl> -<dt><u>Function Reference:</u> $description <b>menu_description</b><i> $description_text \%state</i> -<a name="IDX247"></a> -</dt> -<dd><p><var>$description_text</var> is the text of the menu description. <var>\%state</var> -should be used similarly than for the menu link. -</p></dd></dl> - -<dl> -<dt><u>Function Reference:</u> $menu_comment <b>menu_comment</b><i> $text</i> -<a name="IDX248"></a> -</dt> -<dd><p><var>$text</var> is the text of the menu comment. It is in a preformatted -environment. -</p></dd></dl> - -<p>The following function reference controls the formatting of a wole menu: -</p> -<dl> -<dt><u>Function Reference:</u> $menu <b>menu</b><i> $menu_components_text</i> -<a name="IDX249"></a> -</dt> -<dd><p><var>$menu_components_text</var> is the formatted menu components text, obtained -as explained above. -</p></dd></dl> - -<p>The last function reference corresponds with a special case. It -is used when a menu entry appears within another block command, to -avoid the possibilities of invalid <acronym>HTML</acronym> production. -In that case the menu description and menu comments are not formatted -specially, but treated like normal text. -</p><dl> -<dt><u>Function Reference:</u> $link <b>simple_menu_link</b><i> $link_text $href $node $name $ending</i> -<a name="IDX250"></a> -</dt> -<dd><p><var>$link_text</var> is the text corresponding with the link name, <var>$href</var> -is the link hypertextual reference. -<var>$node</var> is the node name, <var>$name</var> is the -name of the node, and <var>$ending</var> is the text ending the link entry. -</p></dd></dl> - -<hr size="6"> -<a name="Indices"></a> -<a name="SEC76"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC75" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC77" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC84" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h2 class="section"> 7.16 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="#SEC77">7.16.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="#SEC78">7.16.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> -<a name="SEC77"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC76" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC78" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC76" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC84" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h3 class="subsection"> 7.16.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><u>Function Reference:</u> $target <b>index_entry_label</b><i> $identifier $preformatted</i> -<a name="IDX251"></a> -</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. -</p></dd></dl> - -<hr size="6"> -<a name="Index-list"></a> -<a name="SEC78"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC77" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC79" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC76" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC84" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h3 class="subsection"> 7.16.2 Customizing the formatting of index lists </h3> - -<p>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="IDX252"></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><u>Function Reference:</u> $letter <b>summary_letter</b><i> $letter $file $identifier</i> -<a name="IDX253"></a> -</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><u>Function Reference:</u> $summary <b>index_summary</b><i> \@alphabetical_letters \@nonalphabetical_letters</i> -<a name="IDX254"></a> -</dt> -<dd><p><var>\@alphabetical_letters</var> and <var>\@nonalphabetical_letters</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><u>Function Reference:</u> $entry <b>index_entry</b><i> $entry_href $entry_text $section_href $section_heading</i> -<a name="IDX255"></a> -</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><u>Function Reference:</u> $letter_entry <b>index_letter</b><i> $letter $identifier $index_entries_text</i> -<a name="IDX256"></a> -</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><u>Function Reference:</u> $index <b>print_index</b><i> $index_text $index_name</i> -<a name="IDX257"></a> -</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. <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> -<a name="SEC79"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC78" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC80" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC84" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h2 class="section"> 7.17 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, -unformatted. -</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>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>id</code></dt> -<dd><p>The unique identifier associated with the label. Usefull to make an anchor -or a reference. -</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="#SEC80">7.17.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="#SEC81">7.17.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> -<a name="SEC80"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC79" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC81" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC79" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC84" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h3 class="subsection"> 7.17.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><u>Function Reference:</u> (\@caption_lines_returned, \@shortcaption_lines_returned) <b>caption_shortcaption</b><i> \%float \@caption_lines \@shortcaption_lines</i> -<a name="IDX258"></a> -</dt> -<dd><p><var>\%float</var> is the structure defined above. <var>\@caption_lines</var> and -<var>\@shortcaption_lines</var> are references on arrays containing the -texinfo lines for caption and short caption. <var>\@caption_lines_returned</var> -and <var>\@shortcaption_lines_returned</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><u>Function Reference:</u> $text <b>float</b><i> $float_text \%float $caption_text $shortcaption_text</i> -<a name="IDX259"></a> -</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> - -<hr size="6"> -<a name="Lists-of-floats"></a> -<a name="SEC81"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC80" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC82" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC79" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC84" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h3 class="subsection"> 7.17.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><u>Function Reference:</u> $style_texi_returned <b>listoffloats_style</b><i> $style_texi</i> -<a name="IDX260"></a> -</dt> -<dd><p><var>$style_texi</var> is the <code>@listoffloats</code> argument with texinfo -@-commands 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><u>Function Reference:</u> $float_style_texi_returned <b>listoffloats_float_style</b><i> $style_texi \%float</i> -<a name="IDX261"></a> -</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><u>Function Reference:</u> $caption_texi_returned <b>listoffloats_caption</b><i> \%float</i> -<a name="IDX262"></a> -</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><u>Function Reference:</u> $listoffloats_entry <b>listoffloats_entry</b><i> $style_texi \%float $float_style $caption $href</i> -<a name="IDX263"></a> -</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><u>Function Reference:</u> $listoffloats <b>listoffloats</b><i> $style_texi $style \@listoffloats_entries</i> -<a name="IDX264"></a> -</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>\@listoffloats_entries</var> holds the entries formatted by the above -function. -</p></dd></dl> - -<hr size="6"> -<a name="Footnotes"></a> -<a name="SEC82"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC81" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC83" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC84" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h2 class="section"> 7.18 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><u>Function Reference:</u> (\@lines $text_for_document) <b>foot_line_and_ref</b><i> $number_in_doc $number_in_page $footnote_id $place_id $document_file $footnote_file \@lines \%state</i> -<a name="IDX265"></a> -</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>\@lines</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>\@lines</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="#SEC44">Customizing the layout of the special pages</a>. For -the determination of the footnote locations, <a href="#SEC10">Page layout related command line options</a>. -</p> -<dl> -<dt><u>Function Reference:</u> <b>foot_section</b><i> \@footnotes_lines</i> -<a name="IDX266"></a> -</dt> -<dd><p>This function formats a group of footnotes. <var>\@footnotes_lines</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="Other-and-unknown-commands"></a> -<a name="SEC83"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC82" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC84" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC47" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC84" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h2 class="section"> 7.19 Customizing other commands, and unknown commands </h2> - - - -<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="IDX267"></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>texi</code></dt> -<dd><p>If true the arguments are considered to real texinfo, therefore - <code>@value</code> and <code>@macro</code> are expanded. -</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="IDX268"></a> -<code>%simple_map</code>, <a name="IDX269"></a> -<code>%simple_map_pre</code>, -<a name="IDX270"></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><u>Function Reference:</u> ($result_line, $result, $result_text, $message) <b>unknown</b><i> $command $line</i> -<a name="IDX271"></a> -</dt> -<dd><p><var>$command</var> is the @-command, <var>$line</var> is the line following the -<var>$command</var>. <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="IDX272"></a> -<code>%style_map</code>, <a name="IDX273"></a> -<code>%style_map_pre</code> and -<a name="IDX274"></a> -<code>%style_map_texi</code> are processed -by the following function reference -</p> -<dl> -<dt><u>Function Reference:</u> ($result, $result_text, $message) <b>unknown_style</b><i> $command $text</i> -<a name="IDX275"></a> -</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> -<a name="SEC84"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC83" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC85" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC47" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC_Top" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC87" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<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="#SEC56">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="#SEC85">A.1 Translating strings</a></td><td> </td><td align="left" valign="top"> -</td></tr> -<tr><td align="left" valign="top"><a href="#SEC86">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> -<a name="SEC85"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC84" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC86" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC84" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC84" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC87" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h2 class="appendixsec"> A.1 Translating strings </h2> - - -<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="#SEC56">Customizing strings written by <code>texi2html</code></a>. -</p> -<p>After that you should run the command <code>./manage_i18n.pl all</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>./configure</code>. -</p> -<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 similarly run the command -<code>./manage_i18n.pl all</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="#SEC4">Installation of <code>texi2html</code></a>) -you will have to reinstall them otherwise the installated files will -take precedence (see section <a href="#SEC13">Use initialization files for fine tuning</a>). -</p> -<hr size="6"> -<a name="Adding-new-strings"></a> -<a name="SEC86"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC85" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC87" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC84" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC84" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC87" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h2 class="appendixsec"> A.2 Adding new strings written to document </h2> - - -<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 all</code> in the top -directory, it should add your new strings to all the files in the <tt>`i18n'</tt> -directory. -</p> -<hr size="6"> -<a name="Indexop"></a> -<a name="SEC87"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC86" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC88" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC84" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC_Top" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC88" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h1 class="appendix"> B. Command Line Option Index </h1> -<table><tr><th valign="top">Jump to: </th><td><a href="#SEC87_0" class="summary-letter"><b>C</b></a> - -<a href="#SEC87_1" class="summary-letter"><b>D</b></a> - -<a href="#SEC87_2" class="summary-letter"><b>F</b></a> - -<a href="#SEC87_3" class="summary-letter"><b>H</b></a> - -<a href="#SEC87_4" class="summary-letter"><b>I</b></a> - -<a href="#SEC87_5" class="summary-letter"><b>L</b></a> - -<a href="#SEC87_6" class="summary-letter"><b>M</b></a> - -<a href="#SEC87_7" class="summary-letter"><b>N</b></a> - -<a href="#SEC87_8" class="summary-letter"><b>O</b></a> - -<a href="#SEC87_9" class="summary-letter"><b>P</b></a> - -<a href="#SEC87_10" class="summary-letter"><b>S</b></a> - -<a href="#SEC87_11" class="summary-letter"><b>T</b></a> - -<a href="#SEC87_12" class="summary-letter"><b>U</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="SEC87_0">C</a></th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#IDX49">css-include=<var>file</var></a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr> -<tr><td colspan="3"> <hr></td></tr> -<tr><th><a name="SEC87_1">D</a></th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#IDX53">def-table</a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX42">doctype=<var>DTD</var></a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX30">D<var>var</var></a></td><td valign="top"><a href="#SEC9">4.4 Command line options related to Texinfo language features</a></td></tr> -<tr><td colspan="3"> <hr></td></tr> -<tr><th><a name="SEC87_2">F</a></th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#IDX36">frames</a></td><td valign="top"><a href="#SEC10">4.5 Page layout related command line options</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX44">frameset-doctype</a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX43">frameset-doctype=<var>DTD</var></a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr> -<tr><td colspan="3"> <hr></td></tr> -<tr><th><a name="SEC87_3">H</a></th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#IDX51">html-xref-prefix=<var>path</var></a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr> -<tr><td colspan="3"> <hr></td></tr> -<tr><th><a name="SEC87_4">I</a></th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#IDX34">I<var>dir</var></a></td><td valign="top"><a href="#SEC9">4.4 Command line options related to Texinfo language features</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX23">if<region></a></td><td valign="top"><a href="#SEC8">4.3 Specifying which regions get expanded</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX121">include-css</a></td><td valign="top"><a href="#SEC34">6.7 Customizing the <code>texi2html</code> css lines</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX69">init-file</a></td><td valign="top"><a href="#SEC13">4.8 Use initialization files for fine tuning</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX70">init-file</a></td><td valign="top"><a href="#SEC13">4.8 Use initialization files for fine tuning</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX47">iso</a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr> -<tr><td colspan="3"> <hr></td></tr> -<tr><th><a name="SEC87_5">L</a></th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#IDX61">l2h</a></td><td valign="top"><a href="#SEC12">4.7 Expanding <code>@tex</code> and <code>@math</code> regions using LaTeX2HTML</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX66">l2h-file</a></td><td valign="top"><a href="#SEC12">4.7 Expanding <code>@tex</code> and <code>@math</code> regions using LaTeX2HTML</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX62">l2h-l2h=<var>program</var></a></td><td valign="top"><a href="#SEC12">4.7 Expanding <code>@tex</code> and <code>@math</code> regions using LaTeX2HTML</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX64">l2h-tmp</a></td><td valign="top"><a href="#SEC12">4.7 Expanding <code>@tex</code> and <code>@math</code> regions using LaTeX2HTML</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX72">lang</a></td><td valign="top"><a href="#SEC13">4.8 Use initialization files for fine tuning</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX206">lang</a></td><td valign="top"><a href="#SEC56">7.6 Customizing strings written by <code>texi2html</code></a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX28">lang=<var>lang</var></a></td><td valign="top"><a href="#SEC9">4.4 Command line options related to Texinfo language features</a></td></tr> -<tr><td colspan="3"> <hr></td></tr> -<tr><th><a name="SEC87_6">M</a></th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#IDX3">menu</a></td><td valign="top"><a href="#SEC5">4. Invoking <code>texi2html</code></a></td></tr> -<tr><td colspan="3"> <hr></td></tr> -<tr><th><a name="SEC87_7">N</a></th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#IDX24">no-if<region></a></td><td valign="top"><a href="#SEC8">4.3 Specifying which regions get expanded</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX21">node-files</a></td><td valign="top"><a href="#SEC7">4.2 Setting output file and directory names</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX2">nomenu</a></td><td valign="top"><a href="#SEC5">4. Invoking <code>texi2html</code></a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX26">nomenu</a></td><td valign="top"><a href="#SEC8">4.3 Specifying which regions get expanded</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX38">nosec-nav</a></td><td valign="top"><a href="#SEC10">4.5 Page layout related command line options</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX57">number</a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr> -<tr><td colspan="3"> <hr></td></tr> -<tr><th><a name="SEC87_8">O</a></th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#IDX10">output</a></td><td valign="top"><a href="#SEC7">4.2 Setting output file and directory names</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX12">output</a></td><td valign="top"><a href="#SEC7">4.2 Setting output file and directory names</a></td></tr> -<tr><td colspan="3"> <hr></td></tr> -<tr><th><a name="SEC87_9">P</a></th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#IDX32">P<var>dir</var></a></td><td valign="top"><a href="#SEC9">4.4 Command line options related to Texinfo language features</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX1">pkgdatadir=<var>dir</var></a></td><td valign="top"><a href="#SEC4">3. Installation of <code>texi2html</code></a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX67">pkgdatadir=dir</a></td><td valign="top"><a href="#SEC13">4.8 Use initialization files for fine tuning</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX13">prefix</a></td><td valign="top"><a href="#SEC7">4.2 Setting output file and directory names</a></td></tr> -<tr><td colspan="3"> <hr></td></tr> -<tr><th><a name="SEC87_10">S</a></th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#IDX40">separated-footnotes</a></td><td valign="top"><a href="#SEC10">4.5 Page layout related command line options</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX15">short-ext</a></td><td valign="top"><a href="#SEC7">4.2 Setting output file and directory names</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX55">short-ref</a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX4">split</a></td><td valign="top"><a href="#SEC6">4.1 Specifying where to split the generated document</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX68">sysconfdir=dir</a></td><td valign="top"><a href="#SEC13">4.8 Use initialization files for fine tuning</a></td></tr> -<tr><td colspan="3"> <hr></td></tr> -<tr><th><a name="SEC87_11">T</a></th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#IDX19">toc-file</a></td><td valign="top"><a href="#SEC7">4.2 Setting output file and directory names</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX59">toc-links</a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX17">top-file</a></td><td valign="top"><a href="#SEC7">4.2 Setting output file and directory names</a></td></tr> -<tr><td colspan="3"> <hr></td></tr> -<tr><th><a name="SEC87_12">U</a></th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#IDX6">use-nodes</a></td><td valign="top"><a href="#SEC6">4.1 Specifying where to split the generated document</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX8">use-nodes</a></td><td valign="top"><a href="#SEC6">4.1 Specifying where to split the generated document</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX9">use-nodes</a></td><td valign="top"><a href="#SEC6">4.1 Specifying where to split the generated document</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX31">U<var>var</var></a></td><td valign="top"><a href="#SEC9">4.4 Command line options related to Texinfo language features</a></td></tr> -<tr><td colspan="3"> <hr></td></tr> -</table> -<table><tr><th valign="top">Jump to: </th><td><a href="#SEC87_0" class="summary-letter"><b>C</b></a> - -<a href="#SEC87_1" class="summary-letter"><b>D</b></a> - -<a href="#SEC87_2" class="summary-letter"><b>F</b></a> - -<a href="#SEC87_3" class="summary-letter"><b>H</b></a> - -<a href="#SEC87_4" class="summary-letter"><b>I</b></a> - -<a href="#SEC87_5" class="summary-letter"><b>L</b></a> - -<a href="#SEC87_6" class="summary-letter"><b>M</b></a> - -<a href="#SEC87_7" class="summary-letter"><b>N</b></a> - -<a href="#SEC87_8" class="summary-letter"><b>O</b></a> - -<a href="#SEC87_9" class="summary-letter"><b>P</b></a> - -<a href="#SEC87_10" class="summary-letter"><b>S</b></a> - -<a href="#SEC87_11" class="summary-letter"><b>T</b></a> - -<a href="#SEC87_12" class="summary-letter"><b>U</b></a> - -</td></tr></table> -<hr size="6"> -<a name="Indexvr"></a> -<a name="SEC88"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC87" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC89" title="Next section in reading order"> > </a>]</td> -<td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="#SEC87" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC_Top" title="Up section"> Up </a>]</td> -<td valign="middle" align="left">[<a href="#SEC89" 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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h1 class="appendix"> C. Variable Index </h1> -<table><tr><th valign="top">Jump to: </th><td><a href="#SEC88_0" class="summary-letter"><b>$</b></a> - -<a href="#SEC88_1" class="summary-letter"><b>%</b></a> - -<a href="#SEC88_2" 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="SEC88_0">$</a></th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#IDX123"><code>$AFTER_BODY_OPEN</code></a></td><td valign="top"><a href="#SEC35">6.8 Customizing the page header</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX153"><code>$AFTER_OVERVIEW</code></a></td><td valign="top"><a href="#SEC41">6.11.1.2 Table of contents and Short table of contents</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX155"><code>$AFTER_TOC_LINES</code></a></td><td valign="top"><a href="#SEC41">6.11.1.2 Table of contents and Short table of contents</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX73"><code>$anchor</code></a></td><td valign="top"><a href="#SEC15">5.1 Redefining functions in initialization files</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX198"><code>$anchor</code></a></td><td valign="top"><a href="#SEC54">7.4 Formatting of special simple commands</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX242"><code>$AVOID_MENU_REDUNDANCY</code></a></td><td valign="top"><a href="#SEC75">7.15.2 The formatting of the different menu components</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX152"><code>$BEFORE_OVERVIEW</code></a></td><td valign="top"><a href="#SEC41">6.11.1.2 Table of contents and Short table of contents</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX154"><code>$BEFORE_TOC_LINES</code></a></td><td valign="top"><a href="#SEC41">6.11.1.2 Table of contents and Short table of contents</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX78"><code>$BIG_RULE</code></a></td><td valign="top"><a href="#SEC19">6.2 Page layout and navigation panel overview</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX111"><code>$BODYTEXT</code></a></td><td valign="top"><a href="#SEC32">6.5 Preparing the output</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX127"><code>$BODYTEXT</code></a></td><td valign="top"><a href="#SEC35">6.8 Customizing the page header</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX225"><code>$cell</code></a></td><td valign="top"><a href="#SEC66">7.11.1 Formatting individual table and list items</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX194"><code>$CLOSE_QUOTE_SYMBOL</code></a></td><td valign="top"><a href="#SEC51">7.3.1 An interface for commands formatting with a hash reference</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX196"><code>$CLOSE_QUOTE_SYMBOL</code></a></td><td valign="top"><a href="#SEC52">7.3.2 An interface for commands formatting with a string</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX217"><code>$complex_format_map</code></a></td><td valign="top"><a href="#SEC64">7.10 Formatting of complex formats (<code>@example</code>, <code>@display</code>…)</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX116"><code>$CSS_LINES</code></a></td><td valign="top"><a href="#SEC34">6.7 Customizing the <code>texi2html</code> css lines</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX118"><code>$CSS_LINES</code></a></td><td valign="top"><a href="#SEC34">6.7 Customizing the <code>texi2html</code> css lines</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX120"><code>$CSS_LINES</code></a></td><td valign="top"><a href="#SEC34">6.7 Customizing the <code>texi2html</code> css lines</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX54"><code>$DEF_TABLE</code></a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX76"><code>$DEFAULT_RULE</code></a></td><td valign="top"><a href="#SEC19">6.2 Page layout and navigation panel overview</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX233"><code>$definition_category</code></a></td><td valign="top"><a href="#SEC70">7.12.2 Customization of the definition formatting</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX150"><code>$DO_CONTENTS</code></a></td><td valign="top"><a href="#SEC41">6.11.1.2 Table of contents and Short table of contents</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX151"><code>$DO_SCONTENTS</code></a></td><td valign="top"><a href="#SEC41">6.11.1.2 Table of contents and Short table of contents</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX45"><code>$DOCTYPE</code></a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX126"><code>$DOCUMENT_DESCRIPTION</code></a></td><td valign="top"><a href="#SEC35">6.8 Customizing the page header</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX124"><code>$DOCUMENT_ENCODING</code></a></td><td valign="top"><a href="#SEC35">6.8 Customizing the page header</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX125"><code>$ENCODING</code></a></td><td valign="top"><a href="#SEC35">6.8 Customizing the page header</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX175"><code>$EXTENSION</code></a></td><td valign="top"><a href="#SEC45">6.12 Customizing the file names</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX52"><code>$EXTERNAL_DIR</code></a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX122"><code>$EXTRA_HEAD</code></a></td><td valign="top"><a href="#SEC35">6.8 Customizing the page header</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX37"><code>$FRAMES</code></a></td><td valign="top"><a href="#SEC10">4.5 Page layout related command line options</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX46"><code>$FRAMESET_DOCTYPE</code></a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX82"><code>$ICONS</code></a></td><td valign="top"><a href="#SEC22">6.3.1 Controlling the navigation panel panel at a high level</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX179"><code>$IDX_SUMMARY</code></a></td><td valign="top"><a href="#SEC46">6.13 Generation of external files for index entries</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX80"><code>$INDEX_CHAPTER</code></a></td><td valign="top"><a href="#SEC20">Element labels</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX63"><code>$L2H_L2H</code></a></td><td valign="top"><a href="#SEC12">4.7 Expanding <code>@tex</code> and <code>@math</code> regions using LaTeX2HTML</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX65"><code>$L2H_TMP</code></a></td><td valign="top"><a href="#SEC12">4.7 Expanding <code>@tex</code> and <code>@math</code> regions using LaTeX2HTML</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX29"><code>$LANG</code></a></td><td valign="top"><a href="#SEC9">4.4 Command line options related to Texinfo language features</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX71"><code>$LANG</code></a></td><td valign="top"><a href="#SEC13">4.8 Use initialization files for fine tuning</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX207"><code>$LANG</code></a></td><td valign="top"><a href="#SEC56">7.6 Customizing strings written by <code>texi2html</code></a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX208"><code>$LANGUAGES</code></a></td><td valign="top"><a href="#SEC56">7.6 Customizing strings written by <code>texi2html</code></a></td></tr> -<tr><td></td><td valign="top"><a href="#SEC85"><code>$LANGUAGES</code></a></td><td valign="top"><a href="#SEC85">A.1 Translating strings</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX245"><code>$MENU_PRE_STYLE</code></a></td><td valign="top"><a href="#SEC75">7.15.2 The formatting of the different menu components</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX243"><code>$MENU_SYMBOL</code></a></td><td valign="top"><a href="#SEC75">7.15.2 The formatting of the different menu components</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX77"><code>$MIDDLE_RULE</code></a></td><td valign="top"><a href="#SEC19">6.2 Page layout and navigation panel overview</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX22"><code>$NODE_FILES</code></a></td><td valign="top"><a href="#SEC7">4.2 Setting output file and directory names</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX176"><code>$NODE_FILES</code></a></td><td valign="top"><a href="#SEC45">6.12 Customizing the file names</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX241"><code>$NODE_NAME_IN_MENU</code></a></td><td valign="top"><a href="#SEC75">7.15.2 The formatting of the different menu components</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX58"><code>$NUMBER_SECTIONS</code></a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX193"><code>$OPEN_QUOTE_SYMBOL</code></a></td><td valign="top"><a href="#SEC51">7.3.1 An interface for commands formatting with a hash reference</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX195"><code>$OPEN_QUOTE_SYMBOL</code></a></td><td valign="top"><a href="#SEC52">7.3.2 An interface for commands formatting with a string</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX11"><code>$OUT</code></a></td><td valign="top"><a href="#SEC7">4.2 Setting output file and directory names</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX138"><code>$PRE_BODY_CLOSE</code></a></td><td valign="top"><a href="#SEC37">6.10 Customizing the page footer</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX14"><code>$PREFIX</code></a></td><td valign="top"><a href="#SEC7">4.2 Setting output file and directory names</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX141"><code>$print_chapter_footer</code></a></td><td valign="top"><a href="#SEC37">6.10 Customizing the page footer</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX131"><code>$print_chapter_header</code></a></td><td valign="top"><a href="#SEC35">6.8 Customizing the page header</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX139"><code>$print_foot_navigation</code></a></td><td valign="top"><a href="#SEC37">6.10 Customizing the page footer</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX128"><code>$print_head_navigation</code></a></td><td valign="top"><a href="#SEC35">6.8 Customizing the page header</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX172"><code>$print_misc</code></a></td><td valign="top"><a href="#SEC44">6.11.2 Customizing the layout of the special pages</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX174"><code>$print_misc_footer</code></a></td><td valign="top"><a href="#SEC44">6.11.2 Customizing the layout of the special pages</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX173"><code>$print_misc_header</code></a></td><td valign="top"><a href="#SEC44">6.11.2 Customizing the layout of the special pages</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX143"><code>$print_page_foot</code></a></td><td valign="top"><a href="#SEC37">6.10 Customizing the page footer</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX130"><code>$print_page_head</code></a></td><td valign="top"><a href="#SEC35">6.8 Customizing the page header</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX142"><code>$print_section_footer</code></a></td><td valign="top"><a href="#SEC37">6.10 Customizing the page footer</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX132"><code>$print_section_header</code></a></td><td valign="top"><a href="#SEC35">6.8 Customizing the page header</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX169"><code>$print_Top</code></a></td><td valign="top"><a href="#SEC44">6.11.2 Customizing the layout of the special pages</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX171"><code>$print_Top_footer</code></a></td><td valign="top"><a href="#SEC44">6.11.2 Customizing the layout of the special pages</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX170"><code>$print_Top_header</code></a></td><td valign="top"><a href="#SEC44">6.11.2 Customizing the layout of the special pages</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX39"><code>$SECTION_NAVIGATION</code></a></td><td valign="top"><a href="#SEC10">4.5 Page layout related command line options</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX83"><code>$SECTION_NAVIGATION</code></a></td><td valign="top"><a href="#SEC22">6.3.1 Controlling the navigation panel panel at a high level</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX41"><code>$SEPARATED_FOOTNOTES</code></a></td><td valign="top"><a href="#SEC10">4.5 Page layout related command line options</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX56"><code>$SHORT_REF</code></a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX16"><code>$SHORTEXTN</code></a></td><td valign="top"><a href="#SEC7">4.2 Setting output file and directory names</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX27"><code>$SHOW_MENU</code></a></td><td valign="top"><a href="#SEC8">4.3 Specifying which regions get expanded</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX75"><code>$SMALL_RULE</code></a></td><td valign="top"><a href="#SEC19">6.2 Page layout and navigation panel overview</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX5"><code>$SPLIT</code></a></td><td valign="top"><a href="#SEC6">4.1 Specifying where to split the generated document</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX252"><code>$SPLIT_INDEX</code></a></td><td valign="top"><a href="#SEC78">7.16.2 Customizing the formatting of index lists</a></td></tr> -<tr><td></td><td valign="top"><a href="#SEC85"><code>$T2H_OBSOLETE_STRINGS</code></a></td><td valign="top"><a href="#SEC85">A.1 Translating strings</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX91"><code>$Texi2HTML::NODE{Next}</code></a></td><td valign="top"><a href="#SEC23">6.3.2 Specifying the buttons formatting</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX105"><code>$Texi2HTML::OVERVIEW</code></a></td><td valign="top"><a href="#SEC30">Section lines</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX160"><code>$Texi2HTML::OVERVIEW</code></a></td><td valign="top"><a href="#SEC41">6.11.1.2 Table of contents and Short table of contents</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX104"><code>$Texi2HTML::THIS_HEADER</code></a></td><td valign="top"><a href="#SEC30">Section lines</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX103"><code>$Texi2HTML::THIS_SECTION</code></a></td><td valign="top"><a href="#SEC30">Section lines</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX108"><code>$Texi2HTML::THIS_SECTION</code></a></td><td valign="top"><a href="#SEC31">6.4.3 Function usefull in page formatting</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX106"><code>$Texi2HTML::TOC_LINES</code></a></td><td valign="top"><a href="#SEC30">Section lines</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX159"><code>$Texi2HTML::TOC_LINES</code></a></td><td valign="top"><a href="#SEC41">6.11.1.2 Table of contents and Short table of contents</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX20"><code>$TOC_FILE</code></a></td><td valign="top"><a href="#SEC7">4.2 Setting output file and directory names</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX60"><code>$TOC_LINKS</code></a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX157"><code>$TOC_LIST_ATTRIBUTE</code></a></td><td valign="top"><a href="#SEC41">6.11.1.2 Table of contents and Short table of contents</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX156"><code>$TOC_LIST_STYLE</code></a></td><td valign="top"><a href="#SEC41">6.11.1.2 Table of contents and Short table of contents</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX18"><code>$TOP_FILE</code></a></td><td valign="top"><a href="#SEC7">4.2 Setting output file and directory names</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX79"><code>$TOP_HEADING</code></a></td><td valign="top"><a href="#SEC20">Element labels</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX244"><code>$UNNUMBERED_SYMBOL_IN_MENU</code></a></td><td valign="top"><a href="#SEC75">7.15.2 The formatting of the different menu components</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX48"><code>$USE_ISO</code></a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX7"><code>$USE_NODES</code></a></td><td valign="top"><a href="#SEC6">4.1 Specifying where to split the generated document</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX81"><code>$VERTICAL_HEAD_NAVIGATION</code></a></td><td valign="top"><a href="#SEC22">6.3.1 Controlling the navigation panel panel at a high level</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX87"><code>$WORDS_IN_PAGE</code></a></td><td valign="top"><a href="#SEC23">6.3.2 Specifying the buttons formatting</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX88"><code>$WORDS_IN_PAGE</code></a></td><td valign="top"><a href="#SEC23">6.3.2 Specifying the buttons formatting</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX109"><code>$WORDS_IN_PAGE</code></a></td><td valign="top"><a href="#SEC31">6.4.3 Function usefull in page formatting</a></td></tr> -<tr><td colspan="3"> <hr></td></tr> -<tr><th><a name="SEC88_1">%</a></th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#IDX192"><code>%accent_map</code></a></td><td valign="top"><a href="#SEC50">7.3 Customizing accent, style and other simple commands</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX93"><code>%ACTIVE_ICONS</code></a></td><td valign="top"><a href="#SEC23">6.3.2 Specifying the buttons formatting</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX113"><code>%BUTTONS_GOTO</code></a></td><td valign="top"><a href="#SEC32">6.5 Preparing the output</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX115"><code>%css_map</code></a></td><td valign="top"><a href="#SEC34">6.7 Customizing the <code>texi2html</code> css lines</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX117"><code>%css_map</code></a></td><td valign="top"><a href="#SEC34">6.7 Customizing the <code>texi2html</code> css lines</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX230"><code>%def_map</code></a></td><td valign="top"><a href="#SEC69">7.12.1 Customizing the interpretation of a definition line</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX216"><code>%format_in_paragraph</code></a></td><td valign="top"><a href="#SEC63">7.9.2 Avoiding paragraphs in formats</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX226"><code>%format_map</code></a></td><td valign="top"><a href="#SEC67">7.11.2 Formatting of a whole table or list</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX228"><code>%format_map</code></a></td><td valign="top"><a href="#SEC67">7.11.2 Formatting of a whole table or list</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX101"><code>%main::value</code></a></td><td valign="top"><a href="#SEC29">Flags</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX102"><code>%main::value</code></a></td><td valign="top"><a href="#SEC29">Flags</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX267"><code>%misc_command</code></a></td><td valign="top"><a href="#SEC83">7.19 Customizing other commands, and unknown commands</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX92"><code>%NAVIGATION_TEXT</code></a></td><td valign="top"><a href="#SEC23">6.3.2 Specifying the buttons formatting</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX112"><code>%NAVIGATION_TEXT</code></a></td><td valign="top"><a href="#SEC32">6.5 Preparing the output</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX212"><code>%paragraph_style</code></a></td><td valign="top"><a href="#SEC60">7.8 Commands used for centering and flushing of text</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX94"><code>%PASSIVE_ICONS</code></a></td><td valign="top"><a href="#SEC23">6.3.2 Specifying the buttons formatting</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX187"><code>%pre_map</code></a></td><td valign="top"><a href="#SEC49">7.2 Customizing the formatting of commands without argument</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX183"><code>%simple_map</code></a></td><td valign="top"><a href="#SEC49">7.2 Customizing the formatting of commands without argument</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX268"><code>%simple_map</code></a></td><td valign="top"><a href="#SEC83">7.19 Customizing other commands, and unknown commands</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX184"><code>%simple_map_pre</code></a></td><td valign="top"><a href="#SEC49">7.2 Customizing the formatting of commands without argument</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX269"><code>%simple_map_pre</code></a></td><td valign="top"><a href="#SEC83">7.19 Customizing other commands, and unknown commands</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX185"><code>%simple_map_texi</code></a></td><td valign="top"><a href="#SEC49">7.2 Customizing the formatting of commands without argument</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX270"><code>%simple_map_texi</code></a></td><td valign="top"><a href="#SEC83">7.19 Customizing other commands, and unknown commands</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX219"><code>%special_list_commands</code></a></td><td valign="top"><a href="#SEC66">7.11.1 Formatting individual table and list items</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX189"><code>%style_map</code></a></td><td valign="top"><a href="#SEC50">7.3 Customizing accent, style and other simple commands</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX272"><code>%style_map</code></a></td><td valign="top"><a href="#SEC83">7.19 Customizing other commands, and unknown commands</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX190"><code>%style_map_pre</code></a></td><td valign="top"><a href="#SEC50">7.3 Customizing accent, style and other simple commands</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX273"><code>%style_map_pre</code></a></td><td valign="top"><a href="#SEC83">7.19 Customizing other commands, and unknown commands</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX191"><code>%style_map_texi</code></a></td><td valign="top"><a href="#SEC50">7.3 Customizing accent, style and other simple commands</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX274"><code>%style_map_texi</code></a></td><td valign="top"><a href="#SEC83">7.19 Customizing other commands, and unknown commands</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX97"><code>%Texi2HTML::HREF</code></a></td><td valign="top"><a href="#SEC26">6.4.1 Accessing elements informations</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX96"><code>%Texi2HTML::NAME</code></a></td><td valign="top"><a href="#SEC26">6.4.1 Accessing elements informations</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX99"><code>%Texi2HTML::NO_TEXI</code></a></td><td valign="top"><a href="#SEC26">6.4.1 Accessing elements informations</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX98"><code>%Texi2HTML::NODE</code></a></td><td valign="top"><a href="#SEC26">6.4.1 Accessing elements informations</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX100"><code>%Texi2HTML::THISDOC</code></a></td><td valign="top"><a href="#SEC28">Global strings</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX188"><code>%texi_map</code></a></td><td valign="top"><a href="#SEC49">7.2 Customizing the formatting of commands without argument</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX186"><code>%things_map</code></a></td><td valign="top"><a href="#SEC49">7.2 Customizing the formatting of commands without argument</a></td></tr> -<tr><td colspan="3"> <hr></td></tr> -<tr><th><a name="SEC88_2">@</a></th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#IDX89"><code>@CHAPTER_BUTTONS</code></a></td><td valign="top"><a href="#SEC23">6.3.2 Specifying the buttons formatting</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX50"><code>@CSS_FILES</code></a></td><td valign="top"><a href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX25"><code>@EXPAND</code></a></td><td valign="top"><a href="#SEC8">4.3 Specifying which regions get expanded</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX35"><code>@INCLUDE_DIRS</code></a></td><td valign="top"><a href="#SEC9">4.4 Command line options related to Texinfo language features</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX90"><code>@MISC_BUTTONS</code></a></td><td valign="top"><a href="#SEC23">6.3.2 Specifying the buttons formatting</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX86"><code>@NODE_FOOTER_BUTTONS</code></a></td><td valign="top"><a href="#SEC23">6.3.2 Specifying the buttons formatting</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX33"><code>@PREPEND_DIRS</code></a></td><td valign="top"><a href="#SEC9">4.4 Command line options related to Texinfo language features</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX84"><code>@SECTION_BUTTONS</code></a></td><td valign="top"><a href="#SEC23">6.3.2 Specifying the buttons formatting</a></td></tr> -<tr><td></td><td valign="top"><a href="#IDX85"><code>@SECTION_FOOTER_BUTTONS</code></a></td><td valign="top"><a href="#SEC23">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="#SEC88_0" class="summary-letter"><b>$</b></a> - -<a href="#SEC88_1" class="summary-letter"><b>%</b></a> - -<a href="#SEC88_2" class="summary-letter"><b>@</b></a> -</td></tr></table> -<hr size="6"> -<a name="Indexcp"></a> -<a name="SEC89"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC88" 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="#SEC88" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC_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="#SEC_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="#SEC87" title="Index">Index</a>]</td> -<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ? </a>]</td> -</tr></table> -<h1 class="appendix"> D. Concept Index </h1> -<table><tr><th valign="top">Jump to: </th><td><a href="#SEC89_0" class="summary-letter"><b>A</b></a> - -<a href="#SEC89_1" class="summary-letter"><b>B</b></a> - -<a href="#SEC89_2" class="summary-letter"><b>C</b></a> - -<a href="#SEC89_3" class="summary-letter"><b>D</b></a> - -<a href="#SEC89_4" class="summary-letter"><b>E</b></a> - -<a href="#SEC89_5" class="summary-letter"><b>F</b></a> - -<a href="#SEC89_6" class="summary-letter"><b>I</b></a> - -<a href="#SEC89_7" class="summary-letter"><b>M</b></a> - -<a href="#SEC89_8" class="summary-letter"><b>P</b></a> - -<a href="#SEC89_9" class="summary-letter"><b>R</b></a> - -<a href="#SEC89_10" class="summary-letter"><b>S</b></a> - -<a href="#SEC89_11" class="summary-letter"><b>T</b></a> - -<a href="#SEC89_12" 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="SEC89_0">A</a></th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#SEC63">Avoid paragraph opening</a></td><td valign="top"><a href="#SEC63">7.9.2 Avoiding paragraphs in formats</a></td></tr> -<tr><td colspan="3"> <hr></td></tr> -<tr><th><a name="SEC89_1">B</a></th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#SEC_Top">bug report</a></td><td valign="top"><a href="#SEC_Top">Texi2HTML</a></td></tr> -<tr><td colspan="3"> <hr></td></tr> -<tr><th><a name="SEC89_2">C</a></th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#SEC60">centering</a></td><td valign="top"><a href="#SEC60">7.8 Commands used for centering and flushing of text</a></td></tr> -<tr><td></td><td valign="top"><a href="#SEC64">complex format</a></td><td valign="top"><a href="#SEC64">7.10 Formatting of complex formats (<code>@example</code>, <code>@display</code>…)</a></td></tr> -<tr><td></td><td valign="top"><a href="#SEC13"><tt>`Config'</tt></a></td><td valign="top"><a href="#SEC13">4.8 Use initialization files for fine tuning</a></td></tr> -<tr><td></td><td valign="top"><a href="#SEC4">configure</a></td><td valign="top"><a href="#SEC4">3. Installation of <code>texi2html</code></a></td></tr> -<tr><td colspan="3"> <hr></td></tr> -<tr><th><a name="SEC89_3">D</a></th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#SEC3">downloading <code>texi2html</code> source</a></td><td valign="top"><a href="#SEC3">2. Obtaining <code>texi2html</code></a></td></tr> -<tr><td colspan="3"> <hr></td></tr> -<tr><th><a name="SEC89_4">E</a></th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#SEC1">examples of manuals</a></td><td valign="top"><a href="#SEC1">1. Overview</a></td></tr> -<tr><td></td><td valign="top"><a href="#SEC58">external manual</a></td><td valign="top"><a href="#SEC58">7.7.1 Reference to external manual</a></td></tr> -<tr><td colspan="3"> <hr></td></tr> -<tr><th><a name="SEC89_5">F</a></th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#SEC60">flushing text</a></td><td valign="top"><a href="#SEC60">7.8 Commands used for centering and flushing of text</a></td></tr> -<tr><td colspan="3"> <hr></td></tr> -<tr><th><a name="SEC89_6">I</a></th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#SEC56">i18n</a></td><td valign="top"><a href="#SEC56">7.6 Customizing strings written by <code>texi2html</code></a></td></tr> -<tr><td></td><td valign="top"><a href="#SEC85">i18n</a></td><td valign="top"><a href="#SEC85">A.1 Translating strings</a></td></tr> -<tr><td></td><td valign="top"><a href="#SEC4">Installation</a></td><td valign="top"><a href="#SEC4">3. Installation of <code>texi2html</code></a></td></tr> -<tr><td></td><td valign="top"><a href="#SEC13">internationalization</a></td><td valign="top"><a href="#SEC13">4.8 Use initialization files for fine tuning</a></td></tr> -<tr><td></td><td valign="top"><a href="#SEC86">internationalized strings</a></td><td valign="top"><a href="#SEC86">A.2 Adding new strings written to document</a></td></tr> -<tr><td colspan="3"> <hr></td></tr> -<tr><th><a name="SEC89_7">M</a></th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#SEC2">makeinfo</a></td><td valign="top"><a href="#SEC2">1.1 Why <code>texi2html</code> and not <code>makeinfo</code>?</a></td></tr> -<tr><td></td><td valign="top"><a href="#SEC86"><code>manage_i18n.pl</code></a></td><td valign="top"><a href="#SEC86">A.2 Adding new strings written to document</a></td></tr> -<tr><td colspan="3"> <hr></td></tr> -<tr><th><a name="SEC89_8">P</a></th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#SEC62">paragraph</a></td><td valign="top"><a href="#SEC62">7.9.1 Paragraph and preformatted region formatting</a></td></tr> -<tr><td></td><td valign="top"><a href="#SEC62">preformatted region</a></td><td valign="top"><a href="#SEC62">7.9.1 Paragraph and preformatted region formatting</a></td></tr> -<tr><td colspan="3"> <hr></td></tr> -<tr><th><a name="SEC89_9">R</a></th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#SEC57">reference</a></td><td valign="top"><a href="#SEC57">7.7 References</a></td></tr> -<tr><td colspan="3"> <hr></td></tr> -<tr><th><a name="SEC89_10">S</a></th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#SEC83">skipped command</a></td><td valign="top"><a href="#SEC83">7.19 Customizing other commands, and unknown commands</a></td></tr> -<tr><td></td><td valign="top"><a href="#SEC3">source code for <code>texi2html</code>, downloading</a></td><td valign="top"><a href="#SEC3">2. Obtaining <code>texi2html</code></a></td></tr> -<tr><td colspan="3"> <hr></td></tr> -<tr><th><a name="SEC89_11">T</a></th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#SEC3"><code>texi2html</code> source, downloading</a></td><td valign="top"><a href="#SEC3">2. Obtaining <code>texi2html</code></a></td></tr> -<tr><td></td><td valign="top"><a href="#SEC1">Texinfo</a></td><td valign="top"><a href="#SEC1">1. Overview</a></td></tr> -<tr><td></td><td valign="top"><a href="#SEC60">text alignement</a></td><td valign="top"><a href="#SEC60">7.8 Commands used for centering and flushing of text</a></td></tr> -<tr><td></td><td valign="top"><a href="#SEC85">Translation</a></td><td valign="top"><a href="#SEC85">A.1 Translating strings</a></td></tr> -<tr><td colspan="3"> <hr></td></tr> -<tr><th><a name="SEC89_12">U</a></th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#SEC83">unknown command</a></td><td valign="top"><a href="#SEC83">7.19 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="#SEC89_0" class="summary-letter"><b>A</b></a> - -<a href="#SEC89_1" class="summary-letter"><b>B</b></a> - -<a href="#SEC89_2" class="summary-letter"><b>C</b></a> - -<a href="#SEC89_3" class="summary-letter"><b>D</b></a> - -<a href="#SEC89_4" class="summary-letter"><b>E</b></a> - -<a href="#SEC89_5" class="summary-letter"><b>F</b></a> - -<a href="#SEC89_6" class="summary-letter"><b>I</b></a> - -<a href="#SEC89_7" class="summary-letter"><b>M</b></a> - -<a href="#SEC89_8" class="summary-letter"><b>P</b></a> - -<a href="#SEC89_9" class="summary-letter"><b>R</b></a> - -<a href="#SEC89_10" class="summary-letter"><b>S</b></a> - -<a href="#SEC89_11" class="summary-letter"><b>T</b></a> - -<a href="#SEC89_12" class="summary-letter"><b>U</b></a> - -</td></tr></table> -<hr size="6"> -<a name="SEC_Contents"></a> -<table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC_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="#SEC87" 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="TOC1" href="#SEC1">1. Overview</a> - <ul class="toc"> - <li><a name="TOC2" href="#SEC2">1.1 Why <code>texi2html</code> and not <code>makeinfo</code>?</a></li> - </ul></li> - <li><a name="TOC3" href="#SEC3">2. Obtaining <code>texi2html</code></a></li> - <li><a name="TOC4" href="#SEC4">3. Installation of <code>texi2html</code></a></li> - <li><a name="TOC5" href="#SEC5">4. Invoking <code>texi2html</code></a> - <ul class="toc"> - <li><a name="TOC6" href="#SEC6">4.1 Specifying where to split the generated document</a></li> - <li><a name="TOC7" href="#SEC7">4.2 Setting output file and directory names</a></li> - <li><a name="TOC8" href="#SEC8">4.3 Specifying which regions get expanded</a></li> - <li><a name="TOC9" href="#SEC9">4.4 Command line options related to Texinfo language features</a></li> - <li><a name="TOC10" href="#SEC10">4.5 Page layout related command line options</a></li> - <li><a name="TOC11" href="#SEC11">4.6 Customizing the <acronym>HTML</acronym> and text style</a></li> - <li><a name="TOC12" href="#SEC12">4.7 Expanding <code>@tex</code> and <code>@math</code> regions using LaTeX2HTML</a></li> - <li><a name="TOC13" href="#SEC13">4.8 Use initialization files for fine tuning</a></li> - </ul></li> - <li><a name="TOC14" href="#SEC14">5. Overview of initialization files content and loading</a> - <ul class="toc"> - <li><a name="TOC15" href="#SEC15">5.1 Redefining functions in initialization files</a></li> - <li><a name="TOC16" href="#SEC16">5.2 Conventions used for function prototypes</a></li> - </ul></li> - <li><a name="TOC17" href="#SEC17">6. Fine tuning of the page layout</a> - <ul class="toc"> - <li><a name="TOC18" href="#SEC18">6.1 The different categories of pages and sectioning elements</a></li> - <li><a name="TOC19" href="#SEC19">6.2 Page layout and navigation panel overview</a></li> - <li><a name="TOC20" href="#SEC21">6.3 Customization of the navigation panels buttons</a> - <ul class="toc"> - <li><a name="TOC21" href="#SEC22">6.3.1 Controlling the navigation panel panel at a high level</a></li> - <li><a name="TOC22" href="#SEC23">6.3.2 Specifying the buttons formatting</a></li> - <li><a name="TOC23" href="#SEC24">6.3.3 Changing the navigation panel formatting</a></li> - </ul></li> - <li><a name="TOC24" href="#SEC25">6.4 Main program variables and usefull functions</a> - <ul class="toc"> - <li><a name="TOC25" href="#SEC26">6.4.1 Accessing elements informations</a></li> - <li><a name="TOC26" href="#SEC27">6.4.2 Accessing global informations</a></li> - <li><a name="TOC27" href="#SEC31">6.4.3 Function usefull in page formatting</a></li> - </ul></li> - <li><a name="TOC28" href="#SEC32">6.5 Preparing the output</a></li> - <li><a name="TOC29" href="#SEC33">6.6 Finalizing the output</a></li> - <li><a name="TOC30" href="#SEC34">6.7 Customizing the <code>texi2html</code> css lines</a></li> - <li><a name="TOC31" href="#SEC35">6.8 Customizing the page header</a></li> - <li><a name="TOC32" href="#SEC36">6.9 Customizing the sections</a></li> - <li><a name="TOC33" href="#SEC37">6.10 Customizing the page footer</a></li> - <li><a name="TOC34" href="#SEC38">6.11 Special pages formatting</a> - <ul class="toc"> - <li><a name="TOC35" href="#SEC39">6.11.1 Customizing the content of the special pages</a> - <ul class="toc"> - <li><a name="TOC36" href="#SEC40">6.11.1.1 Top element text formatting</a></li> - <li><a name="TOC37" href="#SEC41">6.11.1.2 Table of contents and Short table of contents</a></li> - <li><a name="TOC38" href="#SEC42">6.11.1.3 Formatting of footnotes text</a></li> - <li><a name="TOC39" href="#SEC43">6.11.1.4 Formatting of about text</a></li> - </ul></li> - <li><a name="TOC40" href="#SEC44">6.11.2 Customizing the layout of the special pages</a></li> - </ul></li> - <li><a name="TOC41" href="#SEC45">6.12 Customizing the file names</a></li> - <li><a name="TOC42" href="#SEC46">6.13 Generation of external files for index entries</a></li> - </ul></li> - <li><a name="TOC43" href="#SEC47">7. Customizing <acronym>HTML</acronym> and text style in init files</a> - <ul class="toc"> - <li><a name="TOC44" href="#SEC48">7.1 Three contexts for expansions: preformatted, normal and string</a></li> - <li><a name="TOC45" href="#SEC49">7.2 Customizing the formatting of commands without argument</a></li> - <li><a name="TOC46" href="#SEC50">7.3 Customizing accent, style and other simple commands</a> - <ul class="toc"> - <li><a name="TOC47" href="#SEC51">7.3.1 An interface for commands formatting with a hash reference</a></li> - <li><a name="TOC48" href="#SEC52">7.3.2 An interface for commands formatting with a string</a></li> - <li><a name="TOC49" href="#SEC53">7.3.3 Defining the style and indicatric commands interface</a></li> - </ul></li> - <li><a name="TOC50" href="#SEC54">7.4 Formatting of special simple commands</a></li> - <li><a name="TOC51" href="#SEC55">7.5 Processing special characters in text</a></li> - <li><a name="TOC52" href="#SEC56">7.6 Customizing strings written by <code>texi2html</code></a></li> - <li><a name="TOC53" href="#SEC57">7.7 References</a> - <ul class="toc"> - <li><a name="TOC54" href="#SEC58">7.7.1 Reference to external manual</a></li> - <li><a name="TOC55" href="#SEC59">7.7.2 Reference to an internal node</a></li> - </ul></li> - <li><a name="TOC56" href="#SEC60">7.8 Commands used for centering and flushing of text</a></li> - <li><a name="TOC57" href="#SEC61">7.9 Formatting or not a paragraph or a preformatted region</a> - <ul class="toc"> - <li><a name="TOC58" href="#SEC62">7.9.1 Paragraph and preformatted region formatting</a></li> - <li><a name="TOC59" href="#SEC63">7.9.2 Avoiding paragraphs in formats</a></li> - </ul></li> - <li><a name="TOC60" href="#SEC64">7.10 Formatting of complex formats (<code>@example</code>, <code>@display</code>…)</a></li> - <li><a name="TOC61" href="#SEC65">7.11 Customizing the formatting of lists and tables</a> - <ul class="toc"> - <li><a name="TOC62" href="#SEC66">7.11.1 Formatting individual table and list items</a></li> - <li><a name="TOC63" href="#SEC67">7.11.2 Formatting of a whole table or list</a></li> - </ul></li> - <li><a name="TOC64" href="#SEC68">7.12 Definition commands formatting</a> - <ul class="toc"> - <li><a name="TOC65" href="#SEC69">7.12.1 Customizing the interpretation of a definition line</a></li> - <li><a name="TOC66" href="#SEC70">7.12.2 Customization of the definition formatting</a></li> - </ul></li> - <li><a name="TOC67" href="#SEC71">7.13 Customizing headings formatting</a></li> - <li><a name="TOC68" href="#SEC72">7.14 Formatting of special regions (<code>@verbatim</code>, <code>@cartouche</code>, <code>@quotation</code>)</a></li> - <li><a name="TOC69" href="#SEC73">7.15 Menu formatting</a> - <ul class="toc"> - <li><a name="TOC70" href="#SEC74">7.15.1 The structure of a menu</a></li> - <li><a name="TOC71" href="#SEC75">7.15.2 The formatting of the different menu components</a></li> - </ul></li> - <li><a name="TOC72" href="#SEC76">7.16 Indices formatting</a> - <ul class="toc"> - <li><a name="TOC73" href="#SEC77">7.16.1 Formatting of index entries</a></li> - <li><a name="TOC74" href="#SEC78">7.16.2 Customizing the formatting of index lists</a></li> - </ul></li> - <li><a name="TOC75" href="#SEC79">7.17 Floats and lists of floats</a> - <ul class="toc"> - <li><a name="TOC76" href="#SEC80">7.17.1 Formatting a float</a></li> - <li><a name="TOC77" href="#SEC81">7.17.2 Formatting lists of floats</a></li> - </ul></li> - <li><a name="TOC78" href="#SEC82">7.18 Customizing the footnotes formatting</a></li> - <li><a name="TOC79" href="#SEC83">7.19 Customizing other commands, and unknown commands</a></li> - </ul></li> - <li><a name="TOC80" href="#SEC84">A. Internationalization</a> - <ul class="toc"> - <li><a name="TOC81" href="#SEC85">A.1 Translating strings</a></li> - <li><a name="TOC82" href="#SEC86">A.2 Adding new strings written to document</a></li> - </ul></li> - <li><a name="TOC83" href="#SEC87">B. Command Line Option Index</a></li> - <li><a name="TOC84" href="#SEC88">C. Variable Index</a></li> - <li><a name="TOC85" href="#SEC89">D. 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="#SEC_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="#SEC87" 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="TOC1" href="#SEC1">1. Overview</a></li> -<li><a name="TOC3" href="#SEC3">2. Obtaining <code>texi2html</code></a></li> -<li><a name="TOC4" href="#SEC4">3. Installation of <code>texi2html</code></a></li> -<li><a name="TOC5" href="#SEC5">4. Invoking <code>texi2html</code></a></li> -<li><a name="TOC14" href="#SEC14">5. Overview of initialization files content and loading</a></li> -<li><a name="TOC17" href="#SEC17">6. Fine tuning of the page layout</a></li> -<li><a name="TOC43" href="#SEC47">7. Customizing <acronym>HTML</acronym> and text style in init files</a></li> -<li><a name="TOC80" href="#SEC84">A. Internationalization</a></li> -<li><a name="TOC83" href="#SEC87">B. Command Line Option Index</a></li> -<li><a name="TOC84" href="#SEC88">C. Variable Index</a></li> -<li><a name="TOC85" href="#SEC89">D. 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="#SEC_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="#SEC87" 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>Derek R. Price</em> on <em>February, 3 2005</em> using <a href="http://texi2html.cvshome.org/"><em>texi2html 1.76</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>Derek R. Price</em> on <em>February, 3 2005</em> using <a href="http://texi2html.cvshome.org/"><em>texi2html 1.76</em></a>. - </font> - <br> - -</p> -</body> -</html> |