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

From: Date: Sun, 25 Jan 2004 22:33:58 +0000
Subject: cvs: peardoc /en/guide/developers documentation.xml
Groups: php.pear.doc 
Request: Send a blank email to pear-doc+get-2155@lists.php.net to get a copy of this message
mj Sun Jan 25 17:33:58 2004 EDT Modified files: /peardoc/en/guide/developers documentation.xml Log: * Updated some of the instructions for the documentation chapter http://cvs.php.net/diff.php/peardoc/en/guide/developers/documentation.xml?r1=1.1&r2=1.2&ty=u Index: peardoc/en/guide/developers/documentation.xml diff -u peardoc/en/guide/developers/documentation.xml:1.1 peardoc/en/guide/developers/documentation.xml:1.2 --- peardoc/en/guide/developers/documentation.xml:1.1 Thu Oct 9 15:55:06 2003 +++ peardoc/en/guide/developers/documentation.xml Sun Jan 25 17:33:57 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1" ?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- WORK IN PROGRESS, THERE IS PROBABLY LITTLE POINT IN TRANSLATING THIS DOCUMENT YET. @@ -14,6 +14,7 @@ </docinfo> <title>Writing documentation</title> + <titleabbrev>Documentation</titleabbrev> <para> This chapter provides a detailed description how to write @@ -23,8 +24,7 @@ </para> <sect1 id="developers.documentation.docbook"> - <title>Using Docbook XML</title> - <titleabbrev>Docbook</titleabbrev> + <title>Docbook XML</title> <para> <ulink url="&url.docbook.xml;">Docbook</ulink> is an XML dialect @@ -42,8 +42,8 @@ Even if Docbook XML can (like any other XML file) be written using a normal text editor, one needs to install some software on their machine in order to test the validity of the documenting - efforts. A list of the requires software and a installation - instruction can be found + efforts. A list of the required software and a installation + instruction can be found in the <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 @@ -75,13 +75,14 @@ <title>Directory structure</title> <para> - In the directory <filename>peardoc</filename> one will find a bunch - of files in the root directory and some subdirectories. The files - in the root folder are not important yet. As a first step one - should browse through the subdirectory <filename>en</filename>, - which contains the english version of the manual. For developers - who want to document their packages, only the subdirectory - <filename>package</filename> is of importance now. + 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 + mailinglist</ulink>. </para> </sect2> </sect1>

« previous php.pear.doc (#2155) next »