OpenJPA
  1. OpenJPA
  2. OPENJPA-897

OpenJPA Documentaion should provide better navigation

    Details

    • Type: Improvement Improvement
    • Status: Open
    • Priority: Major Major
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: None
    • Labels:
      None

      Description

      Navigating from Table of Contents in OpenJPA web-based documentation is not very user-friendly. On the chunked version, you click a topic link in TOC and you go to a new page altogether.
      It can be easier if TOC topics always appeared in a left-sided Navigational Panel.
      With my very limited skill on such matters, I have assembled a draft solution based on HTML Frame. Given that HTML Frames are not always supported by a browser, the fallback option is what it used to be.
      The changes can be found in [1,2].

      Because what is a 'user-friendly' navigation style of web-based document is a pretty subjective choice, please check if you prefer this new style or not.

      If I hear lots of nays, the change will be rolled back.

      Even if the style is accepted, given my very limited knowledge of XSL, HTML and other animals found in the web, some of you may suggest a much better way of achieving the same purpose.

      [1] http://svn.apache.org/viewvc?view=rev&revision=740805
      [2] http://cwiki.apache.org/confluence/pages/diffpagesbyversion.action?pageId=23626&originalVersion=19&revisedVersion=20

        Activity

        Pinaki Poddar created issue -

          People

          • Assignee:
            Unassigned
            Reporter:
            Pinaki Poddar
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:

              Development