pg.ddx.io pgsql-docs@postgresql.org mailing list archive
help / color / mirror / Atom feedRFC - Navigation menu for documents (2nd attempt)
3+ messages / 3 participants
[nested] [flat]
* RFC - Navigation menu for documents (2nd attempt)
@ 2010-02-19 14:37 Richard Huxton <dev@archonet.com>
0 siblings, 0 replies; 3+ messages in thread
From: Richard Huxton @ 2010-02-19 14:37 UTC (permalink / raw)
To: pgsql-docs; +Cc: Andrew Dunstan <andrew@dunslane.net>
Previous copy of this hasn't appeared, presumably because of the
attachment (under 8KB but tar.gz). Link to attachment below:
http://www.archonet.com/pg_js_manual.tgz
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.
--
Richard Huxton
Archonet Ltd
^ permalink raw reply [nested|flat] 3+ messages in thread
* https://www.postgresql.org/docs/13/tutorial-join.html missing a table
@ 2020-10-18 20:13 PG Doc comments form <noreply@postgresql.org>
0 siblings, 1 reply; 3+ messages in thread
From: PG Doc comments form @ 2020-10-18 20:13 UTC (permalink / raw)
To: pgsql-docs@lists.postgresql.org; +Cc: brdmster@gmail.com
The following documentation comment has been logged on the website:
Page: https://www.postgresql.org/docs/13/tutorial-join.html
Description:
This page references a "cities" table, but not prior page showed this table.
Suggest adding a new "cities" table on this page.
^ permalink raw reply [nested|flat] 3+ messages in thread
* Re: https://www.postgresql.org/docs/13/tutorial-join.html missing a table
@ 2020-10-18 23:07 David G. Johnston <david.g.johnston@gmail.com>
parent: PG Doc comments form <noreply@postgresql.org>
0 siblings, 0 replies; 3+ messages in thread
From: David G. Johnston @ 2020-10-18 23:07 UTC (permalink / raw)
To: brdmster@gmail.com, Pg Docs <pgsql-docs@lists.postgresql.org>
On Sun, Oct 18, 2020 at 2:29 PM PG Doc comments form <noreply@postgresql.org>
wrote:
> The following documentation comment has been logged on the website:
>
> Page: https://www.postgresql.org/docs/13/tutorial-join.html
> Description:
>
> This page references a "cities" table, but not prior page showed this
> table.
> Suggest adding a new "cities" table on this page.
>
It's created in the "Create a New Table" section, along with weather, and
that seems sufficient.
David J.
^ permalink raw reply [nested|flat] 3+ messages in thread
end of thread, other threads:[~2020-10-18 23:07 UTC | newest]
Thread overview: 3+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2010-02-19 14:37 RFC - Navigation menu for documents (2nd attempt) Richard Huxton <dev@archonet.com>
2020-10-18 20:13 https://www.postgresql.org/docs/13/tutorial-join.html missing a table PG Doc comments form <noreply@postgresql.org>
2020-10-18 23:07 ` Re: https://www.postgresql.org/docs/13/tutorial-join.html missing a table David G. Johnston <david.g.johnston@gmail.com>
This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox