Re: #PEAR IRC channel

Martin Jansen wrote: > > On Wed, 10 Oct 2001 13:07:05 +0200, Tomas V.V.Cox wrote: > > >Perhaps we could setup a IRC meeting to talk about Pear & Documentation. > > Unfortuantely I have no chance to stay in IRC for a long time > (expensive dial-up connection @home), so I would prefer to keep > the discussion on this list :-). Oh, that's a pitty. > >- How to document Pear Classes/Apps? Covering formats > > Docbook, Docbook, Docbook :-) I'm in favor of DocBook too, but only if we provide a template, tools and minimal instructions for it. > >- Where to put doc for packages? Covering where to put docs in packages > >and where this doc should be installed. > > The documentation should be placed on pear.php.net/manual or something > equal. I think, a directory 'documentation' in the tgz file of each > package is a good place to store it. I was refering more where to put this doc after a package installation (for all the files marked as role="doc" in package.xml). The idea could be to setup a new php constant PEAR_DOC_DIR. There we could place docs in a flat structure (like the one we have in the "pear" module): PEAR_DOC_DIR | +-Net_Ping +-Net_NNTP +-... > >- Where to put doc for classes under php4/pear/? > > I think they can also be put on pear.php.net. For this, we could build a new package in CVS (as you proposed) for ex: pear/peardoc (I'll prefer the "pear" module). This will be a real package which will contain doc for classes under php4/pear. > >- How the doc will be displayed in pear.php.net? > > The PHP-GTK documentation (http://gtk.php.net/manual/en) and > the PHP Manual are the best examples IMO :). Yes, but we need to decide where to put it in the pearweb space, how to link it, how to display it, needed scripts, ... Tomas V.V.Cox