RE: [PHP-DOC] writing documentation for php modules From: php user (vksphp <email protected>)
Date: 07/13/00

Hi, I am trying to write documentation for a new module.

After a bit of struggling and trying to get some sort of editor to work for
me and help me write documentation for PHP, I finally gave it up and decided
to revert to using vi. After all, xml syntax is not all that bad.

Now, here is the question. I do not know how those xml files get converted
to php files, or to html files that can be viewed on the php site. Also, I
want to test them and make sure that they are correct before I commit them
to CVS. Can somebody walk me through the process of getting those .xml files
and getting them to be viewable in a browser?

In other words, can somebody show me what happens to
http://cvs.php.net/viewcvs.cgi/phpdoc/en/functions/aspell.xml so that it
eventually becomes
http://www.php.net/manual/ref.aspell.php
???

How can I make this transformation on my compiter so I can test the .xml
file before commiting it? Also, when I upload the tested .xml file, do I
need to do anything special so that it becomes available for viewing from
php site?

I guess, most of my questions are covered in some nice FAQ or tutorial,
which I miserably failed to find. If that's the case, please, direct me to
one.

Thanks in advance,
Vlad Krupin

>From: ROSmith <email protected>
>To: vksphp <email protected>, phpdoc <email protected>
>Subject: RE: [PHP-DOC] writing documentation for php modules
>Date: Tue, 11 Jul 2000 12:21:00 -0400
>
> > -----Original Message-----
> > From: php user [mailto:vksphp <email protected>]
> > Sent: Tuesday, July 11, 2000 9:12 AM
> > To: phpdoc <email protected>
> > Subject: [PHP-DOC] writing documentation for php modules
> >...
> > Question: Is there a HOWTO, or some sort of tutorial that
> > shows how to write a sample chapter of documentation for PHP, or at
>least
>some
> > reference that newbies to php documentation can use?
>
>Vlad,
>
>You might look at:
>
>http://www.linuxdoc.org/HOWTO/HOWTO-HOWTO/index.html
>
>While it's not specifically about PHP doc writing, it may be a good place
>to
>start.
>
>-Ross

________________________________________________________________________
Get Your Private, Free E-mail from MSN Hotmail at http://www.hotmail.com