Re: Tips needed for contrib doc - Mailing list pgsql-docs

From Albert Cervera i Areny
Subject Re: Tips needed for contrib doc
Date
Msg-id 200710122004.44884.albert@nan-tic.com
Whole thread Raw
In response to Re: Tips needed for contrib doc  (Peter Eisentraut <peter_e@gmx.net>)
Responses Re: Tips needed for contrib doc
List pgsql-docs
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

pgsql-docs by date:

Previous
From: Peter Eisentraut
Date:
Subject: Re: Tips needed for contrib doc
Next
From: Ian Barwick
Date:
Subject: FAQ corrections