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

[Nicolas Malin (Jira)]

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

David E. Jones commented on OFBIZ-2133:
---------------------------------------

servletContext.getContextPath()

or if you only have a request object: request.getSession().getServletContext().getContextPath()

> 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: help.patch, help.zip
>
>
> 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.

[Nicolas Malin (Jira)]

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

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

    Attachment: help.patch

> 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: help.patch, help.patch, help.zip
>
>
> 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.

[Nicolas Malin (Jira)]

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

Bruno Busco commented on OFBIZ-2133:
------------------------------------

Thank you David,
at the end I decided to use the webSiteId in the help topic key.
I hope this is OK.
I found defining webSiteId for ALL webapp usefull for both the help link issue and to associate the VisualThemeSet to webapp (a different issue).

Please find attached a new patch in which I implemented the online help links as agree (I hope so).

Basically I created a CommonHelpUrls.xml file in the framework that should be used to define the help url prefix, suffix and the "HelpPageNotFound" page.
Having the prefix and suffix in a localization file will let us to link localized help pages that could be distinguished by a prefix in the URL or a suffix.

I have linked some of the pages available on the Open of OFBiz Confluence site so that OOTB OFBiz help will be get from docs.ofbiz.org.
More page links will come if we agree on this pattern and commit 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
>            Assignee: Bruno Busco
>             Fix For: Release Branch 9.3
>
>         Attachments: help.patch, help.patch, help.zip
>
>
> 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.

[Nicolas Malin (Jira)]

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

Bruno Busco commented on OFBIZ-2133:
------------------------------------

Just to inform who will test this patch that now the file help.zip is not needed. The "help.patch" works by alone. I do not delete help.zip because it could be usefull for further improvements.

> 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: help.patch, help.patch, help.zip
>
>
> 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.

[Nicolas Malin (Jira)]

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

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

    Attachment: help.patch

An updated help.patch file with:
- The complete links of all lately added Accounting help pages
- A more reused code solution (both default and bluelight themes include a single helplink.ftl file that is responsible for help link calculation)

> 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: help.patch, help.patch, help.patch, help.zip
>
>
> 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.

[Nicolas Malin (Jira)]

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

Jacques Le Roux commented on OFBIZ-2133:
----------------------------------------

I see that Sharan is regularly updating the accouting documentation (actually it's not final draft, just a work in progress, but even OFBiz trunk gives the same feeling nowadays ;o). Maybe we could ask her to update also the help links when she creates/updated wiki pages. I'm not sure she is aware of this help effort...

> 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: help.patch, help.patch, help.patch, help.zip
>
>
> 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.

[Nicolas Malin (Jira)]

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

Jacques Le Roux commented on OFBIZ-2133:
----------------------------------------

Thanks Bruno,

Your last patch is in trunk  at revision: 748884  

I did not close as I don't know if you want to put more effort on this, and especially in this issue or a new one.

Also I have [asked Sharan|http://docs.ofbiz.org/display/OFBIZ/Accounting-+Module+-in+progress?focusedCommentId=6758#comment-6758]  to update the AccountingHelpUrls.xml file as much as she can.

> 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: help.patch, help.patch, help.patch, help.zip
>
>
> 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.

[Nicolas Malin (Jira)]

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

Bruno Busco closed OFBIZ-2133.
------------------------------

    Resolution: Fixed

Thank you Jacques,
I think it is better to close it. This was scheduled to release 9.3 and we should have a clear picture of what is still to do to release it. (open issues scheduled for 9.3)

> 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: help.patch, help.patch, help.patch, help.zip
>
>
> 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.