[ 
https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13406008#comment-13406008
 ] 

Tom Burns commented on OFBIZ-4941:
----------------------------------

Hi Jacques,

Thanks for the feedback.

I'm not sure what you meant by "...Edit Agreements.html could not be a pb..."

A few small problems with the patch. 
To run the ant "build-all" task after installing the patch you will need to 
create two directories. 
1. ofbizhelp\lib
2. ofbizhelp\data\helpdata\docbook\images
Also missing from the patch was the JavaHelp jar jh.jar.
It goes in ofbizhelp/webapp/ofbizhelp/WEB-INF/lib
And remember to install docbook-xsl-1.77.1

My main concern is with the licensing and community desire to use JavaHelp. 
JavaHelp 2 can be downloaded from two sources:

1.  http://download.java.net/javadesktop/javahelp/javahelp2_0_05.zip
License attached

2.  SVN at http://java.net/projects/javahelp/sources/svn/show/trunk?rev=89
https://svn.java.net/svn/javahelp~svn
GNU General Public License (GPL) Version 2, June 1991

I understand that GPL 2 is not compatible with the Apache license.
If this is not a problem and the community would like to go the JavaHelp route 
then I'll submit an improved POC for discussion.

If  JavaHelp is not part of the solution then either the existing help system 
would have to upgraded to display html or something different would have to be 
built. I will look into that after I complete the HR documentation.

The HR docs are taking time because I am doing a functional review documenting 
unexpected behavior and creating some improvements as I go.

Tom

Uploads to follow:
docbook-xsl-1.77.1
jh.jar
jh2.0/LICENSE.html

                
> Proposal for a new help system
> ------------------------------
>
>                 Key: OFBIZ-4941
>                 URL: https://issues.apache.org/jira/browse/OFBIZ-4941
>             Project: OFBiz
>          Issue Type: Wish
>          Components: ALL COMPONENTS
>    Affects Versions: SVN trunk
>            Reporter: Jacques Le Roux
>            Priority: Minor
>             Fix For: SVN trunk
>
>         Attachments: HelpAccounting.jpg, HelpPerformanceReview1.jpg, 
> HelpPerformanceReview2.jpg, HelpRoadmap.jpg, LICENSE.html, OFBIZ-4941 POC HR 
> Help.patch, docbook-xsl-1.77.1.zip, jh.jar
>
>
> Quoting Tom Burns at OFBIZ-4869
> {quote}
> 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.
> {quote}

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: 
https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

Reply via email to