OpenJPA Documentaion should provide better navigation
-----------------------------------------------------

                 Key: OPENJPA-897
                 URL: https://issues.apache.org/jira/browse/OPENJPA-897
             Project: OpenJPA
          Issue Type: Improvement
            Reporter: Pinaki Poddar


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



-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

Reply via email to