Re: Status report: Automated API documentation

> The only serious nitpick I have is > > that some of the newer package versions seem not to be there (e.g. > > Text_Wiki 0.14 is online, but the latest version in /Reference/ is > > 0.8). > > That's strange - normally all packages should be in there. Anyway, we > will take care of this problem once that everything has stabilized. same here: UDDI is there up to 0.1.3, but 0.2.0alpha1 is missing. Apart from that: great job! Regards Christian > > > -- > - Martin Martin Jansen > http://martinjansen.com/ > > ------------------------------------------------------------------------ > > Subject: Re: [PEAR-DOC] Status report: Automated API documentation > Date: Sun, 02 May 2004 22:54:33 +0200 > From: Christophe Gesché <moosh@php.net> > Reply-To: moosh@phpFrance.com > To: pear-doc@lists.php.net > > Hoping not be pointed as "never happy guy" > > IT's difficult (or bad idea) > > to have > > ... > /reference/HTML_QuickForm/2.7/ > /reference/HTML_QuickForm/3.0/ > /reference/HTML_QuickForm/3.0RC1/ > /reference/HTML_QuickForm/3.1.1/ > ... > instead of > ... > /reference/HTML_QuickForm-2.7/ > /reference/HTML_QuickForm-3.0/ > /reference/HTML_QuickForm-3.0RC1/ > /reference/HTML_QuickForm-3.1.1/ > ... > > Moosh > > ------------------------------------------------------------------------ > > Subject: Re: [PEAR-DOC] Status report: Automated API documentation > Date: Sun, 2 May 2004 18:43:45 -0400 > From: Daniel Convissor <danielc@analysisandsolutions.com> > To: PEAR Doc List <pear-doc@lists.php.net> > > Folks: > > On Sun, May 02, 2004 at 11:57:40AM -0500, Paul M Jones wrote: > > > > * Maybe a comment system attached to the individual pages. > > The comments should be a part of the real manual, not the API > documentation. Creating and maintaining a comments system is a lot of > work. Also, comments could get lost in there, not showing up where > they're really needed: the real docs. Also, which version would the > comments be associated with? All versions? Then comments will become > outdated. Etc... > > --Dan > > -- > T H E A N A L Y S I S A N D S O L U T I O N S C O M P A N Y > data intensive web and database programming > http://www.AnalysisAndSolutions.com/ > 4015 7th Ave #4, Brooklyn NY 11232 v: 718-854-0335 f: 718-854-0409 > > ------------------------------------------------------------------------ > > Subject: Re: [PEAR-DOC] Status report: Automated API documentation > Date: Mon, 3 May 2004 09:53:27 +0200 > From: Martin Jansen <mj@php.net> > To: Daniel Convissor <danielc@analysisandsolutions.com> > CC: PEAR Doc List <pear-doc@lists.php.net> > > On Sun May 02, 2004 at 06:4345PM -0400, Daniel Convissor wrote: > > Folks: > > > > On Sun, May 02, 2004 at 11:57:40AM -0500, Paul M Jones wrote: > > > > > > * Maybe a comment system attached to the individual pages. > > > > The comments should be a part of the real manual, not the API > > documentation. > > Alternatively we might associate the comments with the packages and make > them available via the package homepage *and* the corresponding manual > section. > > > Creating and maintaining a comments system is a lot of > > work. > > Initially creating a comments system isn't that much work, but I think > that maintaining the comments, deleting spam and FUD, etc. may quickly > turn out to be a nightmare. > > -- > - Martin Martin Jansen > http://martinjansen.com/ > > ------------------------------------------------------------------------ > > Subject: Re: [PEAR-DOC] Status report: Automated API documentation > Date: Mon, 3 May 2004 09:59:47 +0200 > From: Martin Jansen <mj@php.net> > To: Paul M Jones <pmjones@ciaweb.net> > CC: pear-doc@lists.php.net > > On Sun May 02, 2004 at 11:5740AM -0500, Paul M Jones wrote: > > * Maybe a "package-current" version that always has the most-recent > > documentation (so that external links to 0.1 do not break when 0.2 > > comes out), and > > In the final version the API documentation will (using a bit of > mod_rewrite magic) be available via /package/<name>/docs/1.2.0/. Adding > "current" as an alias for the latest version number will be no big deal > then. > > This functionality will be in place as soon as the folks on the > webmasters list have given their blessing to [1]. > > [1] > http://news.php.net/article.php?group=php.pear.webmaster&article=2196 > > -- > - Martin Martin Jansen > http://martinjansen.com/ > > ------------------------------------------------------------------------ > > Subject: cvs: peardoc /en/package/database/db intro-portability.xml > Date: Sun, 02 May 2004 19:34:38 -0000 > From: "Daniel Convissor" <danielc@php.net> > To: pear-doc@lists.php.net > > danielc Sun May 2 15:34:38 2004 EDT > > Modified files: > /peardoc/en/package/database/db intro-portability.xml > Log: > Alphabetize list of constants. > > > http://cvs.php.net/diff.php/peardoc/en/package/database/db/intro-portability.xml?r1=1.17&r2=1.18&ty=u > Index: peardoc/en/package/database/db/intro-portability.xml > diff -u peardoc/en/package/database/db/intro-portability.xml:1.17 > peardoc/en/package/database/db/intro-portability.xml:1.18 > --- peardoc/en/package/database/db/intro-portability.xml:1.17 Sat May 1 17:35:26 2004 > +++ peardoc/en/package/database/db/intro-portability.xml Sun May 2 15:34:38 2004 > @@ -1,5 +1,5 @@ > <?xml version="1.0" encoding="iso-8859-1" ?> > -<!-- $Revision: 1.17 $ --> > +<!-- $Revision: 1.18 $ --> > > <refentry id="package.database.db.intro-portability"> > <refnamediv> > @@ -37,33 +37,16 @@ > <title>Portability Mode Constants</title> > <para> > <itemizedlist> > + > <listitem> > <para> > - <constant>DB_PORTABILITY_NONE</constant> (default) > - </para> > - <para> > - turn off all portability features > - </para> > - </listitem> > - <listitem> > - <para> > - <constant>DB_PORTABILITY_LOWERCASE</constant> > - </para> > - <para> > - convert names of tables and fields to lower case when using > - <function>get*</function>, <function>fetch*</function> and > - <function>tableInfo</function> > - </para> > - </listitem> > - <listitem> > - <para> > - <constant>DB_PORTABILITY_RTRIM</constant> > + <constant>DB_PORTABILITY_ALL</constant> > </para> > <para> > - right trim the data output by <function>get*</function> and > - <function>fetch*</function> > + turn on all portability features > </para> > </listitem> > + > <listitem> > <para> > <constant>DB_PORTABILITY_DELETE_COUNT</constant> > @@ -77,14 +60,6 @@ > queries. > </para> > </listitem> > - <listitem> > - <para> > - <constant>DB_PORTABILITY_NUMROWS</constant> > - </para> > - <para> > - enable hack that makes <function>numRows</function> work in Oracle > - </para> > - </listitem> > > <listitem> > <para> > @@ -166,6 +141,24 @@ > > <listitem> > <para> > + <constant>DB_PORTABILITY_LOWERCASE</constant> > + </para> > + <para> > + convert names of tables and fields to lower case when using > + <function>get*</function>, <function>fetch*</function> and > + <function>tableInfo</function> > + </para> > + </listitem> > + <listitem> > + <para> > + <constant>DB_PORTABILITY_NONE</constant> (default) > + </para> > + <para> > + turn off all portability features > + </para> > + </listitem> > + <listitem> > + <para> > <constant>DB_PORTABILITY_NULL_TO_EMPTY</constant> > </para> > <para> > @@ -174,13 +167,21 @@ > while most other DBMS's know the difference between empty and null. > </para> > </listitem> > - > <listitem> > <para> > - <constant>DB_PORTABILITY_ALL</constant> > + <constant>DB_PORTABILITY_NUMROWS</constant> > </para> > <para> > - turn on all portability features > + enable hack that makes <function>numRows</function> work in Oracle > + </para> > + </listitem> > + <listitem> > + <para> > + <constant>DB_PORTABILITY_RTRIM</constant> > + </para> > + <para> > + right trim the data output by <function>get*</function> and > + <function>fetch*</function> > </para> > </listitem> > > > ------------------------------------------------------------------------ > > Subject: cvs: peardoc /en/package/database/db intro-portability.xml > Date: Sun, 02 May 2004 19:37:35 -0000 > From: "Daniel Convissor" <danielc@php.net> > To: pear-doc@lists.php.net > > danielc Sun May 2 15:37:35 2004 EDT > > Modified files: > /peardoc/en/package/database/db intro-portability.xml > Log: > Change '/' to 'and' to improve line wrapping. > > > http://cvs.php.net/diff.php/peardoc/en/package/database/db/intro-portability.xml?r1=1.18&r2=1.19&ty=u > Index: peardoc/en/package/database/db/intro-portability.xml > diff -u peardoc/en/package/database/db/intro-portability.xml:1.18 > peardoc/en/package/database/db/intro-portability.xml:1.19 > --- peardoc/en/package/database/db/intro-portability.xml:1.18 Sun May 2 15:34:38 2004 > +++ peardoc/en/package/database/db/intro-portability.xml Sun May 2 15:37:34 2004 > @@ -1,5 +1,5 @@ > <?xml version="1.0" encoding="iso-8859-1" ?> > -<!-- $Revision: 1.18 $ --> > +<!-- $Revision: 1.19 $ --> > > <refentry id="package.database.db.intro-portability"> > <refnamediv> > @@ -89,7 +89,7 @@ > mysql, mysqli > </entry> > <entry> > - unique/primary key constraints > + unique and primary key constraints > </entry> > <entry> > <constant>DB_ERROR_ALREADY_EXISTS</constant> > > ------------------------------------------------------------------------ > > Subject: cvs: peardoc /en/package/database/db intro-portability.xml > Date: Sun, 02 May 2004 19:39:56 -0000 > From: "Daniel Convissor" <danielc@php.net> > To: pear-doc@lists.php.net > > danielc Sun May 2 15:39:56 2004 EDT > > Modified files: > /peardoc/en/package/database/db intro-portability.xml > Log: > Change tense in titles to imply it being optional. > > > http://cvs.php.net/diff.php/peardoc/en/package/database/db/intro-portability.xml?r1=1.19&r2=1.20&ty=u > Index: peardoc/en/package/database/db/intro-portability.xml > diff -u peardoc/en/package/database/db/intro-portability.xml:1.19 > peardoc/en/package/database/db/intro-portability.xml:1.20 > --- peardoc/en/package/database/db/intro-portability.xml:1.19 Sun May 2 15:37:34 2004 > +++ peardoc/en/package/database/db/intro-portability.xml Sun May 2 15:39:56 2004 > @@ -1,5 +1,5 @@ > <?xml version="1.0" encoding="iso-8859-1" ?> > -<!-- $Revision: 1.19 $ --> > +<!-- $Revision: 1.20 $ --> > > <refentry id="package.database.db.intro-portability"> > <refnamediv> > @@ -222,7 +222,7 @@ > <refsect1 id="package.database.db.intro-portability.example"> > &title.example; > <example> > - <title>Turn on all portability options while connecting</title> > + <title>Turning on all portability options while connecting</title> > <programlisting role="php"> > <![CDATA[ > <?php > @@ -245,7 +245,7 @@ > > <example> > <title> > - Use <function>setOption</function> to enable portability > + Using <function>setOption</function> to enable portability > for lowercasing and trimming > </title> > <programlisting role="php"> > @@ -261,7 +261,7 @@ > > <example> > <title> > - Use <function>setOption</function> to enable all portability > + Using <function>setOption</function> to enable all portability > options except trimming > </title> > <programlisting role="php"> > > ------------------------------------------------------------------------ > > Subject: cvs: peardoc /en/package/database/db intro-portability.xml > Date: Mon, 03 May 2004 04:24:23 -0000 > From: "Daniel Convissor" <danielc@php.net> > To: pear-doc@lists.php.net > > danielc Mon May 3 00:24:23 2004 EDT > > Modified files: > /peardoc/en/package/database/db intro-portability.xml > Log: > Use <function> around get/fetch. > > > http://cvs.php.net/diff.php/peardoc/en/package/database/db/intro-portability.xml?r1=1.20&r2=1.21&ty=u > Index: peardoc/en/package/database/db/intro-portability.xml > diff -u peardoc/en/package/database/db/intro-portability.xml:1.20 > peardoc/en/package/database/db/intro-portability.xml:1.21 > --- peardoc/en/package/database/db/intro-portability.xml:1.20 Sun May 2 15:39:56 2004 > +++ peardoc/en/package/database/db/intro-portability.xml Mon May 3 00:24:23 2004 > @@ -1,5 +1,5 @@ > <?xml version="1.0" encoding="iso-8859-1" ?> > -<!-- $Revision: 1.20 $ --> > +<!-- $Revision: 1.21 $ --> > > <refentry id="package.database.db.intro-portability"> > <refnamediv> > @@ -162,8 +162,9 @@ > <constant>DB_PORTABILITY_NULL_TO_EMPTY</constant> > </para> > <para> > - convert null values to empty strings in data output by get*() and > - fetch*(). Needed because Oracle considers empty strings to be null, > + convert null values to empty strings in data output by > + <function>get*</function> and <function>fetch*</function>. > + Needed because Oracle considers empty strings to be null, > while most other DBMS's know the difference between empty and null. > </para> > </listitem> > > ------------------------------------------------------------------------ > > Subject: cvs: peardoc /fr/core/pear/pear-errorstack constants.xml > Date: Mon, 03 May 2004 05:00:57 -0000 > From: "Christophe Gesché" <moosh@php.net> > To: pear-doc@lists.php.net > > moosh Mon May 3 01:00:57 2004 EDT > > Modified files: > /peardoc/fr/core/pear/pear-errorstack constants.xml > Log: > - error in en-revision > > > > http://cvs.php.net/diff.php/peardoc/fr/core/pear/pear-errorstack/constants.xml?r1=1.3&r2=1.4&ty=u > Index: peardoc/fr/core/pear/pear-errorstack/constants.xml > diff -u peardoc/fr/core/pear/pear-errorstack/constants.xml:1.3 > peardoc/fr/core/pear/pear-errorstack/constants.xml:1.4 > --- peardoc/fr/core/pear/pear-errorstack/constants.xml:1.3 Thu Apr 29 10:24:56 2004 > +++ peardoc/fr/core/pear/pear-errorstack/constants.xml Mon May 3 01:00:56 2004 > @@ -1,5 +1,5 @@ > -<!-- $Revision: 1.3 $ --> > -<!-- EN-Revision: 1.3 Maintainer: moosh Status: ready --> > +<!-- $Revision: 1.4 $ --> > +<!-- EN-Revision: 1.1 Maintainer: moosh Status: ready --> > <refentry id="core.pear.pear-errorstack.constants"> > <refnamediv> > <refname>Constantes du Package PEAR_ErrorStack</refname> > @@ -58,7 +58,7 @@ > </refsect2> > </refsect1> > </refentry> > -<!-- Generated by phpDocumentor v 1.3.0RC3 > http://www.phpdoc.org --> > +<!-- Original Generated by phpDocumentor v 1.3.0RC3 > http://www.phpdoc.org --> > <!-- > Keep this comment at the end of the file > Local variables: > > ------------------------------------------------------------------------ > > Subject: cvs: peardoc /fr/package/networking/net-geo example.xml > Date: Mon, 03 May 2004 05:18:41 -0000 > From: "Christophe Gesché" <moosh@php.net> > To: pear-doc@lists.php.net > > moosh Mon May 3 01:18:41 2004 EDT > > Modified files: > /peardoc/fr/package/networking/net-geo example.xml > Log: > - syncronize with en update > > > > http://cvs.php.net/diff.php/peardoc/fr/package/networking/net-geo/example.xml?r1=1.3&r2=1.4&ty=u > Index: peardoc/fr/package/networking/net-geo/example.xml > diff -u peardoc/fr/package/networking/net-geo/example.xml:1.3 > peardoc/fr/package/networking/net-geo/example.xml:1.4 > --- peardoc/fr/package/networking/net-geo/example.xml:1.3 Mon Apr 26 02:49:20 2004 > +++ peardoc/fr/package/networking/net-geo/example.xml Mon May 3 01:18:41 2004 > @@ -1,5 +1,5 @@ > -<!-- $Revision: 1.3 $ --> > -<!-- EN-Revision: 1.3 Maintainer: moosh Status: ready --> > +<!-- $Revision: 1.4 $ --> > +<!-- EN-Revision: 1.4 Maintainer: moosh Status: ready --> > <refentry id="package.networking.net-geo.example"> > <refnamediv> > <refname>Net_Geo - Exemple</refname> > > ------------------------------------------------------------------------ > > Subject: Re: cvs: peardoc /en/package/mail/mail-rfc822 intro.xml > Date: Mon, 03 May 2004 07:21:37 +0200 > From: Christophe Gesché <moosh@php.net> > To: pear-doc@lists.php.net > > I' cant update translation, I dont see the change.... > > Mehdi Achour wrote: > > didou Wed Feb 25 09:13:16 2004 EDT > > > > Modified files: > > /peardoc/en/package/mail/mail-rfc822 intro.xml > > Log: > > fix #853 > > > > > > http://cvs.php.net/diff.php/peardoc/en/package/mail/mail-rfc822/intro.xml?r1=1.2&r2=1.3&ty=u > > Index: peardoc/en/package/mail/mail-rfc822/intro.xml > > diff -u peardoc/en/package/mail/mail-rfc822/intro.xml:1.2 > > peardoc/en/package/mail/mail-rfc822/intro.xml:1.3 > > --- peardoc/en/package/mail/mail-rfc822/intro.xml:1.2 Sun Jun 22 10:03:36 2003 > > +++ peardoc/en/package/mail/mail-rfc822/intro.xml Wed Feb 25 09:13:15 2004 > > @@ -1,4 +1,4 @@ > > -<!-- $Revision: 1.2 $ --> > > +<!-- $Revision: 1.3 $ --> > > <refentry id="package.mail.mail-rfc822.intro"> > > <refnamediv> > > <refname>RFC822 - Introduction</refname> > > @@ -8,7 +8,7 @@ > > <title>Description</title> > > <para> > > This class performs email address checking according to the > > - <ulink url="&url.rfc;882">RFC822</ulink> specification. > > + <ulink url="&url.rfc;822">RFC822</ulink> specification. > > </para> > > <para> > > Note that the class only checks for a proper format of the indicated