[
https://issues.apache.org/jira/browse/OFBIZ-6450?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14576263#comment-14576263
]
Sharan Foga edited comment on OFBIZ-6450 at 6/7/15 2:42 PM:
------------------------------------------------------------
Hi Taher
I dont think the HELP_HR.xml will display in webhelp because it is setup to be
displayed by Content Manager. I think all our existing online documentation
doesn;t use Webhelp. (although I think the Webhelp display looks a lot nicer
than what we currently have)
The Webhelp branch was taken and made into an OFBiz addon but the XML files for
the addon are still docbook files and in fact seem to be rendered I think by
Webhelp.
If you want to see what it looks like then use this link
https://demo.ofbizextra.org/humanres/control/main and login as admin / ofbiz
Go to the HR application and click on the help button or question mark and the
docbook webhelp will be displayed.
So this is what the webhelp addon looks like.
I took the docbook files from this addon and copied in some of the code into
the existing ofbiz docbook xml files (e.g HELP_HR.xml) since some of the
generic HR help information could go there.
I will attach the HR file as it is in the addon so you can see what the
original file it looks like.
So how am I testing it?
I took a copy of the trunk and then I update HELP_HR.xml.
I'm then doing an a load demo so that the updates are loaded into content
manager
I'm then starting OFBiz, going to the HR app main menu and clicking the help
button to display the help documentation. (Because this is the trunk it will
display using content manager not Webhelp)
was (Author: sharan ):
Hi Taher
I dont think the HELP_HR.xml will display in webhelp because it is setup to be
displayed by Content Manager. I think all our existing online documentation
doesn;t use Webhelp. (although I think the Webhelp display looks a lot nicer
than what we currently have)
The Webhelp branch was taken and made into an OFBiz addon but the XML files for
the addon are still docbook files and in fact seem to be rendered I think by
Webhelp.
If you want to see what it looks like then use this link
https://demo.ofbizextra.org and login as admin / ofbiz
Go to the HR application and click on the help button or question mark and the
docbook webhelp will be displayed.
So this is what the webhelp addon looks like.
I took the docbook files from this addon and copied in some of the code into
the existing ofbiz docbook xml files (e.g HELP_HR.xml) since some of the
generic HR help information could go there.
I will attach the HR file as it is in the addon so you can see what the
original file it looks like.
So how am I testing it?
I took a copy of the trunk and then I update HELP_HR.xml.
I'm then doing an a load demo so that the updates are loaded into content
manager
I'm then starting OFBiz, going to the HR app main menu and clicking the help
button to display the help documentation. (Because this is the trunk it will
display using content manager not Webhelp)
> Docbook and OFBIz Online Help
> -----------------------------
>
> Key: OFBIZ-6450
> URL: https://issues.apache.org/jira/browse/OFBIZ-6450
> Project: OFBiz
> Issue Type: Bug
> Reporter: Sharan Foga
> Attachments: 02-docbook_overview_diagram.pdf, humanres.xml
>
>
> Jira created based on the steps suggested by Taher as follows:
> - First, we attempt to fix whatever is wrong in DocBook at the moment. If you
> can share exactly what you spotted then this would save us a lot of time in
> trying to dig to the problem. So a repeat process to identify the bugs from
> you would be great.
> - Second, we decide on a category structure for the sections of the
> documentation if we do not like the existing one
> - We also introduce or enforce a workflow that mandates an update of the
> documentation on each JIRA that affects functionality that requires
> documentation. For example, if we add or modify a screen in the party
> component, then we must provide the documentation for that screen before
> closing the JIRA for example.
> - As a last step we decide on the appropriate technology to move forward.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
