cvs: peardoc /en/guide/developers contributing.xml packagedef.xml

cellog Fri Aug 29 22:12:13 2003 EDT Modified files: /peardoc/en/guide/developers contributing.xml packagedef.xml Log: touchup for phpDocumentor 1.2.2.1 Index: peardoc/en/guide/developers/contributing.xml diff -u peardoc/en/guide/developers/contributing.xml:1.7 peardoc/en/guide/developers/contributing.xml:1.8 --- peardoc/en/guide/developers/contributing.xml:1.7 Thu Jul 24 03:58:26 2003 +++ peardoc/en/guide/developers/contributing.xml Fri Aug 29 22:12:13 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1" ?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <!-- WORK IN PROGRESS, THERE IS PROBABLY LITTLE POINT IN TRANSLATING THIS DOCUMENT YET. @@ -75,11 +75,21 @@ <note> <para> There are plans to provide an automated system which converts - the <ulink url="&url.phpdoc;">PHPDoc</ulink> API + the <ulink url="&url.phpdocumentor;">PHPDoc</ulink> API documentation of PEAR packages into Docbook XML which can be added to the official manual automatically. But until this system is in place, you have to write your documentation manually. + </para> + <para> + As of August, 2003, phpDocumentor is fully capable of converting + in-code API documentation and external tutorials into XML DocBook. + Version 1.2.2 or greater is required. Install with + <literal>pear install phpDocumentor</literal>. Use the + XML:DocBook/peardoc2:default converter on your source code to generate + output. The output should be generated directly into the + <literal>peardoc/lang/package</literal> directory, where lang is en, + fr, etc. </para> </note> </listitem> Index: peardoc/en/guide/developers/packagedef.xml diff -u peardoc/en/guide/developers/packagedef.xml:1.10 peardoc/en/guide/developers/packagedef.xml:1.11 --- peardoc/en/guide/developers/packagedef.xml:1.10 Fri Aug 15 18:07:35 2003 +++ peardoc/en/guide/developers/packagedef.xml Fri Aug 29 22:12:13 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1" ?> -<!-- $Revision: 1.10 $ --> +<!-- $Revision: 1.11 $ --> <!-- WORK IN PROGRESS, THERE IS PROBABLY LITTLE POINT IN TRANSLATING THIS DOCUMENT YET. @@ -24,9 +24,9 @@ </simpara> <simpara> - A package named PEAR_PackageFileManager simplifies the processing - of creating the package.xml file is available. Be aware that it is - still in development. You can install via the usual command + The <link linkend="package.pear.pear-packagefilemanager">PEAR_PackageFileManager</link> + simplifies the creation of package.xml. + You can install PEAR_PackageFileManager via the usual command </simpara> <para>