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

Re: Tips needed for contrib doc

From: Guillaume Lelarge <guillaume(at)lelarge(dot)info>
To: Albert Cervera i Areny <albert(at)nan-tic(dot)com>
Cc: pgsql-docs(at)postgresql(dot)org
Subject: Re: Tips needed for contrib doc
Date: 2007-10-11 07:48:25
Message-ID: 470DD549.40307@lelarge.info (view raw or flat)
Thread:
Lists: pgsql-docs
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

In response to

Responses

pgsql-docs by date

Next:From: Tom LaneDate: 2007-10-11 14:08:46
Subject: Re: Tips needed for contrib doc
Previous:From: Neil ConwayDate: 2007-10-10 21:39:08
Subject: Re: Last patch

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