Re: Re: Pear documentation
| From: | Markus Fischer | Date: | Wed, 10 Oct 2001 07:19:15 +0000 |
| Subject: | Re: Re: Pear documentation | ||
| Groups: | php.pear.dev | ||
| Request: | Send a blank email to pear-dev+get-2220@lists.php.net to get a copy of this message | ||
On Wed, Oct 10, 2001 at 08:19:05AM +0200, Martin Jansen wrote :
> On Wed, 10 Oct 2001 01:19:50 +0200, Markus Fischer wrote:
>
> >Just adopt the existing standards. Ie, check out the current
> >php.net doc und pearify it. Or use php-gtk-doc. Or even ZendAPI
> >doc. All are using docbook.
>
> But Docbook still seems to be a problem for lots of people here.
> Quoting Bjoern Schotte:
>
> | ( .oO("Oh dear,
> | I have to learn DocBook, that's shit, I think I won't write any
> | tutorial, people should RTFM or die.") ).
>
> I also see this problem, that lots of people don't want to look into
> Docbook. We could perhaps avoid this by setting up a very simple
> skeleton for the developers, so they can easily Copy&Paste their
> documentation without having to learn Docbook.
Those who shall not learn docbook shall put up their contribution
in whatever form and we put it on pear.php.net; but for a serious
manual there's no way around docbook. We ]could[ write a 'idiots
guide' wrapper which covnerts from simpler ML syntax to docbook.
But I don't see such a problem. The number of people working on
the php manual is not that low; and they all had to get used to
docbook.
Don't we want to provide nifty docs in every thinable formats
from html to chm to pdf? At least, I want to.
> >(James
> >Moore comes into my mind but I'm sure there are others too)
>
> I approached James yesterday and the day before yesterday since I
> wanted to build the GTK Manual on my machine to see how the GTK
> guys solved the documentation problem. He answered some of my question
> but didn't answer on my last problem, which still prevents me from
> successfully building the manual :-).
Then look at ZendAPI (cvs.zend.com); it uses Jade and the manual
'compiles' out-of-the-box.
- Markus
--
Markus Fischer, http://guru.josefine.at/~mfischer/
EMail: mfischer@guru.josefine.at
PGP Public Key: http://guru.josefine.at/~mfischer/C2272BD0.asc
PGP Fingerprint: D3B0 DD4F E12B F911 3CE1 C2B5 D674 B445 C227 2BD0
-All your scripts are belong to Zend-