OFBiz › OFBiz - Dev

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

_‹ Previous Topic Next Topic _›

Classic

List

Threaded

147 messages Options

1 ... 345678

Nicolas Malin (Jira)

[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=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

Nicolas Malin (Jira)

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

In reply to this post by Nicolas Malin (Jira)

[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=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...

Nicolas Malin (Jira)

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

In reply to this post by Nicolas Malin (Jira)

[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=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.

Nicolas Malin (Jira)

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

In reply to this post by Nicolas Malin (Jira)

[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=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 ;) )

Nicolas Malin (Jira)

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

In reply to this post by Nicolas Malin (Jira)

[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=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

Nicolas Malin (Jira)

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

In reply to this post by Nicolas Malin (Jira)

[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=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?

Nicolas Malin (Jira)

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

In reply to this post by Nicolas Malin (Jira)

[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=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?

Nicolas Malin (Jira)

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

In reply to this post by Nicolas Malin (Jira)

[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=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

Nicolas Malin (Jira)

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

In reply to this post by Nicolas Malin (Jira)

[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=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!

Nicolas Malin (Jira)

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

In reply to this post by Nicolas Malin (Jira)

[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=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

Nicolas Malin (Jira)

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

In reply to this post by Nicolas Malin (Jira)

[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=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...

Nicolas Malin (Jira)

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

In reply to this post by Nicolas Malin (Jira)

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

Nicolas Malin (Jira)

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

In reply to this post by Nicolas Malin (Jira)

[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=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}

Nicolas Malin (Jira)

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

In reply to this post by Nicolas Malin (Jira)

[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=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}

Nicolas Malin (Jira)

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

In reply to this post by Nicolas Malin (Jira)

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

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}

Nicolas Malin (Jira)

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

In reply to this post by Nicolas Malin (Jira)

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

Nicolas Malin (Jira)

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

In reply to this post by Nicolas Malin (Jira)

[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=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}

Nicolas Malin (Jira)

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

In reply to this post by Nicolas Malin (Jira)

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

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}

Tom

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

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) <[hidden email]>
To: [hidden email]
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}

Tom

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

In reply to this post by Nicolas Malin (Jira)

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) <[hidden email]>
To: [hidden email]
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}

1 ... 345678