Re: [PHP-DEV] Re: "waldschrotts guide to nifty references" - manual page draft, version 0.9b From: eschmid+sic <email protected>
Date: 08/20/00

On Sun, Aug 20, 2000 at 09:45:49PM +0200, André Langhorst wrote:
> > AL>> Checked it out. If we both merge our stuff we?ll possibly
> > AL>> target all the important things to know about, I?d like to merge
> > AL>> your doc into mine cause it?s not regarding all of the discussed things
> > AL>> (at least not circular ones)...
> > AL>> How do we continue? Do you want to take the task...
> >
> > Well, I've put it already in the manual (visible at least at
> > www.zend.com/manual/) and I'll integrate some parts of your doc there. You
> > are free to take whtever part of this and add to your doc (which I see is
> > meant to be more like tutorial or HOWTO).
>
> I´d now like to rewrite my whole page, according to your "bug-reports",
> but where do I put it then.
> We have two lines of people out there (correct me if I´m wrong):

Please keep this discussion on the phpdoc list.
 
> a) the one you belong to, manual should be minimalistic and reference only,
> basic idea, provide information for the experienced user as fast as possible,
> no examples or few and short ones
> b) the one I belong to (matching with Rasmus,Hartmut,Ron...I think), manual
> should not contain as less information as possible, basic idea, help the
> users as much as possible, thorough examples do not hurt

We don't have two lines of people. We have two editors. And one of the
editors believes that the manual should be as complete as in every book
you can buy now.

Stas can you update Hartmuts functions tables? There is a statistics page
which shows very clearly where the problem is. Many functions don't have
protos. If there is a proto, one can generate the XML for the function
reference. It is then sometimes useless because minimalistic.

Another problem is with the online and printed manual. The printed manual
is now not very usefull because it lacks an index.

> well, I don´t know what to do, sure I won´t overwrite your reference guide,
> although I don´t think it´s that user-friendly, we don´t have two manuals,
> proposals?

The function reference is the most valuable part in the manual. You will
see this propably never in a book. Unfortunately there is a German book
with 300 pages translated from the manual. I hope it will be stopped ASAP.

-Egon 

-- 
http://www.linuxtag.de/
http://php.net/books.php 
http://www.concert-band.de/

-- 
PHP Development Mailing List <http://www.php.net/>
To unsubscribe, e-mail: php-dev-unsubscribe <email protected>
For additional commands, e-mail: php-dev-help <email protected>
To contact the list administrators, e-mail: php-list-admin <email protected>