3.1. Checking Your Documents

Obviously, as you modify your document set, things can go wrong.

The ant build process generates a steady stream of messages, some pure information and some errors. You can capture these into a file by using the -l option to write all messages to a log file, e.g.:

ant -l build.log

Unfortunately, that hides the messages from you while the build is running. On Unix/Linux system, therefore, I prefer

ant | tee build.log

Error Messages

Watch for messages indicating that a file did not exist or could not be read, particularly if you have just made changes to the sitemap.

Most of all, watch for error messages indicating that an Olink was "unresolved". This could mean that you misspelled a targetdoc entry in an olink, or that you forgot to list a document in the sitemap.

Use a Link Checker

Once the document set has been constructed, I recommend using a link checker such as Xenu's Link Sleuth on the documents. It's best to do this before you publish the documents to your website. The reason, besides simply avoiding embarrassment, is that link checkers may have problems with any security you have put on your website, so it's best to do this checking on the file set within your working directory.

As a convenient target for a link checker, a file is created in the output directory named sitemap.html with a link to every output form of every document named in the course.sitemap file.