Writing Foresight Docs: Part 3

My original intent in this continuing series on Writing Documentation for Foresight was to post weekly, but I just had to share the latest news.

With Paul Scott-Wilson’s help in IRC last night, the Userguide’s first two chapters are now working in Yelp. Pscott shared a diff file fixing some syntax issues, and pointed out I could just run yelp installation.xml to display the Docbook file in Yelp, or if it crashed, the terminal spit back all the errors and the lines to go fix them on. (I really do need to use the command line more.)

After spending a couple hours on all the errors that the terminal was yelling at me about, we now have Yelp displaying the Userguide (with images!):


There are still a number of typo’s I’m finding, especially as it relates to bullets and indentation, but the menu’s and links are working, the content is displayed, and best of all, no errors when starting from the command line. Check it out yourself from the Mercurial repository , it’s up to date.

Next up: Learn how to tie the docbook files together (Pscott pointed me at this link: http://www.sagehill.net/docbookxsl/ModularDoc.html) and package them up in Foresight. These first two chapters took me longer than expected to port to Docbook and re-write, so it’s probably a good idea to see if this even works.

Paul Cutler
Father. Husband. Vinyl Music Lover. Football fan. Python student. He / him.