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

["Tom Burns (JIRA)" <ji...@apache.org>]

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

Tom Burns edited comment on OFBIZ-4941 at 10/9/12 1:27 PM:
-----------------------------------------------------------

Jacques,

I think point 5 is confusing because I had to break the data files into two packages to keep them under 10M.
The intent in the instructions is to first copy the whole package
1. WebhelpFiles\WebhelpFiles\docbookhelp 
> applications\content\data\helpdata

2. Then copy the folders
WebhelpHRAppDocbook\WebhelpHRAppDocbook\docbookhelp\humanres_en
WebhelpHRAppDocbook\WebhelpHRAppDocbook\docbookhelp\images_en
> applications\content\data\helpdata\docbookhelp\

The screen shot help_content.jpg shows you where everything should land.

I've opened access to the files in on AWS. Go to:
http://ec2-23-20-150-243.compute-1.amazonaws.com
and you can browse the file structure if any questions remain.

The good news - checked out r1395307 and applied all the changes. Everything works.

Tom

                
      was (Author: brettonwoods):
    Jacques,

I think point 5 is confusing because I had to break the data files into two packages to keep them under 10M.
The intent in the instructions is to first copy the whole package
1. WebhelpFiles\WebhelpFiles\docbookhelp 
> applications\content\data\helpdata

2. Then copy the folders
WebhelpHRAppDocbook\WebhelpHRAppDocbook\docbookhelp\humanres_en
WebhelpHRAppDocbook\WebhelpHRAppDocbook\docbookhelp\images_en
> applications\content\data\helpdata

The screen shot help_content.jpg shows you where everything should land.

I've opened access to the files in on AWS. Go to:
http://ec2-23-20-150-243.compute-1.amazonaws.com
and you can browse the file structure if any questions remain.

The good news - checked out r1395307 and applied all the changes. Everything works.

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 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, 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