/[texi2html]/texi2html/doc/texi2html.texi
ViewVC logotype

Diff of /texi2html/doc/texi2html.texi

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.36 by pertusus, Sun Aug 21 21:31:55 2005 UTC revision 1.37 by pertusus, Tue Aug 23 06:58:04 2005 UTC
# Line 284  producing, have a look at the following Line 284  producing, have a look at the following
284    
285  You would like to produce @acronym{HTML} files from your existing Texinfo  You would like to produce @acronym{HTML} files from your existing Texinfo
286  files?  There are two programs you can use to do this.  The first is  files?  There are two programs you can use to do this.  The first is
287  @command{makeinfo} (@pxref{Generating HTML,,,texinfo}).  @command{makeinfo} (@pxref{Generating HTML,,,texinfo,GNU Texinfo}).
288  The second is @command{texi2html}.  The second is @command{texi2html}.
289    
290  The design goal of @command{makeinfo}'s @acronym{HTML} output was to produce  The design goal of @command{makeinfo}'s @acronym{HTML} output was to produce
# Line 539  element. Line 539  element.
539    
540  This default behaviour mimics @command{texi2dvi} behaviour, which ignores  This default behaviour mimics @command{texi2dvi} behaviour, which ignores
541  @code{@@node} commands for the purprose of sectioning, while the second  @code{@@node} commands for the purprose of sectioning, while the second
542  looks like @command{makeinfo} behaviour (@pxref{Two Paths,,, texinfo}).  looks like @command{makeinfo} behaviour (@pxref{Two Paths,,,texinfo,GNU Texinfo}).
543    
544  As an illustration, the following table shows how a sample Texinfo document is  As an illustration, the following table shows how a sample Texinfo document is
545  divided into sectioning elements when @longopt{use-nodes} is used and not:  divided into sectioning elements when @longopt{use-nodes} is used and not:
# Line 796  specified, and @samp{-} stands for the s Line 796  specified, and @samp{-} stands for the s
796  @variable{@@CSS_FILES}).  @variable{@@CSS_FILES}).
797    
798  The option use is the same than for @command{makeinfo} and is described  The option use is the same than for @command{makeinfo} and is described
799  extensively in @ref{HTML CSS,,,texinfo}.  extensively in @ref{HTML CSS,,,texinfo,GNU Texinfo}.
800  Briefly, the @acronym{CSS} @code{@@import} lines from the external file  Briefly, the @acronym{CSS} @code{@@import} lines from the external file
801  @acronym{CSS} file are pasted  before the  @acronym{CSS} file are pasted  before the
802  @c What does this mean?  I don't think I clarified this one much.  -DRP  @c What does this mean?  I don't think I clarified this one much.  -DRP
# Line 1358  Homepage for @command{texi2html}. Line 1358  Homepage for @command{texi2html}.
1358  Authors of @command{texi2html}.  Authors of @command{texi2html}.
1359  @item file_base_name  @item file_base_name
1360  base name of the texinfo manual file.  base name of the texinfo manual file.
1361    @item filename
1362    This is a reference on a hash that holds the filenames for special elements.
1363    The keys are
1364    @table @code
1365    @item doc
1366    the document file if not split, if split should be the top element file.
1367    @item top
1368    Top element file name.
1369    @item toc
1370    Table of contents element file name.
1371    @item stoc
1372    Overview (also called short table of contents) element file name.
1373    @item about
1374    About element file name.
1375    @item foot
1376    Footnotes element file name.
1377    @end table
1378  @item destination_directory  @item destination_directory
1379  Destination directory for the resulting files.  Destination directory for the resulting files.
1380  @item toc_file  @item toc_file
# Line 2417  external manual. Line 2434  external manual.
2434  node name mapped to an identifier acceptable as a file name.  node name mapped to an identifier acceptable as a file name.
2435  @var{$xml_node_identifier} is the  @var{$xml_node_identifier} is the
2436  node name mapped to an identifier acceptable as an @acronym{XML} identifier.  node name mapped to an identifier acceptable as an @acronym{XML} identifier.
2437  Those identifiers are built as explained in @ref{HTML Xref,,,texinfo},  Those identifiers are built as explained in @ref{HTML Xref,,,texinfo,GNU Texinfo},
2438  thus allowing for cross references to external manuals. @var{$file} is the  thus allowing for cross references to external manuals. @var{$file} is the
2439  manual or file name of the external reference. This function should return an  manual or file name of the external reference. This function should return an
2440  href leading to the external manual.  href leading to the external manual.
2441    
2442  The default for this function is to make a reference compatible with  The default for this function is to make a reference compatible with
2443  @command{makeinfo}  (@pxref{HTML Xref,,,texinfo}).  @command{makeinfo}  (@pxref{HTML Xref,,,texinfo,GNU Texinfo}).
2444  @end deftypefn  @end deftypefn
2445    
2446  @deftypefn {Function Reference} $text external_ref $command $section $book $node_and_file $href $cross_ref_name  @deftypefn {Function Reference} $text external_ref $command $section $book $node_and_file $href $cross_ref_name

Legend:
Removed from v.1.36  
changed lines
  Added in v.1.37

savannah-hackers-public@gnu.org
ViewVC Help
Powered by ViewVC 1.1.26