[jira] Updated: (OFBIZ-2133) Linking End User Documentation to OFBiz

["Bruno Busco (JIRA)" <ji...@apache.org>]

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

Bruno Busco updated OFBIZ-2133:
-------------------------------

    Fix Version/s: Release Branch 9.3

I am working to have a simple hot-deplyable application containing an html export from the End User Documentation Confluence area.
This will be ready hopefully soon.

BTW we should think to better organize the Open End User Documentation in order to have the export easier.
I would suggest to have a public writable Confluence space enterely dedicated to the End User Doc that we want to export and have available locally with links from OFBiz screens.
This would make the periodic export painless.
All pages in this space should follow the structure of OFBiz application screens (like the recently added pages).


> 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
>            Assignee: Bruno Busco
>             Fix For: Release Branch 9.3
>
>         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.