Status: In Progress
Affects Version/s: Trunk
Fix Version/s: None
Component/s: ALL COMPONENTS
Quoting Tom Burns at
This is a status update just to let anyone who is interested know that this item is being worked on.
I started out using the OFBiz structure for help docs but after a while I needed/wanted something more expressive.
Here is what I wound up using for development:
Java Help System http://java.net/projects/javahelp/content
DocBook XSL: The Complete Guide
Help Master - FE for managing java help files. Best feature drag and drop TOC creates TOC matching file folder structure. Convenient launcher for viewing & testing. http://www.halogenware.com/software/helpmaster.html
XML Mind XML Editor - Free Personal Edition is far better then editing in Eclipse. download from http://www.xmlmind.com/xmleditor/download.shtml
Tutorial - DocBook editing with XML Mind XML Editor. Worth going through http://www.xmlmind.com/xmleditor/tutorial.html
Read Me First style guide from Sun (cost from Amazon 1 cent + shipping)
Attached are some screen shots of the results.
Every screen is/will be documented in a similar structure. This is as much for defining requirements and testing as for help. More work but worth it.
The screenshots show a Java Help format generated using DocBook XSL. This will likely not be the final presentation format.
Note the Performance Review screen shots do not match the trunk. There is a bug in update screen and I did some clean up of labels and drop-down list. There are issues like this all through the application so I did not want to get bogged down with patches at this time.