Documenti di Didattica
Documenti di Professioni
Documenti di Cultura
Texi2HTML
Copyright 1999, 2000, 2001, 2002, 2003 Free Software Foundation, Inc. Portions of texi2html Copyright 1999, 2000 Lionel Cons Copyright 1999, 2000 Karl Berry Copyright 1999, 2000 Olaf Bachmann Copyright 2002, 2003 Patrice Dumas Copyright 2001, 2002, 2003 Derek Price Copyright many others.
Portions of this manual Copyright 1999, 2000 Karl Heinz Marbaise (manual) Copyright 2003 Patrice Dumas (manual) Copyright 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, last updated 26 February 2004, describes version 1.70 of the texi2html Perl script which converts Texinfo 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.
This manual is currently under construction and of course incomplete. ;-)
1. Overview 2. Obtaining texi2html 3. Installation of texi2html 4. Invoking texi2html 5. Overview of initialization files content and loading 6. Fine tuning of the page layout
Obtaining a copy of the texi2html source code distribution Installing texi2html Description of the command line options What kind of variables and subroutines appear in init files and how they are called
le://localhost/Library/Documentation/Commands/texi2html/texi2html.html
1/46
14/12/11
7. Customizing HTML and text style in init files A. Internationalization B. Command Line Option Index C. Variable Index D. Concept Index
Fine tuning of the HTML elements associated with the texinfo constructs Help translating !
1. Overview
Texinfo is the official documentation format of the GNU 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, the Cederqvist (CVS Manual). 1.1 Why texi2html and not makeinfo? [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ ? ]
2. Obtaining texi2html
The latest version of the source code for texi2html should be available from texi2html.cvshome.org.
le://localhost/Library/Documentation/Commands/texi2html/texi2html.html
2/46
14/12/11
3. Installation of texi2html
To install texi2html, you must first obtain a copy of the source distribution. See section Obtaining 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.
texi2html
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 `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 (see section Expanding @tex and @math regions using LaTeX2HTML), 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. See section Use initialization files for fine tuning for more. [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ ? ]
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'. 4.1 Specifying where to split the generated document The HTML output may be split at different levels 4.2 Setting output file and directory names 4.3 Specifying which regions get expanded 4.4 Command line options related to Texinfo language features 4.5 Page layout related command line options Customizing page layout 4.6 Customizing the HTML and text style 4.7 Expanding @tex and @math regions using LaTeX2HTML 4.8 Use initialization files for fine tuning Specifying initialization files for fine tuning
le://localhost/Library/Documentation/Commands/texi2html/texi2html.html
3/46
14/12/11
@node node1 @chapter node 1 node1 text @node node2 node2 text @node node3 node3 text @chapter node 3 chapter text
second element:
@node node2 node2 text
second element:
@node node3 node3 text @chapter node 3 chapter text
third element:
@node node3 node3 text @chapter node 3 chapter text
le://localhost/Library/Documentation/Commands/texi2html/texi2html.html
4/46
14/12/11
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 default is to put the files in the current directory. 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
we get:
index.htm manual_1.htm manual_2.htm contents.htm manual_abt.htm --> --> --> --> --> @node Top or @top section Chapter 1 Chapter 2 Table of Contents 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. Warning: the way makeinfo (and hopefully texi2html) handle HTML manual cross references should change in the future. [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ ? ]
le://localhost/Library/Documentation/Commands/texi2html/texi2html.html
5/46
14/12/11
le://localhost/Library/Documentation/Commands/texi2html/texi2html.html
6/46
14/12/11
`--iso' If this option is set, ISO8859 entities are used for some special symbols, like Copyright (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 (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. [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ ? ]
le://localhost/Library/Documentation/Commands/texi2html/texi2html.html
7/46
14/12/11
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. [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ ? ]
le://localhost/Library/Documentation/Commands/texi2html/texi2html.html
8/46
14/12/11
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 }
Customizing table of contents, top, about page. Putting index entries in external files.
le://localhost/Library/Documentation/Commands/texi2html/texi2html.html
9/46
14/12/11
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 (see section Page layout related command line 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. [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ ? ]
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 (see section Specifying the buttons formatting), and used in the formatting functions (see section Main program variables and usefull functions). 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
le://localhost/Library/Documentation/Commands/texi2html/texi2html.html
10/46
14/12/11
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 [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ ? ]
le://localhost/Library/Documentation/Commands/texi2html/texi2html.html
11/46
14/12/11
6.3.1 Controlling the navigation panel panel at a high level Variables controlling the navigation panel at a global level 6.3.2 Specifying the buttons formatting 6.3.3 Changing the navigation panel formatting [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ ? ]
A vertical navigation panel will be used for the header navigation panel if this variable is true.
$ICONS
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 Page layout related command line options). [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ ? ]
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, Accessing elements informations. 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
le://localhost/Library/Documentation/Commands/texi2html/texi2html.html
12/46
14/12/11
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 (see section Preparing the output). 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. [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ ? ]
le://localhost/Library/Documentation/Commands/texi2html/texi2html.html
13/46
14/12/11
title set by @title. If there is no @title other possibilities are tried (@settitle, @shorttitlepage).
title
Text appearing in @copying with all the texinfo commands removed, put in comments.
program
Authors of texi2html.
file_base_name
The date. 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.
le://localhost/Library/Documentation/Commands/texi2html/texi2html.html
14/46
14/12/11
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 appearing before the element label (anchors).
$Texi2HTML::OVERVIEW
Lines of table of contents. See section Special pages formatting. [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ ? ]
le://localhost/Library/Documentation/Commands/texi2html/texi2html.html
15/46
14/12/11
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. See section Customizing the HTML and text style. [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ ? ]
le://localhost/Library/Documentation/Commands/texi2html/texi2html.html
16/46
14/12/11
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. [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ ? ]
le://localhost/Library/Documentation/Commands/texi2html/texi2html.html
17/46
14/12/11
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. [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ ? ]
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
le://localhost/Library/Documentation/Commands/texi2html/texi2html.html
18/46
14/12/11
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
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
the file containing the element, usefull to do href to that file in case the document is split,
text
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. [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ ? ]
6.11.1.3 Formatting of footnotes text The footnotes text is allready formatting when @footnote commands are expanded. See section Customizing the footnotes formatting. [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ ? ]
6.11.1.4 Formatting of about text The default about element contains an explaination of the buttons used in the document (@SECTION_BUTTONS, Specifying the buttons formatting) and an example locating the buttons targets in an example. The formatting of this text may be influenced by the following
le://localhost/Library/Documentation/Commands/texi2html/texi2html.html
19/46
14/12/11
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 (see 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 (see section Preparing the output).
%BUTTONS_EXAMPLE
The keys of this hash are element labels (see 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. [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ ? ]
Formatting of top element page or section. It is also used for the formatting of the top element text (see section Top element text formatting).
print_Toc
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. [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ ? ]
le://localhost/Library/Documentation/Commands/texi2html/texi2html.html
20/46
14/12/11
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
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
A number incremented whenever a new file should begin, based on how the document is split (see section Specifying where to split the generated document).
text
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. [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ ? ]
le://localhost/Library/Documentation/Commands/texi2html/texi2html.html
21/46
14/12/11
$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. [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ ? ]
Formatting of @anchor, @image and @sp Some characters are processed specially texi2html write some strings in the output different for each languages
@center, @flushleft
@example, @display
@verbatim, @cartouche
le://localhost/Library/Documentation/Commands/texi2html/texi2html.html
22/46
14/12/11
looking like:
<table><tr><td>an item</td></tr></table>
with foo_item the function formating the @foo @item line. And the HTML resulting from:
@example some text @end example
looks like
<pre> some text </pre>
To avoid that, @foo will close the preformatted context opened by @example, and the function foo_item will have to reopen it, leading to
<table><tr><td><pre>an item </pre></td></tr></table>
which is valid. All such function should allready have an hash reference passed as one of their arguments, the state. The only entry of interest in the corresponding hash is 'preformatted' which is true if the function was called in a preformatted context. Opening and closing the preformatted context should then be done by calling a function from the main program, main::do_preformatted with the text and the state as arguments. Here is an example:
sub foo_item { my $arg1 = shift; my $arg2 = shift; my $state = shift; if ($state->{'preformatted'}) { my $text; # add some text to $text, # possibly using $arg1 and $arg2. return '<td>' . main::do_preformatted($text, $state) . '</td>'; } else
le://localhost/Library/Documentation/Commands/texi2html/texi2html.html
23/46
14/12/11
{ ..... }
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
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{'-'} = '­';
le://localhost/Library/Documentation/Commands/texi2html/texi2html.html
24/46
14/12/11
7.3.1 An interface for commands formatting with a hash reference 7.3.2 string 7.3.3 Defining the style and indicatric commands interface [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ ? ]
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 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 `''.
le://localhost/Library/Documentation/Commands/texi2html/texi2html.html
25/46
14/12/11
` function ' The corresponding value should be a function reference. The corresponding function is called with the following arguments:
$command
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. [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ ? ]
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>.
le://localhost/Library/Documentation/Commands/texi2html/texi2html.html
26/46
14/12/11
le://localhost/Library/Documentation/Commands/texi2html/texi2html.html
27/46
14/12/11
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. [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ ? ]
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 Internationalization. [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ ? ]
le://localhost/Library/Documentation/Commands/texi2html/texi2html.html
28/46
14/12/11
spaces and new lines following the command are skipped. [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ ? ]
7.8 References
The references are produced with two function references, one for the reference to external manuals the other for refences within the manual. 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 same conventions than makeinfo. $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. 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. [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ ? ]
le://localhost/Library/Documentation/Commands/texi2html/texi2html.html
29/46
14/12/11
opening the preformatted region (example, see Formatting of complex formats (@example, @display)) or a identifier for the preformatted context (for example menu-comment, see Menu formatting). 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. See section Formatting individual 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. [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ ? ]
le://localhost/Library/Documentation/Commands/texi2html/texi2html.html
30/46
14/12/11
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' => '' };
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. See section Formatting of index entries. $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 This function is used to format a multitable row. $text is the row text, with cells allready formatted with the $cell function reference. [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ ? ]
le://localhost/Library/Documentation/Commands/texi2html/texi2html.html
31/46
14/12/11
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. 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. [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ ? ]
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. If the entry begins with `{', then the corresponding item is the next bracketed item or the next word. The remaining of the entry word specify what corresponds with this item. Currently the word may be `category', `name', `type', `class' and `arg'.
le://localhost/Library/Documentation/Commands/texi2html/texi2html.html
32/46
14/12/11
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. [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ ? ]
The level of the element in the document tree. `0' is for @top, `1' for @chapter and so on
le://localhost/Library/Documentation/Commands/texi2html/texi2html.html
33/46
14/12/11
tag_level
the sectioning element name, with @raisesections and @lowersections taken into account [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ ? ]
le://localhost/Library/Documentation/Commands/texi2html/texi2html.html
34/46
14/12/11
le://localhost/Library/Documentation/Commands/texi2html/texi2html.html
35/46
14/12/11
$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. [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ ? ]
le://localhost/Library/Documentation/Commands/texi2html/texi2html.html
36/46
14/12/11
$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, Customizing the layout of the special pages. For the determination of the footnote locations, Page layout related command line 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. [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ ? ]
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 Customizing strings written by texi2html. This also enables translation of the strings. A.1 Translating strings A.2 Adding new strings written to document [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ ? ]
le://localhost/Library/Documentation/Commands/texi2html/texi2html.html
37/46
14/12/11
means that the string will be expanded by texi2html. For an example, see Customizing strings written by texi2html. 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 (see section Installation of texi2html) you will have to reinstall them otherwise the installated files will take precedence (see section Use initialization files for fine tuning). [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ ? ]
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. [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [ ? ]
le://localhost/Library/Documentation/Commands/texi2html/texi2html.html
38/46
14/12/11
if<region> include-css init-file init-file iso L l2h l2h-file l2h-l2h=program l2h-tmp lang lang lang=lang M menu N no-if<region> node-files nomenu nomenu nosec-nav number O output output P Pdir pkgdatadir=dir pkgdatadir=dir prefix S separated-footnotes short-ext short-ref split sysconfdir=dir T toc-file toc-links top-file U use-nodes use-nodes use-nodes Uvar
4.3 Specifying which regions get expanded 6.7 Customizing the texi2html css lines 4.8 Use initialization files for fine tuning 4.8 Use initialization files for fine tuning 4.6 Customizing the HTML and text style
4.7 Expanding @tex and @math regions using LaTeX2HTML 4.7 Expanding @tex and @math regions using LaTeX2HTML 4.7 Expanding @tex and @math regions using LaTeX2HTML 4.7 Expanding @tex and @math regions using LaTeX2HTML 4.8 Use initialization files for fine tuning 7.6 Customizing strings written by texi2html 4.4 Command line options related to Texinfo language features
4. Invoking texi2html
4.3 Specifying which regions get expanded 4.2 Setting output file and directory names 4. Invoking texi2html 4.3 Specifying which regions get expanded 4.5 Page layout related command line options 4.6 Customizing the HTML and text style
4.2 Setting output file and directory names 4.2 Setting output file and directory names
4.4 Command line options related to Texinfo language features 3. Installation of texi2html 4.8 Use initialization files for fine tuning 4.2 Setting output file and directory names
4.5 Page layout related command line options 4.2 Setting output file and directory names 4.6 Customizing the HTML and text style 4.1 Specifying where to split the generated document 4.8 Use initialization files for fine tuning
4.2 Setting output file and directory names 4.6 Customizing the HTML and text style 4.2 Setting output file and directory names
4.1 Specifying where to split the generated document 4.1 Specifying where to split the generated document 4.1 Specifying where to split the generated document 4.4 Command line options related to Texinfo language features
le://localhost/Library/Documentation/Commands/texi2html/texi2html.html
39/46
14/12/11
C. Variable Index
Jump to: $ % @ Index Entry $
$AFTER_BODY_OPEN $AFTER_OVERVIEW $AFTER_TOC_LINES $anchor $anchor $AVOID_MENU_REDUNDANCY $BEFORE_OVERVIEW $BEFORE_TOC_LINES $BIG_RULE $BODYTEXT $BODYTEXT $cell $CLOSE_QUOTE_SYMBOL $CLOSE_QUOTE_SYMBOL $complex_format_map $CSS_LINES $CSS_LINES $CSS_LINES $DEF_TABLE $DEFAULT_RULE $definition_category $DO_CONTENTS $DO_SCONTENTS $DOCTYPE $DOCUMENT_DESCRIPTION $DOCUMENT_ENCODING $ENCODING $EXTENSION $EXTERNAL_DIR $EXTRA_HEAD $FRAMES $FRAMESET_DOCTYPE $ICONS $IDX_SUMMARY $INDEX_CHAPTER $L2H_L2H $L2H_TMP $LANG $LANG $LANG $LANGUAGES $LANGUAGES $MENU_PRE_STYLE $MENU_SYMBOL
Section
6.8 Customizing the page header 6.11.1.2 Table of contents and Short table of contents 6.11.1.2 Table of contents and Short table of contents 5.1 Redefining functions in initialization files 7.4 Formatting of special simple commands 7.16.2 The formatting of the different menu components 6.11.1.2 Table of contents and Short table of contents 6.11.1.2 Table of contents and Short table of contents 6.2 Page layout and navigation panel overview 6.5 Preparing the output 6.8 Customizing the page header 7.12.1 Formatting individual table and list items 7.3.1 An interface for commands formatting with a hash reference 7.3.2 An interface for commands formatting with a string 7.11 Formatting of complex formats (@example, @display) 6.7 Customizing the texi2html css lines 6.7 Customizing the texi2html css lines 6.7 Customizing the texi2html css lines 4.6 Customizing the HTML and text style 6.2 Page layout and navigation panel overview 7.13.2 Customization of the definition formatting 6.11.1.2 Table of contents and Short table of contents 6.11.1.2 Table of contents and Short table of contents 4.6 Customizing the HTML and text style 6.8 Customizing the page header 6.8 Customizing the page header 6.8 Customizing the page header 6.12 Customizing the file names 4.6 Customizing the HTML and text style 6.8 Customizing the page header 4.5 Page layout related command line options 4.6 Customizing the HTML and text style 6.3.1 Controlling the navigation panel panel at a high level 6.13 Generation of external files for index entries Element labels 4.7 Expanding @tex and @math regions using LaTeX2HTML 4.7 Expanding @tex and @math regions using LaTeX2HTML 4.4 Command line options related to Texinfo language features 4.8 Use initialization files for fine tuning 7.6 Customizing strings written by texi2html 7.6 Customizing strings written by texi2html A.1 Translating strings 7.16.2 The formatting of the different menu components 7.16.2 The formatting of the different menu components
le://localhost/Library/Documentation/Commands/texi2html/texi2html.html
40/46
14/12/11
$MIDDLE_RULE $NODE_FILES $NODE_FILES $NODE_NAME_IN_MENU $NUMBER_SECTIONS $OPEN_QUOTE_SYMBOL $OPEN_QUOTE_SYMBOL $OUT $PRE_BODY_CLOSE $PREFIX $print_chapter_footer $print_chapter_header $print_foot_navigation $print_head_navigation $print_misc $print_misc_footer $print_misc_header $print_page_foot $print_page_head $print_section_footer $print_section_header $print_Top $print_Top_footer $print_Top_header $SECTION_NAVIGATION $SECTION_NAVIGATION $SEPARATED_FOOTNOTES $SHORT_REF $SHORTEXTN $SHOW_MENU $SMALL_RULE $SPLIT $SPLIT_INDEX $T2H_OBSOLETE_STRINGS $Texi2HTML::NODE{Next} $Texi2HTML::OVERVIEW $Texi2HTML::OVERVIEW $Texi2HTML::THIS_HEADER $Texi2HTML::THIS_SECTION $Texi2HTML::THIS_SECTION $Texi2HTML::TOC_LINES $Texi2HTML::TOC_LINES $TOC_FILE $TOC_LINKS $TOC_LIST_ATTRIBUTE $TOC_LIST_STYLE
6.2 Page layout and navigation panel overview 4.2 Setting output file and directory names 6.12 Customizing the file names 7.16.2 The formatting of the different menu components 4.6 Customizing the HTML and text style 7.3.1 An interface for commands formatting with a hash reference 7.3.2 An interface for commands formatting with a string 4.2 Setting output file and directory names 6.10 Customizing the page footer 4.2 Setting output file and directory names 6.10 Customizing the page footer 6.8 Customizing the page header 6.10 Customizing the page footer 6.8 Customizing the page header 6.11.2 Customizing the layout of the special pages 6.11.2 Customizing the layout of the special pages 6.11.2 Customizing the layout of the special pages 6.10 Customizing the page footer 6.8 Customizing the page header 6.10 Customizing the page footer 6.8 Customizing the page header 6.11.2 Customizing the layout of the special pages 6.11.2 Customizing the layout of the special pages 6.11.2 Customizing the layout of the special pages 4.5 Page layout related command line options 6.3.1 Controlling the navigation panel panel at a high level 4.5 Page layout related command line options 4.6 Customizing the HTML and text style 4.2 Setting output file and directory names 4.3 Specifying which regions get expanded 6.2 Page layout and navigation panel overview 4.1 Specifying where to split the generated document 7.17.2 Customizing the formatting of index lists A.1 Translating strings 6.3.2 Specifying the buttons formatting Section lines 6.11.1.2 Table of contents and Short table of contents Section lines Section lines 6.4.3 Function usefull in page formatting Section lines 6.11.1.2 Table of contents and Short table of contents 4.2 Setting output file and directory names 4.6 Customizing the HTML and text style
6.11.1.2 Table of contents and Short table of contents 6.11.1.2 Table of contents and Short table of contents $TOP_FILE 4.2 Setting output file and directory names $TOP_HEADING Element labels $UNNUMBERED_SYMBOL_IN_MENU 7.16.2 The formatting of the different menu components $USE_ISO 4.6 Customizing the HTML and text style $USE_NODES 4.1 Specifying where to split the generated document $VERTICAL_HEAD_NAVIGATION 6.3.1 Controlling the navigation panel panel at a high level $WORDS_IN_PAGE 6.3.2 Specifying the buttons formatting $WORDS_IN_PAGE 6.3.2 Specifying the buttons formatting
le://localhost/Library/Documentation/Commands/texi2html/texi2html.html
41/46
14/12/11
$WORDS_IN_PAGE
6.4.3 Function usefull in page formatting 7.3 Customizing accent, style and other simple commands 6.3.2 Specifying the buttons formatting 6.5 Preparing the output 6.7 Customizing the texi2html css lines 6.7 Customizing the texi2html css lines 7.13.1 Customizing the interpretation of a definition line 7.12.2 Formatting of a whole table, list or quotation 7.12.2 Formatting of a whole table, list or quotation Flags Flags 6.3.2 Specifying the buttons formatting 6.5 Preparing the output 7.9 Commands used for centering and flushing of text 6.3.2 Specifying the buttons formatting 7.2 Customizing the formatting of commands without argument 7.2 Customizing the formatting of commands without argument 7.19 Customizing other commands 7.2 Customizing the formatting of commands without argument 7.19 Customizing other commands 7.2 Customizing the formatting of commands without argument 7.19 Customizing other commands 7.12.1 Formatting individual table and list items 7.3 Customizing accent, style and other simple commands 7.19 Customizing other commands 7.3 Customizing accent, style and other simple commands 7.19 Customizing other commands 7.3 Customizing accent, style and other simple commands 7.19 Customizing other commands 6.4.1 Accessing elements informations 6.4.1 Accessing elements informations 6.4.1 Accessing elements informations 6.4.1 Accessing elements informations Global strings 7.2 Customizing the formatting of commands without argument 7.2 Customizing the formatting of commands without argument 7.7 Customizing ignored commands and text
%
%accent_map %ACTIVE_ICONS %BUTTONS_GOTO %css_map %css_map %def_map %format_map %format_map %main::value %main::value %NAVIGATION_TEXT %NAVIGATION_TEXT %paragraph_style %PASSIVE_ICONS %pre_map %simple_map %simple_map %simple_map_pre %simple_map_pre %simple_map_texi %simple_map_texi %special_list_commands %style_map %style_map %style_map_pre %style_map_pre %style_map_texi %style_map_texi %Texi2HTML::HREF %Texi2HTML::NAME %Texi2HTML::NO_TEXI %Texi2HTML::NODE %Texi2HTML::THISDOC %texi_map %things_map %to_skip
@
@CHAPTER_BUTTONS @CSS_FILES @EXPAND @INCLUDE_DIRS @MISC_BUTTONS @NODE_FOOTER_BUTTONS @PREPEND_DIRS @SECTION_BUTTONS @SECTION_FOOTER_BUTTONS
6.3.2 Specifying the buttons formatting 4.6 Customizing the HTML and text style 4.3 Specifying which regions get expanded 4.4 Command line options related to Texinfo language features 6.3.2 Specifying the buttons formatting 6.3.2 Specifying the buttons formatting 4.4 Command line options related to Texinfo language features 6.3.2 Specifying the buttons formatting 6.3.2 Specifying the buttons formatting
le://localhost/Library/Documentation/Commands/texi2html/texi2html.html
42/46
14/12/11
D. Concept Index
Jump to: B C D E F I M P R S T Index Entry B bug report C centering complex format `Config' configure D downloading texi2html source E examples of manuals external manual F flushing text I i18n i18n Installation internationalization internationalized strings M makeinfo
manage_i18n.pl
Section
Texi2HTML
7.9 Commands used for centering and flushing of text 7.11 Formatting of complex formats (@example, @display) 4.8 Use initialization files for fine tuning 3. Installation of texi2html
2. Obtaining texi2html
7.6 Customizing strings written by texi2html A.1 Translating strings 3. Installation of texi2html 4.8 Use initialization files for fine tuning A.2 Adding new strings written to document
1.1 Why texi2html and not makeinfo? A.2 Adding new strings written to document
P paragraph preformatted region R reference S skipped command 7.7 Customizing ignored commands and text source code for texi2html, downloading 2. Obtaining texi2html T
texi2html
7.10 Formatting a paragraph or a preformatted region 7.10 Formatting a paragraph or a preformatted region
7.8 References
source, downloading
2. Obtaining texi2html 1. Overview 7.9 Commands used for centering and flushing of text A.1 Translating strings
Jump to: B C D E F I M P R S T
le://localhost/Library/Documentation/Commands/texi2html/texi2html.html
43/46
14/12/11
Table of Contents
1. Overview 1.1 Why texi2html and not makeinfo? 2. Obtaining texi2html 3. Installation of texi2html 4. Invoking texi2html 4.1 Specifying where to split the generated document 4.2 Setting output file and directory names 4.3 Specifying which regions get expanded 4.4 Command line options related to Texinfo language features 4.5 Page layout related command line options 4.6 Customizing the HTML and text style 4.7 Expanding @tex and @math regions using LaTeX2HTML 4.8 Use initialization files for fine tuning 5. Overview of initialization files content and loading 5.1 Redefining functions in initialization files 5.2 Conventions used for function prototypes 6. Fine tuning of the page layout 6.1 The different categories of pages and sectioning elements 6.2 Page layout and navigation panel overview 6.3 Customization of the navigation panels buttons 6.3.1 Controlling the navigation panel panel at a high level 6.3.2 Specifying the buttons formatting 6.3.3 Changing the navigation panel formatting 6.4 Main program variables and usefull functions 6.4.1 Accessing elements informations 6.4.2 Accessing global informations 6.4.3 Function usefull in page formatting 6.5 Preparing the output 6.6 Finalizing the output 6.7 Customizing the texi2html css lines 6.8 Customizing the page header 6.9 Customizing the sections 6.10 Customizing the page footer 6.11 Special pages formatting 6.11.1 Customizing the content of the special pages 6.11.1.1 Top element text formatting 6.11.1.2 Table of contents and Short table of contents 6.11.1.3 Formatting of footnotes text 6.11.1.4 Formatting of about text 6.11.2 Customizing the layout of the special pages 6.12 Customizing the file names 6.13 Generation of external files for index entries 7. Customizing HTML and text style in init files 7.1 Three contexts for expansions: preformatted, normal and string 7.2 Customizing the formatting of commands without argument 7.3 Customizing accent, style and other simple commands 7.3.1 An interface for commands formatting with a hash reference 7.3.2 An interface for commands formatting with a string 7.3.3 Defining the style and indicatric commands interface 7.4 Formatting of special simple commands 7.5 Processing special characters in text 7.6 Customizing strings written by texi2html 7.7 Customizing ignored commands and text 7.8 References 7.9 Commands used for centering and flushing of text 7.10 Formatting a paragraph or a preformatted region 7.11 Formatting of complex formats (@example, @display) 7.12 Customizing the formatting of lists, tables and quotations 7.12.1 Formatting individual table and list items 7.12.2 Formatting of a whole table, list or quotation 7.13 Definition commands formatting
le://localhost/Library/Documentation/Commands/texi2html/texi2html.html
44/46
14/12/11
7.13.1 Customizing the interpretation of a definition line 7.13.2 Customization of the definition formatting 7.14 Customizing headings formatting 7.15 Formatting of special regions (@verbatim, @cartouche) 7.16 Menu formatting 7.16.1 The structure of a menu 7.16.2 The formatting of the different menu components 7.17 Indices formatting 7.17.1 Formatting of index entries 7.17.2 Customizing the formatting of index lists 7.18 Customizing the footnotes formatting 7.19 Customizing other commands A. Internationalization A.1 Translating strings A.2 Adding new strings written to document B. Command Line Option Index C. Variable Index D. Concept Index [Top] [Contents] [Index] [ ? ]
[ >> ] FastForward next chapter [Top] Top cover (top) of document [Contents] Contents table of contents [Index] Index index [?] About about (help)
where the Example assumes that the current position is at Subsubsection One-Two-Three of a document of the following structure: 1. Section One 1.1 Subsection One-One ...
le://localhost/Library/Documentation/Commands/texi2html/texi2html.html
45/46
14/12/11
1.2 Subsection One-Two 1.2.1 Subsubsection One-Two-One 1.2.2 Subsubsection One-Two-Two 1.2.3 Subsubsection One-Two-Three 1.2.4 Subsubsection One-Two-Four 1.3 Subsection One-Three ... 1.4 Subsection One-Four
This document was generated by System Administrator on May, 25 2011 using texi2html 1.70.
le://localhost/Library/Documentation/Commands/texi2html/texi2html.html
46/46