From: Tom Lane <tgl@sss.pgh.pa.us>
To: Peter Eisentraut <peter_e@gmx.net>
Cc: pgsql-general@postgresql.org
Cc: pgsql-docs@postgresql.org
Subject: Doc indexes (was Re: [GENERAL] Re: PostgreSQL vs Oracle vs DB2 vs MySQL - Which should I use?)
Date: Fri, 16 Feb 2001 12:04:16 -0500
Message-ID: <12290.982343056@sss.pgh.pa.us> (raw)
In-Reply-To: <Pine.LNX.4.30.0102161741290.1009-100000@peter.localdomain>
References: <Pine.LNX.4.30.0102161741290.1009-100000@peter.localdomain>
Peter Eisentraut <peter_e@gmx.net> writes:
> One thing we should try to do in the future (i.e., the next big attack I
> have on you) is to maintain a human-edited concept index for the docs,
> like every good non-fiction book has at the end. The technical details
> for this are mostly worked out, it just needs someone to compose a list of
> all "concepts" and find all the places where they're discussed.
The large documents I've done in the past (product manuals and such)
used automatic index generation in LaTeX. You add a tag to text that
needs an index entry:
To fix this problem, frobnitz the foobar<index>foobar</index>.
and then the index will have an entry for "foobar" that references this
page, along with any other pages where <index>foobar</index> appears.
<index>foobar</index> doesn't affect the visible text on the page
however.
Assuming that our SGML tools can do something similar, this would seem
like the way to go. Getting the docs marked up initially would be a
painful task, but once it's done it'd be relatively easy for doco
contributors to include appropriate index entries in new text.
I think an index that's maintained separately from the text proper would
be doomed to failure ...
regards, tom lane
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Reply to all the recipients using the --to and --cc options:
reply via email
To: pgsql-docs@postgresql.org
Cc: tgl@sss.pgh.pa.us, peter_e@gmx.net, pgsql-general@postgresql.org
Subject: Re: Doc indexes (was Re: [GENERAL] Re: PostgreSQL vs Oracle vs DB2 vs MySQL - Which should I use?)
In-Reply-To: <12290.982343056@sss.pgh.pa.us>
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
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