pg.ddx.io  pgsql-docs@postgresql.org mailing list archive  
help / color / mirror / Atom feed
From: Albert Cervera i Areny <albert@nan-tic.com>
To: pgsql-docs@postgresql.org
Subject: Tips needed for contrib doc
Date: Wed, 10 Oct 2007 23:15:49 +0200
Message-ID: <200710102315.50067.albert@nan-tic.com> (raw)

Hi,
	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">

	- 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.

[1] You can find the current state at 
http://www.nan-tic.com/ftp/pgdoc-0.0.2/index.html
[2] http://www.nan-tic.com/ftp/pgdoc-0.0.2/adminpack.html

-- 
Albert Cervera i Areny
http://www.NaN-tic.com



view thread (13+ messages)  latest in thread

Message-ID: <200710102315.50067.albert@nan-tic.com>
Permalink:  ../200710102315.50067.albert@nan-tic.com/
Also on:    postgresql.org/message-id/200710102315.50067.albert@nan-tic.com

 · 

reply

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
  Subject: Re: Tips needed for contrib doc
  In-Reply-To: <200710102315.50067.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