Skip site navigation (1) Skip section navigation (2)

Re: Docs with index

From: "Richard Huxton" <dev(at)archonet(dot)com>
To: "Peter Eisentraut" <peter_e(at)gmx(dot)net>, <pgsql-docs(at)postgresql(dot)org>
Subject: Re: Docs with index
Date: 2001-04-03 08:41:39
Message-ID: 00cf01c0bc19$ecda2ee0$1001a8c0@archonet.com (view raw or flat)
Thread:
Lists: pgsql-docs
From: "Peter Eisentraut" <peter_e(at)gmx(dot)net>

> I've added some index entries to the user's guide as exploration.  The
> result can be seen at
>
> http://www.postgresql.org/~petere/doc-with-index/bookindex.html
>
> The patch is at
>
> http://www.postgresql.org/~petere/doc-with-index/patch
>
> Comments are welcome as to whether this seems useful, and if so, about the
> selection of the index entries.  (There need to be more, of course.)

Very useful indeed.

The categories seem right to me. Looks like you've got:

1. types (integer, date)
2. keywords (limit, where)
3. concepts (joins, operators)

Can't think of any other categories, just more entries in each. I think it
might prove useful to identify weaknesses in the docs since if it doesn't
index well it probably needs reworking.

The only thing that struck me was the fact that lines like "see macaddr"
aren't clickable, but presumably that's down to the stylesheet.

Again - if I can be of any use, just holler.

- Richard Huxton


In response to

Responses

pgsql-docs by date

Next:From: Peter EisentrautDate: 2001-04-03 16:28:42
Subject: Re: Docs with index
Previous:From: Bruce MomjianDate: 2001-04-02 22:06:12
Subject: Internals diagrams

Privacy Policy | About PostgreSQL
Copyright © 1996-2014 The PostgreSQL Global Development Group