Message-ID: <4AC46468.7010307@archonet.com>
Date: Thu, 01 Oct 2009 09:12:24 +0100
From: Richard Huxton <dev@archonet.com>
User-Agent: Thunderbird 2.0.0.23 (X11/20090817)
MIME-Version: 1.0
To: "David E. Wheeler" <david@kineticode.com>
CC: Andrew Dunstan <andrew@dunslane.net>,
	Alvaro Herrera <alvherre@commandprompt.com>,
	Peter Eisentraut <peter_e@gmx.net>, pgsql-hackers@postgresql.org,
	Dimitri Fontaine <dfontaine@hi-media.com>
Subject: Re: navigation menu for documents
References: <4A5CE7EB.20809@pgexperts.com> <4A5D10AD.6060305@dunslane.net>
	<4A5D1464.4040202@archonet.com>
	<200907151333.02260.peter_e@gmx.net> <4A607573.60904@archonet.com>
	<20090929151548.GD6116@alvh.no-ip.org>
	<4AC22933.2030701@dunslane.net> <4AC22DE5.8060805@archonet.com>
	<7E8F774C-0F55-4512-BC04-A38CA8358DBE@kineticode.com>
In-Reply-To: <7E8F774C-0F55-4512-BC04-A38CA8358DBE@kineticode.com>
Content-Type: text/plain; charset=ISO-8859-1
Content-Transfer-Encoding: 7bit

David E. Wheeler wrote:
> On Sep 29, 2009, at 8:55 AM, Richard Huxton wrote:
> 
>> For the browser, does the following match what you're after, Andrew?
>> - clicking chapter title opens the browser panel
>> - panel stays open until you click close icon
>> - panel contains collapsable tree of chapter/section headings
>> Alternatively, could just auto-open the browser panel if javascript is
>> enabled and window is wider than N pixels.
> 
> Why wouldn't the entire TOC be in a collapsed list?

Permanently on-screen? My only concern there would be for people viewing
on phones etc.

>> In addition we'll presumably want to meet:
>> - no external js libraries (or do we care, if we just reference it from
>> google?)
> 
> Save yourself the hassle and just bundle jQuery. That's what I've done
> for Pod::Site (module that builds the Bricolage API browser).

It's MIT licensed (well MIT+GPL) which is BSD compatible, but I don't
know if that's acceptable. It would be easier for me if it could be
bundled and presumably make it easier for other contributors in the
future too.

>> - navigation is optional, disabling js leaves docs as at present
> 
> As long as there's a way to get the nav back from a link on each doc page.
> 
>> - works on all reasonable browsers (anything not IE6)
> 
> +1 (IE6--)
> 
>> - works online and in downloaded docs (except Windows .chm of course)
> 
> That'd be nice, too.

Offline is crucial as far as I'm concerned.

-- 
  Richard Huxton
  Archonet Ltd