[
https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13480779#comment-13480779
]
Tom Burns commented on OFBIZ-4941:
----------------------------------
Adrian,
I think you are confusing the build strategy with the architecture.
Each component will have it's own help system for each webapp in the component.
It is built independently or other component/webapps. The current help is at
the component level which is problematic when a component has multiple webapps.
The build strategy, as I am proposing is to deliver help pre-built.
Try it out, if you have not already. Your feed back would be greatly
appreciated.
1. Go to https://54.243.213.35:8443/humanres/control/main
2. Select any screen, from any component, in any locale, in any theme and click
the help icon/text.
Help is presented at the component/webapp level. This is apparent by selecting
help from accounting vs from ap/ar.
If help is available in the new format/locale it will be presented.
If not available in the locale will default to en. (An improvement would be to
offer alt available locals)
If not available in new format will default to current help (legacy current
help will be replaced in phase 2).
Tom
> 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
> Assignee: Jacques Le Roux
> Priority: Minor
> Fix For: SVN trunk
>
> Attachments: content.7z, docbook diff.patch, docbook-xsl-1.77.1.zip,
> HelpAccounting.jpg, help_content.jpg, help_ofbizhelp.jpg, helppdf.zip,
> HelpPerformanceReview1.jpg, HelpPerformanceReview2.jpg, HelpRoadmap.jpg,
> help_webhlep.jpg, jh.jar, LICENSE.html, OFBIZ-4941 POC HR Help.patch,
> WebhelpFiles.zip, WebhelpFiles.zip, WebhelpHRAppDocbook.zip,
> WebhelpHRAppDocbook.zip, webhelp.jpg
>
>
> 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
For more information on JIRA, see: http://www.atlassian.com/software/jira