6.4 Building Documentation

Documentation currently cannot be built under Windows alone. Luckily, this step is optional. If you don't do it, then you simply have a system without documentation, but it runs.

For Windows, we deliver documentation not as a big bunch of HTML files, but as an HTML Help file (also called a CHM file). HTML Help files provide full-text search capabilities, a full table of contents, and are much smaller than all the HTML sources. This section explains how to obtain this file. Take yourself to a Unix machine. You will need gawk and nsgml installed in your system. These tools are used to parse, validate, and normalize SGML and XML files. You can find them in http://www.gnu.org/software/gawk/gawk.html and http://www.jclark.com/sp/. Then, do something like:

unset OZHOME OZPATH OZEMULATOR TEXT2PICKLE export PATH=/opt/gcc-2.95.3/bin:/opt/jdk/bin:/usr/bin:/bin:/usr/X11R6/bin:/usr/local/bin mkdir /tmp/build cd /tmp/buildmozart/configure --prefix=linux-install \ --with-documents=all --enable-chm --with-stdlib=stdlib make bootstrap make install

where linux-install is a directory different from the install directory. Get back to your Windows machine and do:

cd linux-install/doc /cygdrive/c/Program\ Files/HTML\ Help\ Workshop/hhc Mozart

(assuming that you have linux-install on a network shared file system. If not, you'll have to somehow copy this directory to your Windows machine). hhc is the HTML Help Compiler from Microsoft's HTML Help Workshop, available freely for download at http://msdn.microsoft.com/library/en-us/htmlhelp/html/hwMicrosoftHTMLHelpDownloads.asp. The current version is 1.4, but this one does not provide hhc. The version you'll have to install is 1.32. (If the URL is broken, search Microsoft's site for ``download html help workshop''. It seems Microsoft tends to reorganize their site every so often.)

This process will leave behind a file Mozart.chm, which we can copy to a sensible place:

cp Mozart.chm install/doc

If you want, you can delete from the install/doc directory all files except Mozart.chm and the demo/applets directory.