You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@openjpa.apache.org by "Pinaki Poddar (JIRA)" <ji...@apache.org> on 2009/02/04 18:47:59 UTC
[jira] Created: (OPENJPA-897) OpenJPA Documentaion should provide
better navigation
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.
Re: [jira] Created: (OPENJPA-897) OpenJPA Documentaion should provide
better navigation
Posted by Kevin Sutter <kw...@gmail.com>.
I must have hit your window of opportunity... :-) It does display
correctly now (I was getting a 404 error).
Pinaki,
I personally don't use the individual page view, but I do like the TOC on
the side. Is there anyway to synch the viewed page with the TOC? That is,
suppose I follow several links and I found the information I was looking
for. But, now I am wondering where in the manual I really am. Part of this
confusion is because we have combined user and reference manual and the
section numbers overlap. But, it still would be handy.
Thanks,
Kevin
On Wed, Feb 4, 2009 at 2:46 PM, Michael Dick <mi...@gmail.com>wrote:
> Hi Kevin,
>
> Did you get a 404, or is it a case of the page not looking right? Pinaki
> mentioned his changes to me and I triggered an early build of the doc
> (normally it kicks off overnight). The build finished just after your email
> (around 2:37) so you might have just missed the page.
>
> I took a look a couple min ago and the page is there, but looks like it's
> missing some images.
>
> -mike
>
> On Wed, Feb 4, 2009 at 2:34 PM, Kevin Sutter <kw...@gmail.com> wrote:
>
> > Looks like the link to the manual isn't working right:
> >
> > http://openjpa.apache.org/builds/latest/docs/manual/main.html
> >
> >
> > On Wed, Feb 4, 2009 at 2:22 PM, Kevin Sutter <kw...@gmail.com> wrote:
> >
> > > Pinaki,
> > > Any attempt to improving our documentation navigation is welcomed, but
> I
> > > can't figure out how to view your proposed changes. Are you expecting
> us
> > to
> > > download your changes and re-build the documentation? Could you
> provide
> > a
> > > link to a pre-built version so that we could just "experience" it?
> > >
> > > Thanks,
> > > Kevin
> > >
> > >
> > > On Wed, Feb 4, 2009 at 11:47 AM, Pinaki Poddar (JIRA) <jira@apache.org
> > >wrote:
> > >
> > >> 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.
> > >>
> > >>
> > >
> >
>
Re: [jira] Created: (OPENJPA-897) OpenJPA Documentaion should provide
better navigation
Posted by Michael Dick <mi...@gmail.com>.
Hi Kevin,
Did you get a 404, or is it a case of the page not looking right? Pinaki
mentioned his changes to me and I triggered an early build of the doc
(normally it kicks off overnight). The build finished just after your email
(around 2:37) so you might have just missed the page.
I took a look a couple min ago and the page is there, but looks like it's
missing some images.
-mike
On Wed, Feb 4, 2009 at 2:34 PM, Kevin Sutter <kw...@gmail.com> wrote:
> Looks like the link to the manual isn't working right:
>
> http://openjpa.apache.org/builds/latest/docs/manual/main.html
>
>
> On Wed, Feb 4, 2009 at 2:22 PM, Kevin Sutter <kw...@gmail.com> wrote:
>
> > Pinaki,
> > Any attempt to improving our documentation navigation is welcomed, but I
> > can't figure out how to view your proposed changes. Are you expecting us
> to
> > download your changes and re-build the documentation? Could you provide
> a
> > link to a pre-built version so that we could just "experience" it?
> >
> > Thanks,
> > Kevin
> >
> >
> > On Wed, Feb 4, 2009 at 11:47 AM, Pinaki Poddar (JIRA) <jira@apache.org
> >wrote:
> >
> >> 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.
> >>
> >>
> >
>
Re: [jira] Created: (OPENJPA-897) OpenJPA Documentaion should provide
better navigation
Posted by Kevin Sutter <kw...@gmail.com>.
Looks like the link to the manual isn't working right:
http://openjpa.apache.org/builds/latest/docs/manual/main.html
On Wed, Feb 4, 2009 at 2:22 PM, Kevin Sutter <kw...@gmail.com> wrote:
> Pinaki,
> Any attempt to improving our documentation navigation is welcomed, but I
> can't figure out how to view your proposed changes. Are you expecting us to
> download your changes and re-build the documentation? Could you provide a
> link to a pre-built version so that we could just "experience" it?
>
> Thanks,
> Kevin
>
>
> On Wed, Feb 4, 2009 at 11:47 AM, Pinaki Poddar (JIRA) <ji...@apache.org>wrote:
>
>> 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.
>>
>>
>
Re: [jira] Created: (OPENJPA-897) OpenJPA Documentaion should provide
better navigation
Posted by Kevin Sutter <kw...@gmail.com>.
Pinaki,
Any attempt to improving our documentation navigation is welcomed, but I
can't figure out how to view your proposed changes. Are you expecting us to
download your changes and re-build the documentation? Could you provide a
link to a pre-built version so that we could just "experience" it?
Thanks,
Kevin
On Wed, Feb 4, 2009 at 11:47 AM, Pinaki Poddar (JIRA) <ji...@apache.org>wrote:
> 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.
>
>
Re: [jira] Created: (OPENJPA-897) OpenJPA Documentaion should provide
better navigation
Posted by Donald Woods <dw...@apache.org>.
Yep, it's working for me now with FF3 on Mac after forcing a page
refresh....
-Donald
Kevin Sutter wrote:
> Yep, Firefox on Windows XP...
>
> On Wed, Feb 4, 2009 at 4:02 PM, Michael Dick <mi...@gmail.com>wrote:
>
>> Seems to work for me - firefox on ubuntu 8.10 in case that matters.
>>
>> -mike
>>
>> On Wed, Feb 4, 2009 at 3:56 PM, Donald Woods <dw...@apache.org> wrote:
>>
>>> Is the left nav area working correctly for you?
>>> When I select "Part 2. Java Persistence API" the left frame changes, but
>>> not the right side....
>>>
>>>
>>> -Donald
>>>
>>>
>>>
>>> Pinaki Poddar (JIRA) wrote:
>>>
>>>> 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
>>>>
>>>>
>>>>
>
Re: [jira] Created: (OPENJPA-897) OpenJPA Documentaion should provide
better navigation
Posted by Kevin Sutter <kw...@gmail.com>.
Yep, Firefox on Windows XP...
On Wed, Feb 4, 2009 at 4:02 PM, Michael Dick <mi...@gmail.com>wrote:
> Seems to work for me - firefox on ubuntu 8.10 in case that matters.
>
> -mike
>
> On Wed, Feb 4, 2009 at 3:56 PM, Donald Woods <dw...@apache.org> wrote:
>
> > Is the left nav area working correctly for you?
> > When I select "Part 2. Java Persistence API" the left frame changes, but
> > not the right side....
> >
> >
> > -Donald
> >
> >
> >
> > Pinaki Poddar (JIRA) wrote:
> >
> >> 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
> >>
> >>
> >>
> >>
>
Re: [jira] Created: (OPENJPA-897) OpenJPA Documentaion should provide
better navigation
Posted by Michael Dick <mi...@gmail.com>.
Seems to work for me - firefox on ubuntu 8.10 in case that matters.
-mike
On Wed, Feb 4, 2009 at 3:56 PM, Donald Woods <dw...@apache.org> wrote:
> Is the left nav area working correctly for you?
> When I select "Part 2. Java Persistence API" the left frame changes, but
> not the right side....
>
>
> -Donald
>
>
>
> Pinaki Poddar (JIRA) wrote:
>
>> 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
>>
>>
>>
>>
Re: [jira] Created: (OPENJPA-897) OpenJPA Documentaion should provide
better navigation
Posted by Donald Woods <dw...@apache.org>.
Is the left nav area working correctly for you?
When I select "Part 2. Java Persistence API" the left frame changes, but
not the right side....
-Donald
Pinaki Poddar (JIRA) wrote:
> 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
>
>
>