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

Re: Documentation

From: Guillaume Lelarge <guillaume(at)lelarge(dot)info>
To: Magnus Hagander <magnus(at)hagander(dot)net>
Cc: Dave Page <dpage(at)pgadmin(dot)org>, pgadmin-hackers <pgadmin-hackers(at)postgresql(dot)org>
Subject: Re: Documentation
Date: 2010-09-24 10:13:37
Message-ID: 4C9C79D1.80400@lelarge.info (view raw or flat)
Thread:
Lists: pgadmin-hackers
Le 24/09/2010 11:59, Magnus Hagander a écrit :
> On Fri, Sep 24, 2010 at 11:16, Guillaume Lelarge <guillaume(at)lelarge(dot)info> wrote:
>> Le 24/09/2010 10:39, Dave Page a écrit :
>>> 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/).
>>>
>>
>> Seems interesting. Just at the same time, we (Dalibo) get rid of our
>> documents in ReST format, so I'll still have to work with it for pgadmin :-/
> 
> Why do you get rid of ReST, and what are you changing to?
> 

Not really because of ReST. Our real issue was the tool we used to build
HTML, PDF, etc. This tool was first written by dalibo, but nobody really
maintains it and it became more and more difficult to install it on
recent laptops. So, as you can see, not really an issue with ReST. And
we are changing to... dokuwiki. You surely know Damien felt in love with
this tool :)


-- 
Guillaume
 http://www.postgresql.fr
 http://dalibo.com

In response to

Responses

pgadmin-hackers by date

Next:From: Guillaume LelargeDate: 2010-09-24 10:22:34
Subject: Re: Documentation
Previous:From: Magnus HaganderDate: 2010-09-24 09:59:38
Subject: Re: Documentation

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