From: Albert Cervera i Areny <albert@nan-tic.com>
To: Peter Eisentraut <peter_e@gmx.net>
Cc: pgsql-docs@postgresql.org
Subject: Re: Tips needed for contrib doc
Date: Fri, 12 Oct 2007 20:04:44 +0200
Message-ID: <200710122004.44884.albert@nan-tic.com> (raw)
In-Reply-To: <200710121947.15037.peter_e@gmx.net>
References: <200710102315.50067.albert@nan-tic.com>
<200710121947.15037.peter_e@gmx.net>
Not that I want to make each module a reference. With previous discussions we
seemed to agree that:
- It should go into the References part of the documentation (right
after "III. PostgreSQL Server Applications).
- Each module docs should be in a single page, mainly because some contrib
modules have/require very little documentation.
So it seems that the only way of achieving both things is to make each contrib
module a <refentry> inside a new <reference id="contrib">. I don't like this
idea, among other things because dblink won't be abe to be treated as a
<reference> which I think is appropiate in this case.
If you've got another solution for this, it'll be very welcome!
A Divendres 12 Octubre 2007, Peter Eisentraut va escriure:
> Am Mittwoch, 10. Oktober 2007 schrieb Albert Cervera i Areny:
> > - I can't make this "contrib" doc a part because Reference
> > already is a part and can't be nested.
>
> The Reference things in DocBook are mostly to support legacy man pages, and
> man pages are not necessary the greatest format to document everything.
> What is your reason that you want this as a reference rather than a part
> with chapters?
--
Albert Cervera i Areny
http://www.NaN-tic.com
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: albert@nan-tic.com, peter_e@gmx.net
Subject: Re: Tips needed for contrib doc
In-Reply-To: <200710122004.44884.albert@nan-tic.com>
* 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