Received: from localhost (unknown [200.46.204.182])
	by postgresql.org (Postfix) with ESMTP id B8B789FB301
	for <pgsql-docs-postgresql.org@postgresql.org>;
	Thu, 11 Oct 2007 04:45:48 -0300 (ADT)
Received: from postgresql.org ([200.46.204.71])
	by localhost (mx1.hub.org [200.46.204.182]) (amavisd-maia, port 10024)
	with ESMTP id 31451-09 for <pgsql-docs-postgresql.org@postgresql.org>;
	Thu, 11 Oct 2007 04:45:30 -0300 (ADT)
X-Greylist: from auto-whitelisted by SQLgrey-1.7.5
Received: from sd-2317.dedibox.fr (sd-2317.dedibox.fr [88.191.17.192])
	by postgresql.org (Postfix) with ESMTP id D1ACD9FA517
	for <pgsql-docs@postgresql.org>; Thu, 11 Oct 2007 04:45:43 -0300 (ADT)
Received: from sd-2317.dedibox.fr (localhost.localdomain [127.0.0.1])
	by sd-2317.dedibox.fr (Postfix) with ESMTP id 4AD2AC4AF;
	Thu, 11 Oct 2007 09:45:39 +0200 (CEST)
Received: from [192.168.10.1]
	(ASte-Genev-Bois-153-1-56-83.w81-249.abo.wanadoo.fr [81.249.150.83])
	by sd-2317.dedibox.fr (Postfix) with ESMTP id 04DB3C4AB;
	Thu, 11 Oct 2007 09:45:38 +0200 (CEST)
Message-ID: <470DD549.40307@lelarge.info>
Date: Thu, 11 Oct 2007 09:48:25 +0200
From: Guillaume Lelarge <guillaume@lelarge.info>
User-Agent: Thunderbird 2.0.0.6 (X11/20071008)
MIME-Version: 1.0
To: Albert Cervera i Areny <albert@nan-tic.com>
CC: pgsql-docs@postgresql.org
Subject: Re: Tips needed for contrib doc
References: <200710102315.50067.albert@nan-tic.com>
In-Reply-To: <200710102315.50067.albert@nan-tic.com>
Content-Type: text/plain; charset=ISO-8859-15
Content-Transfer-Encoding: 8bit
X-Virus-Scanned: ClamAV using ClamSMTP
X-Virus-Scanned: Maia Mailguard 1.0.1
X-Archive-Number: 200710/36
X-Sequence-Number: 4457

Hi,

Albert Cervera i Areny a écrit :
> 	I wanted to spend a week or so putting the contrib doc into shape so I want 
> to start by moving the contrib part from a new appendix to the Reference 
> part.
> 	The problems I find are:
> 	- I can't make this "contrib" doc a part because Reference already is a part 
> and can't be nested.
> 	Structure:
> 	<part id="reference">
> 		<part id="contrib">
> 		
> 	- If I make the contrib doc a chapter in the index shows with an arabic 
> number not as a roman one.
> 	Structure:
> 	<part id="reference">
> 		<chapter id="contrib">
> 
> 	- I can't make the doc a <reference> because first I need to point to the 
> modules and not all of them are documented like a reference.
> 	Structure:
> 	<part id="reference">
> 		<reference id="contrib">
> 

I think this is the better way to do it. Even if it means to rewrite the
README to look like a reference.

> 	- If I leave it as it is now [1] the problem is that very small chapters just 
> don't look right IMHO. Take a look at [2], for example. It should be a module 
> per page in most cases except very long ones.
> 	Structure:
> 	<part id="contrib">
> 		<chapter id="adminpack">
> 
> Does anyone have a solution on this? I'm no docbook expert, so I might be very 
> wrong.
> 

The only (or simplest) way to have one page per module is to use the
reference part.

Regards.


-- 
Guillaume.
 http://www.postgresqlfr.org
 http://dalibo.com