Re: [Fwd: RFC - Navigation menu for documents] - Mailing list pgsql-www

Certainly looks interesting and as long as it doesn't break the non-js
experience completely (which from what I can tell it shouldn't do, but
I haven't actually tested it yet) I don't see why we shouldn't add
something like this. It would certainly be very helpful.

I'll stick it on my TODO to have a deeper look at it :-) Hopefully, my
TODO won't be dropped on the flor...

//Magnus

On Tue, May 25, 2010 at 14:21, Andrew Dunstan <andrew@dunslane.net> wrote:
>
> Sending without an attachment this time. The gadget can be found at
> <http://www.archonet.com/pg_js_manual.tgz>
>
> I *really* hope this doesn't just get dropped on the floor. If we're
> interested in it, then I know Taras is also interested in tweaking it.
>
> cheers
>
> andrew
>
> Andrew Dunstan wrote:
>>
>> Has anyone looked at incorporating this in our online docs? It's really
>> quite nifty and makes the docs a lot more user-friendly IMNSHO.
>>
>>
>> -------- Original Message --------
>> Subject:     RFC - Navigation menu for documents
>> Date:     Fri, 19 Feb 2010 13:46:52 +0000
>> From:     Richard Huxton <dev@archonet.com>
>> To:     pgsql-docs@postgresql.org
>> CC:     Andrew Dunstan <andrew@dunslane.net>
>>
>>
>>
>> Andrew Dunstan mentioned a folding table-of-contents facility for the
>> manuals some time ago. I've had a few minutes to tweak my last attempt and I
>> think it's time to decide what to do with it.
>>
>> Objectives:
>> - Make it easier to navigate our (now very long) manual
>> - Make it easier to provide links on the mailing-lists (my bugbear)
>> - Not get in the way if not wanted
>>
>> Features:
>> - Contents panel on LHS, can slide off screen if wanted
>> - Automatically slid off screen on narrow displays
>> - Nested tree controls
>> - Automatically opens tree to currently displayed page
>> - Search-box displayed on A-Z index page (below contents box)
>>  I'm surprised at how much better this is than Ctrl+F
>> - Mailing-list links next to each heading
>>  So you can right-click+copy the url to the "master" copy of the docs
>>
>> Dependencies:
>> - local (writable) copy of the html docs
>> - Perl for installation
>> - wget for installation
>> - jquery (fetched using wget, MIT licence)
>> - Assumes developer (cvs) version of docs
>>  See lines 115/6 of html/contents.js if you want to reference the 8.4 docs
>>
>> Installation:
>> cd /dir/above/html/docs
>> tar -xzf pg_js_manual.tgz
>> ./bin/INSTALL
>>
>> Testing:
>> - Firefox 3.6
>> - Internet Explorer 7
>> - Safari (4?)
>> - Opera 9
>> - Sluggish on a phone, but fine on a 5-year old laptop
>> - Obvious optimisations done - not sure there's much more to be gained
>>
>> Where do we go from here?
>> 1. We can make use of some/all of this on the main site.
>> 2. Add it as a contrib/ project
>> 3. Put it on pgfoundry
>>
>> I'll probably do #3 anyway in case someone else is interested in working
>> on it.
>>
>
> --
> Sent via pgsql-www mailing list (pgsql-www@postgresql.org)
> To make changes to your subscription:
> http://www.postgresql.org/mailpref/pgsql-www
>



-- Magnus HaganderMe: http://www.hagander.net/Work: http://www.redpill-linpro.com/