/[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.31 by dprice, Tue Jul 12 14:59:02 2005 UTC revision 1.32 by pertusus, Mon Aug 8 20:46:15 2005 UTC
# Line 630  If the manual is split the files are put Line 630  If the manual is split the files are put
630  manual name. The file name is constructed using the manual name as basename.  manual name. The file name is constructed using the manual name as basename.
631  An underscore followed by a number is appended  An underscore followed by a number is appended
632  to the basename for each files corresponding with sectioning elements, with the  to the basename for each files corresponding with sectioning elements, with the
633  exception of the top element. For the top element there nothing appended.  exception of the top element. For the top element there is nothing appended.
634  The files containing special elements pages  The files containing special elements pages
635  have an underscore and a 3 letter code corresponding to their content  have an underscore and a 3 letter code corresponding to their content
636  (@samp{toc} for table of contents, @samp{abt} for about, @samp{ovr} for  (@samp{toc} for table of contents, @samp{abt} for about, @samp{ovr} for
637  overview) appended.  Lastly, an @samp{.html} file extension is appended.  overview, @samp{fot} for footnotes if they are separated) appended.  
638    Lastly, an @samp{.html} file extension is appended.
639    
640  Thus, if the texinfo file @file{afile.texi} is processed and split at chapters  Thus, if the texinfo file @file{afile.texi} is processed and split at chapters
641  into 3 files, the generated files (in directory @file{afile}) will be:  into 3 files, the generated files (in directory @file{afile}) will be:
# Line 1860  a redirection to the node @var{$redirect Line 1861  a redirection to the node @var{$redirect
1861  @end deftypefn  @end deftypefn
1862    
1863  The other is usefull if @code{$NODE_FILES} isn't true. It is used to  The other is usefull if @code{$NODE_FILES} isn't true. It is used to
1864  customize the file associated with each element.  customize the file names associated with each element, and the
1865  @deftypefn {Function Reference} $file element_file_name $element $is_top $docu_name  name of the file associated with the special elements.
1866  @var{$element} is a hash reference with the following interesting keys (there  @deftypefn {Function Reference} $file element_file_name $element $type $docu_name
1867    @var{$element} is undefined for the special elements (about, overview,
1868    table of contents, footnotes).
1869    Otherwise it is a hash reference with the following interesting keys (there
1870  are much more keys):  are much more keys):
1871  @table @code  @table @code
1872  @item texi  @item texi
# Line 1877  The element text. Line 1881  The element text.
1881  @item name  @item name
1882  The element text without section number.  The element text without section number.
1883  @end table  @end table
1884  @var{$is_top} is true if the element is considered as the top element.  @var{$type} is empty for normal elements.
1885    For the top element it is @samp{top}, for the table of contents it
1886    is @samp{toc}, for the overview it is @samp{stoc}, for the
1887    footnotes it is @samp{foot} and for about is @samp{about}.
1888  @var{$docu_name} is the basename of the texinfo manual.  @var{$docu_name} is the basename of the texinfo manual.
1889  The result is the element file name.  The result is the element or special element file name.
1890  @end deftypefn  @end deftypefn
1891    
1892  @c --------------------------------------------------------  @c --------------------------------------------------------

Legend:
Removed from v.1.31  
changed lines
  Added in v.1.32

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