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

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
147 messages Options
12345 ... 8
Reply | Threaded
Open this post in threaded view
|

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

Nicolas Malin (Jira)

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

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

Thanks Tom,

This needs more investigations, even if at 1st glance it indeed seems that it's possible. I mean we need to check more how they use Doxygen (compile time vs. run-time, as you mentionned)
               

> 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 | Threaded
Open this post in threaded view
|

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

Nicolas Malin (Jira)
In reply to this post by Nicolas Malin (Jira)

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

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

Also, though unrelated, note that this part of OFBiz documentation is user oriented when HTTPD one you referred to is for dvelopers.

I guess I'd have to digg more on your proposition. The idea would be to create an enhanced documentation from dockbook one, using an ant task that would notably dynamically load (using Ivy) the GPL part?
               

> 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 | Threaded
Open this post in threaded view
|

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

Nicolas Malin (Jira)
In reply to this post by Nicolas Malin (Jira)

     [ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Tom Burns updated OFBIZ-4941:
-----------------------------

    Attachment: webhelp.jpg
   

> 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, 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: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

       
Reply | Threaded
Open this post in threaded view
|

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

Nicolas Malin (Jira)
In reply to this post by Nicolas Malin (Jira)

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

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

Hi Jacques,

The docbook-xsl-1.77.1 supports other help formats so not using Java Help is not the end of the world.

The most interesting is webhelp which was developed as a Google SOC project. It's very Java Help like with a license that should work under Apache. If you have downloaded docbook-xsl-1.77.1 then take a look at docbook-xsl-1.77.1/webhelp/docs/index.html in a browser.

If not here is another screen shot.

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
>            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, 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: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

       
Reply | Threaded
Open this post in threaded view
|

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

Nicolas Malin (Jira)
In reply to this post by Nicolas Malin (Jira)

     [ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Tom Burns updated OFBIZ-4941:
-----------------------------

    Attachment: helppdf.zip
   

> 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: docbook-xsl-1.77.1.zip, HelpAccounting.jpg, helppdf.zip, HelpPerformanceReview1.jpg, HelpPerformanceReview2.jpg, HelpRoadmap.jpg, jh.jar, LICENSE.html, OFBIZ-4941 POC HR Help.patch, 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
Reply | Threaded
Open this post in threaded view
|

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

Nicolas Malin (Jira)
In reply to this post by Nicolas Malin (Jira)

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

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

I'm going to give this another shot.

The attached specification, OFBiz Help Spec.pdg included in the zip file, is an argument for an improved help system built around docbook-xsl-1.77.1 webhelp feature.

Also attached is a PDF of the long ago promised help for the Humanres. If there is any appetite for this I have a Docbook book version of the Accounting help that runs in webhelp.

Upgrading the rest of the help files would not be too much trouble however the code supports both webhelp and the current help files.

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
>            Priority: Minor
>             Fix For: SVN trunk
>
>         Attachments: docbook-xsl-1.77.1.zip, HelpAccounting.jpg, helppdf.zip, HelpPerformanceReview1.jpg, HelpPerformanceReview2.jpg, HelpRoadmap.jpg, jh.jar, LICENSE.html, OFBIZ-4941 POC HR Help.patch, 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
Reply | Threaded
Open this post in threaded view
|

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

Nicolas Malin (Jira)
In reply to this post by Nicolas Malin (Jira)

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

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

Thanks Tom,

It would be hard to neglect a such continued effort :)
               

> 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: docbook-xsl-1.77.1.zip, HelpAccounting.jpg, helppdf.zip, HelpPerformanceReview1.jpg, HelpPerformanceReview2.jpg, HelpRoadmap.jpg, jh.jar, LICENSE.html, OFBIZ-4941 POC HR Help.patch, 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
Reply | Threaded
Open this post in threaded view
|

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

Nicolas Malin (Jira)
In reply to this post by Nicolas Malin (Jira)

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

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

Jacques,

I tested different browsers using OFBiz in an AWS instance.
If you (or anyone else) would like to see Webhelp for OFBiz live try:
https://ec2-23-20-150-243.compute-1.amazonaws.com:8443/humanres/control/main

Try invoking help from Human Resource, Accounting (supported) and any other app (not supported).
Try different themes and locales (only en files now so just alerts user going to alt en).

Tested Opera, Firefox, Chrome, and IE.
Long story short Firefox was best overall.
Only issue is focus stays with OFBiz when a user invokes help and a help instance is open in the background.
Help is refreshed but user may not see it if help is minimized or hidden behind another window.

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
>            Priority: Minor
>             Fix For: SVN trunk
>
>         Attachments: docbook-xsl-1.77.1.zip, HelpAccounting.jpg, helppdf.zip, HelpPerformanceReview1.jpg, HelpPerformanceReview2.jpg, HelpRoadmap.jpg, jh.jar, LICENSE.html, OFBIZ-4941 POC HR Help.patch, 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
Reply | Threaded
Open this post in threaded view
|

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

Nicolas Malin (Jira)
In reply to this post by Nicolas Malin (Jira)

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

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

Thanks Tom,

I just had a glance with FF, I'd have loved to have a such thing when I began to be interested by OFBiz :D. This is even incomparably better than what we have now.

Accounting and HR are the only ones supported because you specifically worked on them, right? Or is it only a matter of running an ant task on them?

>Only issue is focus stays with OFBiz when a user invokes help and a help instance is open in the background.
I don't think it's an issue, having 2 windows seems quite useful to me, or you would prefer a new tab?

>Help is refreshed but user may not see it if help is minimized or hidden behind another window.
Not sure what you mean, from Accounting main, with help opened, I moved to Invoices, no changes in Help window.

I will have a deeper look ASAP, it's appealing!
               

> 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: docbook-xsl-1.77.1.zip, HelpAccounting.jpg, helppdf.zip, HelpPerformanceReview1.jpg, HelpPerformanceReview2.jpg, HelpRoadmap.jpg, jh.jar, LICENSE.html, OFBIZ-4941 POC HR Help.patch, 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
Reply | Threaded
Open this post in threaded view
|

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

Nicolas Malin (Jira)
In reply to this post by Nicolas Malin (Jira)

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

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

Jacques,

1. Accounting and HR are only supported now but it is not too much work to port the others, a bit of cut an paste. Be happy do to that if the community thinks this is a solution.

2. Two windows (and only two) are the goal.
The issue is, after you have a help window open and return to OFBiz and then invoke help, the desired behavior is to have the Webhelp browser get the focus. Try Chrome, it does what I had in mind.
(Downside in Chrome is it does not open the back and forward buttons.
They are very helpful when you use one of the internal links, say to a glossary item, and want to return the screen where you invoked the request. Webhelp navigation is mostly linear, go forward, go back. You need the browser back and forward buttons for a complete navigation solution)

3. If you move to Invoices and then invoke help, help will be updated in the WebHelp browser but (and this is the same as 2) the user does not get any feedback.
Unless the WebHelp browser is visible on the screen, the user will not know the request was acted on.
The desired behavior is for the browser with Webhelp to get the focus when the user invokes OFBiz help (Chrome does this).

Other features to note:

Try search:
In HR App search for Employee
In Accounting search for Invoice

Links:
Blue Underlined - links to another topic
Blue Underlined Italic - links to a Glossary item
See HR App Intra-Application Integration and HR App Menu in:
http://ec2-23-20-150-243.compute-1.amazonaws.com:8080/ofbizhelp/humanres_en/content/ch01s01.html

Blue Underlined Bold - links to an external resource
See Demo and Test Setup Guide in:
http://ec2-23-20-150-243.compute-1.amazonaws.com:8080/ofbizhelp/humanres_en/content/ch02s02.html


Thanks for your encouraging comments,

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
>            Priority: Minor
>             Fix For: SVN trunk
>
>         Attachments: docbook-xsl-1.77.1.zip, HelpAccounting.jpg, helppdf.zip, HelpPerformanceReview1.jpg, HelpPerformanceReview2.jpg, HelpRoadmap.jpg, jh.jar, LICENSE.html, OFBIZ-4941 POC HR Help.patch, 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
Reply | Threaded
Open this post in threaded view
|

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

hans_bakker
In reply to this post by Nicolas Malin (Jira)
Hi Tom, excellent job, looks good.

you might want to consider to store the field descriptions in the
entitymodel so they are also shown on the menus themselves. try the
productstore editscreen and put your mouse over a fieldname.....then the
description is shown....

Regards,
Hans


On 09/21/2012 12:12 AM, Tom Burns (JIRA) wrote:

>      [ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13459750#comment-13459750 ]
>
> Tom Burns commented on OFBIZ-4941:
> ----------------------------------
>
> Jacques,
>
> I tested different browsers using OFBiz in an AWS instance.
> If you (or anyone else) would like to see Webhelp for OFBiz live try:
> https://ec2-23-20-150-243.compute-1.amazonaws.com:8443/humanres/control/main
>
> Try invoking help from Human Resource, Accounting (supported) and any other app (not supported).
> Try different themes and locales (only en files now so just alerts user going to alt en).
>
> Tested Opera, Firefox, Chrome, and IE.
> Long story short Firefox was best overall.
> Only issue is focus stays with OFBiz when a user invokes help and a help instance is open in the background.
> Help is refreshed but user may not see it if help is minimized or hidden behind another window.
>
> 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
>>             Priority: Minor
>>              Fix For: SVN trunk
>>
>>          Attachments: docbook-xsl-1.77.1.zip, HelpAccounting.jpg, helppdf.zip, HelpPerformanceReview1.jpg, HelpPerformanceReview2.jpg, HelpRoadmap.jpg, jh.jar, LICENSE.html, OFBIZ-4941 POC HR Help.patch, 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

Reply | Threaded
Open this post in threaded view
|

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

Nicolas Malin (Jira)
In reply to this post by Nicolas Malin (Jira)

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

Olivier Heintz commented on OFBIZ-4941:
---------------------------------------

Very goob job, it's a important enhancement.
I have no time shortly, but trying to migrate all help I have done for portlet and Project Management will be in my priority, just after created a addon for this help system if it's not integrated in ofbiz standard.
And before translating in French your HR and accounting help.

Thank you very much for the job and the demonstration and all the details to help.
Olivier
               

> 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: docbook-xsl-1.77.1.zip, HelpAccounting.jpg, helppdf.zip, HelpPerformanceReview1.jpg, HelpPerformanceReview2.jpg, HelpRoadmap.jpg, jh.jar, LICENSE.html, OFBIZ-4941 POC HR Help.patch, 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
Reply | Threaded
Open this post in threaded view
|

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

Nicolas Malin (Jira)
In reply to this post by Nicolas Malin (Jira)

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

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

It's a pity Hans don't remember to answer here rather than on dev ML, but well here is the quote (FWIW)
{quote}
Hi Tom, excellent job, looks good.

you might want to consider to store the field descriptions in the
entitymodel so they are also shown on the menus themselves. try the
productstore editscreen and put your mouse over a fieldname.....then the
description is shown....

Regards,
Hans
{quote}


               

> 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: docbook-xsl-1.77.1.zip, HelpAccounting.jpg, helppdf.zip, HelpPerformanceReview1.jpg, HelpPerformanceReview2.jpg, HelpRoadmap.jpg, jh.jar, LICENSE.html, OFBIZ-4941 POC HR Help.patch, 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
Reply | Threaded
Open this post in threaded view
|

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

Nicolas Malin (Jira)
In reply to this post by Nicolas Malin (Jira)

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

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

Ha Hans,

Maybe this will no longer be necessary :) From below I understatnd we can create Jira comments directly from ML, to be tested...

{quote}
#asfinfra IRC Bot ‏@infrabot commenting on jira tcikets via email is now working again. -- <pctony>
{quote}
               

> 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: docbook-xsl-1.77.1.zip, HelpAccounting.jpg, helppdf.zip, HelpPerformanceReview1.jpg, HelpPerformanceReview2.jpg, HelpRoadmap.jpg, jh.jar, LICENSE.html, OFBIZ-4941 POC HR Help.patch, 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
Reply | Threaded
Open this post in threaded view
|

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

Nicolas Malin (Jira)
In reply to this post by Nicolas Malin (Jira)

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

Paul Foxworthy commented on OFBIZ-4941:
---------------------------------------

Hi Hans,

What about internationalization?

If descriptions of entities and attributes are to be displayed on screens, they should be internationalized. I guess that means using resources like everywhere else in OFBiz. So I think the entity model is not the place to do it.

Cheers

Paul Foxworthy
               

> 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: docbook-xsl-1.77.1.zip, HelpAccounting.jpg, helppdf.zip, HelpPerformanceReview1.jpg, HelpPerformanceReview2.jpg, HelpRoadmap.jpg, jh.jar, LICENSE.html, OFBIZ-4941 POC HR Help.patch, 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
Reply | Threaded
Open this post in threaded view
|

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

Nicolas Malin (Jira)
In reply to this post by Nicolas Malin (Jira)

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

Hans Bakker commented on OFBIZ-4941:
------------------------------------

Of course up to you, but keeping it in the data model, would show it on every form automatically. Perhaps think about solving this as was done with the internationalization of the seed entity contents?

Regards,
Hans
               

> 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: docbook-xsl-1.77.1.zip, HelpAccounting.jpg, helppdf.zip, HelpPerformanceReview1.jpg, HelpPerformanceReview2.jpg, HelpRoadmap.jpg, jh.jar, LICENSE.html, OFBIZ-4941 POC HR Help.patch, 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
Reply | Threaded
Open this post in threaded view
|

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

Nicolas Malin (Jira)
In reply to this post by Nicolas Malin (Jira)

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

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

Thanks to all for the comments.

I have added two components to the demo, Project Management (to give Olivier a head start) and Manufacturing to test internationalization.
 
Project

https://ec2-23-20-150-243.compute-1.amazonaws.com:8443/projectmgr/control/main

Manufacturing

https://ec2-23-20-150-243.compute-1.amazonaws.com:8443/manufacturing/control/main

Manufacturing supports both en and nl locales. To test change locale from default en to nl and invoke help.
Internationalization is a problem. As can be seen from the Manufacturing screen shots there is a lot of untranslated text. Much work needs to be done.

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
>            Priority: Minor
>             Fix For: SVN trunk
>
>         Attachments: docbook-xsl-1.77.1.zip, HelpAccounting.jpg, helppdf.zip, HelpPerformanceReview1.jpg, HelpPerformanceReview2.jpg, HelpRoadmap.jpg, jh.jar, LICENSE.html, OFBIZ-4941 POC HR Help.patch, 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
Reply | Threaded
Open this post in threaded view
|

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

Nicolas Malin (Jira)
In reply to this post by Nicolas Malin (Jira)

     [ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Tom Burns updated OFBIZ-4941:
-----------------------------

    Attachment: WebhelpFiles.zip

One of two for installing Webhelp for OFBiz
               

> 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: docbook-xsl-1.77.1.zip, HelpAccounting.jpg, helppdf.zip, HelpPerformanceReview1.jpg, HelpPerformanceReview2.jpg, HelpRoadmap.jpg, jh.jar, LICENSE.html, OFBIZ-4941 POC HR Help.patch, WebhelpFiles.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
Reply | Threaded
Open this post in threaded view
|

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

Nicolas Malin (Jira)
In reply to this post by Nicolas Malin (Jira)

     [ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Tom Burns updated OFBIZ-4941:
-----------------------------

    Attachment: WebhelpHRAppDocbook.zip

Tow of two for installing Webhelp for OFBiz
               

> 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: docbook-xsl-1.77.1.zip, HelpAccounting.jpg, helppdf.zip, HelpPerformanceReview1.jpg, HelpPerformanceReview2.jpg, HelpRoadmap.jpg, jh.jar, LICENSE.html, OFBIZ-4941 POC HR Help.patch, WebhelpFiles.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
Reply | Threaded
Open this post in threaded view
|

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

Nicolas Malin (Jira)
In reply to this post by Nicolas Malin (Jira)

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

Tom Burns edited comment on OFBIZ-4941 at 9/28/12 8:09 AM:
-----------------------------------------------------------

Two of two for installing Webhelp for OFBiz
               
      was (Author: brettonwoods):
    Tow of two for installing Webhelp for OFBiz
                 

> 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: docbook-xsl-1.77.1.zip, HelpAccounting.jpg, helppdf.zip, HelpPerformanceReview1.jpg, HelpPerformanceReview2.jpg, HelpRoadmap.jpg, jh.jar, LICENSE.html, OFBIZ-4941 POC HR Help.patch, WebhelpFiles.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
12345 ... 8