[PHP-DOC] phpdoc-HOWTO-mini -- Was: (Re: [PHP-DOC] cvs: phpdoc /en/functions oracle.xml) From: Daniel Beckham (danbeck <email protected>)
Date: 08/23/00

I have to say.. not only is the howto.xml and README out of date.. they
don't do a very good job of getting the new contributor started. I've been
here for some time and I only just got myself properly setup with emacs,
psgml and jade.

And on top of that.. the howto.xml is an... XML file. If you need to read
the howto in order to help you get started, you have to already know how to
make the howto! Which comes first the chicken or the egg?

I've been considering writing a new howto to help get new users started.
Something that pretty much step by step explains how to get psgml and the
doc tools installed, explains some basic emacs commands. (Meta-q is the
most helpful one I've ever seen. =) And then walks them through how to make
changes to a file, how to add new sections, how to 'make test' or 'make
html' to test their changes and then how to properly commit the document
into the repository.

This would be in addition to the current README and howto.xml documents.
I'm thinking "phpdoc-HOWTO-mini" would be appropriate.

What do people think of this? I'm willing to write the initial document if
other people are willing to critique me and offer suggestions from their own
experiences.

Daniel

----- Original Message -----
From: "Egon Schmid ( <email protected>)" <eschmid <email protected>>
To: <ron <email protected>>
Cc: <phpdoc <email protected>>
Sent: Wednesday, August 23, 2000 6:53 AM
Subject: Re: [PHP-DOC] cvs: phpdoc /en/functions oracle.xml

> Ron Chmara wrote:
> >
> > "Egon Schmid ( <email protected>)" wrote:
> > > > - Returns true on success, false on error. Details about the
error
> > > > + Returns true on success, false on error. Details about the
error
> > > This is not indentation its spacing. Emacs did it the correct American
> > > way. American typewriters are trained to hit two spaces after a every
> > > sentence. The opposit is the so called frenchspacing and is used in
> > > Europe.
>
> > Egon, is there a full fledged "PHP editorial style guide" we can use?
> > As in, standard tagging, spacing, example code conventions,
> > caps/no caps, etc. etc....
>
> There is a README and a howto.xml but both are not uptodate.
>
> > Or, maybe a better way to ask this:
> >
> > What is the best section so far, to use as an example when working on
> > the other sections?
>
> I don't know. I let XEmacs do the indentation so I see missing elements
> if a start or end element is missing. XEmacs does also a good job an
> reformating a whole paragraph to avoid long lines.
>
> -Egon
>
> --
> SIX Offene Systeme GmbH · Stuttgart - Berlin - New York
> Sielminger Straße 63 · D-70771 Leinfelden-Echterdingen
> Fon +49 711 9909164 · Fax +49 711 9909199 http://www.six.de
>