Re: Re: Pear documentation

From: Date: Wed, 10 Oct 2001 19:27:29 +0000
Subject: Re: Re: Pear documentation
References: 1  Groups: php.pear.dev 
Request: Send a blank email to pear-dev+get-2246@lists.php.net to get a copy of this message
hm maybe i'm out sailing (or whatever expression you use ;o) but why not put up some php-pages that let's you edit the manual. you click on your API and then you can ADD function-page. NICE_API --------- $this->getData($param); This function gets some data $this->getData("apples"); and that's it, isn't it? i mean, on the add-page you have, FUNCTION_NAME DESCRIPTION EXAMPLE where EXAMPLE is optional. or am i missing something very important here? i mean, these webpages could then convert the data it have into DocBooks or whatever really.. hm my $0.02 / d "Martin Jansen" <mail@martin-jansen.de> wrote in message news:php.pear.dev-2215@news.php.net... > 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. > > >(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 :-). > > - Martin > >

« previous php.pear.dev (#2246) next »