You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@ofbiz.apache.org by "Jacques Le Roux (JIRA)" <ji...@apache.org> on 2012/06/16 09:21:42 UTC
[jira] [Created] (OFBIZ-4941) Proposal for a new help system
Jacques Le Roux created OFBIZ-4941:
--------------------------------------
Summary: 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
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.
--
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
Re: [jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by Jacques Le Roux <ja...@les7arts.com>.
Tom,
Please keep your comments inside the Jira
Thanks
Jacques
Tom Burns wrote:
> Anil,
> ...option of help documents being hosted outside of business application..
> Have you looked at the other open source projects using webhelp?
>
> I discussed other deployment options in the OFBiz Help Spec.pdf in the helppdf.zip file attached to 4941.
> Please see the following and let me know if this addresses you concerns.
> Copied here for convenience from OFBiz Help Spec.pdf .
> ...
> "OFBiz Help Deployment
> Up until this point the focus has been on deploying webhelp as a vehicle for context sensitive help. A
> docbook xsl / webhelp solution is robust and flexible enough for the deployment in multiple document help
> sites that support large and complex software systems.
> A good example is Rackspace. See http://docs.rackspace.com/api/ . The Getting Started Guides, API
> Developer Guides, Release Notes and other documentation use docbook webhelp integrated with other
> presentation technologies.
> Another example is http://docs.openstack.org/ Administration guides. Each guide is offered in online
> webhelp and PDF generated from a single docbook source.
> The site http://fusesource.com/products/fuse-esb-enterprise/#documentation is another variation that uses
> webhelp. Here the docbook transformations into three presentations: 1. webhelp 2. PDF and 3. Epub are
> clearly defined.
> These notes on presentation are only suggestive of what could be done to improve OFBiz help
> presentation."
>
>
> Tom
>
>
> ________________________________
> From: Anil K Patel (JIRA) <ji...@apache.org>
> To: dev@ofbiz.apache.org
> Sent: Saturday, November 17, 2012 9:50 AM
> Subject: [jira] [Commented] (OFBIZ-4941) Proposal for a new help system
>
>
> [
> https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13499442#comment-13499442
> ]
>
> Anil K Patel commented on OFBIZ-4941:
> -------------------------------------
>
> Current implementation and proposed help system have too many touch points with framework and application. It will be nice if new
> help implementation addressed this problem. If it did, we would also make some more progress in community goal to shave some fat
> from Ofbiz framework and applications.
>
> Both (the current implementation and proposed implementation) don't seem to support for third party hosted help documents. I
> personally like option of help documents being hosted outside of business application. This option opens business opportunity for
> content providers.
>
> The proposed solution can be much more easily changed such that, Help documents are rendered by a Ofbiz Help webapplication. The
> help document can be accessed using url https://localhost:8443/ofbizhelp/OrderManager-FindOrder (or similar). This will also mean
> that Ofbiz Help will be a component that can exists in specialpurpose folder. If we go this route all the End User help content
> will live in OfbizHelp component and not in Content application.
>
>
>> 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,
>> LicenseFiles.zip, LICENSE.html, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, 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}
Re: [jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by Tom Burns <tr...@yahoo.com>.
Anil,
...option of help documents being hosted outside of business application..
Have you looked at the other open source projects using webhelp?
I discussed other deployment options in the OFBiz Help Spec.pdf in the helppdf.zip file attached to 4941.
Please see the following and let me know if this addresses you concerns.
Copied here for convenience from OFBiz Help Spec.pdf .
...
"OFBiz Help Deployment
Up until this point the focus has been on deploying webhelp as a vehicle for context sensitive help. A
docbook xsl / webhelp solution is robust and flexible enough for the deployment in multiple document help
sites that support large and complex software systems.
A good example is Rackspace. See http://docs.rackspace.com/api/ . The Getting Started Guides, API
Developer Guides, Release Notes and other documentation use docbook webhelp integrated with other
presentation technologies.
Another example is http://docs.openstack.org/ Administration guides. Each guide is offered in online
webhelp and PDF generated from a single docbook source.
The site http://fusesource.com/products/fuse-esb-enterprise/#documentation is another variation that uses
webhelp. Here the docbook transformations into three presentations: 1. webhelp 2. PDF and 3. Epub are
clearly defined.
These notes on presentation are only suggestive of what could be done to improve OFBiz help
presentation."
Tom
________________________________
From: Anil K Patel (JIRA) <ji...@apache.org>
To: dev@ofbiz.apache.org
Sent: Saturday, November 17, 2012 9:50 AM
Subject: [jira] [Commented] (OFBIZ-4941) Proposal for a new help system
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13499442#comment-13499442 ]
Anil K Patel commented on OFBIZ-4941:
-------------------------------------
Current implementation and proposed help system have too many touch points with framework and application. It will be nice if new help implementation addressed this problem. If it did, we would also make some more progress in community goal to shave some fat from Ofbiz framework and applications.
Both (the current implementation and proposed implementation) don't seem to support for third party hosted help documents. I personally like option of help documents being hosted outside of business application. This option opens business opportunity for content providers.
The proposed solution can be much more easily changed such that, Help documents are rendered by a Ofbiz Help webapplication. The help document can be accessed using url https://localhost:8443/ofbizhelp/OrderManager-FindOrder (or similar). This will also mean that Ofbiz Help will be a component that can exists in specialpurpose folder. If we go this route all the End User help content will live in OfbizHelp component and not in Content application.
> 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, LicenseFiles.zip, LICENSE.html, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, 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
Re: [jira] [Updated] (OFBIZ-4941) Proposal for a new help system
Posted by Tom Burns <tr...@yahoo.com>.
Jacques,
We can generate ASL2 in the HTML.
I'll upload new copies of the Docbook book files and webhelp modified files with the changes tomorrow.
Did not mention before but stemmer.js files are part of webhelp.
Tom
________________________________
From: Jacques Le Roux (JIRA) <ji...@apache.org>
To: dev@ofbiz.apache.org
Sent: Tuesday, November 13, 2012 3:01 AM
Subject: [jira] [Updated] (OFBIZ-4941) Proposal for a new help system
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Jacques Le Roux updated OFBIZ-4941:
-----------------------------------
Attachment: OFBIZ-4941.patch
Adds missing ASL2 headers where required.
Doing so I stumbled upon browserDetect.js
Not sure what to do with it (no license see http://www.quirksmode.org/about/copyright.html) I guess we can use it safely and I will simply put a line in NOTICE file.
Tom, for ie.css and positioning.css I added the ASL2 header for files under applications/content/template/docbook/webhelp/template/common/css (I guess there are yours, right?). Can't we avoid to create copies when creating the help with the webhelp.* ant targets? Also why are there duplicates in applications/content/template/docbook/webhelp/docs/common/css (maybe an error of mine when copying ;o)?
Also if we deliver OFBiz OOTB with the help deployed we need to put ASL2 headers in all generated HTML files, this begins to be tedious :/
*stemmer.js files are part of webhelp, right? (http://tartarus.org/~martin/PorterStemmer/ => BSD License. => put in NOTICE)
> 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.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, 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
Re: [jira] [Updated] (OFBIZ-4941) Proposal for a new help system
Posted by Tom Burns <tr...@yahoo.com>.
Jacques,
I don't what to say about browserDetect.js, other then that it is part of the webhelp component inside of the docbook-xsl-1.77.1.zip distribution which has hundreds of files.
The ie.css and positioning.css are webhelp files that I modified.
Re: ...avoid to create copies when creating the help with the webhelp.* ant targets...
If you are talking about the duplication of code in the build.xml for each web app than I agree, it's ugly. I tried various ant techniques to parametrize the code but could not come up with a satisfactory solution. I went with brute force duplication because it worked and I wanted to move on. I'll try to improve the build file in Phase II (documentation for help system and remaining legacy apps)
applications/content/template/docbook/webhelp/docs/... is from the webhelp distribution and should be unchanged.
Re: ASL2 in generated files:
In http://www.apache.org/dev/apply-license.html#license-include there is a line:
"Should the license be included in source files for
documentation (e.g. XML that is transformed to HTML)?
Yes. See the policy for more details."
I did not find any details in the policy that address this case.We can (and should) put a copyright notice in the the docbook file, which is a single file, using the docbook copyright tag. The files get chunked, do we really need a notice in each file
since they are viewed as a whole? If we do then we need a extension someplace in the xsl to insert ASL2. I'll have a look and let you know if it's doable. I would not spend time manually inserting the header into the HTML.
Note that the transformations of the "Apache OFBiz official documentation." do not include any copyright. (I fixed some errors in the docbook files and transformed them, outside of OFBiz, to PDF for validation. The resulting PDF does not have an copyright notice. There is still a problem in the java code, I will post the issue to JIRA when I have a solution.)
Tom
________________________________
From: Jacques Le Roux (JIRA) <ji...@apache.org>
To: dev@ofbiz.apache.org
Sent: Tuesday, November 13, 2012 3:01 AM
Subject: [jira] [Updated] (OFBIZ-4941) Proposal for a new help system
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Jacques Le Roux updated OFBIZ-4941:
-----------------------------------
Attachment: OFBIZ-4941.patch
Adds missing ASL2 headers where required.
Doing so I stumbled upon browserDetect.js
Not sure what to do with it (no license see http://www.quirksmode.org/about/copyright.html) I guess we can use it safely and I will simply put a line in NOTICE file.
Tom, for ie.css and positioning.css I added the ASL2 header for files under applications/content/template/docbook/webhelp/template/common/css (I guess there are yours, right?). Can't we avoid to create copies when creating the help with the webhelp.* ant targets? Also why are there duplicates in applications/content/template/docbook/webhelp/docs/common/css (maybe an error of mine when copying ;o)?
Also if we deliver OFBiz OOTB with the help deployed we need to put ASL2 headers in all generated HTML files, this begins to be tedious :/
*stemmer.js files are part of webhelp, right? (http://tartarus.org/~martin/PorterStemmer/ => BSD License. => put in NOTICE)
> 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.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, 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
[jira] [Updated] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13473494#comment-13473494 ]
Tom Burns commented on OFBIZ-4941:
----------------------------------
Well...
I gave it another try and happy days now I'm on everything - commits, digest, high traffic... yada yada.
Einstein's definition of insanity - "Doing the same thing and expecting..." bunk!
I'll post something in the morning.
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: 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, 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
[jira] [Updated] (OFBIZ-4941) Proposal for a new help system
Posted by "Jacques Le Roux (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Jacques Le Roux updated OFBIZ-4941:
-----------------------------------
Comment: was deleted
(was: It should not be related to humanres issue, but why is there only data for humanres?)
> 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, 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13393620#comment-13393620 ]
Tom Burns commented on OFBIZ-4941:
----------------------------------
Jacques,
Here is a POC.
One reason to give this POC a look is because most other open source project documentation uses XSL transformations for presentation formatting (duh - no surprise). The OFBiz help documents, though written in DocBook, are limited in the number of supported DocBook tags. This limitation can be overcome by using DocBook XLS.
Here is patch for a POC in the form of a OFBiz component that loads into hot-deploy. Sadly there is no OFBiz dog food in the component. But maybe inventive minds will suggest the best way to deploy all these HTML files in an OFBiz way if Java Help is unacceptable.
To get started:
1. Apply the patch.
2. Get a copy of DocBook XLS from http://sourceforge.net/projects/docbook/files/docbook-xsl/1.77.1/docbook-xsl-1.77.1.zip
3. Unzip into the component (root of ofbizhelp).
4. Read readme.txt for a description on contents and usage.
Note: image files are not included in the patch. You may have an issue running ant task from the patch. I tested in Eclipse and for some reason they would not execute. I had to create a new component (using the ant task create-component), copy the build.xml into the new components build.xml then copy other files to get it to work. Ugly! You may have better luck. May the force be with you.
A few words on options when using docbook-xsl-1.77.1
If you follow the current OFBiz help document practice of creating many files in a single folder, each containing a DocBook section, the output from the ant task build-javahelp will be a useless flat compilation of files in a single folder (this is why there are separate task for building accounting and OFBizBook.xml).
If however, you put your content in a folder structure that matches the desired output structure, then the html docbook-xsl will recurse through the folders and create the output in a structure matching the folder structure. This can be used by the Help Master tool (see readme.txt) to easily create a Java Help TOC. The patch contains the accounting help in such a structure. See data > helpdata > docbook > accounting. The final output, that can be viewed as Java Help, after creating the Java Help with Help Master is in ofbizhelp > webapp > ofbizhelp > javahelpacct.
An alternative is to create your content in a single DocBook book file (see help > data > docbook > humanres > OFBizBook.xml). The advantage of writing in a single file is that structure is managed for you by the XLS java help transformation. Also links between tags are easier to create and maintain. DocBook books have chapters which support fine grained structure tags sect1 thru sect5. The OFBiz DocBook files are limited to the top level section tag.
When you generate Java Help from a book tag, the table of contents structure is created automatically. One click on the ant task does it all.
The patch has all the support jsp files needed to run java help from the OFBiz container, but for reasons known only to the java gods, it does not work. The helpBroker does not appear to get initialized. I'm sure sharper minds them mine can figure this out, I'm just putting this on the back burner for now.
As a work around, using Help Master, you can view the finished products located in:
* help > webapp > ofbizhelp > javahelpacct
* help > webapp > ofbizhelp > javahelpmaster
Final word - this is a rough cut. I will be surprised if it works OOB, but it does work and the bonus for getting it working is a easy to maintain, scalable and richer OFBiz Help system.
I will be happy to respond to any questions or calls for help.
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
>
>
> 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13475096#comment-13475096 ]
Tom Burns commented on OFBIZ-4941:
----------------------------------
Jacques,
Just to be clear, I know you commited the the patch to the trunk but thought you may not have made the change to your working copy. With out the patch accounting opens the old Birt help.
Are you OK with accounting now?
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, 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13473378#comment-13473378 ]
Jacques Le Roux commented on OFBIZ-4941:
----------------------------------------
You answer in plain text I guess?
Which email client are you using?
> 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: 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, 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13494802#comment-13494802 ]
Tom Burns commented on OFBIZ-4941:
----------------------------------
Hi Anil,
True the solution artifacts are in the content component. A separate thread has developed on the dev list today where I discuss my reasons for putting it there.
A long time ago I uploaded the attached file OFBizHelp.zip which has a functional specification (a few use cases). The solution was built around that. I appreciate your pointing out a requirement that was not considered in that document but it's time to move on. The solution can be placed anywhere in the OFBiz environment but for now it is where it is.
Please look the solution over and let me know if you have any thoughts on the best way to satisfy your new requirement.
Thanks for your comment,
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.patch, 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13499447#comment-13499447 ]
Jacques Le Roux commented on OFBIZ-4941:
----------------------------------------
Tom,
I think you 3 points are clarified now, or rather the 3rd will hopefully be with the help of the community. I also hope that it will not be a no-no from the community if, in a 1st phase, we can't get it to work as the community would like to have it. This has already required some work, and being stopped at this stage would not be fair. On the other hand, it would be certainly better to have it the way the community envisions it before committing, but that requires more than comments or black-hat answers!
> 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, LicenseFiles.zip, LICENSE.html, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13480747#comment-13480747 ]
Jacques Le Roux commented on OFBIZ-4941:
----------------------------------------
You see Tom, this is when it shows that having a branch is easier. I have certainly some changes pending from your 1st zips, now I will need to compare and adapt. When with a branch you would have create a patch, much easier for me ;)
Anyway at this stage not a big deal. What we really miss to commit is the build strategy. Since we got any answer on the dev ML it's implcitily an agreement (yes this is how it works ;) )so please could you provide the global corresponding targets and will commit the whole, next will be patches (or new independent/not-to-merge-just-add zips when it makes sense).
I will wait those to continue on this. For OFBIZ-5051 you simply used the DE.zip and did not apply the patch, right? Because I saw some unwanted removed lines in it...
> 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13499554#comment-13499554 ]
Jacques Le Roux commented on OFBIZ-4941:
----------------------------------------
Tom,
Saxon.jar and logo.gif missing, yes normal: binary files, sounds good.
Now we need to clarify with the team, to decide if we want to commit as is, or then, what we want to do and how...
> 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, LicenseFiles.zip, LICENSE.html, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13496897#comment-13496897 ]
Jacques Le Roux commented on OFBIZ-4941:
----------------------------------------
Tom on dev ML
{quote}
Jacques,
I don't what to say about browserDetect.js, other then that it is part of the webhelp component inside of the docbook-xsl-1.77.1.zip distribution which has hundreds of files.
The ie.css and positioning.css are webhelp files that I modified.
Re: ...avoid to create copies when creating the help with the webhelp.* ant targets...
If you are talking about the duplication of code in the build.xml for each web app than I agree, it's ugly. I tried various ant techniques to parametrize the code but could not come up with a satisfactory solution. I went with brute force duplication because it worked and I wanted to move on. I'll try to improve the build file in Phase II (documentation for help system and remaining legacy apps)
applications/content/template/docbook/webhelp/docs/... is from the webhelp distribution and should be unchanged.
Re: ASL2 in generated files:
In http://www.apache.org/dev/apply-license.html#license-include there is a line:
"Should the license be included in source files for
documentation (e.g. XML that is transformed to HTML)?
Yes. See the policy for more details."
I did not find any details in the policy that address this case.We can (and should) put a copyright notice in the the docbook file, which is a single file, using the docbook copyright tag. The files get chunked, do we really need a notice in each file
since they are viewed as a whole? If we do then we need a extension someplace in the xsl to insert ASL2. I'll have a look and let you know if it's doable. I would not spend time manually inserting the header into the HTML.
Note that the transformations of the "Apache OFBiz official documentation." do not include any copyright. (I fixed some errors in the docbook files and transformed them, outside of OFBiz, to PDF for validation. The resulting PDF does not have an copyright notice. There is still a problem in the java code, I will post the issue to JIRA when I have a solution.)
Tom
{quote}
OK, so:
* browserDetect.js: part of Docbook => already handled in OFBiz (maybe a line in NOTICE though)
* ie.css and positioning.css: part of webhelp => remove the ASL2 headers and replace by Webhelp license header and a line in NOTICE
* duplication not a worry, to be addressed later
Tom on dev ML
{quote}
Jacques,
We can generate ASL2 in the HTML.
I'll upload new copies of the Docbook book files and webhelp modified files with the changes tomorrow.
Did not mention before but stemmer.js files are part of webhelp.
Tom
{quote}
* stemmer.js files: part of webhelp => Webhelp license header and a line in NOTICE
* following [Treatment of Third-Party Works|http://www.apache.org/legal/src-headers.html#3party] and Webhelp License: <<Any stylesheet derived from this Software that is publicly distributed will be identified with a different name and the version strings in any derived Software will be changed so that no possibility of confusion between the derived package and this Software will exist.>>, we have **2 cases**:
** not stylesheet files and not modified stylesheet files => simply put the Webhelp license header, if it's missing
** modified stylesheet files => put the Webhelp license header, if it's missing + change the name and version strings
[Webhelp license header|http://docbook.sourceforge.net/release/xsl/1.76.1/webhelp/docs/content/index.html]:
----
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
* Except as contained in this notice, the names of individuals credited with contribution to this software shall not be used in advertising or otherwise to promote the sale, use or other dealings in this Software without prior written authorization from the individuals in question.
* **Any stylesheet derived from this Software that is publicly distributed will be identified with a different name and the version strings in any derived Software will be changed so that no possibility of confusion between the derived package and this Software will exist.***
Warranty: THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL DAVID CRAMER, KASUN GAJASINGHE, OR ANY OTHER CONTRIBUTOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
----
* jQuery: not a problem already handled in OFBiz
* DITA plugin: add a line in NOTICE
* Stemmers, ok see above
* Apache Lucene: not a problem already handled in 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
> 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.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13493878#comment-13493878 ]
Jacques Le Roux commented on OFBIZ-4941:
----------------------------------------
Last note: the link file:///D:/workspace/ofbiz/applications/content/webapp/ofbizhelp/catalog_en/content/index.html works well (though its content is very poor, but that's another issue, 1st good 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
> 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
[jira] [Updated] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Tom Burns updated OFBIZ-4941:
-----------------------------
Attachment: jh.jar
LICENSE.html
docbook-xsl-1.77.1.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: 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
[jira] [Comment Edited] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13493887#comment-13493887 ]
Jacques Le Roux edited comment on OFBIZ-4941 at 11/9/12 10:33 AM:
------------------------------------------------------------------
== MISSED a comma ==
Tom, what is the situation about OFBIZ-5051 ? I see the webhelp.manufacturing_de target, is that enough? Should we close OFBIZ-5051 if we commit here?
was (Author: jacques.le.roux):
Tom what is the situation about OFBIZ-5051 ? I see the webhelp.manufacturing_de target, is that enough? Should we close OFBIZ-5051 if we commit here?
> 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13497543#comment-13497543 ]
Tom Burns commented on OFBIZ-4941:
----------------------------------
Jacques,
I am not going to add ASF2 and revision tags to the Docbook content files at this time. I was not happy with the way the tags rendered and there were significant differences between the renderings in webhelp and PDF. Maybe I'll do it Phase 2.
I think you have everything you need for now. If not let me know.
Cheers,
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, LicenseFiles.zip, LICENSE.html, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "Jacopo Cappellato (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13407738#comment-13407738 ]
Jacopo Cappellato commented on OFBIZ-4941:
------------------------------------------
Before we consider to commit new work on the help system, it would be nice if we discuss in the dev list what are the goals and requirements for the OFBiz help system, what we have and what are the gaps and then we and we don't have; until now these part of the system has been implemented without an agreed upon strategy and this is probably a good time pause and discuss.
> 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13499879#comment-13499879 ]
Jacques Le Roux commented on OFBIZ-4941:
----------------------------------------
Tom,
To avoid seeing old Birt help instead of old facility (actually catalog) and order helps, I have commented them out in the Birt ofbiz-component.xml as you did intially. We will revert that later when they will be transformed to webhelp.
> 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, LicenseFiles.zip, LICENSE.html, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941 POC HR Help.patch, ofbiz-common.xsl, 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
[jira] [Updated] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Tom Burns updated OFBIZ-4941:
-----------------------------
Attachment: HelpRoadmap.jpg
HelpPerformanceReview2.jpg
HelpPerformanceReview1.jpg
HelpAccounting.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
>
>
> 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13474851#comment-13474851 ]
Jacques Le Roux commented on OFBIZ-4941:
----------------------------------------
Tom,
Good catch, I will wait this to commit
Also could you answer to this question at [the bottom of this comment|https://issues.apache.org/jira/browse/OFBIZ-4941?focusedCommentId=13473010&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-13473010] which I still cross
{quote}
Also, I see the help when running applications\content\webapp\ofbizhelp\accounting_en\index.html but I don't see it from accounting application using the help button, is another step missing?
{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: 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, 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13486093#comment-13486093 ]
Jacques Le Roux commented on OFBIZ-4941:
----------------------------------------
Ha, or rather than with your latest code we can re-enable the webapp example in birt component, right?
> 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
[jira] [Updated] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ 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
[jira] [Comment Edited] (OFBIZ-4941) Proposal for a new help system
Posted by "Jacopo Cappellato (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13407738#comment-13407738 ]
Jacopo Cappellato edited comment on OFBIZ-4941 at 7/6/12 6:24 AM:
------------------------------------------------------------------
Before we consider to commit new work on the help system, it would be nice if we discuss in the dev list what are the goals and requirements for the OFBiz help system, what we have and what are the gaps; until now these part of the system has been implemented without an agreed upon strategy and this is probably a good time pause and discuss.
was (Author: jacopoc):
Before we consider to commit new work on the help system, it would be nice if we discuss in the dev list what are the goals and requirements for the OFBiz help system, what we have and what are the gaps and then we and we don't have; until now these part of the system has been implemented without an agreed upon strategy and this is probably a good time pause and discuss.
> 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13471076#comment-13471076 ]
Tom Burns commented on OFBIZ-4941:
----------------------------------
Hi Jacques,
If you move it to the trunk I will commit to migrating the other help data to the new format ASAP.
This will be an "as is" migration like Accounting, Project etc.
I will also commit to provide documentation that can be published to the wiki for authors and developers who want to use webhelp.
I share your mixed feeling about not having a consistent presentation however I do not like branches (they are full of dead things). I will be more motivated to complete the project if the trunk was in a inconsistent state then if the solution was in a branch.
Just advertise it as Phase / I Phase II in your monthly report. I think a two step is better then incremental by component since each upgrade would require touching the themes and other stuff. Better a one two punch.
Thanks for your support,
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, 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13494044#comment-13494044 ]
Tom Burns commented on OFBIZ-4941:
----------------------------------
Jacques,
I thought you had an appropriate response to Adrian's comment.
The files could be distributed to each app but I don't see what that buys you. You still have dependency on content manager (which you have in the current system.) Keeping them all in one places makes it easier to work with the properties and build files (have a common path to file locations). It also makes it easier for authors and developers to follow best practices for folder and file naming conventions.
Moving them to the components would require a rewriting of the build and proprieties file, add additional complexity to those files and require a lot of retesting.
As noted before the help is at the webapp level so *each webapp will have its own help.*
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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13472426#comment-13472426 ]
Tom Burns commented on OFBIZ-4941:
----------------------------------
Jacques,
Good, I guess there are no more issues.
Note a fix is needed relating to -
Rev 1361130
Moved the "birt" component out of framework to specialpurpose; moved all the birt reports from the applications to the birt component itself, where the _*application webapps are overriden to inject the reports*_; the end result is the same but since all these birt reports are simply a proof of concepts that cannot be used in production (for example they use hardcoded userlogin for authentication) the birt component should be probably disabled by default (but this will be discussed in the dev list).
Now it will be very easy to extract the birt component (for OFBiz Extras) or to disable it when deploying to production or when interested in sparing some hardware resources. I did some cursory tests but since the work has been challenging and rather complex I would appreciate testing help and also reviews to finds chunks of code that I could have missed and that could be moved out as well.
I've added a patch to OFBIZ-5033 that simply places remarks around the problem code. Others may have a better solution.
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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "Paul Foxworthy (JIRA)" <ji...@apache.org>.
[ 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13473074#comment-13473074 ]
Jacques Le Roux commented on OFBIZ-4941:
----------------------------------------
What is the ant target
webhelp Native test webhelp target
useful for? Should it be part of the OFBiz tests?
> 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: 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, 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
[jira] [Comment Edited] (OFBIZ-4941) Proposal for a new help system
Posted by "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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "Anil K Patel (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13494790#comment-13494790 ]
Anil K Patel commented on OFBIZ-4941:
-------------------------------------
The current patch puts help for various components in content component. This is bad. Best case is, OOTB help components comes as special purpose application and Ofbiz service provider should be able override it by dropping a custom help component in hotdeploy.
Ofbiz Content component is Content Management System and not a place to put all the content. This proposed help is using it as folder to store all help content.
> 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.patch, 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13393498#comment-13393498 ]
Jacques Le Roux commented on OFBIZ-4941:
----------------------------------------
Tom,
A good idea would be also to submit the code you used to come to the result you showed... Even if we have not the right folders structure for now
> 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
>
>
> 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13475347#comment-13475347 ]
Jacques Le Roux commented on OFBIZ-4941:
----------------------------------------
OK clear for the points 1 and 3, Don't forget the point 2 ;)
Accouting, humanres or any available help are no longer a problem with Tomahawk, it was just the fieldlookup.js.
Have a nice weekend too.
> 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, 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13473303#comment-13473303 ]
Tom Burns commented on OFBIZ-4941:
----------------------------------
Jacques,
Is everything running now in your test environment so the only issue is deployment? If so a thought on integration with the globalbuild.
My preference would be to distribute the help fully deployed so help works OOTB. What's a few more meg these days? I intentionally did not integrate the the targets to the global-build. The help developer can run the task as needed.
In the end though this is up to you.
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: 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, 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
[jira] [Updated] (OFBIZ-4941) Proposal for a new help system
Posted by "Jacques Le Roux (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Jacques Le Roux updated OFBIZ-4941:
-----------------------------------
Attachment: OFBIZ-4941.patch
OFBIZ-4941.patch is to have a view on what will be actually committed
> 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.patch, 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13493997#comment-13493997 ]
Tom Burns commented on OFBIZ-4941:
----------------------------------
Jacques,
1. Check step 4 copy
"ofbiz-component to applications/content/ofbiz-component.xml".
Clicking help calls the active theme which calls the logic in fieldlookup.js. You are getting the messages from fieldlookup.js but the help app is not loading. My guess is that it is not mounted in ofbiz-component.xml. Use the copy in the last upload which has the line app-bar-display="false" to keep the app from showing up in the main menu.
2. Re: "Of course this should grow with more help in the future." I have promised to upgrade the current apps (as is) to the new system and provide development and deployment instructions.
3. Re: "...content is very poor...", OFBIZ-4941 is just putting "lipstick on a pig" or more accurately putting the pig in a penthouse :(. Content can be addressed in OFBIZ-4868, OFBIZ-2219 or some other issue after 4941 is closed. There needs to be some discussion and buy in on the dev list about requirements for help content at that time.
4. I'll open the BIRT issue.
5. OFBIZ-5051 can be closed after this issue is committed. Note Carsten has promised some additional help for Product and Order Manager. We can work on that under what ever is decided for a content container as per 3 above.
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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13473308#comment-13473308 ]
Jacques Le Roux commented on OFBIZ-4941:
----------------------------------------
Yes agreed, I'm now more concerned by the build integration ;)
> 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: 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, 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13473010#comment-13473010 ]
Jacques Le Roux commented on OFBIZ-4941:
----------------------------------------
Tom,
PS: look at then end of this comment, I kept above for the fun...
----
Mmm... I think I really need some vacation. I did not add these files in svn, so there were on my disk at the right places but not in the working copy, hence not in the export :(
I added all but
template/docbook/webhelp/test-output
webapp/ofbizhelp and its content
since those are generated and I guess should not be committed right?
Anyway when I add them the zipped file is too large to be imported here.
The help files are already in the data directory applications/content/data/helpdata/docbookhelp/...
This is obvious when you look at the result of the build I tried and pasted in comments above, here is my last try, same than before
{code}
D:\workspace\ofbizClean\applications\content\template\docbook\webhelp>ant webhelp.accounting
Buildfile: D:\workspace\ofbizClean\applications\content\template\docbook\webhelp\build.xml
clean.accounting:
[delete] Deleting directory D:\workspace\ofbizClean\applications\content\webapp\ofbizhelp\accounting_en
chunk.accounting:
[mkdir] Created dir: D:\workspace\ofbizClean\applications\content\webapp\ofbizhelp\accounting_en
[xslt] Processing D:\workspace\ofbizClean\applications\content\data\helpdata\docbookhelp\accounting_en\accounting.xml to D:\workspace\ofbizClean\applications\content\webapp\ofbizhelp\accounting_en\null12
9158762
[xslt] Loading stylesheet D:\workspace\ofbizClean\applications\content\template\docbook\profiling\profile.xsl
[xslt] Processing D:\workspace\ofbizClean\applications\content\webapp\ofbizhelp\accounting_en\null129158762 to D:\workspace\ofbizClean\applications\content\webapp\ofbizhelp\accounting_en\null1442042200
[xslt] Loading stylesheet D:\workspace\ofbizClean\applications\content\template\docbook\webhelp\xsl\webhelp.xsl
[xslt] Failed to process D:\workspace\ofbizClean\applications\content\webapp\ofbizhelp\accounting_en\null129158762
BUILD FAILED
D:\workspace\ofbizClean\applications\content\template\docbook\webhelp\build.xml:143: javax.xml.transform.TransformerException: [start prefix mapping event]: uri is an empty string.
{code}
You already asked me about the saxon file:
{quote}
Do you have the saxon.jar in applications/content/template/docbook/webhelp ?
Tom
{quote}
And I replied [in the comment above|https://issues.apache.org/jira/browse/OFBIZ-4941?focusedCommentId=13471429&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-13471429]
----
Arg and you know what: it seems to work from Eclipse when running an ant target in Debug mode!!! I don't know why, but at least a track...
Ha looking at the trace, it could maybe be what I feared from start. You see the line
*[xslt] language: en*
Mine would be French (fr) from command line. Not sure it's that, but a track in the track...
{code}
Buildfile: D:\workspace\ofbizClean\applications\content\template\docbook\webhelp\build.xml
clean.accounting:
[delete] Deleting directory D:\workspace\ofbizClean\applications\content\webapp\ofbizhelp\accounting_en
chunk.accounting:
[mkdir] Created dir: D:\workspace\ofbizClean\applications\content\webapp\ofbizhelp\accounting_en
[xslt] Processing D:\workspace\ofbizClean\applications\content\data\helpdata\docbookhelp\accounting_en\accounting.xml to D:\workspace\ofbizClean\applications\content\webapp\ofbizhelp\accounting_en\null2088187697
[xslt] Loading stylesheet D:\workspace\ofbizClean\applications\content\template\docbook\profiling\profile.xsl
[xslt] Processing D:\workspace\ofbizClean\applications\content\webapp\ofbizhelp\accounting_en\null2088187697 to D:\workspace\ofbizClean\applications\content\webapp\ofbizhelp\accounting_en\null949819810
[xslt] Loading stylesheet D:\workspace\ofbizClean\applications\content\template\docbook\webhelp\xsl\webhelp.xsl
[xslt] language: en
[xslt] Note: namesp. cut : stripped namespace before processing OFBiz Documentation
[xslt] Note: namesp. cut : processing stripped document OFBiz Documentation
[xslt] language: en
[xslt] Writing ../../../webapp/ofbizhelp/accounting_en/content/ch01.html for chapter
[xslt] Writing ../../../webapp/ofbizhelp/accounting_en/content/ACCOUNTING_main.html for chapter(ACCOUNTING_main)
[...]
[copy] Copying 93 files to D:\workspace\ofbizClean\applications\content\webapp\ofbizhelp\accounting_en
index.accounting:
[copy] Copying 1 file to D:\workspace\ofbizClean\applications\content\webapp\ofbizhelp\accounting_en
[copy] Copied 1 empty directory to 1 empty directory under D:\workspace\ofbizClean\applications\content\webapp\ofbizhelp\accounting_en
[copy] Copying 4 files to D:\workspace\ofbizClean\applications\content\webapp\ofbizhelp\accounting_en
[echo] Indexing html files in ../../../webapp/ofbizhelp/accounting_en/content
[java] Stemming enabled
[java] The created index files are located in ..\..\..\webapp\ofbizhelp\accounting_en\content\search\.js
[java] Indexed the contents in 6 seconds
web-images-accounting:
[mkdir] Created dir: D:\workspace\ofbizClean\applications\content\webapp\ofbizhelp\accounting_en\images_accounting_en
[copy] Copying 1 file to D:\workspace\ofbizClean\applications\content\webapp\ofbizhelp\accounting_en\images_accounting_en
webhelp.accounting:
BUILD SUCCESSFUL
Total time: 1 minute 37 seconds
{code}
Also, I see the help when running applications\content\webapp\ofbizhelp\accounting_en\index.html but I don't see it from accounting application using the help button, is another step missing?
> 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: 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, 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13471289#comment-13471289 ]
Jacques Le Roux commented on OFBIZ-4941:
----------------------------------------
Hi Tom,
Finally this will be committed in trunk and I think nobody really cares about help consistency in trunk, anyway it's bleeding edge after all. So I followed "Readme Webhelp OFBiz Initial Installation.txt" (install file) in order to test but got stuck when running the 1st ant target.
What I did before which was not in the install file:
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
*jleroux: actually, from build file seems rather to get to data\helpdata\docbookhelp, like the whole in WebhelpFiles\docbookhelp dir which was not mentionned in the install file*
Else you get
{code}
D:\workspace\ofbizClean\applications\content\template\docbook\webhelp>ant webhelp.humanres
Buildfile: D:\workspace\ofbizClean\applications\content\template\docbook\webhelp\build.xml
clean.humanres:
[delete] Deleting directory D:\workspace\ofbizClean\applications\content\webapp\ofbizhelp\humanres_en
chunk.humanres:
[mkdir] Created dir: D:\workspace\ofbizClean\applications\content\webapp\ofbizhelp\humanres_en
BUILD FAILED
D:\workspace\ofbizClean\applications\content\template\docbook\webhelp\build.xml:182: input file D:\workspace\ofbizClean\applications\content\data\helpdata\docbookhelp\humanres_en\humanres.xml does not exist
Total time: 0 seconds
{code}
*Also minor but worth to be noted I removed those wrong files: C:\WebhelpFiles\WebhelpFiles\docbookhelp\projectmgr_en\projectmgr.xml~ C:\WebhelpFiles\WebhelpFiles\docbookhelp\manufacturing_en\manufacturing.xml~*
When running ant webhelp I got
{code}
D:\workspace\ofbizClean\applications\content\template\docbook\webhelp>ant webhelp
Buildfile: D:\workspace\ofbizClean\applications\content\template\docbook\webhelp\build.xml
validate:
clean:
[delete] Deleting directory D:\workspace\ofbizClean\applications\content\template\docbook\webhelp\test-output
chunk:
[mkdir] Created dir: D:\workspace\ofbizClean\applications\content\template\docbook\webhelp\test-output
[xslt] Processing D:\workspace\ofbizClean\applications\content\template\docbook\webhelp\docsrc\readme.xml to D:\workspace\ofbizClean\applications\content\template\docbook\webhelp\test-output\null10224990
80
[xslt] Loading stylesheet D:\workspace\ofbizClean\applications\content\template\docbook\profiling\profile.xsl
[xslt] Processing D:\workspace\ofbizClean\applications\content\template\docbook\webhelp\test-output\null1022499080 to D:\workspace\ofbizClean\applications\content\template\docbook\webhelp\test-output\nul
l708218887
[xslt] Loading stylesheet D:\workspace\ofbizClean\applications\content\template\docbook\webhelp\xsl\webhelp.xsl
[xslt] Failed to process D:\workspace\ofbizClean\applications\content\template\docbook\webhelp\test-output\null1022499080
BUILD FAILED
D:\workspace\ofbizClean\applications\content\template\docbook\webhelp\build.xml:80: javax.xml.transform.TransformerException: [start prefix mapping event]: uri is an empty string.
at com.intel.xml.transform.TransformerImpl.reportFatalError(TransformerImpl.java:781)
at com.intel.xml.transform.TransformerImpl.transform(TransformerImpl.java:484)
at com.intel.xml.transform.Resolver.resolve(Resolver.java:254)
at com.intel.xml.transform.TemplatesImpl.resolve(TemplatesImpl.java:183)
at com.intel.xml.transform.TemplatesImpl.precompile(Native Method)
at com.intel.xml.transform.TemplatesImpl.<init>(TemplatesImpl.java:120)
at com.intel.xml.transform.TransformerFactoryImpl.newTemplates(TransformerFactoryImpl.java:335)
at org.apache.tools.ant.taskdefs.optional.TraXLiaison.readTemplates(TraXLiaison.java:303)
at org.apache.tools.ant.taskdefs.optional.TraXLiaison.createTransformer(TraXLiaison.java:320)
at org.apache.tools.ant.taskdefs.optional.TraXLiaison.transform(TraXLiaison.java:170)
at org.apache.tools.ant.taskdefs.XSLTProcess.process(XSLTProcess.java:852)
at org.apache.tools.ant.taskdefs.XSLTProcess.execute(XSLTProcess.java:388)
at org.apache.tools.ant.UnknownElement.execute(UnknownElement.java:291)
at sun.reflect.GeneratedMethodAccessor4.invoke(Unknown Source)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:597)
at org.apache.tools.ant.dispatch.DispatchUtils.execute(DispatchUtils.java:106)
at org.apache.tools.ant.Task.perform(Task.java:348)
at org.apache.tools.ant.Target.execute(Target.java:390)
at org.apache.tools.ant.Target.performTasks(Target.java:411)
at org.apache.tools.ant.Project.executeSortedTargets(Project.java:1399)
at org.apache.tools.ant.Project.executeTarget(Project.java:1368)
at org.apache.tools.ant.helper.DefaultExecutor.executeTargets(DefaultExecutor.java:41)
at org.apache.tools.ant.Project.executeTargets(Project.java:1251)
at org.apache.tools.ant.Main.runBuild(Main.java:809)
at org.apache.tools.ant.Main.startAnt(Main.java:217)
at org.apache.tools.ant.launch.Launcher.run(Launcher.java:280)
at org.apache.tools.ant.launch.Launcher.main(Launcher.java:109)
Caused by: org.xml.sax.SAXException: [start prefix mapping event]: uri is an empty string.
at com.intel.xml.transform.SAXESIIDocumentBuilder.startPrefixMapping(SAXESIIDocumentBuilder.java:411)
at com.intel.xml.ses.SAXEventGenerator.handleStartNamespaceEvent(SAXEventGenerator.java:1319)
at com.intel.xml.ses.SAXEventGenerator.processDataByContentHandler(SAXEventGenerator.java:647)
at com.intel.xml.sax.XMLReaderImpl.parse(XMLReaderImpl.java:795)
at com.intel.xml.transform.SAXESIIDocumentBuilder.parse(SAXESIIDocumentBuilder.java:627)
at com.intel.xml.transform.DocumentBuilder.parse(DocumentBuilder.java:319)
at com.intel.xml.transform.DocumentBuilder.parse(DocumentBuilder.java:189)
at com.intel.xml.transform.TransformerImpl.transform(TransformerImpl.java:215)
... 26 more
---------
org.xml.sax.SAXException: [start prefix mapping event]: uri is an empty string.
at com.intel.xml.transform.SAXESIIDocumentBuilder.startPrefixMapping(SAXESIIDocumentBuilder.java:411)
at com.intel.xml.ses.SAXEventGenerator.handleStartNamespaceEvent(SAXEventGenerator.java:1319)
at com.intel.xml.ses.SAXEventGenerator.processDataByContentHandler(SAXEventGenerator.java:647)
at com.intel.xml.sax.XMLReaderImpl.parse(XMLReaderImpl.java:795)
at com.intel.xml.transform.SAXESIIDocumentBuilder.parse(SAXESIIDocumentBuilder.java:627)
at com.intel.xml.transform.DocumentBuilder.parse(DocumentBuilder.java:319)
at com.intel.xml.transform.DocumentBuilder.parse(DocumentBuilder.java:189)
at com.intel.xml.transform.TransformerImpl.transform(TransformerImpl.java:215)
at com.intel.xml.transform.Resolver.resolve(Resolver.java:254)
at com.intel.xml.transform.TemplatesImpl.resolve(TemplatesImpl.java:183)
at com.intel.xml.transform.TemplatesImpl.precompile(Native Method)
at com.intel.xml.transform.TemplatesImpl.<init>(TemplatesImpl.java:120)
at com.intel.xml.transform.TransformerFactoryImpl.newTemplates(TransformerFactoryImpl.java:335)
at org.apache.tools.ant.taskdefs.optional.TraXLiaison.readTemplates(TraXLiaison.java:303)
at org.apache.tools.ant.taskdefs.optional.TraXLiaison.createTransformer(TraXLiaison.java:320)
at org.apache.tools.ant.taskdefs.optional.TraXLiaison.transform(TraXLiaison.java:170)
at org.apache.tools.ant.taskdefs.XSLTProcess.process(XSLTProcess.java:852)
at org.apache.tools.ant.taskdefs.XSLTProcess.execute(XSLTProcess.java:388)
at org.apache.tools.ant.UnknownElement.execute(UnknownElement.java:291)
at sun.reflect.GeneratedMethodAccessor4.invoke(Unknown Source)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:597)
at org.apache.tools.ant.dispatch.DispatchUtils.execute(DispatchUtils.java:106)
at org.apache.tools.ant.Task.perform(Task.java:348)
at org.apache.tools.ant.Target.execute(Target.java:390)
at org.apache.tools.ant.Target.performTasks(Target.java:411)
at org.apache.tools.ant.Project.executeSortedTargets(Project.java:1399)
at org.apache.tools.ant.Project.executeTarget(Project.java:1368)
at org.apache.tools.ant.helper.DefaultExecutor.executeTargets(DefaultExecutor.java:41)
at org.apache.tools.ant.Project.executeTargets(Project.java:1251)
at org.apache.tools.ant.Main.runBuild(Main.java:809)
at org.apache.tools.ant.Main.startAnt(Main.java:217)
at org.apache.tools.ant.launch.Launcher.run(Launcher.java:280)
at org.apache.tools.ant.launch.Launcher.main(Launcher.java:109)
{code}
then when running ant webhelp.humanres, I got:
{code}
D:\workspace\ofbizClean\applications\content\template\docbook\webhelp>ant webhelp.humanres
Buildfile: D:\workspace\ofbizClean\applications\content\template\docbook\webhelp\build.xml
clean.humanres:
[delete] Deleting directory D:\workspace\ofbizClean\applications\content\webapp\ofbizhelp\humanres_en
chunk.humanres:
[mkdir] Created dir: D:\workspace\ofbizClean\applications\content\webapp\ofbizhelp\humanres_en
[xslt] Processing D:\workspace\ofbizClean\applications\content\data\helpdata\docbookhelp\humanres_en\humanres.xml to D:\workspace\ofbizClean\applications\content\webapp\ofbizhelp\humanres_en\null12610962
10
[xslt] Loading stylesheet D:\workspace\ofbizClean\applications\content\template\docbook\profiling\profile.xsl
[xslt] Processing D:\workspace\ofbizClean\applications\content\webapp\ofbizhelp\humanres_en\null1261096210 to D:\workspace\ofbizClean\applications\content\webapp\ofbizhelp\humanres_en\null1313181713
[xslt] Loading stylesheet D:\workspace\ofbizClean\applications\content\template\docbook\webhelp\xsl\webhelp.xsl
[xslt] Failed to process D:\workspace\ofbizClean\applications\content\webapp\ofbizhelp\humanres_en\null1261096210
BUILD FAILED
D:\workspace\ofbizClean\applications\content\template\docbook\webhelp\build.xml:208: javax.xml.transform.TransformerException: [start prefix mapping event]: uri is an empty string.
at com.intel.xml.transform.TransformerImpl.reportFatalError(TransformerImpl.java:781)
at com.intel.xml.transform.TransformerImpl.transform(TransformerImpl.java:484)
at com.intel.xml.transform.Resolver.resolve(Resolver.java:254)
at com.intel.xml.transform.TemplatesImpl.resolve(TemplatesImpl.java:183)
at com.intel.xml.transform.TemplatesImpl.precompile(Native Method)
at com.intel.xml.transform.TemplatesImpl.<init>(TemplatesImpl.java:120)
at com.intel.xml.transform.TransformerFactoryImpl.newTemplates(TransformerFactoryImpl.java:335)
at org.apache.tools.ant.taskdefs.optional.TraXLiaison.readTemplates(TraXLiaison.java:303)
at org.apache.tools.ant.taskdefs.optional.TraXLiaison.createTransformer(TraXLiaison.java:320)
at org.apache.tools.ant.taskdefs.optional.TraXLiaison.transform(TraXLiaison.java:170)
at org.apache.tools.ant.taskdefs.XSLTProcess.process(XSLTProcess.java:852)
at org.apache.tools.ant.taskdefs.XSLTProcess.execute(XSLTProcess.java:388)
at org.apache.tools.ant.UnknownElement.execute(UnknownElement.java:291)
at sun.reflect.GeneratedMethodAccessor4.invoke(Unknown Source)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:597)
at org.apache.tools.ant.dispatch.DispatchUtils.execute(DispatchUtils.java:106)
at org.apache.tools.ant.Task.perform(Task.java:348)
at org.apache.tools.ant.Target.execute(Target.java:390)
at org.apache.tools.ant.Target.performTasks(Target.java:411)
at org.apache.tools.ant.Project.executeSortedTargets(Project.java:1399)
at org.apache.tools.ant.Project.executeTarget(Project.java:1368)
at org.apache.tools.ant.helper.DefaultExecutor.executeTargets(DefaultExecutor.java:41)
at org.apache.tools.ant.Project.executeTargets(Project.java:1251)
at org.apache.tools.ant.Main.runBuild(Main.java:809)
at org.apache.tools.ant.Main.startAnt(Main.java:217)
at org.apache.tools.ant.launch.Launcher.run(Launcher.java:280)
at org.apache.tools.ant.launch.Launcher.main(Launcher.java:109)
Caused by: org.xml.sax.SAXException: [start prefix mapping event]: uri is an empty string.
at com.intel.xml.transform.SAXESIIDocumentBuilder.startPrefixMapping(SAXESIIDocumentBuilder.java:411)
at com.intel.xml.ses.SAXEventGenerator.handleStartNamespaceEvent(SAXEventGenerator.java:1319)
at com.intel.xml.ses.SAXEventGenerator.processDataByContentHandler(SAXEventGenerator.java:647)
at com.intel.xml.sax.XMLReaderImpl.parse(XMLReaderImpl.java:795)
at com.intel.xml.transform.SAXESIIDocumentBuilder.parse(SAXESIIDocumentBuilder.java:627)
at com.intel.xml.transform.DocumentBuilder.parse(DocumentBuilder.java:319)
at com.intel.xml.transform.DocumentBuilder.parse(DocumentBuilder.java:189)
at com.intel.xml.transform.TransformerImpl.transform(TransformerImpl.java:215)
... 26 more
---------
org.xml.sax.SAXException: [start prefix mapping event]: uri is an empty string.
at com.intel.xml.transform.SAXESIIDocumentBuilder.startPrefixMapping(SAXESIIDocumentBuilder.java:411)
at com.intel.xml.ses.SAXEventGenerator.handleStartNamespaceEvent(SAXEventGenerator.java:1319)
at com.intel.xml.ses.SAXEventGenerator.processDataByContentHandler(SAXEventGenerator.java:647)
at com.intel.xml.sax.XMLReaderImpl.parse(XMLReaderImpl.java:795)
at com.intel.xml.transform.SAXESIIDocumentBuilder.parse(SAXESIIDocumentBuilder.java:627)
at com.intel.xml.transform.DocumentBuilder.parse(DocumentBuilder.java:319)
at com.intel.xml.transform.DocumentBuilder.parse(DocumentBuilder.java:189)
at com.intel.xml.transform.TransformerImpl.transform(TransformerImpl.java:215)
at com.intel.xml.transform.Resolver.resolve(Resolver.java:254)
at com.intel.xml.transform.TemplatesImpl.resolve(TemplatesImpl.java:183)
at com.intel.xml.transform.TemplatesImpl.precompile(Native Method)
at com.intel.xml.transform.TemplatesImpl.<init>(TemplatesImpl.java:120)
at com.intel.xml.transform.TransformerFactoryImpl.newTemplates(TransformerFactoryImpl.java:335)
at org.apache.tools.ant.taskdefs.optional.TraXLiaison.readTemplates(TraXLiaison.java:303)
at org.apache.tools.ant.taskdefs.optional.TraXLiaison.createTransformer(TraXLiaison.java:320)
at org.apache.tools.ant.taskdefs.optional.TraXLiaison.transform(TraXLiaison.java:170)
at org.apache.tools.ant.taskdefs.XSLTProcess.process(XSLTProcess.java:852)
at org.apache.tools.ant.taskdefs.XSLTProcess.execute(XSLTProcess.java:388)
at org.apache.tools.ant.UnknownElement.execute(UnknownElement.java:291)
at sun.reflect.GeneratedMethodAccessor4.invoke(Unknown Source)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:597)
at org.apache.tools.ant.dispatch.DispatchUtils.execute(DispatchUtils.java:106)
at org.apache.tools.ant.Task.perform(Task.java:348)
at org.apache.tools.ant.Target.execute(Target.java:390)
at org.apache.tools.ant.Target.performTasks(Target.java:411)
at org.apache.tools.ant.Project.executeSortedTargets(Project.java:1399)
at org.apache.tools.ant.Project.executeTarget(Project.java:1368)
at org.apache.tools.ant.helper.DefaultExecutor.executeTargets(DefaultExecutor.java:41)
at org.apache.tools.ant.Project.executeTargets(Project.java:1251)
at org.apache.tools.ant.Main.runBuild(Main.java:809)
at org.apache.tools.ant.Main.startAnt(Main.java:217)
at org.apache.tools.ant.launch.Launcher.run(Launcher.java:280)
at org.apache.tools.ant.launch.Launcher.main(Launcher.java:109)
Total time: 0 seconds{code}
What could I miss?
> 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13499441#comment-13499441 ]
Tom Burns commented on OFBIZ-4941:
----------------------------------
Jacques,
1. Sorry to confuse you with the term content files. I was only referring to the Docbook book files under applications/content/data/helpdata/docbookhelp like accounting_en/accounting.xml. e.g. somecomponent (accounting) somecomponent.xml (accounting.xml).
2. The docbook folder (\applications\content\template\docbook) is not new to OFBiz. The files that were replaced all had their origin in the docbook xsl distribution so I did not expect this to be an issue. Have you seen http://wiki.docbook.org/DocBookLicense
3. I still do not understand the desire to move to specialpurpose. I will need clarification of the requirements and desired deployment of the webhelp artifacts. Will docbook stay in content? Are the "content files" to go to specialpurpose? Is it being moved there to prepare for Slim Down?
As soon as you release the next patch I'll apply it to a clean trunk for a smoke test and let you know if I see any issues. The last patch only included the catalog_en webapp and it did not render correctly.
Cheers,
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, LicenseFiles.zip, LICENSE.html, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13407111#comment-13407111 ]
Tom Burns commented on OFBIZ-4941:
----------------------------------
Jacques,
White space is OK. The Help Master tool uses file names to build the TOC thus the spaces. That said I think I will convert the Accounting files (and any others) to a single docbook files. This will simplify organization of the data folder and ant tasks.
I was able to download javahelp-2.0.05.jar from Maven using Ivy.
I'm going to put together a patch with a specialpurpose component that has placeholders for the business apps in the applications component. I suppose you could make a case for putting it in content but that increases the complexity of the job. I see what works out and post updates here.
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
>
>
> 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
[jira] [Updated] (OFBIZ-4941) Proposal for a new help system
Posted by "Jacques Le Roux (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Jacques Le Roux updated OFBIZ-4941:
-----------------------------------
Attachment: OFBIZ-4941.patch
Adds missing ASL2 headers where required.
Doing so I stumbled upon browserDetect.js
Not sure what to do with it (no license see http://www.quirksmode.org/about/copyright.html) I guess we can use it safely and I will simply put a line in NOTICE file.
Tom, for ie.css and positioning.css I added the ASL2 header for files under applications/content/template/docbook/webhelp/template/common/css (I guess there are yours, right?). Can't we avoid to create copies when creating the help with the webhelp.* ant targets? Also why are there duplicates in applications/content/template/docbook/webhelp/docs/common/css (maybe an error of mine when copying ;o)?
Also if we deliver OFBiz OOTB with the help deployed we need to put ASL2 headers in all generated HTML files, this begins to be tedious :/
*stemmer.js files are part of webhelp, right? (http://tartarus.org/~martin/PorterStemmer/ => BSD License. => put in NOTICE)
> 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.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "Paul Foxworthy (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13393663#comment-13393663 ]
Paul Foxworthy commented on OFBIZ-4941:
---------------------------------------
Hi Tom,
I think you meant XSL (XML Style Language), not XLS in the above. Normally it wouldn't matter, but XLS is the Excel file format so some of us might get confused.
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: HelpAccounting.jpg, HelpPerformanceReview1.jpg, HelpPerformanceReview2.jpg, HelpRoadmap.jpg, OFBIZ-4941 POC HR Help.patch
>
>
> 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13497513#comment-13497513 ]
Jacques Le Roux commented on OFBIZ-4941:
----------------------------------------
Tom,
I did not review yet, sounds good.
> 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, LicenseFiles.zip, LICENSE.html, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13406008#comment-13406008 ]
Tom Burns commented on OFBIZ-4941:
----------------------------------
Hi Jacques,
Thanks for the feedback.
I'm not sure what you meant by "...Edit Agreements.html could not be a pb..."
A few small problems with the patch.
To run the ant "build-all" task after installing the patch you will need to create two directories.
1. ofbizhelp\lib
2. ofbizhelp\data\helpdata\docbook\images
Also missing from the patch was the JavaHelp jar jh.jar.
It goes in ofbizhelp/webapp/ofbizhelp/WEB-INF/lib
And remember to install docbook-xsl-1.77.1
My main concern is with the licensing and community desire to use JavaHelp.
JavaHelp 2 can be downloaded from two sources:
1. http://download.java.net/javadesktop/javahelp/javahelp2_0_05.zip
License attached
2. SVN at http://java.net/projects/javahelp/sources/svn/show/trunk?rev=89
https://svn.java.net/svn/javahelp~svn
GNU General Public License (GPL) Version 2, June 1991
I understand that GPL 2 is not compatible with the Apache license.
If this is not a problem and the community would like to go the JavaHelp route then I'll submit an improved POC for discussion.
If JavaHelp is not part of the solution then either the existing help system would have to upgraded to display html or something different would have to be built. I will look into that after I complete the HR documentation.
The HR docs are taking time because I am doing a functional review documenting unexpected behavior and creating some improvements as I go.
Tom
Uploads to follow:
docbook-xsl-1.77.1
jh.jar
jh2.0/LICENSE.html
> 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13480761#comment-13480761 ]
Tom Burns commented on OFBIZ-4941:
----------------------------------
Jacques,
1. No need to dif the zips just replace everything from the first zip. Some things are the same but trivial (gifs).
2. On a build strategy, my understanding is that the trunk will include pre-built help. That is if someone checks out the trunk there will be a folder applications/content/webapp/ofbizhelp that will have help files for accounting, catalog, etc. There will be no need for the user to do a build after checkout.
I am not sure how you accomplish that - if you have to build the files offline and upload them or can run the build from the trunk after uploading the zips.
One way or the other you will have to run the targets:
webhelp.accounting
webhelp.catalog
webhelp.humanres
webhelp.manufacturing
webhelp.manufacturing_de
webhelp.manufacturing_nl
webhelp.projectmgr
3. I'm not sure what you are asking for re: patches.
Since you moved the xsl to the trunk I considered supplying the changes to the ofbiz files (themes, data, build.xml etc) as a patch but decided it would be simpler to give you another copy of the zip.
4. I used the content for OFBIZ-5051 to create the content in manufacturing_de. It is not necessary to move the contents of DE.zip to the trunk. The logic in themes will block their presentation. I will add a comment on 5051.
I'll try to answer any other questions you have ASAP
Thanks,
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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13472371#comment-13472371 ]
Jacques Le Roux commented on OFBIZ-4941:
----------------------------------------
You can close access to the server, that's exactly what I have here:
{code}
D:\workspace\ofbizClean\applications\content\data\helpdata\docbookhelp>dir
Le volume dans le lecteur D s'appelle Secondaire
Le numéro de série du volume est 441F-6A20
Répertoire de D:\workspace\ofbizClean\applications\content\data\helpdata\docbookhelp
07/10/2012 20:38 <REP> .
07/10/2012 20:38 <REP> ..
07/10/2012 19:38 <REP> accounting_en
07/10/2012 19:25 <REP> humanres_en
07/10/2012 19:38 <REP> images_accounting_en
07/10/2012 19:25 <REP> images_humanres_en
07/10/2012 19:38 <REP> images_manufacturing_en
07/10/2012 19:38 <REP> images_manufacturing_nl
07/10/2012 19:38 <REP> images_projectmgr_en
07/10/2012 19:38 <REP> manufacturing_en
07/10/2012 19:38 <REP> manufacturing_nl
07/10/2012 19:38 <REP> projectmgr_en
0 fichier(s) 0 octets
12 Rép(s) 50 082 443 264 octets libres
{code}
and of course all files are present:
{code}
D:\workspace\ofbizClean\applications\content\data\helpdata\docbookhelp>dir /s
Le volume dans le lecteur D s'appelle Secondaire
Le numéro de série du volume est 441F-6A20
Répertoire de D:\workspace\ofbizClean\applications\content\data\helpdata\docbookhelp
07/10/2012 20:38 <REP> .
07/10/2012 20:38 <REP> ..
07/10/2012 19:38 <REP> accounting_en
07/10/2012 19:25 <REP> humanres_en
07/10/2012 19:38 <REP> images_accounting_en
07/10/2012 19:25 <REP> images_humanres_en
07/10/2012 19:38 <REP> images_manufacturing_en
07/10/2012 19:38 <REP> images_manufacturing_nl
07/10/2012 19:38 <REP> images_projectmgr_en
07/10/2012 19:38 <REP> manufacturing_en
07/10/2012 19:38 <REP> manufacturing_nl
07/10/2012 19:38 <REP> projectmgr_en
0 fichier(s) 0 octets
Répertoire de D:\workspace\ofbizClean\applications\content\data\helpdata\docbookhelp\accounting_en
07/10/2012 19:38 <REP> .
07/10/2012 19:38 <REP> ..
13/09/2012 22:08 219 387 accounting.xml
1 fichier(s) 219 387 octets
Répertoire de D:\workspace\ofbizClean\applications\content\data\helpdata\docbookhelp\humanres_en
07/10/2012 19:25 <REP> .
07/10/2012 19:25 <REP> ..
13/09/2012 16:53 322 717 humanres.xml
1 fichier(s) 322 717 octets
Répertoire de D:\workspace\ofbizClean\applications\content\data\helpdata\docbookhelp\images_accounting_en
07/10/2012 19:38 <REP> .
07/10/2012 19:38 <REP> ..
13/09/2012 19:55 117 168 man.png
1 fichier(s) 117 168 octets
Répertoire de D:\workspace\ofbizClean\applications\content\data\helpdata\docbookhelp\images_humanres_en
07/10/2012 19:25 <REP> .
07/10/2012 19:25 <REP> ..
13/09/2012 19:55 93 253 AccountingPayCheck.jpg
13/09/2012 19:55 231 431 AccountingSetInvoiceStatus.jpg
13/09/2012 19:55 43 397 EditTrainingApprovalsTraining.jpg
13/09/2012 19:55 74 807 EmployeeAddSecurityGroup.jpg
13/09/2012 19:55 51 883 EmployeeCreatePartyAttribute.jpg
13/09/2012 19:55 58 303 EmployeeCreateUserLogin.jpg
13/09/2012 19:55 84 588 EmployeeEditEmployeeLeaves.jpg
13/09/2012 19:55 71 838 EmployeeEditEmployeeQuals.jpg
13/09/2012 19:55 53 638 EmployeeEditEmployeeSkills.jpg
13/09/2012 19:55 51 301 EmployeeEditPartyAttribute.jpg
13/09/2012 19:55 73 366 EmployeeEditPersonalInformation.jpg
13/09/2012 19:55 70 326 EmployeeEditUserLogin.jpg
13/09/2012 19:55 60 894 EmployeeEmployments.jpg
13/09/2012 19:55 56 940 EmployeeFindEmployee.jpg
13/09/2012 19:55 106 087 EmployeeLeave.jpg
13/09/2012 19:55 38 612 EmployeeListEmployments.jpg
13/09/2012 19:55 63 828 EmployeeListEmplPositions.jpg
13/09/2012 19:55 45 033 EmployeeNewEmployee.jpg
13/09/2012 19:55 115 534 EmployeeNewEmployee.png
13/09/2012 19:55 95 524 EmployeePartyPartyContentScreen.jpg
13/09/2012 19:55 54 072 EmployeePayrollHistory.jpg
13/09/2012 19:55 73 648 EmployeePositionEdit.jpg
13/09/2012 19:55 67 253 EmployeeProfile.jpg
13/09/2012 19:55 80 842 EmployeeProfileEditPersonalInformation.jpg
13/09/2012 19:55 71 256 EmployeeProfilePerson.jpg
13/09/2012 19:55 128 141 EmployeeProfileTest.jpg
13/09/2012 19:55 79 378 EmployeeQualfication.jpg
13/09/2012 19:55 56 940 EmployeesFindEmployee.jpg
13/09/2012 19:55 63 174 EmployeeSkills.jpg
13/09/2012 19:55 98 422 EmployeesMain.jpg
13/09/2012 19:55 65 118 EmployeeTraining.jpg
13/09/2012 19:55 93 143 EmploymentAgreementEmploymentApp.jpg
13/09/2012 19:55 55 299 EmploymentApplicationNew.jpg
13/09/2012 19:55 111 976 EmploymentApplicationSearch.jpg
13/09/2012 19:55 55 445 EmploymentCreateEmployment.jpg
13/09/2012 19:55 79 736 EmploymentCreatePartyBenefit.jpg
13/09/2012 19:55 73 977 EmploymentcreateUnemploymentClaim.jpg
13/09/2012 19:55 58 353 EmploymentEdit.jpg
13/09/2012 19:55 95 339 EmploymentEditAgreementEmploymentAppls.jpg
13/09/2012 19:55 117 628 EmploymentEmplPositionView.jpg
13/09/2012 19:55 90 103 EmploymentMain.jpg
13/09/2012 19:55 47 088 EmploymentNew.jpg
13/09/2012 19:55 40 019 EmploymentNewEmployment.jpg
13/09/2012 19:55 89 225 EmploymentNewEmployment.png
13/09/2012 19:55 79 724 EmploymentPartyBenefits.jpg
13/09/2012 19:55 56 112 EmploymentPayHistories.jpg
13/09/2012 19:55 96 664 EmploymentPayrollPreferences.jpg
13/09/2012 19:55 91 982 EmploymentSearch.jpg
13/09/2012 19:55 83 520 EmploymentUnemploymentClaims.jpg
13/09/2012 19:55 111 874 FindEmployeeSkills.jpg
13/09/2012 19:55 76 263 GlobalHRSettingsEditEditSkills.jpg
13/09/2012 19:55 60 487 GlobalHRSettingsEditPositionTypes.jpg
13/09/2012 19:55 99 848 GlobalHRSettingsEditQualificationGroups.jpg
13/09/2012 19:55 98 163 GlobalHRSettingsEditQualifications.jpg
13/09/2012 19:55 117 682 GlobalHRSettingsEditSkillGroups.jpg
13/09/2012 19:55 149 273 GlobalHRSettingsEditSkills.jpg
13/09/2012 19:55 80 409 GlobalHRSettingsEmployeeLeaveType.jpg
13/09/2012 19:55 77 968 GlobalHRSettingsJobInterviewType.jpg
13/09/2012 19:55 23 309 GlobalHRSettingsMenu.jpg
13/09/2012 19:55 60 769 GlobalHRSettingsPayGradesEdit.jpg
13/09/2012 19:55 55 530 GlobalHRSettingsPayGradesNew.jpg
13/09/2012 19:55 69 092 GlobalHRSettingsPayGradesSalaryStep.jpg
13/09/2012 19:55 76 761 GlobalHRSettingsPayGradesSearch.jpg
13/09/2012 19:55 60 020 GlobalHRSettingsPositionTypeEdit.jpg
13/09/2012 19:55 55 445 GlobalHRSettingsPositionTypeNew.jpg
13/09/2012 19:55 88 727 GlobalHRSettingsPositionTypeRates.jpg
13/09/2012 19:55 79 333 GlobalHRSettingsPositionTypeSearch.jpg
13/09/2012 19:55 79 745 GlobalHRSettingsPublicHoliday.jpg
13/09/2012 19:55 70 506 GlobalHRSettingsReasonType.jpg
13/09/2012 19:55 88 340 GlobalHRSettingsResponsibilitylTypes.jpg
13/09/2012 19:55 83 031 GlobalHRSettingsSkillTypes.jpg
13/09/2012 19:55 64 209 GlobalHRSettingsTerminationReason.jpg
13/09/2012 19:55 70 209 GlobalHRSettingsTerminationTypes.jpg
13/09/2012 19:55 82 900 GlobalHRSettingsTraininClassType.jpg
13/09/2012 19:55 216 768 HelpPerformanceReview1.jpg
13/09/2012 19:55 308 538 HelpPerformanceReview2.jpg
13/09/2012 19:55 372 639 HelpRoadmap.jpg
13/09/2012 19:55 148 565 HROrganizationProfile.jpg
13/09/2012 19:55 71 966 Introduction.jpg
13/09/2012 19:55 59 349 LeaveApproval.jpg
13/09/2012 19:55 97 920 LeaveApprovalSearch.jpg
13/09/2012 19:55 66 481 LeaveEmployeeEdit.jpg
13/09/2012 19:55 56 468 LeaveEmployeeNew.jpg
13/09/2012 19:55 86 328 LeaveEmployeeSearch.jpg
13/09/2012 19:55 35 186 MainCompanyTreeView.jpg
13/09/2012 19:55 80 358 NewEmployee.jpg
13/09/2012 19:55 57 197 OFBizMainScreen.gif
13/09/2012 19:55 3 485 ofbiz_logo.gif
13/09/2012 19:55 114 230 OrganizatinMain.jpg
13/09/2012 19:55 28 318 PartyManagerAddPartyRelationship.jpg
13/09/2012 19:55 121 046 PartyManagerPartyFinancialHistory.jpg
13/09/2012 19:55 65 644 PerformanceReviewEdit.jpg
13/09/2012 19:55 52 138 PerformanceReviewEditPerfReview.jpg
13/09/2012 19:55 72 319 PerformanceReviewEditPerfReviewItems.jpg
13/09/2012 19:55 249 935 PerformanceReviewHelp1.jpg
13/09/2012 19:55 60 942 PerformanceReviewItem.jpg
13/09/2012 19:55 99 832 PerformanceReviewNew.jpg
13/09/2012 19:55 90 206 PerformanceReviewNew.png
13/09/2012 19:55 74 802 PerformanceReviewSearch.jpg
13/09/2012 19:55 71 302 PositionEdit.jpg
13/09/2012 19:55 63 075 PositionFulfillments.jpg
13/09/2012 19:55 105 749 PositionMain.jpg
13/09/2012 19:55 57 819 PositionNew.jpg
13/09/2012 19:55 102 287 PositionReportingStruct.jpg
13/09/2012 19:55 68 346 PositionResponsibilities.jpg
13/09/2012 19:55 123 829 PositionSearch.jpg
13/09/2012 19:55 99 013 PositionSummary.jpg
13/09/2012 19:55 93 130 PositionSummaryReportingStruct.jpg
13/09/2012 19:55 46 242 QualificationsCreatePartyQual.jpg
13/09/2012 19:55 87 017 QualificationsEdit.jpg
13/09/2012 19:55 84 138 QualificationsFindPartyQuals.jpg
13/09/2012 19:55 56 355 QualificationsNew.jpg
13/09/2012 19:55 56 355 QualificationsNewPartyQual.jpg
13/09/2012 19:55 84 138 QualificationsSearch.jpg
13/09/2012 19:55 89 426 RecuritmentFindApprovals.jpg
13/09/2012 19:55 55 668 RecuritmentFindInternalJobPosting.jpg
13/09/2012 19:55 55 668 RecuritmentFindJobInterview.jpg
13/09/2012 19:55 91 025 RecuritmentFindRelocation.jpg
13/09/2012 19:55 52 097 RecuritmentInternalJobPostingNew.jpg
13/09/2012 19:55 75 849 RecuritmentInternalJobPostingSearch.jpg
13/09/2012 19:55 76 404 RecuritmentJobApprovalSearch.jpg
13/09/2012 19:55 73 065 RecuritmentJobInterviewEdit.jpg
13/09/2012 19:55 64 468 RecuritmentJobInterviewNew.jpg
13/09/2012 19:55 86 263 RecuritmentJobInterviewSearch.jpg
13/09/2012 19:55 75 565 RecuritmentJobPostingSearch.jpg
13/09/2012 19:55 81 454 RecuritmentJobRelocationSearch.jpg
13/09/2012 19:55 55 668 RecuritmentJobRequisitionApply.jpg
13/09/2012 19:55 76 702 RecuritmentJobRequisitionEdit.jpg
13/09/2012 19:55 65 688 RecuritmentJobRequisitionNew.jpg
13/09/2012 19:55 104 256 RecuritmentJobRequisitionSearch.jpg
13/09/2012 19:55 47 336 ResumeEdit.jpg
13/09/2012 19:55 46 762 ResumeNew.jpg
13/09/2012 19:55 69 710 ResumeSearch.jpg
13/09/2012 19:55 35 219 SkillsAddEmployeeSkills.jpg
13/09/2012 19:55 68 568 SkillsEdit.jpg
13/09/2012 19:55 69 624 SkillsEditEmployeeSkills.jpg
13/09/2012 19:55 110 250 SkillsFindEmployeeSkills.jpg
13/09/2012 19:55 57 509 SkillsFindPartySkills.jpg
13/09/2012 19:55 47 342 SkillsNew.jpg
13/09/2012 19:55 35 219 SkillsNewPartySkill.jpg
13/09/2012 19:55 122 691 SkillsSearch.jpg
13/09/2012 19:55 77 691 TrainingCalendar.jpg
13/09/2012 19:55 97 165 TrainingCalendarAdd.jpg
13/09/2012 19:55 102 032 TrainingCalendarAddParticipant.jpg
13/09/2012 19:55 112 460 TrainingCalendarApprovals.jpg
13/09/2012 19:55 43 397 TrainingCalendarEditTrainingApprovals.jpg
13/09/2012 19:55 111 599 TrainingCalendarFindTrainingStatus.jpg
13/09/2012 19:55 52 809 TrainingCalendarTrainingCalendar.jpg
148 fichier(s) 12 150 157 octets
Répertoire de D:\workspace\ofbizClean\applications\content\data\helpdata\docbookhelp\images_manufacturing_en
07/10/2012 19:38 <REP> .
07/10/2012 19:38 <REP> ..
26/09/2012 16:57 49 762 MANUFACTURING_BomSimulation.jpg
26/09/2012 16:57 46 432 MANUFACTURING_CreateProductionRun.jpg
26/09/2012 16:57 59 930 MANUFACTURING_EditCalendar.jpg
26/09/2012 16:57 69 668 MANUFACTURING_EditCalendarExceptionDay.jpg
26/09/2012 16:57 70 113 MANUFACTURING_EditCalendarExceptionWeek.jpg
26/09/2012 16:57 83 905 MANUFACTURING_EditCalendarWeek.jpg
26/09/2012 16:57 73 515 MANUFACTURING_EditCostCalcs.jpg
26/09/2012 16:57 113 965 MANUFACTURING_EditProductBom.jpg
26/09/2012 16:57 132 448 MANUFACTURING_EditProductionRun.jpg
26/09/2012 16:57 67 983 MANUFACTURING_EditProductManufacturingRules.jpg
26/09/2012 16:57 44 656 MANUFACTURING_EditRouting.jpg
26/09/2012 16:57 53 944 MANUFACTURING_EditRoutingProductLink.jpg
26/09/2012 16:57 61 874 MANUFACTURING_EditRoutingTask.jpg
26/09/2012 16:57 66 723 MANUFACTURING_EditRoutingTaskAssoc.jpg
26/09/2012 16:57 56 376 MANUFACTURING_EditRoutingTaskCosts.jpg
26/09/2012 16:57 53 525 MANUFACTURING_EditRoutingTaskFixedAssets.jpg
26/09/2012 16:57 36 207 MANUFACTURING_EditRoutingTaskProduct.jpg
26/09/2012 16:57 60 789 MANUFACTURING_FindBom.jpg
26/09/2012 16:57 54 051 MANUFACTURING_FindCalendar.jpg
26/09/2012 16:57 82 767 MANUFACTURING_FindMrpPlannedEvents.jpg
26/09/2012 16:57 64 622 MANUFACTURING_FindProductionRun.jpg
26/09/2012 16:57 70 631 MANUFACTURING_FindRouting.jpg
26/09/2012 16:57 127 927 MANUFACTURING_FindRoutingTask.jpg
26/09/2012 16:57 51 149 MANUFACTURING_ListCalendarWeek.jpg
26/09/2012 16:57 47 283 MANUFACTURING_ListRoutingTaskProducts.jpg
26/09/2012 16:57 57 762 MANUFACTURING_main.jpg
26/09/2012 16:57 25 967 MANUFACTURING_ManufacturingReports.jpg
26/09/2012 16:57 35 511 MANUFACTURING_MrpExecution.jpg
26/09/2012 16:57 64 559 MANUFACTURING_ProductionRunActualComponents.jpg
26/09/2012 16:57 66 879 MANUFACTURING_ProductionRunAssocs.jpg
26/09/2012 16:57 81 530 MANUFACTURING_ProductionRunComponents.jpg
26/09/2012 16:57 78 407 MANUFACTURING_ProductionRunContent.jpg
26/09/2012 16:57 94 047 MANUFACTURING_ProductionRunCosts.jpg
26/09/2012 16:57 122 771 MANUFACTURING_ProductionRunDeclaration.jpg
26/09/2012 16:57 94 261 MANUFACTURING_ProductionRunFixedAssets.jpg
26/09/2012 16:57 101 102 MANUFACTURING_ProductionRunTasks.jpg
26/09/2012 16:57 29 436 MANUFACTURING_WorkWithShipmentPlans.jpg
37 fichier(s) 2 552 477 octets
Répertoire de D:\workspace\ofbizClean\applications\content\data\helpdata\docbookhelp\images_manufacturing_nl
07/10/2012 19:38 <REP> .
07/10/2012 19:38 <REP> ..
26/09/2012 16:57 49 179 MANUFACTURING_BomSimulation.jpg
26/09/2012 16:57 42 583 MANUFACTURING_CreateProductionRun.jpg
26/09/2012 16:57 49 782 MANUFACTURING_EditCalendar.jpg
26/09/2012 16:57 60 881 MANUFACTURING_EditCalendarExceptionDay.jpg
26/09/2012 16:57 59 272 MANUFACTURING_EditCalendarExceptionWeek.jpg
26/09/2012 16:57 74 864 MANUFACTURING_EditCalendarWeek.jpg
26/09/2012 16:57 74 596 MANUFACTURING_EditCostCalcs.jpg
26/09/2012 16:57 119 329 MANUFACTURING_EditProductBom.jpg
26/09/2012 16:57 139 453 MANUFACTURING_EditProductionRun.jpg
26/09/2012 16:57 65 076 MANUFACTURING_EditProductManufacturingRules.jpg
26/09/2012 16:57 44 138 MANUFACTURING_EditRouting.jpg
26/09/2012 16:57 55 483 MANUFACTURING_EditRoutingProductLink.jpg
26/09/2012 16:57 60 393 MANUFACTURING_EditRoutingTask.jpg
26/09/2012 16:57 70 629 MANUFACTURING_EditRoutingTaskAssoc.jpg
26/09/2012 16:57 54 221 MANUFACTURING_EditRoutingTaskCosts.jpg
26/09/2012 16:57 55 587 MANUFACTURING_EditRoutingTaskFixedAssets.jpg
26/09/2012 16:57 35 297 MANUFACTURING_EditRoutingTaskProduct.jpg
26/09/2012 16:57 57 000 MANUFACTURING_FindBom.jpg
26/09/2012 16:57 50 575 MANUFACTURING_FindCalendar.jpg
26/09/2012 16:57 78 592 MANUFACTURING_FindMrpPlannedEvents.jpg
26/09/2012 16:57 65 139 MANUFACTURING_FindProductionRun.jpg
26/09/2012 16:57 70 572 MANUFACTURING_FindRouting.jpg
26/09/2012 16:57 127 711 MANUFACTURING_FindRoutingTask.jpg
26/09/2012 16:57 47 493 MANUFACTURING_ListCalendarWeek.jpg
26/09/2012 16:57 45 736 MANUFACTURING_ListRoutingTaskProducts.jpg
26/09/2012 16:57 61 465 MANUFACTURING_main.jpg
26/09/2012 16:57 26 586 MANUFACTURING_ManufacturingReports.jpg
26/09/2012 16:57 33 244 MANUFACTURING_MrpExecution.jpg
26/09/2012 16:57 65 740 MANUFACTURING_ProductionRunActualComponents.jpg
26/09/2012 16:57 59 322 MANUFACTURING_ProductionRunAssocs.jpg
26/09/2012 16:57 71 983 MANUFACTURING_ProductionRunComponents.jpg
26/09/2012 16:57 69 973 MANUFACTURING_ProductionRunContent.jpg
26/09/2012 16:57 80 918 MANUFACTURING_ProductionRunCosts.jpg
26/09/2012 16:57 126 255 MANUFACTURING_ProductionRunDeclaration.jpg
26/09/2012 16:57 85 500 MANUFACTURING_ProductionRunFixedAssets.jpg
26/09/2012 16:57 89 068 MANUFACTURING_ProductionRunTasks.jpg
26/09/2012 16:57 26 308 MANUFACTURING_WorkWithShipmentPlans.jpg
37 fichier(s) 2 449 943 octets
Répertoire de D:\workspace\ofbizClean\applications\content\data\helpdata\docbookhelp\images_projectmgr_en
07/10/2012 19:38 <REP> .
07/10/2012 19:38 <REP> ..
22/09/2012 16:31 76 504 PROJECTMGR_EditProject.jpg
22/09/2012 16:31 77 067 PROJECTMGR_FindResource.jpg
22/09/2012 16:31 116 583 PROJECTMGR_FindTask.jpg
22/09/2012 16:31 73 441 PROJECTMGR_FindTimeSheet.jpg
22/09/2012 16:31 50 691 PROJECTMGR_main.jpg
22/09/2012 16:31 93 444 PROJECTMGR_MyTasks.jpg
22/09/2012 16:31 142 929 PROJECTMGR_projectView.jpg
22/09/2012 16:31 184 454 PROJECTMGR_RequestList.jpg
22/09/2012 16:31 225 073 requestlist.jpg
22/09/2012 16:31 76 281 ROJECTMGR_EditSkillTypes.jpg
22/09/2012 16:31 70 608 ROJECTMGR_FindProject.jpg
22/09/2012 16:31 109 154 ROJECTMGR_MyTasks.jpg
22/09/2012 16:31 81 875 ROJECTMGR_MyTimesheet.jpg
13 fichier(s) 1 378 104 octets
Répertoire de D:\workspace\ofbizClean\applications\content\data\helpdata\docbookhelp\manufacturing_en
07/10/2012 19:38 <REP> .
07/10/2012 19:38 <REP> ..
26/09/2012 17:08 25 960 manufacturing.xml
1 fichier(s) 25 960 octets
Répertoire de D:\workspace\ofbizClean\applications\content\data\helpdata\docbookhelp\manufacturing_nl
07/10/2012 19:38 <REP> .
07/10/2012 19:38 <REP> ..
26/09/2012 17:08 28 867 manufacturing.xml
1 fichier(s) 28 867 octets
Répertoire de D:\workspace\ofbizClean\applications\content\data\helpdata\docbookhelp\projectmgr_en
07/10/2012 19:38 <REP> .
07/10/2012 19:38 <REP> ..
22/09/2012 20:32 14 199 project.xml
22/09/2012 20:32 14 460 projectmgr.xml
2 fichier(s) 28 659 octets
Total des fichiers listés :
242 fichier(s) 19 273 439 octets
32 Rép(s) 50 082 443 264 octets libres
{code}
Actually that's what I already reported after failing following the point 5 instructions
> 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13471320#comment-13471320 ]
Jacques Le Roux commented on OFBIZ-4941:
----------------------------------------
Sorry removed wrong comment
> 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, 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13474957#comment-13474957 ]
Tom Burns commented on OFBIZ-4941:
----------------------------------
Did you apply the patch to fix the Birt issue?
> 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: 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, 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13473011#comment-13473011 ]
Jacques Le Roux commented on OFBIZ-4941:
----------------------------------------
When I say I don't see the help, I mean I still see the old one
> 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: 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, 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13475290#comment-13475290 ]
Jacques Le Roux commented on OFBIZ-4941:
----------------------------------------
OK while quickly searching, I found some things:
* above ofbizhelp webapp should have
app-bar-display="false"
* in themes files I noticed
{code}
<#if parameters.componentName!="accounting" && parameters.componentName!="humanres" && parameters.componentName!="projectmgr" && parameters.componentName!="manufacturing">
{code}
I know you are working on a solution to have this as the webapp level and not component level. But in all cases we must have it centrealized and more visible. Like a properties of why not in DB, or what not... (I'm too tired to think :D )
> 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, 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "Hans Bakker (JIRA)" <ji...@apache.org>.
[ 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13473081#comment-13473081 ]
Jacques Le Roux commented on OFBIZ-4941:
----------------------------------------
Not sure if this is important or not, found this when running the test target:
D:\workspace\ofbizClean\applications\content\template\docbook\webhelp\xsl\webhelp-common.xsl:317:18: Warning! language: en
> 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: 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, 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
[jira] [Updated] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Tom Burns updated OFBIZ-4941:
-----------------------------
Attachment: OFBIZ-4941 POC HR Help.patch
> 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, OFBIZ-4941 POC HR Help.patch
>
>
> 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13472188#comment-13472188 ]
Jacques Le Roux commented on OFBIZ-4941:
----------------------------------------
Tom,
Yes I did so, and after I committed at r1395307 (see above). To be sure I then checked out what I committed and compared with docbook version 1.77.1. It made me really wonder so I just did it again. The files are the same but, due to the svn commit, everywhere we have a line with $Id or $Revision. See attached "docbook diff.patch". This should not be a functional problem but I will certainly have to check what it means from a license POV. I don't think it's a biggy even in this perspective.
One thing makes me wonder. You say you followed the inclosed instructions. Did you read my report in a comment above about the point 5?
{quote}
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
*jleroux: actually, from build file seems rather to get to data\helpdata\docbookhelp, like the whole in WebhelpFiles\docbookhelp dir which was not mentionned in the install file*
Else you get
{code}
D:\workspace\ofbizClean\applications\content\template\docbook\webhelp>ant webhelp.humanres
Buildfile: D:\workspace\ofbizClean\applications\content\template\docbook\webhelp\build.xml
clean.humanres:
[delete] Deleting directory D:\workspace\ofbizClean\applications\content\webapp\ofbizhelp\humanres_en
chunk.humanres:
[mkdir] Created dir: D:\workspace\ofbizClean\applications\content\webapp\ofbizhelp\humanres_en
BUILD FAILED
D:\workspace\ofbizClean\applications\content\template\docbook\webhelp\build.xml:182: input file D:\workspace\ofbizClean\applications\content\data\helpdata\docbookhelp\humanres_en\humanres.xml does not exist
Total time: 0 seconds
{code}
{quote}
To be continued...
> 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13471053#comment-13471053 ]
Jacques Le Roux commented on OFBIZ-4941:
----------------------------------------
After reviewing OBFBIZ-5042 (Solr component) I wondered a small moment if Apache Extra could not be also used here. But I still stronly believe this should be embedded OOTB to (hopefully not too slowly) replace the current help system. We could create a branch and wait to merge until all is replaced. But though I have a mixed feeling (I'd like to have the new feature ASAP even if not complete, on the other hand the inconsistency in help could trouble users - not that much I guess), actually I prefer to commit ASAP :D
> 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13406714#comment-13406714 ]
Jacques Le Roux commented on OFBIZ-4941:
----------------------------------------
Hi Tom,
{quote}
I'm not sure what you meant by "...Edit Agreements.html could not be a pb..."
{quote}
white space in name
BCL license (JavaHelp) is also an issue: http://www.apache.org/legal/resolved.html#category-x . One possibility in cases like that is to dynamically grab the lib using Ivy. There are already some examples in ivy.xml, it's pretty simple.
> 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13497143#comment-13497143 ]
Tom Burns commented on OFBIZ-4941:
----------------------------------
Jacques,
I can't get to it today but I want to give you update Docbook content files that will include ASF2 in the content and additional book info section to track revisions and versions.
Tomorrow...
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, LicenseFiles.zip, LICENSE.html, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ 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
[jira] [Updated] (OFBIZ-4941) Proposal for a new help system
Posted by "Jacques Le Roux (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Jacques Le Roux updated OFBIZ-4941:
-----------------------------------
Attachment: content.7z
No sorry I still get the same. I attach here a zipped export of the content component w/out the libs (content.7z) for you to compare, will be the easiest way I guess ;)
> 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: 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, 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
[jira] [Updated] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Tom Burns updated OFBIZ-4941:
-----------------------------
Attachment: help_content.jpg
help_webhlep.jpg
help_ofbizhelp.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: 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13493887#comment-13493887 ]
Jacques Le Roux commented on OFBIZ-4941:
----------------------------------------
Tom what is the situation about OFBIZ-5051 ? I see the webhelp.manufacturing_de target, is that enough? Should we close OFBIZ-5051 if we commit here?
> 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13475303#comment-13475303 ]
Tom Burns commented on OFBIZ-4941:
----------------------------------
Jacques,
The <#if parameters.componentName!... stuff is just a temp kluge to separate the old and new styles. The line will go away after everything is ported.
Changing from component to webapp touches all of the files WebhelpFiles and WebhelpHRAppDocbook. I'll have a new set by Mon or Tues. After you test them we can worry about accounting if it is still an issue.
Till then, get some rest and have a nice weekend!
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, 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "Anil K Patel (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13499442#comment-13499442 ]
Anil K Patel commented on OFBIZ-4941:
-------------------------------------
Current implementation and proposed help system have too many touch points with framework and application. It will be nice if new help implementation addressed this problem. If it did, we would also make some more progress in community goal to shave some fat from Ofbiz framework and applications.
Both (the current implementation and proposed implementation) don't seem to support for third party hosted help documents. I personally like option of help documents being hosted outside of business application. This option opens business opportunity for content providers.
The proposed solution can be much more easily changed such that, Help documents are rendered by a Ofbiz Help webapplication. The help document can be accessed using url https://localhost:8443/ofbizhelp/OrderManager-FindOrder (or similar). This will also mean that Ofbiz Help will be a component that can exists in specialpurpose folder. If we go this route all the End User help content will live in OfbizHelp component and not in Content application.
> 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, LicenseFiles.zip, LICENSE.html, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, 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
[jira] [Updated] (OFBIZ-4941) Proposal for a new help system
Posted by "Jacques Le Roux (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Jacques Le Roux updated OFBIZ-4941:
-----------------------------------
Attachment: OFBIZ-4941.patch
> 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.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13486209#comment-13486209 ]
Tom Burns commented on OFBIZ-4941:
----------------------------------
Jacques,
If you use the latest code you can re-enable the webapps in the BIRT component. This is because the new code is at the webapp level. BIRT was blocking at the component level.
What is keeping you from finishing this issue? It's getting old.
Alert: a digression / rant follows
During my testing on the BIRT impact I found problems with the current BIRT implementation. Below are two examples you can try in:
https://ec2-50-17-48-232.compute-1.amazonaws.com:8443/accounting/control/main.
That instance has latest help code with the BIRT webapps enabled.
Payment example
1. In accounting select Payments
2. Click Find
3. Click Payment Id 8004
4. Click Acctg Trans Entries PDF (a BIRT report)
5. Expect report of transaction
Actual - PDF Report outline with no data
Export with Invoice and Payment as PDF example
1. In Accounting select Organizational GL Settings
2. In Click the Accounting command button in the first record "Your Company Name Here "
3. Click Accounting Transactions Entries
4. Click Find
5. Click Export with Invoice and Payment as PDF (a BIRT report)
6. Expect PDF report
Actual - A blank screen
I do not understand the logic behind moving BIRT to special purpose and leaving it in this state. What is the next step? Remove the BIRT reports completely or replace them with new screenfop versions?
Tom
PS I am on Long Island with Sandy and may loose power and not be able to reply.
> 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
[jira] [Comment Edited] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13496897#comment-13496897 ]
Jacques Le Roux edited comment on OFBIZ-4941 at 11/14/12 6:30 AM:
------------------------------------------------------------------
== TYPO ==
Tom on dev ML
{quote}
Jacques,
I don't what to say about browserDetect.js, other then that it is part of the webhelp component inside of the docbook-xsl-1.77.1.zip distribution which has hundreds of files.
The ie.css and positioning.css are webhelp files that I modified.
Re: ...avoid to create copies when creating the help with the webhelp.* ant targets...
If you are talking about the duplication of code in the build.xml for each web app than I agree, it's ugly. I tried various ant techniques to parametrize the code but could not come up with a satisfactory solution. I went with brute force duplication because it worked and I wanted to move on. I'll try to improve the build file in Phase II (documentation for help system and remaining legacy apps)
applications/content/template/docbook/webhelp/docs/... is from the webhelp distribution and should be unchanged.
Re: ASL2 in generated files:
In http://www.apache.org/dev/apply-license.html#license-include there is a line:
"Should the license be included in source files for
documentation (e.g. XML that is transformed to HTML)?
Yes. See the policy for more details."
I did not find any details in the policy that address this case.We can (and should) put a copyright notice in the the docbook file, which is a single file, using the docbook copyright tag. The files get chunked, do we really need a notice in each file
since they are viewed as a whole? If we do then we need a extension someplace in the xsl to insert ASL2. I'll have a look and let you know if it's doable. I would not spend time manually inserting the header into the HTML.
Note that the transformations of the "Apache OFBiz official documentation." do not include any copyright. (I fixed some errors in the docbook files and transformed them, outside of OFBiz, to PDF for validation. The resulting PDF does not have an copyright notice. There is still a problem in the java code, I will post the issue to JIRA when I have a solution.)
Tom
{quote}
OK, so:
* browserDetect.js: part of Docbook => already handled in OFBiz (maybe a line in NOTICE though)
* ie.css and positioning.css: part of webhelp => remove the ASL2 headers and replace by Webhelp license header and a line in NOTICE
* duplication not a worry, to be addressed later
Tom on dev ML
{quote}
Jacques,
We can generate ASL2 in the HTML.
I'll upload new copies of the Docbook book files and webhelp modified files with the changes tomorrow.
Did not mention before but stemmer.js files are part of webhelp.
Tom
{quote}
* stemmer.js files: part of webhelp => Webhelp license header and a line in NOTICE
* following [Treatment of Third-Party Works|http://www.apache.org/legal/src-headers.html#3party] and Webhelp License: <<Any stylesheet derived from this Software that is publicly distributed will be identified with a different name and the version strings in any derived Software will be changed so that no possibility of confusion between the derived package and this Software will exist.>>, we have *2 cases*:
** not stylesheet files and not modified stylesheet files => simply put the Webhelp license header, if it's missing
** modified stylesheet files => put the Webhelp license header, if it's missing + change the name and version strings
[Webhelp license header|http://docbook.sourceforge.net/release/xsl/1.76.1/webhelp/docs/content/index.html]:
----
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
* Except as contained in this notice, the names of individuals credited with contribution to this software shall not be used in advertising or otherwise to promote the sale, use or other dealings in this Software without prior written authorization from the individuals in question.
* **Any stylesheet derived from this Software that is publicly distributed will be identified with a different name and the version strings in any derived Software will be changed so that no possibility of confusion between the derived package and this Software will exist.***
Warranty: THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL DAVID CRAMER, KASUN GAJASINGHE, OR ANY OTHER CONTRIBUTOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
----
* jQuery: not a problem already handled in OFBiz
* DITA plugin: add a line in NOTICE
* Stemmers, ok see above
* Apache Lucene: not a problem already handled in OFBiz
was (Author: jacques.le.roux):
Tom on dev ML
{quote}
Jacques,
I don't what to say about browserDetect.js, other then that it is part of the webhelp component inside of the docbook-xsl-1.77.1.zip distribution which has hundreds of files.
The ie.css and positioning.css are webhelp files that I modified.
Re: ...avoid to create copies when creating the help with the webhelp.* ant targets...
If you are talking about the duplication of code in the build.xml for each web app than I agree, it's ugly. I tried various ant techniques to parametrize the code but could not come up with a satisfactory solution. I went with brute force duplication because it worked and I wanted to move on. I'll try to improve the build file in Phase II (documentation for help system and remaining legacy apps)
applications/content/template/docbook/webhelp/docs/... is from the webhelp distribution and should be unchanged.
Re: ASL2 in generated files:
In http://www.apache.org/dev/apply-license.html#license-include there is a line:
"Should the license be included in source files for
documentation (e.g. XML that is transformed to HTML)?
Yes. See the policy for more details."
I did not find any details in the policy that address this case.We can (and should) put a copyright notice in the the docbook file, which is a single file, using the docbook copyright tag. The files get chunked, do we really need a notice in each file
since they are viewed as a whole? If we do then we need a extension someplace in the xsl to insert ASL2. I'll have a look and let you know if it's doable. I would not spend time manually inserting the header into the HTML.
Note that the transformations of the "Apache OFBiz official documentation." do not include any copyright. (I fixed some errors in the docbook files and transformed them, outside of OFBiz, to PDF for validation. The resulting PDF does not have an copyright notice. There is still a problem in the java code, I will post the issue to JIRA when I have a solution.)
Tom
{quote}
OK, so:
* browserDetect.js: part of Docbook => already handled in OFBiz (maybe a line in NOTICE though)
* ie.css and positioning.css: part of webhelp => remove the ASL2 headers and replace by Webhelp license header and a line in NOTICE
* duplication not a worry, to be addressed later
Tom on dev ML
{quote}
Jacques,
We can generate ASL2 in the HTML.
I'll upload new copies of the Docbook book files and webhelp modified files with the changes tomorrow.
Did not mention before but stemmer.js files are part of webhelp.
Tom
{quote}
* stemmer.js files: part of webhelp => Webhelp license header and a line in NOTICE
* following [Treatment of Third-Party Works|http://www.apache.org/legal/src-headers.html#3party] and Webhelp License: <<Any stylesheet derived from this Software that is publicly distributed will be identified with a different name and the version strings in any derived Software will be changed so that no possibility of confusion between the derived package and this Software will exist.>>, we have **2 cases**:
** not stylesheet files and not modified stylesheet files => simply put the Webhelp license header, if it's missing
** modified stylesheet files => put the Webhelp license header, if it's missing + change the name and version strings
[Webhelp license header|http://docbook.sourceforge.net/release/xsl/1.76.1/webhelp/docs/content/index.html]:
----
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
* Except as contained in this notice, the names of individuals credited with contribution to this software shall not be used in advertising or otherwise to promote the sale, use or other dealings in this Software without prior written authorization from the individuals in question.
* **Any stylesheet derived from this Software that is publicly distributed will be identified with a different name and the version strings in any derived Software will be changed so that no possibility of confusion between the derived package and this Software will exist.***
Warranty: THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL DAVID CRAMER, KASUN GAJASINGHE, OR ANY OTHER CONTRIBUTOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
----
* jQuery: not a problem already handled in OFBiz
* DITA plugin: add a line in NOTICE
* Stemmers, ok see above
* Apache Lucene: not a problem already handled in 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
> 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.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, 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
[jira] [Updated] (OFBIZ-4941) Proposal for a new help system
Posted by "Jacques Le Roux (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Jacques Le Roux updated OFBIZ-4941:
-----------------------------------
Attachment: OFBIZ-4941.patch
New patch with few changes in
LICENSE
NOTICE
applications/content/template/docbook/webhelp/LICENSE
> 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.patch, OFBIZ-4941.patch, 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13395817#comment-13395817 ]
Tom Burns commented on OFBIZ-4941:
----------------------------------
Thanks for pointing that out Paul. Excel has nothing to do with it.
> 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, OFBIZ-4941 POC HR Help.patch
>
>
> 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13472545#comment-13472545 ]
Tom Burns commented on OFBIZ-4941:
----------------------------------
Jacques,
To build the help apps from content.7z:
1. Add the help files to the data directory applications/content/data/helpdata/docbookhelp/...
2. Add saxon.jar to the web app root applications/content/template/docbook/webhelp/saxon.jar
Note use the jar in the WebhelpFiles\webhelp\saxon.jar some later implementations do not work and may have licensing issues.
3. Run the build targets:
content\content\content\template\docbook\webhelp>ant webhelp.accounting
content\content\content\template\docbook\webhelp>ant webhelp.humanres
etc.
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: 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, 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
[jira] [Updated] (OFBIZ-4941) Proposal for a new help system
Posted by "Jacques Le Roux (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Jacques Le Roux updated OFBIZ-4941:
-----------------------------------
Description:
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}
was:
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.
> 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
>
>
> 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13471883#comment-13471883 ]
Tom Burns commented on OFBIZ-4941:
----------------------------------
Jacques,
I checkout a copy of the OFBiz trunk to a different AWS instance and downloaded the files from this page. I was able to build all of the webhelp files by following the inclosed instructions using only the files in the attachments.
When you replaced the contents of the docbook folder did you delete all of the old files in the folder before copying the 1.77.1 files to the folder? That's the only thing I can think of that would make a difference.
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, 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
[jira] [Updated] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ 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
> 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, 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13499853#comment-13499853 ]
Jacques Le Roux commented on OFBIZ-4941:
----------------------------------------
OK, thanks Tom for the file
> 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, LicenseFiles.zip, LICENSE.html, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941 POC HR Help.patch, ofbiz-common.xsl, 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13485499#comment-13485499 ]
Tom Burns commented on OFBIZ-4941:
----------------------------------
If it looks like a duck, swims like a duck, and quacks like a duck, then it probably is a duck. This imitative looks, swims and quacks like a dead duck. It would have been nice to know why.
I will just add one last note before the coda.
The latest code sent is not blocked by the BIRT ofbiz-component.xml, so if implemented BIRT and help can co-exist. That change was from OFBIZ-5053 patch committed in r1400463. It causes a error:
"org.ofbiz.webapp.control.RequestHandlerException: Unknown request [InvoiceAcctgTransEntriesPdf]; this request does not exist or cannot be called directly." when some BIRT reports are invoked.
Good luck with your project,
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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13473328#comment-13473328 ]
Tom Burns commented on OFBIZ-4941:
----------------------------------
Jacques,
You will have to discuss with the dev ML. I am not a member.
Every time I reply to the confirmation email using any of the suggested response methods I get (n).
The confirm subscribe return message begins:
Sorry, we were unable to deliver your message to the following address.
<de...@ofbiz.apache.org>:
Remote host said: 552 spam score (7.5) exceeded threshold...
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: 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, 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13494908#comment-13494908 ]
Tom Burns commented on OFBIZ-4941:
----------------------------------
Jacques,
Please request a vote before a final commit. There seem to be doubters and I do not want to spend more time on this if the developers think the current system is OK or they have other ideas on how help should be delivered to users.
Thanks,
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.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, 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
[jira] [Assigned] (OFBIZ-4941) Proposal for a new help system
Posted by "Jacques Le Roux (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Jacques Le Roux reassigned OFBIZ-4941:
--------------------------------------
Assignee: Jacques Le Roux
> 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, 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13473556#comment-13473556 ]
Tom Burns commented on OFBIZ-4941:
----------------------------------
Or just a coincidence - may be?
A sequence of events that although accidental seems to have been planned or arranged.
or
http://www.coincidencemaybe.com/fr_home.cfm
> 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: 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, 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13494064#comment-13494064 ]
Jacques Le Roux commented on OFBIZ-4941:
----------------------------------------
Yes I tend to agree with you, let's see what others think about it... Without answers I will commit as is...
> 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13497887#comment-13497887 ]
Tom Burns commented on OFBIZ-4941:
----------------------------------
Jacques,
The docbook content files in data/helpdata/docbookhelp/somecomponent/somecomponent.xml
The docbook separates content from presentation. Having PDF output as an alternate presentation allows off line review by stakeholders.
There are examples of webhelp / pdf presentation at:
http://docs.rackspace.com/servers/api/v2/cs-gettingstarted/content/overview.html
http://docs.openstack.org/
http://docs.rackspace.com/api/
I should not have brought it up here, it's not a requirement in the use cases (helppdf.zip that were attached).
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, LicenseFiles.zip, LICENSE.html, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, 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
[jira] [Updated] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13296122#comment-13296122 ]
Jacques Le Roux commented on OFBIZ-4941:
----------------------------------------
Of course if we go this way, the changes will be *only* in trunk...
> 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
>
>
> 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "Scott Gray (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13407720#comment-13407720 ]
Scott Gray commented on OFBIZ-4941:
-----------------------------------
Ivy or not I don't think you can have the system depend on a category-x licensed library.
> 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
[jira] [Updated] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13408321#comment-13408321 ]
Tom Burns commented on OFBIZ-4941:
----------------------------------
Scott / Jacopo,
OFBiz developer resources are limited. They are now focused on slimming down the project to a manageable scope. Given that fact, if it can be avoided, I do not think it is a good time to open a discussion on the requirements of a help system (never mind analysis, design and implementation).
There is wiggle room (* below) in the cat-x page but after reading some (endless) post in legal-discuss on GPL I think it's best go just go with the spirit of the law and forget about JavaHelp.
So for my part as per a prior post -
"If JavaHelp is not part of the solution then either the existing help system would have to upgraded to display html or something different would have to be built. I will look into that after I complete the HR documentation. "
Tom
*For example:
Wiggle 1
"Can Apache projects rely on components whose licensing affects the Apache product?
Apache projects cannot distribute any such components. However, if the component is only needed for optional features, a project can provide the user with instructions on how to obtain and install the non-included work. Optional means that the component is not required for standard use of the product or for the product to achieve a desirable level of quality. The question to ask yourself in this situation is:
'Will the majority of users want to use my product without adding the optional components?'
Comment
OFBiz has a help feature. A new component supporting JavaHelp could be optional implantation of an OFBiz help feature interface.
"Will the majority of users want to use my product without adding the optional components?" Who knows!
Wiggle 2
Can Apache projects rely on components under prohibited licenses?
Apache projects cannot distribute any such components. As with the previous question on platforms, the component can be relied on if the component's license terms do not affect the Apache product's licensing. For example, using a GPL'ed tool during the build is OK.
Comment
If build is OK why not 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13499451#comment-13499451 ]
Tom Burns commented on OFBIZ-4941:
----------------------------------
Anil,
...option of help documents being hosted outside of business application..
Have you looked at the other open source projects using webhelp?
I discussed other deployment options in the OFBiz Help Spec.pdf in the helppdf.zip file attached.
Please see the following and let me know if this addresses you concerns.
Copied here for convenience from OFBiz Help Spec.pdf .
...
"OFBiz Help Deployment
Up until this point the focus has been on deploying webhelp as a vehicle for context sensitive help. A
docbook xsl / webhelp solution is robust and flexible enough for the deployment in multiple document help
sites that support large and complex software systems.
A good example is Rackspace. See http://docs.rackspace.com/api/ . The Getting Started Guides, API
Developer Guides, Release Notes and other documentation use docbook webhelp integrated with other
presentation technologies.
Another example is http://docs.openstack.org/ Administration guides. Each guide is offered in online
webhelp and PDF generated from a single docbook source.
The site http://fusesource.com/products/fuse-esb-enterprise/#documentation is another variation that uses
webhelp. Here the docbook transformations into three presentations: 1. webhelp 2. PDF and 3. Epub are
clearly defined.
These notes on presentation are only suggestive of what could be done to improve OFBiz help
presentation."
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, LicenseFiles.zip, LICENSE.html, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13471429#comment-13471429 ]
Jacques Le Roux commented on OFBIZ-4941:
----------------------------------------
Tom,
Yes it's there
{code}
D:\workspace\ofbizClean\applications\content\template\docbook\webhelp>dir
Le volume dans le lecteur D s'appelle Secondaire
Le numéro de série du volume est 441F-6A20
Répertoire de D:\workspace\ofbizClean\applications\content\template\docbook\webhelp
07/10/2012 20:38 <REP> .
07/10/2012 20:38 <REP> ..
25/09/2012 22:09 3 755 build.properties
26/09/2012 00:16 53 395 build.xml
07/10/2012 16:03 <REP> docs
07/10/2012 16:03 <REP> docsrc
09/01/2012 16:06 27 LICENSE
06/08/2012 18:04 572 551 saxon.jar
07/10/2012 18:40 <REP> template
07/10/2012 20:38 <REP> test-output
07/10/2012 18:39 <REP> WEB-INF
07/10/2012 18:41 <REP> xsl
4 fichier(s) 629 728 octets
8 Rép(s) 50 194 251 776 octets libres
{code}
I also checked its size downloading saxon6-5-5.zip, it's the right one
> 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, 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13475301#comment-13475301 ]
Jacques Le Roux commented on OFBIZ-4941:
----------------------------------------
This is where you see that adding things like we try to do is harder and much less safer than using patches ;)
Ok I got it working, I was missing the fieldlookup.js change because in the meantime I had to commit (r1395488|http://svn.apache.org/viewvc?view=revision&revision=1395488] and forgot to put your change back, my bad.
One last remark: in Flat Grey theme (at least) the help text dissapear.
So I only wait from you now:
# the 2nd point in the comment just above
# a fix for other/s template than Tomahawk for the text button/link
# A way to have help at the webapp and not component level (related to point 1 here)
> 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, 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13473059#comment-13473059 ]
Jacques Le Roux commented on OFBIZ-4941:
----------------------------------------
OK, I found the reason, I needed to run from OFBiz root:
"C:\Program Files\Java\jdk1.6.0_22\bin\java" -jar D:/workspace\ofbizClean/framework/base/lib/ant-launcher-1.8.4.jar -lib framework/base/lib/ant webhelp.humanres
works
So now the question is more how to integrate these targets to the globalbuild. They are resource eager (more or less 1 min on my machine for each). A perfect way would be to run them with the global build, but only when changes in content (or only applications\content\data\helpdata\docbookhelp?) would be detected...
> 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: 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, 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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 commented on OFBIZ-4941:
----------------------------------
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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13471175#comment-13471175 ]
Jacques Le Roux commented on OFBIZ-4941:
----------------------------------------
I checked the [license|http://docbook.sourceforge.net/release/xsl/1.76.1/webhelp/docs/content/index.html]. It's an MIT with this specific paragraph added
{quote}
Any stylesheet derived from this Software that is publicly distributed will be identified with a different name and the version strings in any derived Software will be changed so that no possibility of confusion between the derived package and this Software will exist.
{quote}
Not problematic. Also all included works are compatible with the ASL2
> 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13493882#comment-13493882 ]
Jacques Le Roux commented on OFBIZ-4941:
----------------------------------------
Tom, please open an issue for the Birt/PDF issue, I reproduced but did not find anything obvious (like a path to change), just this, not sure it's related
UtilNumber.java:218:WARN ] Cannot format rule based amount for locale us because rule set for that locale does not exist
> 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13393497#comment-13393497 ]
Jacques Le Roux commented on OFBIZ-4941:
----------------------------------------
Quoting Tom from OFBIZ-2219
{quote}
As noted in OFBIZ-4869 and now OFBIZ-4941 I have been working on a POC to create OFBiz help using DocBook-xsl to generate html files for presentation. Any one interested should take a look at http://www.sagehill.net/docbookxsl/index.html .
The transformation is triggered by ant tasks. I've attached a copy of the file I am using in a hot-deploy component so you can see how its done. Current help files can be used as is. All that is needed is to move them into folders that map to the desired structure of help file. Attached is a screen shot of the transformed Accounting files.
If there is any interest in this approach in the community I can provide more information on options for proceeding.
{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: HelpAccounting.jpg, HelpPerformanceReview1.jpg, HelpPerformanceReview2.jpg, HelpRoadmap.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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "Adrian Crum (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13480771#comment-13480771 ]
Adrian Crum commented on OFBIZ-4941:
------------------------------------
"2. On a build strategy, my understanding is that the trunk will include pre-built help. That is if someone checks out the trunk there will be a folder applications/content/webapp/ofbizhelp that will have help files for accounting, catalog, etc. There will be no need for the user to do a build after checkout. "
Please, no.
Each component should have its own help system. The kind of dependency proposed here is a terrible idea.
> 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
[jira] [Updated] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ 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
Code reworked to filter help at the webapp level. Also added help for manufacturing_de based on text in OFBIZ-5051.
app-bar-display="false" to suppress HR help as a component.
> 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13471319#comment-13471319 ]
Jacques Le Roux commented on OFBIZ-4941:
----------------------------------------
It should not be related to humanres issue, but why is there only data for humanres?
> 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, 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13474687#comment-13474687 ]
Tom Burns commented on OFBIZ-4941:
----------------------------------
Jacques,
The naming conventions used for image files and docbook xml id's have to be adjusted to support components with multiple web apps.
The problem exist in the current help system. For example opening help from the Catalog and Facility main page opens the same help file since the file is keyed on the component product not the web app.
I will have to replace the files in the attached WebhelpFiles and WebhelpHRAppDocbook.
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: 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, 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13471318#comment-13471318 ]
Jacques Le Roux commented on OFBIZ-4941:
----------------------------------------
Indeed D:\workspace\ofbizClean\applications\content\webapp\ofbizhelp\humanres_en is empty, but I still don't see why. Could it be because my default locale is French?
> 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, 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
[jira] [Comment Edited] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13475301#comment-13475301 ]
Jacques Le Roux edited comment on OFBIZ-4941 at 10/12/12 8:02 PM:
------------------------------------------------------------------
== TYPO ==
This is where you see that adding things like we try to do is harder and much less safer than using patches ;)
Ok I got it working, I was missing the fieldlookup.js change because in the meantime I had to commit [r1395488|http://svn.apache.org/viewvc?view=revision&revision=1395488] and forgot to put your change back, my bad.
One last remark: in Flat Grey theme (at least) the help text dissapear.
So I only wait from you now:
# the 2nd point in the comment just above
# a fix for other/s template than Tomahawk for the text button/link
# A way to have help at the webapp and not component level (related to point 1 here)
was (Author: jacques.le.roux):
This is where you see that adding things like we try to do is harder and much less safer than using patches ;)
Ok I got it working, I was missing the fieldlookup.js change because in the meantime I had to commit (r1395488|http://svn.apache.org/viewvc?view=revision&revision=1395488] and forgot to put your change back, my bad.
One last remark: in Flat Grey theme (at least) the help text dissapear.
So I only wait from you now:
# the 2nd point in the comment just above
# a fix for other/s template than Tomahawk for the text button/link
# A way to have help at the webapp and not component level (related to point 1 here)
> 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, 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13499446#comment-13499446 ]
Jacques Le Roux commented on OFBIZ-4941:
----------------------------------------
Thanks for feedback Anil,
>Current implementation and proposed help system have too many touch points with framework and application
Could you elaborate, give details and examples of the issues you see?
>The proposed solution can be much more easily changed such that, Help documents are rendered by a Ofbiz Help webapplication.
How do you envision that technically? It seems to me you just add a new requirement, that I like but I'm not sure the new implementation can *easily* change for that.
> 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, LicenseFiles.zip, LICENSE.html, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13473207#comment-13473207 ]
Tom Burns commented on OFBIZ-4941:
----------------------------------
Good Morning Jacques,
The webhelp target is the demo site for webhelp.
Running the task the creates a demo web site that can be invoked from:
applications/content/template/docbook/webhelp/docs/index.html
If you open that site you will find help info on "Stemmers" see:
Developer Docs > Search > New Stemmers
It has a note:
"Make sure you changed the webhelp.indexer.language property in build.properties to your language."
The message you received "Warning! language: en" traces to the line
<xsl:message>language: <xsl:value-of select="$webhelp.indexer.language"/> </xsl:message>
Long story short, help developers in other languages need to be aware of this impact on search indexing.
I would leave the task for webhelp in the build file because there is a lot of useful information in the sample app and it takes little space.
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: 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, 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13486089#comment-13486089 ]
Jacques Le Roux commented on OFBIZ-4941:
----------------------------------------
Hi Tom,
Do you mean that the change introduced for OFBIZ-5053 is causing this issue, or?
> 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13471439#comment-13471439 ]
Jacques Le Roux commented on OFBIZ-4941:
----------------------------------------
Tom, did you try to use your install instructions on a fresh checkout?
> 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, 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
[jira] [Updated] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Tom Burns updated OFBIZ-4941:
-----------------------------
Attachment: ofbiz-common.xsl
Jacques,
OFBiz logo in header was linked to DocBook site. Attached links it to OFBiz.org
Note: facility and order help will open to BIRT help in current helps system because they do not have a webhelp implementation. accounting which has a webhelp implementation will open accounting help. This is a BIRT problem. Will go away when webhelp is published for facility and order.
Everything else looks ok as long a all the binary files are put in the right place.
Thanks,
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, LicenseFiles.zip, LICENSE.html, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941 POC HR Help.patch, ofbiz-common.xsl, 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13487323#comment-13487323 ]
Jacques Le Roux commented on OFBIZ-4941:
----------------------------------------
Hi Tom,
>What is keeping you from finishing this issue? It's getting old.
It's not very old in OFBiz standards, I hope to proceed this week. I will first deeply review Adrian's concern.
>I do not understand the logic behind moving BIRT to special purpose and leaving it in this state. What is the next step? Remove the BIRT reports completely or replace them with new screenfop versions?
This is part of the [slim-down effort|https://issues.apache.org/jira/browse/OFBIZ/fixforversion/12320551]: Birt will be moved to Attic. When is another question... But indeed, 1st we must have it working from specialpurpose if it's no longer the case...
> 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13499415#comment-13499415 ]
Jacques Le Roux commented on OFBIZ-4941:
----------------------------------------
Tom,
I'm still not quite sure what you refer too by <<The docbook content files in data/helpdata/docbookhelp/somecomponent/somecomponent.xml>>. Did you notice that, in my last OFBIZ-4941.patch, I put the ASL2 header in all XML files under applications\content\data\helpdata\docbookhelp?
So, with your LicenseFiles.zip, I think we have all the needed now in content component. I will rebuild the webhelp and handle the rest (mostly in NOTICE file) in a new, hopefully last, OFBIZ-4941.patch. Then I will ask the community to review. I want to commit as is and to move later in a new webhelp specialpurpose component.
I'm just a bit worried by this point from http://www.apache.org/legal/src-headers.html#3party as I referred above (but did not put the link in clear):
2. Do ensure that every third-party work includes its associated license, *even if that requires adding a copy of the license from the third-party download site into the distribution.
Actually this is not particularly related to webhelp (which have much less files, pfew... still 293, but most are binaries) but Docboock in a whole. So my question to the OFBiz team: do we really need to put the Webhelp license header (see above) in every non modified files if it misses or is a reference enough (like we have for webhelp in applications\content\template\docbook\webhelp\LICENSE). Then if we miss that, it begins to be ridiculous for files like applications\content\template\docbook\webhelp\template\content\search\default.props...
> 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, LicenseFiles.zip, LICENSE.html, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13499443#comment-13499443 ]
Jacques Le Roux commented on OFBIZ-4941:
----------------------------------------
OK, no worries, Jacopo clarified: I will just put their license in the LICENSE file at root of OFBiz project.
> 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, LicenseFiles.zip, LICENSE.html, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13475082#comment-13475082 ]
Jacques Le Roux commented on OFBIZ-4941:
----------------------------------------
Yes, I commited it :)
> 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, 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13404699#comment-13404699 ]
Jacques Le Roux commented on OFBIZ-4941:
----------------------------------------
Hi Tom,
I quickly reviewed your patch this morning and there are trivial things missing, I'm sure you can help:
* No license headers in some new files (ASL2, see OOTB examples for types of headers). Of course not Sun files, which will keep their own headers.
** neglect for generated files, but then they should not be put in repo but rather generated on fly
* We need to reference the Java Help System in LICENSE and NOTICE files
* I wonder if in some cases the file name "Edit Agreements.html" could not be a pb (just an intuition, neglect if you think otherwise)
Just a fast review I might have missed some points...
Ha! Re-reading you last big comment, I understand now that this needs more work... OK we will see, too much for me today...
> 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, OFBIZ-4941 POC HR Help.patch
>
>
> 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13471249#comment-13471249 ]
Jacques Le Roux commented on OFBIZ-4941:
----------------------------------------
As a 1st step I updated docbook to version 1.77.1 at revision 1395307
> 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
[jira] [Updated] (OFBIZ-4941) Proposal for a new help system
Posted by "Jacques Le Roux (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Jacques Le Roux updated OFBIZ-4941:
-----------------------------------
Attachment: OFBIZ-4941.patch
New patch without generated files but with a new webhelp.all target to generate them all in a single shoot. This is for test only, we will commit with the generated files (in applications\content\webapp\ofbizhelp for now)
To run the webhelp.all target from OFBiz root, use:
ant -f applications/content/template/docbook/webhelp/build.ofbiz.xml webhelp.all
> 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, LicenseFiles.zip, LICENSE.html, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941 POC HR Help.patch, ofbiz-common.xsl, 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=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
[jira] [Updated] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Tom Burns updated OFBIZ-4941:
-----------------------------
Attachment: LicenseFiles.zip
Jacques,
The attached zip contains webhelp files that were modified for OFBiz.
The names of the modified files have been changed to comply with the webhelp license and include ASL2.
The original unmodified webhelp files are also included as a convenience. They should be included in the OFBiz distribution of webhelp.
The file ofbiz-common.xsl contains a customization to include ASL2 in compiled HTML files. Updates to ASL can be made in this file.
Help files will have to be re-compiled to include ASL2.
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, LicenseFiles.zip, LICENSE.html, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, 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
[jira] [Updated] (OFBIZ-4941) Proposal for a new help system
Posted by "Jacques Le Roux (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Jacques Le Roux updated OFBIZ-4941:
-----------------------------------
Attachment: OFBIZ-4941.patch
Tom,
>The last patch only included the catalog_en webapp and it did not render correctly
I just created a new complete patch (tested succesfully) but it's too large (25MB) for ASF Jira which allows only 10MB. So I cleaned all generated file but catalog_en in the new attached patch. It's normal that by applying this and previous patch you don't get it working: it does not contains the binary files (images, etc.)
Please check that I have not forgotten anything, thanks!
> 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, LicenseFiles.zip, LICENSE.html, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "Olivier Heintz (JIRA)" <ji...@apache.org>.
[ 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13494033#comment-13494033 ]
Jacques Le Roux commented on OFBIZ-4941:
----------------------------------------
Tom,
# Yes I was pretty stupid on this one :D and thought afterward, noted you changed for app-bar-display="false" as I suggested good :)
# You did not answer to Adrian's concern, can't we move these files into their respective component?
# Yes of course
# OK
# I will do and ask Carstein for his support to create a new one and do the neeed there
We will now wait Adrian's and hopefully other committers comments before I commit your work, thanks!
> 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13473540#comment-13473540 ]
Jacques Le Roux commented on OFBIZ-4941:
----------------------------------------
Could be that they changed the Spamassassin rules...
> 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: 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, 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
[jira] [Comment Edited] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13497818#comment-13497818 ]
Jacques Le Roux commented on OFBIZ-4941:
----------------------------------------
Tom,
Could you please refer to a path for what you call "Docbook content files"? I guess it's the HTML generated file? Why PDF?
> 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, LicenseFiles.zip, LICENSE.html, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13499536#comment-13499536 ]
Tom Burns commented on OFBIZ-4941:
----------------------------------
Jacques,
Testing using latest trunk -
1. Copied missing image files to docbookhelp image folders
2. Built acounting webhelp web apps
Build failed - applications/content/template/docbook/webhelp/saxon.jar was missing
3. Built acounting webhelp web apps
4. Build success
5. Opened app from file system
6. App missing logo
7. Added applications/content/template/docbook/webhelp/template/common/images/logo.gif
8. Built acounting webhelp web app
9. Opened app from file system
10. App performed and displayed as expected
11. Ran OFBiz
12. Invoked Accounting app and help - pass
13. Invoked Facility app and help - Expected Facility help in legacy help - Acutal BIRT Help
I will have to complete testing tomorrow. Just wanted to let you know what was happening. Should have be able to resolve everything in the morning.
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, LicenseFiles.zip, LICENSE.html, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13471334#comment-13471334 ]
Tom Burns commented on OFBIZ-4941:
----------------------------------
Jacques,
Re: 07/Oct/12 16:50
applications\content\webapp\ofbizhelp\humanres_en
is created when you run webhelp.humanres
It should not matter if is is missing, the command will recreate it
Perhaps the problem is in build.xml:208
D:\workspace\ofbizClean\applications\content\template\docbook\webhelp\build.xml:208: javax.xml.transform.TransformerException: [start prefix mapping event]: uri is an empty string.
classpath="${xslt-processor-classpath}">
xslt-processor-classpath=saxon.jar
Do you have the saxon.jar in applications/content/template/docbook/webhelp ?
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, 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13465111#comment-13465111 ]
Tom Burns commented on OFBIZ-4941:
----------------------------------
Hi All,
Because of the number of of non text files, and the requirement to overwrite the contents of applications/content/template/docbook with the contents of docbook-xsl-1.77.1, using a patch to implement this improvement is problematic. Therefore the solution is offered in two zip files WebhelpFiles.zip and WebhelpHRAppDocbook.zip.
The file "Readme Webhelp OFBiz Initial Installation.txt" in WebhelpFiles has step by step instructions for installing Webhelp for OFBiz into the trunk or other OFBiz deployments.
I have to leave it to the committers to to devise an efficient method to implement the solutions should implementation be desirable.
Thanks.
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, 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13471298#comment-13471298 ]
Tom Burns commented on OFBIZ-4941:
----------------------------------
Jacques,
Seems like a path problem. There is no path \workspace\ofbizClean\...
Attached are screen shots of the path to the content, webhelp and web files. Do your paths look like them?
A successful ant webhelp.humanres looks like:
Buildfile: C:\workspace\ofbiz24\applications\content\template\docbook\webhelp\build.xml
clean.humanres:
[delete] Deleting directory C:\workspace\ofbiz24\applications\content\webapp\ofbizhelp\humanres_en
chunk.humanres:
[mkdir] Created dir: C:\workspace\ofbiz24\applications\content\webapp\ofbizhelp\humanres_en
[xslt] Processing C:\workspace\ofbiz24\applications\content\data\helpdata\docbookhelp\humanres_en\humanres.xml to C:\workspace\ofbiz24\applications\content\webapp\ofbizhelp\humanres_en\null1671035212
[xslt] Loading stylesheet C:\workspace\ofbiz24\applications\content\template\docbook\profiling\profile.xsl
[xslt] Processing C:\workspace\ofbiz24\applications\content\webapp\ofbizhelp\humanres_en\null1671035212 to C:\workspace\ofbiz24\applications\content\webapp\ofbizhelp\humanres_en\null1799120406
[xslt] Loading stylesheet C:\workspace\ofbiz24\applications\content\template\docbook\webhelp\xsl\webhelp.xsl
[xslt] language: en
[xslt] Note: namesp. cut : stripped namespace before processing OFBiz Human Resource Guide
[xslt] Note: namesp. cut : processing stripped document OFBiz Human Resource Guide
[xslt] language: en
[xslt] Writing ../../../webapp/ofbizhelp/humanres_en/content/ch01s01.html for sect1
...
[copy] Copying 94 files to C:\workspace\ofbiz24\applications\content\webapp\ofbizhelp\humanres_en
index.humanres:
[copy] Copying 1 file to C:\workspace\ofbiz24\applications\content\webapp\ofbizhelp\humanres_en
[copy] Copied 1 empty directory to 1 empty directory under C:\workspace\ofbiz24\applications\content\webapp\ofbizhelp\humanres_en
[copy] Copying 4 files to C:\workspace\ofbiz24\applications\content\webapp\ofbizhelp\humanres_en
[echo] Indexing html files in ../../../webapp/ofbizhelp/humanres_en/content
[java] Stemming enabled
[java] The created index files are located in ..\..\..\webapp\ofbizhelp\humanres_en\content\search\.js
[java] Indexed the contents in 3 seconds
web-images-humanres:
[mkdir] Created dir: C:\workspace\ofbiz24\applications\content\webapp\ofbizhelp\humanres_en\images_humanres_en
[copy] Copying 148 files to C:\workspace\ofbiz24\applications\content\webapp\ofbizhelp\humanres_en\images_humanres_en
webhelp.humanres:
BUILD SUCCESSFUL
Total time: 43 seconds
> 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
[jira] [Updated] (OFBIZ-4941) Proposal for a new help system
Posted by "Jacques Le Roux (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Jacques Le Roux updated OFBIZ-4941:
-----------------------------------
Attachment: docbook diff.patch
> 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13499862#comment-13499862 ]
Tom Burns commented on OFBIZ-4941:
----------------------------------
Jacques,
That will be nice thanks.
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, LicenseFiles.zip, LICENSE.html, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941 POC HR Help.patch, ofbiz-common.xsl, 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
[jira] [Comment Edited] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13499415#comment-13499415 ]
Jacques Le Roux edited comment on OFBIZ-4941 at 11/17/12 1:13 PM:
------------------------------------------------------------------
== MISSED AN ENDING * FOR BOLD (actually removed stupidely while reviewing, doh) ==
Tom,
I'm still not quite sure what you refer too by <<The docbook content files in data/helpdata/docbookhelp/somecomponent/somecomponent.xml>>. Did you notice that, in my last OFBIZ-4941.patch, I put the ASL2 header in all XML files under applications\content\data\helpdata\docbookhelp?
So, with your LicenseFiles.zip, I think we have all the needed now in content component. I will rebuild the webhelp and handle the rest (mostly in NOTICE file) in a new, hopefully last, OFBIZ-4941.patch. Then I will ask the community to review. I want to commit as is and to move later in a new webhelp specialpurpose component.
I'm just a bit worried by this point from http://www.apache.org/legal/src-headers.html#3party as I referred above (but did not put the link in clear):
2. Do ensure that every third-party work includes its associated license, *even if that requires adding a copy of the license from the third-party download site into the distribution*.
Actually this is not particularly related to webhelp (which have much less files, pfew... still 293, but most are binaries) but Docboock in a whole. So my question to the OFBiz team: do we really need to put the Webhelp license header (see above) in every non modified files if it misses or is a reference enough (like we have for webhelp in applications\content\template\docbook\webhelp\LICENSE). Then if we miss that, it begins to be ridiculous for files like applications\content\template\docbook\webhelp\template\content\search\default.props...
was (Author: jacques.le.roux):
Tom,
I'm still not quite sure what you refer too by <<The docbook content files in data/helpdata/docbookhelp/somecomponent/somecomponent.xml>>. Did you notice that, in my last OFBIZ-4941.patch, I put the ASL2 header in all XML files under applications\content\data\helpdata\docbookhelp?
So, with your LicenseFiles.zip, I think we have all the needed now in content component. I will rebuild the webhelp and handle the rest (mostly in NOTICE file) in a new, hopefully last, OFBIZ-4941.patch. Then I will ask the community to review. I want to commit as is and to move later in a new webhelp specialpurpose component.
I'm just a bit worried by this point from http://www.apache.org/legal/src-headers.html#3party as I referred above (but did not put the link in clear):
2. Do ensure that every third-party work includes its associated license, *even if that requires adding a copy of the license from the third-party download site into the distribution.
Actually this is not particularly related to webhelp (which have much less files, pfew... still 293, but most are binaries) but Docboock in a whole. So my question to the OFBiz team: do we really need to put the Webhelp license header (see above) in every non modified files if it misses or is a reference enough (like we have for webhelp in applications\content\template\docbook\webhelp\LICENSE). Then if we miss that, it begins to be ridiculous for files like applications\content\template\docbook\webhelp\template\content\search\default.props...
> 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, LicenseFiles.zip, LICENSE.html, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, 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
Re: [jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by Hans Bakker <ma...@antwebsystems.com>.
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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13475275#comment-13475275 ]
Jacques Le Roux commented on OFBIZ-4941:
----------------------------------------
It's quite clear, what I see is the old accouting help.
As I said, I see also the new one, but only when running the applications\content\webapp\ofbizhelp\accounting_en\index.html file, hence my question. BTW I tried with English locale, same.
And as you know this is already committed (and in my working copy, it's the one I use to commit)
{code}
<webapp name="ofbizhelp"
title="OFBiz Help"
server="default-server"
location="webapp/ofbizhelp"
base-permission="OFBTOOLS"
mount-point="/ofbizhelp"/>
{code}
So what could I miss? In other word how is the help button trigerring the new help, if it's there I guess, instead of the old one?
> 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, 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
[jira] [Comment Edited] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13473308#comment-13473308 ]
Jacques Le Roux edited comment on OFBIZ-4941 at 10/10/12 3:37 PM:
------------------------------------------------------------------
== CROSSED On WIRE ==
^Yes agreed, I'm now more concerned by the build integration ;)
Your last comment: Yes maybe the better solution indeed, with warning. Anyway we should really discuss that with the team on the dev ML, I let you fire 1st :)
was (Author: jacques.le.roux):
Yes agreed, I'm now more concerned by the build integration ;)
> 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: 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, 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "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=13499855#comment-13499855 ]
Jacques Le Roux commented on OFBIZ-4941:
----------------------------------------
BTW, I will create a new webhelp.all ant target in order to globally build all existing webhelp in a shoot.
> 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, LicenseFiles.zip, LICENSE.html, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941 POC HR Help.patch, ofbiz-common.xsl, 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
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Posted by "Tom Burns (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13471678#comment-13471678 ]
Tom Burns commented on OFBIZ-4941:
----------------------------------
Jacques,
The demo in
https://ec2-23-20-150-243.compute-1.amazonaws.com:8443/humanres/control/main
was created from a fresh checkout using the same file set that is posted here.
At the time I was following the download instructions as a test.
I'll try another clean install to see of I missed anything and let you know the outcome.
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, 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