[
https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13408497#comment-13408497
]
Tom Burns commented on OFBIZ-4941:
----------------------------------
I want to give the this dead horse (JavaHelp) one more beating.
In a thread on the user list Jacques directed an inquirer to the father of all
Apache projects, http://httpd.apache.org. I would think that they should have a
good doc system by now so I took a look.
See Apache developer documentation:
http://httpd.apache.org/docs/2.4/developer/documenting.html
"Apache 2.4 uses Doxygen to document the APIs and global variables in the code."
See Doxygen license: http://www.stack.nl/~dimitri/doxygen/
"Permission to use, copy, modify, and distribute this software and its
documentation under the terms of the GNU General Public License is hereby
granted."
The quotes may be out of context by it seems like we are really splitting hairs
if the test for conformance to a license is using the code at compile time vs.
run-time.
> 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
