ofbiz-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Sharan Foga (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (OFBIZ-6450) Docbook and OFBIz Online Help
Date Mon, 08 Jun 2015 06:48:01 GMT

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

Sharan Foga commented on OFBIZ-6450:
------------------------------------

Hi Taher (and everyone)

Yesterday I had a bit of brainwave – I think.

The humanres.xml file that I have included as an attachment is a complete docbook file that
can be rendered by Webhelp.  The processing is context sensitive so the correct screen help
displays depending on which screen you are on.

What we have been doing in the past for the OFBiz online help by including it in Content Manager
is creating a new xml file for each individual screen and then linking them all together and
building a content structure around them all. 

I dont think we need to do that at all and in fact to keep it extremely simple all we really
need is one docbook file per application (e.g like the humanres.xml) that contains the details
for all of the screens. This means that it is centralised in one place rather than spread
out in separate files.

We could display it using the webhelp rather than OFBiz Content Manager. My understanding
is that webhelp is already there in OFBiz – it just needs to be enabled. 

I'll do some more investigation but am keen to hear what you or other people think.

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

Mime
View raw message