[ https://issues.apache.org/jira/browse/OFBIZ-6015?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Sharan Foga updated OFBIZ-6015: ------------------------------- Sprint: Bug Crush Event - 21/2/2015, Community Day 2 - 2015, Community Day 3 - 2015 (was: Bug Crush Event - 21/2/2015, Community Day 2 - 2015) > Move Online Help Documentation from Webhelp into Trunk > ------------------------------------------------------ > > Key: OFBIZ-6015 > URL: https://issues.apache.org/jira/browse/OFBIZ-6015 > Project: OFBiz > Issue Type: Improvement > Components: ALL APPLICATIONS > Reporter: Sharan Foga > Assignee: Sharan Foga > Priority: Minor > Attachments: Webhelp Analysis.ods > > > This Jira has been created to manage the migration of all the documentation > from the Webhelp branch into the current help system so that it will work > with what we already have (essentially so that we dont lose it!). The > original issue for the Webhelp is > https://issues.apache.org/jira/browse/OFBIZ-4941 > As well as HR, there is also online documentation for Accounting, > Manufacturing (English, German and Dutch), Project Manager and Catalog - > though not as complete, so I will be consolidating and moving those too. The > files use the docbook format and are compatible with what we have although he > implemented everything into one file (i.e book) per module. I now think this > is the better way to go. > Update as at July 2015 > ================== > The original code from the Webhelp branch was updated and converted to an > OFBiz addon. > The addon was created from the Webhelp branch but is setup as an addon. > To see a what the webhelp will look like and function like. > Go to https://demo.ofbizextra.org/accounting/control/main > Login as admin/ofbiz > Select HR and then click the help button (The docbook webhelp should be > displayed) > As well as using docbook and webhelp for displaying it. Some additonal > funcitonality has been added. These are as follows: > 1) There are some ant targets created (e.g. ant webhelp, clean-webhelp) > 2) There is a flag setup to indicate whether a module has webhelp or uses > OFBiz standard help (i.e. what we are using now). > To test it on the ofbizextra demo > Select Facilities and then click the help button (The normal OFBiz help menu > is displayed because no webhelp exists for this module) > I think this could be good thing as we convert the existing documentation > from the current online help format to the webhelp because it wont break > anything and leaves the option open for people who are using the existing > help system. > 3) There is also some functionality related to language that looks at the > language of the user to see if the webhelp exists in that language. If it > doesn't there is a message saying so but that documentation exists in another > language > The addon uses the patch Files. (.patch) I think this is because the addon > tries to maintain compatibility with different OFBiz versions but I think > it's still just xml or java code. > I have done an initial (non technical) analysis of the files and attached > that too -- This message was sent by Atlassian JIRA (v6.3.4#6332)