OFBiz
  1. OFBiz
  2. OFBIZ-2133

Linking End User Documentation to OFBiz

    Details

    • Type: New Feature New Feature
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: Release Branch 09.04
    • Component/s: None
    • Labels:
      None

      Description

      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?

      1. help.patch
        0.8 kB
        Bruno Busco
      2. help.zip
        634 kB
        Bruno Busco
      3. help.patch
        9 kB
        Bruno Busco
      4. help.patch
        13 kB
        Bruno Busco

        Issue Links

          Activity

          Bruno Busco created issue -
          Bruno Busco made changes -
          Field Original Value New Value
          Attachment AccountingHelpLinks.patch [ 12398273 ]
          Bruno Busco made changes -
          Assignee Bruno Busco [ bruno.busco ]
          Bruno Busco made changes -
          Status Open [ 1 ] In Progress [ 3 ]
          Bruno Busco made changes -
          Fix Version/s Release Branch 9.3 [ 12313602 ]
          Bruno Busco made changes -
          Attachment AccountingHelpLinks.patch [ 12398273 ]
          Bruno Busco made changes -
          Attachment help.patch [ 12400016 ]
          Attachment help.zip [ 12400017 ]
          Bruno Busco made changes -
          Attachment help.patch [ 12400228 ]
          Bruno Busco made changes -
          Status In Progress [ 3 ] Open [ 1 ]
          Bruno Busco made changes -
          Attachment help.patch [ 12400653 ]
          Bruno Busco made changes -
          Status Open [ 1 ] Closed [ 6 ]
          Resolution Fixed [ 1 ]
          Gavin made changes -
          Workflow jira [ 12450602 ] OFbiz Workflow [ 12506277 ]
          BJ Freeman made changes -
          Link This issue relates to OFBIZ-2219 [ OFBIZ-2219 ]

            People

            • Assignee:
              Bruno Busco
              Reporter:
              Bruno Busco
            • Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development