goba Sat Sep 8 16:08:22 2001 EDT
Modified files:
/phpdoc/howto howto.ent howto.xml
Log:
Porting the first part of the old SGML howto to the PHPDOC Howto,
also changed the copyright notices, and authors
Index: phpdoc/howto/howto.ent
diff -u phpdoc/howto/howto.ent:1.1 phpdoc/howto/howto.ent:1.2
--- phpdoc/howto/howto.ent:1.1 Sat Sep 8 14:40:10 2001
+++ phpdoc/howto/howto.ent Sat Sep 8 16:08:22 2001
@@ -2,6 +2,9 @@
phpdoc-howto.ent: global entities for the phpdoc HOWTO
-->
<!ENTITY email.danbeck "[EMAIL PROTECTED]">
+<!ENTITY email.stig "[EMAIL PROTECTED]">
+<!ENTITY email.goba "[EMAIL PROTECTED]">
+<!ENTITY email.phpdoc "[EMAIL PROTECTED]">
<!ENTITY email.group.php "[EMAIL PROTECTED]">
<!ENTITY url.php "http://www.php.net/";>
Index: phpdoc/howto/howto.xml
diff -u phpdoc/howto/howto.xml:1.2 phpdoc/howto/howto.xml:1.3
--- phpdoc/howto/howto.xml:1.2 Sat Sep 8 14:43:58 2001
+++ phpdoc/howto/howto.xml Sat Sep 8 16:08:22 2001
@@ -31,7 +31,25 @@
</simpara>
</authorblurb>
</author>
- <title>The PHP Documentation Contribution HOWTO</title>
+ <author>
+ <firstname>Stig</firstname>
+ <surname>Sæther Bakken</surname>
+ <authorblurb>
+ <simpara>
+ (<ulink url="mailto:&email.stig;";>&email.stig;</ulink>)
+ </simpara>
+ </authorblurb>
+ </author>
+ <author>
+ <firstname>Gábor</firstname>
+ <surname>Hojtsy</surname>
+ <authorblurb>
+ <simpara>
+ (<ulink url="mailto:&email.goba;";>&email.goba;</ulink>)
+ </simpara>
+ </authorblurb>
+ </author>
+ <title>PHP Documentation HOWTO</title>
</artheader>
<!-- Section1: intro -->
@@ -40,17 +58,21 @@
<title>About This Document</title>
<para>
- phpdoc HOWTO full introduction
+ This document contains information important for the PHP
+ Documentation team members. When this document will be ready,
+ you will find sections here about generating HTML documentation
+ from XML sources, adding new XML files, or using XSL style
+ sheets to process the source files.
</para>
-
<!-- Section2: copyright -->
<sect2 id="copyright">
<title>Copyright Information</title>
<para>
- This document is copyrighted (c) 2000 Daniel Beckham and is
- distributed under terms stated below.
+ This document is copyrighted (c) 2000, 2001 by
+ the PHP Documentation Group, and is distributed
+ under terms stated below.
</para>
<para>
@@ -67,7 +89,7 @@
notice. That is, you may not produce a derivative work from this
document and impose additional restrictions on its
distribution. Exceptions to these rules may be granted under
- certain conditions; please contact the HOWTO coordinator at the
+ certain conditions; please contact the HOWTO coordinators at the
address given below.
</para>
@@ -79,8 +101,8 @@
</para>
<para>
- If you have any questions, please contact Daniel Beckham,
- <email>&email.danbeck;</email>
+ If you have any questions, please contact the PHP Documentation
+ Group at <email>&email.phpdoc;</email>
</para>
</sect2>
@@ -101,7 +123,7 @@
<para>
All copyrights are held by their by their respective owners,
- unless specifically noted otherwise. Use of a term in this
+ unless specifically noted otherwise. Use of a term in this
document should not be regarded as affecting the validity of any
trademark or service mark.
</para>
@@ -124,7 +146,13 @@
<title>Credits</title>
<para>
- Thanks to the following people for contributions and critisism:
+ This document is based on many files, previously hosted
+ in the phpdoc module at cvs.php.net, containg information
+ about several distinct subjects, ranging from generating
+ the HTML files from XML sources, to starting a new translation.
+ This is a central place for all these things. We tried to
+ include the original authors in the authors list of
+ this file.
</para>
</sect2>
@@ -138,7 +166,7 @@
Feedback is most certainly welcome for this document. Without your
submissions and input, this document wouldn't exist. Please send
your additions, comments and criticisms to the following email
- address : <email>&email.danbeck;</email>.
+ address : <email>&email.phpdoc;</email>.
</para>
</sect2>
@@ -155,10 +183,13 @@
<para>
The PHP documentation is written in XML using the <ulink
- url="&url.docbookdtd;">DocBook 3.0 DTD</ulink>. The viewable manual,
+ url="&url.docbookdtd;">DocBook DTD</ulink>. The viewable manual,
and other formats such as PDF and RTF, are created using <ulink
url="&url.jade;">Jade</ulink> and <ulink url="&url.nwalsh;">Norman
- Walsh's Modular DocBook Stylesheets</ulink>.
+ Walsh's Modular DocBook Stylesheets</ulink>. There are other
+ tools used to produce some other formats and files. You
+ can find information about them in the appropriate places
+ in this documentation.
</para>
<para>
@@ -169,12 +200,16 @@
<para>
In addition to the above tools, you will need your favorite text
editor and a working <ulink url="&url.cvs;">CVS</ulink>
- installation. If you don't already have a favorite text editor, I
- recommend Emacs, one of the best XML/SGML editors around. Both
- Emacs and CVS are already part of just about every Linux
- distribution available.
+ installation. Although it is possible to use a simple text editor
+ such as vi or notepad to write the XML files, it is recommended
+ to use an XML/SGML editor that helps you along and makes sure
+ your document is proper XML conforming to the used document
+ type definition (DTD). A very good (and free) XML/SGML editor
+ is Emacs+PSGML. Both Emacs and CVS are already part of just
+ about every Linux distribution available, and they are also
+ ported to Windows 95/NT.
</para>
-
+
<para>
You will also need <ulink url="&url.autoconf;">autoconf</ulink> to
build the <emphasis>phpdoc</emphasis> GNU configure script. Many
