[
https://issues.apache.org/jira/browse/OFBIZ-2133?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12671514#action_12671514
]
Bruno Busco commented on OFBIZ-2133:
------------------------------------
Hi Jacques,
I have spent some time to find a way to integrate in the best way the help
pages that are being developed on Confluence into OFBiz.
And this is what I did find.
The best would be to be IMO to periodically export the END-USER space in HTML,
put all this content in an help component, zip everything and put back on a
Confluence page.
Users could download this zip file and install it in the hot-deploy.
This should be all a user should do to install an updated help.
The solution in the patch, at the moment, is not so versatile but I do not know
how to do what I have described.
It would be great to have help in doing it.
> Linking End User Documentation to OFBiz
> ---------------------------------------
>
> Key: OFBIZ-2133
> URL: https://issues.apache.org/jira/browse/OFBIZ-2133
> Project: OFBiz
> Issue Type: New Feature
> Reporter: Bruno Busco
> Attachments: AccountingHelpLinks.patch
>
>
> I have seen that several updates are in progress in this
> http://docs.ofbiz.org/display/OFBIZ/End+User+Documentation
> area of Confluence.
> Specially the Accounting application seems going to be described with a
> one-to-one help page to OFBiz screens.
> This is great and I think that having those pages linked to the relative
> OFBiz screens will be usefull and will also encourage more people to create
> (and _fill_) more documentation pages.
> What is attached to this issue is a simple patch that creates this link using
> the "titleProperty" field.
> It makes no use of the help request that is defined in the framework but uses
> an even simpler mechanism.
> I would like to discuss this pattern, it is a first trial and I am not sure
> it will be OK for every case.
> What I was also considering is to have the AccountingHelpUiLabels.xml file
> not committed but attached to the Confluence documentation main page.
> In this way who updates the documentation can update this "index" file also.
> Who is interested in using the onlline documentation will download this file
> and install infor OFBiz.
> Who is interested to have a local copy of the help can consider using the
> export space function present in Confluence.
> This creates a complete static HTML copy of the documentation. A specific
> version of the AccountingHelpUiLabels.xml can be used to access to this
> exported copy.
> What do you think?
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
