Next: CVS Keywords in Web Pages, Up: Web Pages
The script gendocs.sh eases the task of generating the Texinfo documentation output for your web pages section above. It has a companion template file, used as the basis for the HTML index pages. Both are available from the Texinfo CVS sources:
http://savannah.gnu.org/cgi-bin/viewcvs/texinfo/texinfo/util/gendocs.sh http://savannah.gnu.org/cgi-bin/viewcvs/texinfo/texinfo/util/gendocs_template
Invoke the script like this, in the directory containing the Texinfo source:
gendocs.sh yourmanual "GNU yourmanual manual"
where yourmanual is the short name for your package. The script processes the file yourmanual.texinfo (or .texi or .txi). For example:
cd .../emacs/man
# download gendocs.sh and gendocs_template
gendocs.sh emacs "GNU Emacs manual"
gendocs.sh creates a subdirectory manual/ containing the manual generated in all the standard output formats: Info, HTML, DVI, and so on, as well as the Texinfo source. You then need to move all those files, retaining the subdirectories, into the web pages for your package.
You can specify the option -o outdir to override the name manual. Any previous contents of outdir will be deleted.
The second argument, with the description, is included as part of the
HTML <title> of the overall manual/index.html file. It
should include the name of the package being documented, as shown.
manual/index.html is created by substitution from the file
gendocs_template. (Feel free to modify the generic template
for your own purposes.)
If you have several manuals, you'll need to run this script several times with different arguments, specifying a different output directory with -o each time, and moving all the output to your web page. Then write (by hand) an overall index.html with links to them all. For example:
cd .../texinfo/doc
gendocs.sh -o texinfo texinfo "GNU Texinfo manual"
gendocs.sh -o info info "GNU Info manual"
gendocs.sh -o info-stnd info-stnd "GNU info-stnd manual"
You can set the environment variables MAKEINFO, TEXI2DVI, and DVIPS to control the programs that get executed, and GENDOCS_TEMPLATE_DIR to control where the gendocs_template file is found.
Please email bug reports, enhancement requests, or other correspondence to bug-texinfo@gnu.org.