SORTIE-NDSoftware for spatially-explicit simulation of forest dynamics
SORTIE-ND Help System
The SORTIE-ND help files are written in HTML and displayed using JavaHelp. There are help authoring tools which support JavaHelp; if you want to use one, go ahead. I do everything by hand because it's simple to do and doesn't take a lot of time. The SORTIE-N help files are packaged together in a .jar file called "sortie_help.jar". You can extract this jar to get the help source (you can use the Java JAR utility if you're a command-line guru, or many compression programs can handle the job by treating it like a ZIP file). The help files should all be packaged within a top-level folder called "help".
The code documentation is generated using Doxygen. You can download it here. Read about how code should be commented in order to be auto-documented. Doxygen is kind of picky, and I'm always finding mistakes in my code comments. If you find any, let me know. I do everything using Javadoc style.
User documentation - making updates to help
If you need to make updates to the help, here's the brief description for how to do it. You can also email me (Lora Murphy); I'll get your updates into the official help along with your code.
Tips for writing help
Keep in mind that when writing HTML help topics, HTML 4.0 features may not be supported in the help viewer (although they show up fine in a browser). I've noticed two: entities for Greek letters and anchor tags. When writing Greek letter entities, HTML 4.0 specifications allow writing them like this: "λ". However, the viewer chokes unless they are in the old decimal format, like this: "Λ". When doing anchor tags within a document, you can't use "< a id="name"> < /a> " with "< a href="#name"> link text< /a> ". You need to use the old name attribute, and do it this way: "< a name="name"> < /a> " with "< a href=#name> link text< /a> ". (Keep track of those quotation marks.) I recommend that you always preview your text in both a browser and the Java help viewer. The JavaHelp documentation tells you how to use the help viewer.