Details

      Description

      Fix the help screens of Humanres

      1. HelpPerformanceReview1.jpg
        212 kB
        Tom Burns
      2. HelpPerformanceReview2.jpg
        301 kB
        Tom Burns
      3. HelpRoadmap.jpg
        364 kB
        Tom Burns

        Issue Links

          Activity

          Hide
          Jacques Le Roux added a comment - - edited

          Duplicate of OFBIZ-2219

          Show
          Jacques Le Roux added a comment - - edited Duplicate of OFBIZ-2219
          Hide
          Pierre Smits added a comment -

          Reopening to enable Tom Burns to upload his patch regarding the HUMANRES Help Pages

          Show
          Pierre Smits added a comment - Reopening to enable Tom Burns to upload his patch regarding the HUMANRES Help Pages
          Hide
          Tom Burns added a comment -

          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:

          • 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.

          Show
          Tom Burns added a comment - 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 5: The Definitive Guide http://www.docbook.org/tdg5/en/html/docbook.html http://www.docbook.org/xml/5.0/ DocBook XSL: The Complete Guide http://www.sagehill.net/docbookxsl/index.html http://sourceforge.net/projects/docbook/files/docbook-xsl/1.77.1/docbook-xsl-1.77.1.zip 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.
          Hide
          Jacques Le Roux added a comment - - edited

          == ENTERED TOO EARLY BY ACCIDENT ==
          Hi Tom,

          OK this looks good, but I have then created a new OFBIZ-4941 wish issue "Proposal for a new help system" and moved your comment there, please do the same for the images.

          After, before doing anything else, let know the community about your proposition. A simple link to OFBIZ-4941 with few words on the dev ML will be enough.

          If the community agree, OFBIZ-4941 will be then transformed from a wish to a main task. From that we will create subtasks to create the new structure, move the existing help, add new help, etc.

          For now I will definitively close this issue and if we go the new way I will later close OFBIZ-2219 and all related tasks and subtasks

          Looking forward for a continued effort

          Show
          Jacques Le Roux added a comment - - edited == ENTERED TOO EARLY BY ACCIDENT == Hi Tom, OK this looks good, but I have then created a new OFBIZ-4941 wish issue "Proposal for a new help system" and moved your comment there, please do the same for the images. After, before doing anything else, let know the community about your proposition. A simple link to OFBIZ-4941 with few words on the dev ML will be enough. If the community agree, OFBIZ-4941 will be then transformed from a wish to a main task . From that we will create subtasks to create the new structure, move the existing help, add new help, etc. For now I will definitively close this issue and if we go the new way I will later close OFBIZ-2219 and all related tasks and subtasks Looking forward for a continued effort
          Hide
          Jacques Le Roux added a comment -

          Closing: we use now OFBIZ-4941 instead

          Show
          Jacques Le Roux added a comment - Closing: we use now OFBIZ-4941 instead

            People

            • Assignee:
              Jacques Le Roux
              Reporter:
              Pierre Smits
            • Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development