Wikify Your Documenation
Those that have an aversion to Wiki's - look away!!!!
Want a quick and central method for writing your documentation for Java CAPS in wiki format?
I came across a product called tiddlywiki (www.tiddlywiki.com).
Its a free personal wiki that is contained in an html file and a small jar file.
Open up the html file in any web browser and you can start editing your wiki. The best bit is, its an html file, so it can be hosted on any web server (viewable only).
Glassfish, being an appserver has web server capabilities, so you can host your documentation on the same server that your Java CAPS environment runs on.
Great for keeping details regarding your Java CAPS implementation.
Also, being so small, it won't kill Java CAPS.
To deploy tiddlywiki on your Glassfish server, simply place the html (after renaming from empty.html to something more appropriate) and jar file in the JavaCAPS6/appserver/domains/domain1/docroot directory. The jar file isn't really required its only used to save your changes, but its handy to keep it with the html file.
To access, use http://hostname:port/wikiname.html
To edit the wiki, you will need to open the file locally in the browser (ie in the docroot directory), make your modifications that way.
This also works in older versions of Java CAPS. For 5.X, place the tiddlywiki file in JavaCAPS5/logicalhost/is/domains/<domain>/docroot and to access use http://hostname:port/wikiname.html where the port is 18001 instead of 8080.
If you need something with a little more grunt - http://www.wikimatrix.org can do search through the various wikis for one that suits your needs.
Posted at 12:11PM Feb 17, 2009 by Holger Paffrath in Personal | Comments[0]