cvs: peardoc /en/guide/developers documentation.xml

mj Fri Apr 9 16:57:17 2004 EDT Modified files: /peardoc/en/guide/developers documentation.xml Log: * Adding a bit more information about using CVS and Docbook. http://cvs.php.net/diff.php/peardoc/en/guide/developers/documentation.xml?r1=1.4&r2=1.5&ty=u Index: peardoc/en/guide/developers/documentation.xml diff -u peardoc/en/guide/developers/documentation.xml:1.4 peardoc/en/guide/developers/documentation.xml:1.5 --- peardoc/en/guide/developers/documentation.xml:1.4 Wed Feb 11 21:46:44 2004 +++ peardoc/en/guide/developers/documentation.xml Fri Apr 9 16:57:17 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1" ?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- WORK IN PROGRESS, THERE IS PROBABLY LITTLE POINT IN TRANSLATING THIS DOCUMENT YET. @@ -31,9 +31,18 @@ that is used by a wide range of projects to maintain their documentation. Examples for Docbook usage in OpenSource projects are the documentations of <ulink url="&url.kde;">KDE</ulink> and - <ulink url="&url.php;">PHP</ulink>. + <ulink url="&url.php;">PHP</ulink>. PEAR has opted for using + Docbook, because we believe that it provides a solid foundation for + the technical documentation for PEAR packages. </para> + <para> + The trade-off for using Docbook is that it is relatively hard to + use. Testing documentation requires a number of tools to be + installed and one needs to learn a (not very complicated) XML + dialect. Once one is familiar with how Docbook works, they will + enjoy writing documentation with it though. + </para> <sect2> <title>Required software</title> @@ -47,7 +56,7 @@ <ulink url="&url.php.manual.howto;">PHP Documentation HOWTO</ulink>. Apart from providing information about the software, this HOWTO does also provide a ton of other useful - information that goes beyond this chapter. One is encouraged to + information that goes far beyond this chapter. One is encouraged to completely read it. (Chapter II can be skipped, because it only contains information that is very PHP specific.) </para> @@ -64,10 +73,20 @@ &dollar; cvs co peardoc </userinput> </screen> + + <para> + If you do not own an account for cvs.php.net, please choose + <literal>cvsread</literal> as the username. When asked for the + password, type <literal>phpfi</literal>. + </para> + <para> After that the directory <filename>./peardoc</filename> will contain a local copy (<quote>sandbox</quote>) of the latest - sources. + sources. If you are not yet familiar with CVS, then the online + book <ulink url="&url.cvs.book;"><quote>Open Source Development + with CVS</quote></ulink> will provide you with all the necessary + information. </para> </sect2> @@ -77,11 +96,11 @@ <para> This chapter will not describe all the details about the directory structure, because one can find out the essentials about it by - browsing the directory <filename>peardoc</filename>. As a starting - point for package documentors - <filename>peardoc/en/package/</filename> fits well. If one has - further questions concerning the directory structure, they can ask - on the <ulink url="&email.pear.doc;">documentation + browsing the previously created directory + <filename>peardoc</filename>. As a starting point for package + documentors <filename>peardoc/en/package/</filename> fits well. If + one has further questions concerning the directory structure, they + can ask on the <ulink url="mailto:&email.pear.doc;">documentation mailinglist</ulink>. </para> </sect2>