cvs: phpdoc /howto preface.xml
| From: | Philip Olson | Date: | Mon, 07 Jan 2008 02:20:11 +0000 |
| Subject: | cvs: phpdoc /howto preface.xml | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-999@lists.php.net to get a copy of this message | ||
philip Mon Jan 7 02:20:11 2008 UTC
Modified files:
/phpdoc/howto preface.xml
Log:
A rewrite
http://cvs.php.net/viewvc.cgi/phpdoc/howto/preface.xml?r1=1.7&r2=1.8&diff_format=u
Index: phpdoc/howto/preface.xml
diff -u phpdoc/howto/preface.xml:1.7 phpdoc/howto/preface.xml:1.8
--- phpdoc/howto/preface.xml:1.7 Sat Dec 29 19:17:47 2007
+++ phpdoc/howto/preface.xml Mon Jan 7 02:20:11 2008
@@ -6,31 +6,32 @@
<abstract>
<para>
- This document contains information important for the PHP
- Documentation Group members. If you are interested in the
- documentation of PHP, you are at the wrong place, see
- <link xlink:href="&url.php.docs;">&url.php.docs;</link> for
- downloadable documentation.
+ <acronym>PHP</acronym> is well known for having excellent documentation,
+ documentation that is created by volunteers who collectively make changes
+ every day. This HOWTO is designed for people who work on the official PHP
+ documentation. See also <link
xlink:href="&url.php.docs;">&url.php.docs;</link>
+ for viewable and downloadable versions of the PHP manual.
</para>
<para>
- This HOWTO is an evolving document, and always "under construction".
- It is supposed to contain sections about generating HTML documentation
- from XML sources, adding new XML files, or using XSL style sheets to
- process the source files.
+ This HOWTO contains information about every aspect of the documentation
+ process, which includes editing the DocBook <acronym>XML</acronym>
+ sources, validating changes made to these sources, using the build system
+ to generate documentation into other formats, and general tips like how to
+ use <acronym>CVS</acronym>.
</para>
<para>
- The latest copy of this HOWTO can be downloaded from
- the web at: <link
xlink:href="&url.php.howto;">&url.php.howto;</link>,
- and it can be read at <link
- xlink:href="&url.php.howto.online;">&url.php.howto.online;</link>.
+ Related to this HOWTO is the simple <filename>README</filename> file that
+ lives within the phpdoc CVS module. It's a quick guide for those already
+ familiar with the basics of XML and CVS.
</para>
<para>
- There is also a very short <filename>README</filename> in phpdoc
- complementing this HOWTO, in which you can find short checklists
- to read before committing modifications or adding new parts.
+ The latest copy of this HOWTO is available here:
+ <link
xlink:href="&url.php.howto.online;">&url.php.howto.online;</link>,
+ and it may be downloaded from here:
+ <link xlink:href="&url.php.howto;">&url.php.howto;</link>.
</para>
</abstract>
</info>