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

Diff of /texi2html/doc/texi2html.html

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

revision 1.21 by dprice, Thu Jul 28 13:59:48 2005 UTC revision 1.22 by pertusus, Tue Aug 9 17:19:27 2005 UTC
# Line 31  conditions for modified versions, except Line 31  conditions for modified versions, except
31  permission notice may be stated in a translation approved  permission notice may be stated in a translation approved
32  by the Free Software Foundation.  by the Free Software Foundation.
33  -->  -->
34  <!-- Created on July, 25 2005 by texi2html @PACKAGE_VERSION@ -->  <!-- Created on August, 9 2005 by texi2html @PACKAGE_VERSION@ -->
35  <!--  <!--
36  Written by: Lionel Cons <Lionel.Cons@cern.ch> (original author)  Written by: Lionel Cons <Lionel.Cons@cern.ch> (original author)
37              Karl Berry  <karl@freefriends.org>              Karl Berry  <karl@freefriends.org>
38              Olaf Bachmann <obachman@mathematik.uni-kl.de>              Olaf Bachmann <obachman@mathematik.uni-kl.de>
39              and many others.              and many others.
40  Maintained by: Many creative people <dev@texi2html.cvshome.org>  Maintained by: Many creative people.
41  Send bugs and suggestions to <users@texi2html.cvshome.org>  Send bugs and suggestions to <texi2html-bug@nongnu.org>
42    
43  -->  -->
44  <head>  <head>
# Line 130  by the Free Software Foundation. Line 130  by the Free Software Foundation.
130  <a name="SEC_Top"></a>  <a name="SEC_Top"></a>
131    
132    
133  <p>This manual, last updated 12 July 2005, describes version 1.77  <p>This manual, last updated 9 August 2005, describes version 1.77
134  of the <code>texi2html</code> Perl script which converts  of the <code>texi2html</code> Perl script which converts
135  <a href="http://www.texinfo.org">Texinfo</a> into <a href="http://w3c.org">HTML</a>.  <a href="http://www.texinfo.org">Texinfo</a> into <a href="http://w3c.org">HTML</a>.
136  </p>  </p>
137  <p>Please send bug reports concerning this manual to the Texi2HTML developement  <p>Please send bug reports concerning this manual to the Texi2HTML developement
138  list <a href="mailto:dev@texi2html.cvshome.org">dev@texi2html.cvshome.org</a>. Please state the exact  list <a href="mailto:texi2html-bug@nongnu.org">texi2html-bug@nongnu.org</a>. Please state the exact
139  version of the manual which contains the bug, as given above.  version of the manual which contains the bug, as given above.
140  </p>  </p>
141    
# Line 286  provided with the distribution. Line 286  provided with the distribution.
286  </p>  </p>
287  <p><code>texi2html</code> should reasonably convert all Texinfo  <p><code>texi2html</code> should reasonably convert all Texinfo
288  4.8 constructs.  If you find it does not, please send a bug report to the  4.8 constructs.  If you find it does not, please send a bug report to the
289  <a href="mailto:users@texi2html.cvshome.org">users@texi2html.cvshome.org</a> email list.  <a href="mailto:texi2html-bug@nongnu.org">texi2html-bug@nongnu.org</a> email list.
290  </p>  </p>
291  <hr size="6">  <hr size="6">
292  <a name="Obtaining-texi2html"></a>  <a name="Obtaining-texi2html"></a>
# Line 310  provided with the distribution. Line 310  provided with the distribution.
310  <h1 class="chapter"> 2. Obtaining <code>texi2html</code> </h1>  <h1 class="chapter"> 2. Obtaining <code>texi2html</code> </h1>
311    
312  <p>The latest version of the source code for <code>texi2html</code> should be  <p>The latest version of the source code for <code>texi2html</code> should be
313  available from <a href="http://texi2html.cvshome.org">texi2html.cvshome.org</a>.  available from
314    <a href="http://www.nongnu.org/texi2html/">www.nongnu.org/texi2html/</a>.
315  <code>texi2html</code> is also available with  <code>texi2html</code> is also available with
316  <a href="http://www.tug.org/teTeX/">teTeX</a>.  <a href="http://www.tug.org/teTeX/">teTeX</a>.
317  </p>  </p>
# Line 753  to the manual name. Line 754  to the manual name.
754  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.
755  An underscore followed by a number is appended  An underscore followed by a number is appended
756  to the basename for each files corresponding with sectioning elements, with the  to the basename for each files corresponding with sectioning elements, with the
757  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.
758  The files containing special elements pages  The files containing special elements pages
759  have an underscore and a 3 letter code corresponding to their content  have an underscore and a 3 letter code corresponding to their content
760  (<samp>`toc'</samp> for table of contents, <samp>`abt'</samp> for about, <samp>`ovr'</samp> for  (<samp>`toc'</samp> for table of contents, <samp>`abt'</samp> for about, <samp>`ovr'</samp> for
761  overview) appended.  Lastly, an <samp>`.html'</samp> file extension is appended.  overview, <samp>`fot'</samp> for footnotes if they are separated) appended.  
762    Lastly, an <samp>`.html'</samp> file extension is appended.
763  </p>  </p>
764  <p>Thus, if the texinfo file <tt>`afile.texi'</tt> is processed and split at chapters  <p>Thus, if the texinfo file <tt>`afile.texi'</tt> is processed and split at chapters
765  into 3 files, the generated files (in directory <tt>`afile'</tt>) will be:  into 3 files, the generated files (in directory <tt>`afile'</tt>) will be:
# Line 2900  a redirection to the node <var>$redirect Line 2902  a redirection to the node <var>$redirect
2902  </p></dd></dl>  </p></dd></dl>
2903    
2904  <p>The other is usefull if <code>$NODE_FILES</code> isn't true. It is used to  <p>The other is usefull if <code>$NODE_FILES</code> isn't true. It is used to
2905  customize the file associated with each element.  customize the file names associated with each element, and the
2906    name of the file associated with the special elements.
2907  </p><dl>  </p><dl>
2908  <dt><u>Function Reference:</u> $file <b>element_file_name</b><i> $element $is_top $docu_name</i>  <dt><u>Function Reference:</u> $file <b>element_file_name</b><i> $element $type $docu_name</i>
2909  <a name="IDX180"></a>  <a name="IDX180"></a>
2910  </dt>  </dt>
2911  <dd><p><var>$element</var> is a hash reference with the following interesting keys (there  <dd><p><var>$element</var> is undefined for the special elements (about, overview,
2912    table of contents, footnotes).
2913    Otherwise it is a hash reference with the following interesting keys (there
2914  are much more keys):  are much more keys):
2915  </p><dl compact="compact">  </p><dl compact="compact">
2916  <dt> <code>texi</code></dt>  <dt> <code>texi</code></dt>
# Line 2925  document is split (see section <a href=" Line 2930  document is split (see section <a href="
2930  <dd><p>The element text without section number.  <dd><p>The element text without section number.
2931  </p></dd>  </p></dd>
2932  </dl>  </dl>
2933  <p><var>$is_top</var> is true if the element is considered as the top element.  <p><var>$type</var> is empty for normal elements.
2934    For the top element it is <samp>`top'</samp>, for the table of contents it
2935    is <samp>`toc'</samp>, for the overview it is <samp>`stoc'</samp>, for the
2936    footnotes it is <samp>`foot'</samp> and for about is <samp>`about'</samp>.
2937  <var>$docu_name</var> is the basename of the texinfo manual.  <var>$docu_name</var> is the basename of the texinfo manual.
2938  The result is the element file name.  The result is the element or special element file name.
2939  </p></dd></dl>  </p></dd></dl>
2940    
2941  <hr size="6">  <hr size="6">
# Line 4545  The first one is usefull in case the <co Line 4553  The first one is usefull in case the <co
4553  it allows to prepend a string to the quotation text:  it allows to prepend a string to the quotation text:
4554  </p>  </p>
4555  <dl>  <dl>
4556  <dt><u>Function Reference:</u> $prepended_string <b>quotation_prepend_text</b><i> $style $text</i>  <dt><u>Function Reference:</u> $prepended_string <b>quotation_prepend_text</b><i> $text</i>
4557  <a name="IDX241"></a>  <a name="IDX241"></a>
4558  </dt>  </dt>
4559  <dd><p><var>$style</var> is the first argument of the <code>@quotation</code> if there are  <dd><p><var>$text</var> is the argument of the quotation with @-commands not
4560  two arguments. <var>$text</var> is the second argument or the first if there is  interpreted. This function
 one argument. There are still @-commands in these strings. This function  
4561  can return a string which will be prepended to the quotation text.  can return a string which will be prepended to the quotation text.
4562  </p></dd></dl>  </p></dd></dl>
4563    
4564    
4565  <p>The whole quotation is formatted by:  <p>The whole quotation is formatted by:
4566  </p>  </p>
4567  <dl>  <dl>
4568  <dt><u>Function Reference:</u> $quotation <b>quotation</b><i> $quotation_text $argument_text $argument_style_texi $argument_style_id</i>  <dt><u>Function Reference:</u> $quotation <b>quotation</b><i> $quotation_text $argument_text $argument_text_texi</i>
4569  <a name="IDX242"></a>  <a name="IDX242"></a>
4570  </dt>  </dt>
4571  <dd><p><var>$quotation_text</var> is the quotation text, formatted, with the text  <dd><p><var>$quotation_text</var> is the quotation text, formatted, with the text
4572  prepended by the function above. <var>$argument_text</var> is the second argument  prepended by the function above. <var>$argument_text</var> is the argument
4573  of the <code>@quotation</code> or the first if there is one argument, formatted.  of the <code>@quotation</code>, formatted. <var>$argument_text_texi</var> is the argument
4574  The other arguments are defiend if there are two arguments for the  of the <code>@quotation</code>, unformatted.
 <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.  
4575  </p></dd></dl>  </p></dd></dl>
4576    
4577    
# Line 6193  is added to <tt>`Makefile.am'</tt>. Line 6198  is added to <tt>`Makefile.am'</tt>.
6198  </tr></table>  </tr></table>
6199  <h1>About This Document</h1>  <h1>About This Document</h1>
6200  <p>  <p>
6201    This document was generated by <em>Derek Price</em> on <em>July, 25 2005</em> using <a href="http://texi2html.cvshome.org/"><em>texi2html @PACKAGE_VERSION@</em></a>.    This document was generated by <em>Patrice Dumas</em> on <em>August, 9 2005</em> using <a href="http://www.nongnu.org/texi2html/"><em>texi2html @PACKAGE_VERSION@</em></a>.
6202  </p>  </p>
6203  <p>  <p>
6204    The buttons in the navigation panels have the following meaning:    The buttons in the navigation panels have the following meaning:
# Line 6295  is added to <tt>`Makefile.am'</tt>. Line 6300  is added to <tt>`Makefile.am'</tt>.
6300  <hr size="1">  <hr size="1">
6301  <p>  <p>
6302   <font size="-1">   <font size="-1">
6303    This document was generated by <em>Derek Price</em> on <em>July, 25 2005</em> using <a href="http://texi2html.cvshome.org/"><em>texi2html @PACKAGE_VERSION@</em></a>.    This document was generated by <em>Patrice Dumas</em> on <em>August, 9 2005</em> using <a href="http://www.nongnu.org/texi2html/"><em>texi2html @PACKAGE_VERSION@</em></a>.
6304   </font>   </font>
6305   <br>   <br>
6306    

Legend:
Removed from v.1.21  
changed lines
  Added in v.1.22

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