[jira] [Commented] (OFBIZ-4941) Proposal for a new help system

["Jacques Le Roux (JIRA)" <ji...@apache.org>]

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

Jacques Le Roux commented on OFBIZ-4941:
----------------------------------------

Tom, 

I did it again in a fresh checked out OFBiz trunk instance. All went well (for those interested, see the 2 remarks below tough), after running all the ant targets, I ran OFBiz and when I tried the (catalog) help I got a js message saying "Help is not available for this language. Opening Help in English", so far so good (I was in French, my default language). But when I went further clicking the OK button, I got nothing at 
http://localhost:8080/ofbizhelp/catalog_en/content/catalog_main.html
nor at
http://localhost:8080/ofbizhelp/accounting_en/content/accounting_main.html
Actually I got a FF message in French saying "Oups ! Petit problème... Ce lien semble brisé.", nothing in log. What could I have missed (I ran all the ant targets, they went all well, including the "Native test webhelp target")? I also tried to set English language but got the same issue.

For those interested, some reminders and abstract from conversation above:

# The Readme Webhelp OFBiz Initial Installation.txt file is still confusing, it should rather say
5. Copy WebhelpFiles docbookhelp to applications/content/data/helpdata/docbookhelp
Copy WebhelpHRAppDocbook/docbookhelp to docbookhelp applications/content/data/helpdata/docbookhelp
instead of 
5. Copy from WebhelpFiles docbookhelp to applications/content/data/helpdata
Copy folders humanres_en and images_humanres_en from WebhelpHRAppDocbook/docbookhelp to docbookhelp applications/content/data/helpdata
Anyway this is only for testing before we decide to commit or not.
# You must run the webhelp.* build targets from Eclipse (or your preferred IDE). At least it did not work for me from command line on XP (either from root or in applications/content/template/docbook/webhelp). I guess it's related to the Ant version but did not dig in.


BTW Tom, should we not say something specific about applications\content\template\docbook\webhelp\test-output ? Is it suppposed to help help-developers?

For Adrian's concern about applications components dependency upon the content component. Could we not have the files under applications\content\data\helpdata\docbookhelp rather in their respective components? Is that blocking for building the help?
For those interested we have this folders under applications\content\data\helpdata\docbookhelp
{quote}
accounting_en
accounting_en_images
catalog_en
catalog_en_images
humanres_en
humanres_en_images
manufacturing_de
manufacturing_de_images
manufacturing_en
manufacturing_en_images
manufacturing_nl
manufacturing_nl_images
projectmgr_en
projectmgr_en_images
{quote}
Of course this should grow with more help in the future.
                
> 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