cvs: peardoc / html-common.dsl html.xsl htmlhelp.xsl /de/package/database/db db.ent /en/guide/developers documentation.xml /fr/package/database/db
db.ent /ja/package/database/db db.ent /nl/package/database/db db.ent /ru/package/database/db db.ent
| From: | Daniel Convissor | Date: | Thu, 12 Feb 2004 02:43:23 +0000 |
| Subject: | cvs: peardoc / html-common.dsl html.xsl htmlhelp.xsl /de/package/database/db db.ent /en/guide/developers documentation.xml /fr/package/database/db db.ent /ja/package/database/db db.ent /nl/package/database/db db.ent /ru/package/database/db db.ent |
||
| Groups: | php.pear.doc | ||
| Request: | Send a blank email to pear-doc+get-2530@lists.php.net to get a copy of this message | ||
danielc Wed Feb 11 21:43:23 2004 EDT
Modified files:
/peardoc html-common.dsl html.xsl htmlhelp.xsl
/peardoc/de/package/database/db db.ent
/peardoc/en/guide/developers documentation.xml
/peardoc/fr/package/database/db db.ent
/peardoc/ja/package/database/db db.ent
/peardoc/nl/package/database/db db.ent
/peardoc/ru/package/database/db db.ent
Log:
Use standard revision translation tags.
http://cvs.php.net/diff.php/peardoc/html-common.dsl?r1=1.3&r2=1.4&ty=u Index: peardoc/html-common.dsl diff -u peardoc/html-common.dsl:1.3 peardoc/html-common.dsl:1.4 --- peardoc/html-common.dsl:1.3 Thu Jan 29 10:01:10 2004 +++ peardoc/html-common.dsl Wed Feb 11 21:43:19 2004 @@ -1,6 +1,6 @@ ;; -*- Scheme -*- ;; -;; $Id: html-common.dsl,v 1.3 2004/01/29 15:01:10 alan_k Exp $ +;; $Id: html-common.dsl,v 1.4 2004/02/12 02:43:19 danielc Exp $ ;; ;; Returns the depth of the auto-generated TOC (table of http://cvs.php.net/diff.php/peardoc/html.xsl?r1=1.3&r2=1.4&ty=u Index: peardoc/html.xsl diff -u peardoc/html.xsl:1.3 peardoc/html.xsl:1.4 --- peardoc/html.xsl:1.3 Thu Jan 29 10:01:10 2004 +++ peardoc/html.xsl Wed Feb 11 21:43:19 2004 @@ -2,7 +2,7 @@ HTML specific stylesheet - $Id: html.xsl,v 1.3 2004/01/29 15:01:10 alan_k Exp $ + $Id: html.xsl,v 1.4 2004/02/12 02:43:19 danielc Exp $ --> <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" http://cvs.php.net/diff.php/peardoc/htmlhelp.xsl?r1=1.3&r2=1.4&ty=u Index: peardoc/htmlhelp.xsl diff -u peardoc/htmlhelp.xsl:1.3 peardoc/htmlhelp.xsl:1.4 --- peardoc/htmlhelp.xsl:1.3 Thu Jan 29 10:01:10 2004 +++ peardoc/htmlhelp.xsl Wed Feb 11 21:43:19 2004 @@ -2,7 +2,7 @@ HTML Help specific stylesheet - $Id: htmlhelp.xsl,v 1.3 2004/01/29 15:01:10 alan_k Exp $ + $Id: htmlhelp.xsl,v 1.4 2004/02/12 02:43:19 danielc Exp $ --> <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" http://cvs.php.net/diff.php/peardoc/de/package/database/db/db.ent?r1=1.3&r2=1.4&ty=u Index: peardoc/de/package/database/db/db.ent diff -u peardoc/de/package/database/db/db.ent:1.3 peardoc/de/package/database/db/db.ent:1.4 --- peardoc/de/package/database/db/db.ent:1.3 Tue Feb 10 13:27:14 2004 +++ peardoc/de/package/database/db/db.ent Wed Feb 11 21:43:19 2004 @@ -1,5 +1,5 @@ -<!-- $Revision: 1.3 $ --> -<!-- Sync 1.7 --> +<!-- $Revision: 1.4 $ --> +<!-- EN-Revision: 1.7 Maintainer: Status: ready --> <!ENTITY class.db '<link linkend="package.database.db"><classname>DB</classname></link>'> <!ENTITY class.db-common '<link linkend="package.database.db.db-common"><classname>DB_common</classname></link>'> <!ENTITY class.db-result '<link linkend="package.database.db.db-result"><classname>DB_result</classname></link>'> http://cvs.php.net/diff.php/peardoc/en/guide/developers/documentation.xml?r1=1.2&r2=1.3&ty=u Index: peardoc/en/guide/developers/documentation.xml diff -u peardoc/en/guide/developers/documentation.xml:1.2 peardoc/en/guide/developers/documentation.xml:1.3 --- peardoc/en/guide/developers/documentation.xml:1.2 Sun Jan 25 17:33:57 2004 +++ peardoc/en/guide/developers/documentation.xml Wed Feb 11 21:43:20 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1" ?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- WORK IN PROGRESS, THERE IS PROBABLY LITTLE POINT IN TRANSLATING THIS DOCUMENT YET. @@ -11,6 +11,10 @@ <firstname>Martin</firstname> <surname>Jansen</surname> </author> + <author> + <firstname>Daniel</firstname> + <surname>Convissor</surname> + </author> </docinfo> <title>Writing documentation</title> @@ -42,16 +46,68 @@ 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 required software and a installation + efforts. + </para> + + <para> + 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, + HOWTO</ulink>. + </para> + <para> + 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 completely read it. (Chapter II can be skipped, because it only contains information that is very PHP specific.) </para> <para> + If you are using a Windows machine, here are some tweaks to the + HOWTO's "Installing the Tools" section that will make + your documentation validation experience easier. + + <itemizedlist> + <listitem> + That page isn't clear on which Cygwin packages you need, but two + things you definitely need to install are autoconf and make, which + when running the setup program are under the Devel section. Once all + the Cygwin packages you need are installed, reboot your computer. + </listitem> + <listitem> + You don't need to check out the phpdoc sources. + </listitem> + <listitem> + You don't need to add a php.bat file to the phpdoc-tools directory. + </listitem> + <listitem> + Once you get the tools and peardoc sources (see below) installed, + the tree structure should look like this: + <informalexample> + <programlisting> ++--peardoc +| | +| +--CVS +| | +| +--en +| | +| \--... +| +\--phpdoc-tools + | + +--jade + | + \--jade.exe (etc) + </programlisting> + </informalexample> + </listitem> + </itemizedlist> + </para> + </sect2> + + <sect2> + <title>Getting the XML sources</title> + <para> Once the necessary software is in place, one has to get the latest version of the XML sources from PEAR's CVS repository: </para> @@ -85,6 +141,36 @@ mailinglist</ulink>. </para> </sect2> + + <sect2> + <title>Testing your docs</title> + <para> + Before committing your changes to CVS, make sure to test them out. + The second and third steps below only need to be done the first time. + </para> + <screen> + <userinput> +$ cd peardoc + </userinput> + </screen> + <screen> + <userinput> +$ autoconf + </userinput> + </screen> + <screen> + <userinput> +$ ./configure + </userinput> + </screen> + <screen> + <userinput> +$ make + </userinput> + </screen> + </sect2> + <xxxxxxxxxx> + </sect1> </chapter> http://cvs.php.net/diff.php/peardoc/fr/package/database/db/db.ent?r1=1.3&r2=1.4&ty=u Index: peardoc/fr/package/database/db/db.ent diff -u peardoc/fr/package/database/db/db.ent:1.3 peardoc/fr/package/database/db/db.ent:1.4 --- peardoc/fr/package/database/db/db.ent:1.3 Tue Feb 10 13:23:58 2004 +++ peardoc/fr/package/database/db/db.ent Wed Feb 11 21:43:21 2004 @@ -1,5 +1,5 @@ -<!-- $Revision: 1.3 $ --> -<!-- Sync: 1.7 --> +<!-- $Revision: 1.4 $ --> +<!-- EN-Revision: 1.7 Maintainer: Status: ready --> <!ENTITY class.db '<link linkend="package.database.db"><classname>DB</classname></link>'> <!ENTITY class.db-common '<link linkend="package.database.db.db-common"><classname>DB_common</classname></link>'> <!ENTITY class.db-result '<link linkend="package.database.db.db-result"><classname>DB_result</classname></link>'> http://cvs.php.net/diff.php/peardoc/ja/package/database/db/db.ent?r1=1.3&r2=1.4&ty=u Index: peardoc/ja/package/database/db/db.ent diff -u peardoc/ja/package/database/db/db.ent:1.3 peardoc/ja/package/database/db/db.ent:1.4 --- peardoc/ja/package/database/db/db.ent:1.3 Tue Feb 10 13:23:59 2004 +++ peardoc/ja/package/database/db/db.ent Wed Feb 11 21:43:21 2004 @@ -1,5 +1,5 @@ -<!-- $Revision: 1.3 $ --> -<!-- Sync: 1.7 --> +<!-- $Revision: 1.4 $ --> +<!-- EN-Revision: 1.7 Maintainer: Status: ready --> <!ENTITY class.db '<link linkend="package.database.db"><classname>DB</classname></link>'> <!ENTITY class.db-common '<link linkend="package.database.db.db-common"><classname>DB_Common</classname></link>'> <!ENTITY class.db-result '<link linkend="package.database.db.db-result"><classname>DB_Result</classname></link>'> http://cvs.php.net/diff.php/peardoc/nl/package/database/db/db.ent?r1=1.2&r2=1.3&ty=u Index: peardoc/nl/package/database/db/db.ent diff -u peardoc/nl/package/database/db/db.ent:1.2 peardoc/nl/package/database/db/db.ent:1.3 --- peardoc/nl/package/database/db/db.ent:1.2 Tue Feb 10 13:24:00 2004 +++ peardoc/nl/package/database/db/db.ent Wed Feb 11 21:43:22 2004 @@ -1,5 +1,5 @@ -<!-- $Revision: 1.2 $ --> -<!-- Sync: 1.7 --> +<!-- $Revision: 1.3 $ --> +<!-- EN-Revision: 1.7 Maintainer: Status: ready --> <!ENTITY class.db '<link linkend="package.database.db"><classname>DB</classname></link>'> <!ENTITY class.db-common '<link linkend="package.database.db.db-common"><classname>DB_common</classname></link>'> <!ENTITY class.db-result '<link linkend="package.database.db.db-result"><classname>DB_result</classname></link>'> http://cvs.php.net/diff.php/peardoc/ru/package/database/db/db.ent?r1=1.2&r2=1.3&ty=u Index: peardoc/ru/package/database/db/db.ent diff -u peardoc/ru/package/database/db/db.ent:1.2 peardoc/ru/package/database/db/db.ent:1.3 --- peardoc/ru/package/database/db/db.ent:1.2 Tue Feb 10 13:24:02 2004 +++ peardoc/ru/package/database/db/db.ent Wed Feb 11 21:43:23 2004 @@ -1,5 +1,5 @@ -<!-- $Revision: 1.2 $ --> -<!-- Sync: 1.7 --> +<!-- $Revision: 1.3 $ --> +<!-- EN-Revision: 1.7 Maintainer: Status: ready --> <!ENTITY class.db '<link linkend="package.database.db"><classname>DB</classname></link>'> <!ENTITY class.db-common '<link linkend="package.database.db.db-common"><classname>DB_common</classname></link>'> <!ENTITY class.db-result '<link linkend="package.database.db.db-result"><classname>DB_result</classname></link>'>
http://cvs.php.net/diff.php/peardoc/html-common.dsl?r1=1.3&r2=1.4&ty=u Index: peardoc/html-common.dsl diff -u peardoc/html-common.dsl:1.3 peardoc/html-common.dsl:1.4 --- peardoc/html-common.dsl:1.3 Thu Jan 29 10:01:10 2004 +++ peardoc/html-common.dsl Wed Feb 11 21:43:19 2004 @@ -1,6 +1,6 @@ ;; -*- Scheme -*- ;; -;; $Id: html-common.dsl,v 1.3 2004/01/29 15:01:10 alan_k Exp $ +;; $Id: html-common.dsl,v 1.4 2004/02/12 02:43:19 danielc Exp $ ;; ;; Returns the depth of the auto-generated TOC (table of http://cvs.php.net/diff.php/peardoc/html.xsl?r1=1.3&r2=1.4&ty=u Index: peardoc/html.xsl diff -u peardoc/html.xsl:1.3 peardoc/html.xsl:1.4 --- peardoc/html.xsl:1.3 Thu Jan 29 10:01:10 2004 +++ peardoc/html.xsl Wed Feb 11 21:43:19 2004 @@ -2,7 +2,7 @@ HTML specific stylesheet - $Id: html.xsl,v 1.3 2004/01/29 15:01:10 alan_k Exp $ + $Id: html.xsl,v 1.4 2004/02/12 02:43:19 danielc Exp $ --> <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" http://cvs.php.net/diff.php/peardoc/htmlhelp.xsl?r1=1.3&r2=1.4&ty=u Index: peardoc/htmlhelp.xsl diff -u peardoc/htmlhelp.xsl:1.3 peardoc/htmlhelp.xsl:1.4 --- peardoc/htmlhelp.xsl:1.3 Thu Jan 29 10:01:10 2004 +++ peardoc/htmlhelp.xsl Wed Feb 11 21:43:19 2004 @@ -2,7 +2,7 @@ HTML Help specific stylesheet - $Id: htmlhelp.xsl,v 1.3 2004/01/29 15:01:10 alan_k Exp $ + $Id: htmlhelp.xsl,v 1.4 2004/02/12 02:43:19 danielc Exp $ --> <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" http://cvs.php.net/diff.php/peardoc/de/package/database/db/db.ent?r1=1.3&r2=1.4&ty=u Index: peardoc/de/package/database/db/db.ent diff -u peardoc/de/package/database/db/db.ent:1.3 peardoc/de/package/database/db/db.ent:1.4 --- peardoc/de/package/database/db/db.ent:1.3 Tue Feb 10 13:27:14 2004 +++ peardoc/de/package/database/db/db.ent Wed Feb 11 21:43:19 2004 @@ -1,5 +1,5 @@ -<!-- $Revision: 1.3 $ --> -<!-- Sync 1.7 --> +<!-- $Revision: 1.4 $ --> +<!-- EN-Revision: 1.7 Maintainer: Status: ready --> <!ENTITY class.db '<link linkend="package.database.db"><classname>DB</classname></link>'> <!ENTITY class.db-common '<link linkend="package.database.db.db-common"><classname>DB_common</classname></link>'> <!ENTITY class.db-result '<link linkend="package.database.db.db-result"><classname>DB_result</classname></link>'> http://cvs.php.net/diff.php/peardoc/en/guide/developers/documentation.xml?r1=1.2&r2=1.3&ty=u Index: peardoc/en/guide/developers/documentation.xml diff -u peardoc/en/guide/developers/documentation.xml:1.2 peardoc/en/guide/developers/documentation.xml:1.3 --- peardoc/en/guide/developers/documentation.xml:1.2 Sun Jan 25 17:33:57 2004 +++ peardoc/en/guide/developers/documentation.xml Wed Feb 11 21:43:20 2004 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1" ?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- WORK IN PROGRESS, THERE IS PROBABLY LITTLE POINT IN TRANSLATING THIS DOCUMENT YET. @@ -11,6 +11,10 @@ <firstname>Martin</firstname> <surname>Jansen</surname> </author> + <author> + <firstname>Daniel</firstname> + <surname>Convissor</surname> + </author> </docinfo> <title>Writing documentation</title> @@ -42,16 +46,68 @@ 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 required software and a installation + efforts. + </para> + + <para> + 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, + HOWTO</ulink>. + </para> + <para> + 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 completely read it. (Chapter II can be skipped, because it only contains information that is very PHP specific.) </para> <para> + If you are using a Windows machine, here are some tweaks to the + HOWTO's "Installing the Tools" section that will make + your documentation validation experience easier. + + <itemizedlist> + <listitem> + That page isn't clear on which Cygwin packages you need, but two + things you definitely need to install are autoconf and make, which + when running the setup program are under the Devel section. Once all + the Cygwin packages you need are installed, reboot your computer. + </listitem> + <listitem> + You don't need to check out the phpdoc sources. + </listitem> + <listitem> + You don't need to add a php.bat file to the phpdoc-tools directory. + </listitem> + <listitem> + Once you get the tools and peardoc sources (see below) installed, + the tree structure should look like this: + <informalexample> + <programlisting> ++--peardoc +| | +| +--CVS +| | +| +--en +| | +| \--... +| +\--phpdoc-tools + | + +--jade + | + \--jade.exe (etc) + </programlisting> + </informalexample> + </listitem> + </itemizedlist> + </para> + </sect2> + + <sect2> + <title>Getting the XML sources</title> + <para> Once the necessary software is in place, one has to get the latest version of the XML sources from PEAR's CVS repository: </para> @@ -85,6 +141,36 @@ mailinglist</ulink>. </para> </sect2> + + <sect2> + <title>Testing your docs</title> + <para> + Before committing your changes to CVS, make sure to test them out. + The second and third steps below only need to be done the first time. + </para> + <screen> + <userinput> +$ cd peardoc + </userinput> + </screen> + <screen> + <userinput> +$ autoconf + </userinput> + </screen> + <screen> + <userinput> +$ ./configure + </userinput> + </screen> + <screen> + <userinput> +$ make + </userinput> + </screen> + </sect2> + <xxxxxxxxxx> + </sect1> </chapter> http://cvs.php.net/diff.php/peardoc/fr/package/database/db/db.ent?r1=1.3&r2=1.4&ty=u Index: peardoc/fr/package/database/db/db.ent diff -u peardoc/fr/package/database/db/db.ent:1.3 peardoc/fr/package/database/db/db.ent:1.4 --- peardoc/fr/package/database/db/db.ent:1.3 Tue Feb 10 13:23:58 2004 +++ peardoc/fr/package/database/db/db.ent Wed Feb 11 21:43:21 2004 @@ -1,5 +1,5 @@ -<!-- $Revision: 1.3 $ --> -<!-- Sync: 1.7 --> +<!-- $Revision: 1.4 $ --> +<!-- EN-Revision: 1.7 Maintainer: Status: ready --> <!ENTITY class.db '<link linkend="package.database.db"><classname>DB</classname></link>'> <!ENTITY class.db-common '<link linkend="package.database.db.db-common"><classname>DB_common</classname></link>'> <!ENTITY class.db-result '<link linkend="package.database.db.db-result"><classname>DB_result</classname></link>'> http://cvs.php.net/diff.php/peardoc/ja/package/database/db/db.ent?r1=1.3&r2=1.4&ty=u Index: peardoc/ja/package/database/db/db.ent diff -u peardoc/ja/package/database/db/db.ent:1.3 peardoc/ja/package/database/db/db.ent:1.4 --- peardoc/ja/package/database/db/db.ent:1.3 Tue Feb 10 13:23:59 2004 +++ peardoc/ja/package/database/db/db.ent Wed Feb 11 21:43:21 2004 @@ -1,5 +1,5 @@ -<!-- $Revision: 1.3 $ --> -<!-- Sync: 1.7 --> +<!-- $Revision: 1.4 $ --> +<!-- EN-Revision: 1.7 Maintainer: Status: ready --> <!ENTITY class.db '<link linkend="package.database.db"><classname>DB</classname></link>'> <!ENTITY class.db-common '<link linkend="package.database.db.db-common"><classname>DB_Common</classname></link>'> <!ENTITY class.db-result '<link linkend="package.database.db.db-result"><classname>DB_Result</classname></link>'> http://cvs.php.net/diff.php/peardoc/nl/package/database/db/db.ent?r1=1.2&r2=1.3&ty=u Index: peardoc/nl/package/database/db/db.ent diff -u peardoc/nl/package/database/db/db.ent:1.2 peardoc/nl/package/database/db/db.ent:1.3 --- peardoc/nl/package/database/db/db.ent:1.2 Tue Feb 10 13:24:00 2004 +++ peardoc/nl/package/database/db/db.ent Wed Feb 11 21:43:22 2004 @@ -1,5 +1,5 @@ -<!-- $Revision: 1.2 $ --> -<!-- Sync: 1.7 --> +<!-- $Revision: 1.3 $ --> +<!-- EN-Revision: 1.7 Maintainer: Status: ready --> <!ENTITY class.db '<link linkend="package.database.db"><classname>DB</classname></link>'> <!ENTITY class.db-common '<link linkend="package.database.db.db-common"><classname>DB_common</classname></link>'> <!ENTITY class.db-result '<link linkend="package.database.db.db-result"><classname>DB_result</classname></link>'> http://cvs.php.net/diff.php/peardoc/ru/package/database/db/db.ent?r1=1.2&r2=1.3&ty=u Index: peardoc/ru/package/database/db/db.ent diff -u peardoc/ru/package/database/db/db.ent:1.2 peardoc/ru/package/database/db/db.ent:1.3 --- peardoc/ru/package/database/db/db.ent:1.2 Tue Feb 10 13:24:02 2004 +++ peardoc/ru/package/database/db/db.ent Wed Feb 11 21:43:23 2004 @@ -1,5 +1,5 @@ -<!-- $Revision: 1.2 $ --> -<!-- Sync: 1.7 --> +<!-- $Revision: 1.3 $ --> +<!-- EN-Revision: 1.7 Maintainer: Status: ready --> <!ENTITY class.db '<link linkend="package.database.db"><classname>DB</classname></link>'> <!ENTITY class.db-common '<link linkend="package.database.db.db-common"><classname>DB_common</classname></link>'> <!ENTITY class.db-result '<link linkend="package.database.db.db-result"><classname>DB_result</classname></link>'>