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

Re: Documentation

From: Dave Page <dpage(at)pgadmin(dot)org>
To: Guillaume Lelarge <guillaume(at)lelarge(dot)info>
Cc: pgadmin-hackers <pgadmin-hackers(at)postgresql(dot)org>
Subject: Re: Documentation
Date: 2010-09-24 08:39:31
Message-ID: AANLkTi=R+407k+rmNOWkdzFwoCtrS27cc3ozZigQ+RJz@mail.gmail.com (view raw or flat)
Thread:
Lists: pgadmin-hackers
On Fri, Sep 24, 2010 at 9:29 AM, Guillaume Lelarge
<guillaume(at)lelarge(dot)info> wrote:
> Documentation for pgAdmin is really weak right now. Just to take an
> example, I don't know where a plugin file is described.
>
> The real question is how we do this. Right now, the documentation is a
> set of HTML files. Which is fine for some people and not for others.
> Kind of hard to get a consistent style. Kind of hard to get a good PDF
> and CHM file out of it. Not sure we really need these formats, I'm sure
> we want a consistent style.
>
> The only way to get all these options, AFAICT, is to use Docbook. SGML
> or XML. I have no problem working with Docbook, but I'm not sure
> everyone feels the same. I really prefer XML because of the toolset we
> can use (which seems, at least to me, in much better shape than the SGML
> one).
>
> Anyone has better ideas?

Yeah, I was looking at this the other day, but ran out of time.
Looking at using Sphinx (http://sphinx.pocoo.org/).

I really don't want to use SGML or XML.

-- 
Dave Page
Blog: http://pgsnake.blogspot.com
Twitter: @pgsnake

EnterpriseDB UK: http://www.enterprisedb.com
The Enterprise Postgres Company

In response to

Responses

pgadmin-hackers by date

Next:From: Guillaume LelargeDate: 2010-09-24 08:39:53
Subject: Re: gitignore
Previous:From: Magnus HaganderDate: 2010-09-24 08:38:20
Subject: Re: Documentation

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