PREV UP NEXT texi2www user's guide

Chapter 1: A Real Life Example

Here's how I used texi2www to set up a directory of texinfo documents. This discussion is the minimum I had to do to set up texinfo and texi2www. First, I created the directory ``$HTDOCS/info'' ($HTDOCS is the root directory of my web server).

Then, I copied arrow icons ``missing-arrow.gif'', ``next-arrow.gif'', ``prev-arrow.gif'', and ``up-arrow.gif'' into ``$HTDOCS/info''. (I obtained my icons from Rutgers University Network Services at http://ns2.rutgers.edu/doc-images/buttons.)

Next, I created subdirectories ``$HTDOCS/info/texinfo'' and ``$HTDOCS/info/texi2wwwdoc''. (I determined the names of these subdirectories by examining the ``@setfilename'' line in the texinfo files. files; texi2wwwdoc.texi contains the line ``@setfilename texi2wwwdoc.info'' and texinfo.texi contains ``@setfilename texinfo.info''.

Next, I copied the texinfo files into the appropriate directories. This step isn't strictly required, but I think its a good idea since it makes it simple to keep track of which texinfo files generated which set of html documents.

Then I generated the html documents. I used the commands:

> cd $HTDOCS/info/texinfo
> texi2www texinfo.texi
Normal completion.
> cd ../texi2wwwdoc
> texi2www texi2wwwdoc.texi
Normal completion.

Examing these directories shows that a bunch of .html files got generated, including, in each directory, ``Top.html''.

Finally, I created a table of contents file ``$HTDOCS/info/dir.html''. The first version of that file looked like:

<HTML>
<HEAD><TITLE>info directory table of contents</TITLE></HEAD>
<BODY>
<MENU>
<LI><A HREF="texinfo/Top.html">texinfo</A>
    GNU texinfo version 3.1
<LI><A HREF="texi2wwwdoc/Top.html">texi2www</A>
    Converts texinfo to html
</MENU>
</BODY></HTML>