• Type: Wish Wish
    • Status: In Progress
    • Priority: Minor Minor
    • Resolution: Unresolved
    • Affects Version/s: Trunk
    • Fix Version/s: None
    • Component/s: ALL COMPONENTS
    • Labels:


      Quoting Tom Burns at OFBIZ-4869

      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

      DocBook 5: The Definitive Guide

      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.

      XML Mind XML Editor - Free Personal Edition is far better then editing in Eclipse. download from

      Tutorial - DocBook editing with XML Mind XML Editor. Worth going through

      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.

      1. OFBIZ-4941.patch
        1.14 MB
        Jacques Le Roux
      2. ofbiz-common.xsl
        43 kB
        Tom Burns
      3. OFBIZ-4941.patch
        1.85 MB
        Jacques Le Roux
        34 kB
        Tom Burns
      5. OFBIZ-4941.patch
        1.75 MB
        Jacques Le Roux
      6. OFBIZ-4941.patch
        1.74 MB
        Jacques Le Roux
      7. OFBIZ-4941.patch
        1.74 MB
        Jacques Le Roux
      8. OFBIZ-4941.patch
        1.73 MB
        Jacques Le Roux
        7.77 MB
        Tom Burns
        8.60 MB
        Tom Burns
      11. content.7z
        3.84 MB
        Jacques Le Roux
      12. docbook diff.patch
        90 kB
        Jacques Le Roux
      13. help_content.jpg
        34 kB
        Tom Burns
      14. help_webhlep.jpg
        90 kB
        Tom Burns
      15. help_ofbizhelp.jpg
        61 kB
        Tom Burns
        8.59 MB
        Tom Burns
        4.90 MB
        Tom Burns
        5.16 MB
        Tom Burns
      19. webhelp.jpg
        205 kB
        Tom Burns
      20. jh.jar
        496 kB
        Tom Burns
      21. LICENSE.html
        13 kB
        Tom Burns
        5.94 MB
        Tom Burns
      23. OFBIZ-4941 POC HR Help.patch
        1.36 MB
        Tom Burns
      24. HelpRoadmap.jpg
        364 kB
        Tom Burns
      25. HelpPerformanceReview2.jpg
        301 kB
        Tom Burns
      26. HelpPerformanceReview1.jpg
        212 kB
        Tom Burns
      27. HelpAccounting.jpg
        135 kB
        Tom Burns

        Issue Links



            • Assignee:
              Paul Foxworthy
              Jacques Le Roux
            • Votes:
              0 Vote for this issue
              12 Start watching this issue


              • Created: