Re: cvs: phpdoc /en/functions dbplus.xml

On Tue, Aug 21, 2001 at 11:19:47PM -0000, Jeroen van Wolffelaar wrote: > jeroen Tue Aug 21 19:19:47 2001 EDT > > Modified files: > /phpdoc/en/functions dbplus.xml > Log: > According to autoreply Hartmut is N/A for a while, so: > > WS fix (converted tabs to two spaces) Please revert this patch! I have done this in the meantime and two space looks very silly to me. Please read the READMEs in phpdoc. On every page you can read, "sgml-indent-step=1". So your patch is wrong. -Egon > Index: phpdoc/en/functions/dbplus.xml > diff -u phpdoc/en/functions/dbplus.xml:1.5 phpdoc/en/functions/dbplus.xml:1.6 > --- phpdoc/en/functions/dbplus.xml:1.5 Tue Aug 21 14:16:46 2001 > +++ phpdoc/en/functions/dbplus.xml Tue Aug 21 19:19:47 2001 > @@ -1,60 +1,60 @@ > <?xml encoding="iso-8859-1"?> > -<!-- $Revision: 1.5 $ --> > +<!-- $Revision: 1.6 $ --> > <reference id="ref.dbplus"> > <title>DB++ functions</title> > <titleabbrev></titleabbrev> > - > + > <partintro> > &warn.experimental; > - > - <section id="dbplus.intro"> > - <title>Experimental support for db++ database</title> > - <para> > - This paper describes the the db++ extension which enables > - PHP to access db++ relation files through all of the > - search and update methods available in the client/server "C" > - library interface of db++ and to read and process the output of a > - db++ query. > - </para> > - </section> > - > - <section id="dbplus.requirenments"> > - <title>Requirenments</title> > - <para> > - ??? Download where > - </para> > - </section> > - > - <section id="dbplus.installation"> > - <title>Installation</title> > - <para> > - Creation and installation of this extension requires the db++ > - client libraries and header files to be installed on your system > - as described above. You have to run <command>configure</command> > - with option <option>--with-dbplus</option> to build this extension. > - </para> > - <para> > - <command>configure</command> looks for the client libraries and > - header files under the default > - path<filename>/usr/dbplus/</filename>. > - If you have installed db++ in a different place you have add the > - installation path to the <command>configure</command> option like > - this: <option>--with-dbplus=/your/installation/path</option>. > - </para> > - </section> > - <section id="dbplus.errorcodes"> > - <title>db++ error codes</title> > - <para> > - <table> > - <title>db++ error codes</title> > - <tgroup cols="3"> > - <thead> > - <row> > - <entry>PHP Constant</entry> > - <entry>db++ constant</entry> > - <entry>meaning</entry> > - </row> > - </thead> > + > + <section id="dbplus.intro"> > + <title>Experimental support for db++ database</title> > + <para> > + This paper describes the the db++ extension which enables > + PHP to access db++ relation files through all of the > + search and update methods available in the client/server "C" > + library interface of db++ and to read and process the output of a > + db++ query. > + </para> > + </section> > + > + <section id="dbplus.requirenments"> > + <title>Requirenments</title> > + <para> > + ??? Download where > + </para> > + </section> > + > + <section id="dbplus.installation"> > + <title>Installation</title> > + <para> > + Creation and installation of this extension requires the db++ > + client libraries and header files to be installed on your system > + as described above. You have to run <command>configure</command> > + with option <option>--with-dbplus</option> to build this extension. > + </para> > + <para> > + <command>configure</command> looks for the client libraries and > + header files under the default > + path<filename>/usr/dbplus/</filename>. > + If you have installed db++ in a different place you have add the > + installation path to the <command>configure</command> option like > + this: <option>--with-dbplus=/your/installation/path</option>. > + </para> > + </section> > + <section id="dbplus.errorcodes"> > + <title>db++ error codes</title> > + <para> > + <table> > + <title>db++ error codes</title> > + <tgroup cols="3"> > + <thead> > + <row> > + <entry>PHP Constant</entry> > + <entry>db++ constant</entry> > + <entry>meaning</entry> > + </row> > + </thead> > <tbody> > <row> > <entry>DBPLUS_ERR_NOERR</entry> > @@ -251,13 +251,13 @@ > <entry>ERR_UNKNOWN</entry> > <entry></entry> > </row> > - </tbody> > - </tgroup> > - </table> > - </para> > - </section> > + </tbody> > + </tgroup> > + </table> > + </para> > + </section> > </partintro> > - > + > <refentry id="function.dbplus-add"> > <refnamediv> > <refname>dbplus_add</refname> > @@ -268,29 +268,29 @@ > <funcsynopsis> > <funcprototype> > <funcdef>int <function>dbplus_add</function></funcdef> > - <paramdef>int <parameter>relation</parameter></paramdef> > - <paramdef>array <parameter>tuple</parameter></paramdef> > + <paramdef>int <parameter>relation</parameter></paramdef> > + <paramdef>array <parameter>tuple</parameter></paramdef> > </funcprototype> > </funcsynopsis> > &warn.experimental.func; > <para> > - This function will add a tuple to a relation. The > - <parameter>tuple</parameter> data is an array of attribute/value > - pairs to be inserted into the given > - <parameter>relation</parameter>. After successfull execution the > - <parameter>tuple</parameter> array will contain the complete data > - of the newly created tuple, including all implicitly set domain > - fields like sequences. > + This function will add a tuple to a relation. The > + <parameter>tuple</parameter> data is an array of attribute/value > + pairs to be inserted into the given > + <parameter>relation</parameter>. After successfull execution the > + <parameter>tuple</parameter> array will contain the complete data > + of the newly created tuple, including all implicitly set domain > + fields like sequences. > + </para> > + <para> > + The function will return zero (aka. DBPLUS_ERR_NOERR) on success > + or a db++ error code on failure. See > + <function>dbplus_errcode</function> or the introduction to this > + chapter for more information on db++ error codes. > </para> > - <para> > - The function will return zero (aka. DBPLUS_ERR_NOERR) on success > - or a db++ error code on failure. See > - <function>dbplus_errcode</function> or the introduction to this > - chapter for more information on db++ error codes. > - </para> > </refsect1> > </refentry> > - > + > <refentry id="function.dbplus-aql"> > <refnamediv> > <refname>dbplus_aql</refname> > @@ -333,14 +333,14 @@ > </funcsynopsis> > &warn.experimental.func; > <para> > - <function>dbplus_chdir</function> will change the virtual current > - directory where relation files will be looked for by > - <function>dbplus_open</function>. > - <function>dbplus_chdir</function> will return the absolute path > - of the current directory. Calling > - <function>dbplus_chdir</function> without giving any > - <parameter>newdir</parameter> may be used to query the current > - working directory. > + <function>dbplus_chdir</function> will change the virtual current > + directory where relation files will be looked for by > + <function>dbplus_open</function>. > + <function>dbplus_chdir</function> will return the absolute path > + of the current directory. Calling > + <function>dbplus_chdir</function> without giving any > + <parameter>newdir</parameter> may be used to query the current > + working directory. > </para> > </refsect1> > </refentry> > @@ -360,8 +360,8 @@ > </funcsynopsis> > &warn.experimental.func; > <para> > - Calling <function>dbplus_close</function> will close a relation > - previously opened by <function>dbplus_open</function>. > + Calling <function>dbplus_close</function> will close a relation > + previously opened by <function>dbplus_open</function>. > </para> > </refsect1> > </refentry> > @@ -382,23 +382,23 @@ > </funcsynopsis> > &warn.experimental.func; > <para> > - <function>dbplus_curr</function> will read the data for the > - current tuple for the given <parameter>relation</parameter> and > - will pass it back as an associative array in > - <parameter>tuple</parameter>. > - </para> > - <para> > - The function will return zero (aka. DBPLUS_ERR_NOERR) on success > - or a db++ error code on failure. See > - <function>dbplus_errcode</function> or the introduction to this > - chapter for more information on db++ error codes. > - </para> > - <para> > - See also <function>dbplus_first</function>, > - <function>dbplus_prev</function>, > - <function>dbplus_next</function>, > - and <function>dbplus_last</function>. > - </para> > + <function>dbplus_curr</function> will read the data for the > + current tuple for the given <parameter>relation</parameter> and > + will pass it back as an associative array in > + <parameter>tuple</parameter>. > + </para> > + <para> > + The function will return zero (aka. DBPLUS_ERR_NOERR) on success > + or a db++ error code on failure. See > + <function>dbplus_errcode</function> or the introduction to this > + chapter for more information on db++ error codes. > + </para> > + <para> > + See also <function>dbplus_first</function>, > + <function>dbplus_prev</function>, > + <function>dbplus_next</function>, > + and <function>dbplus_last</function>. > + </para> > </refsect1> > </refentry> > > @@ -455,23 +455,23 @@ > </funcsynopsis> > &warn.experimental.func; > <para> > - <function>dbplus_curr</function> will read the data for the > - first tuple for the given <parameter>relation</parameter>, make > - it the current tuple and pass it back as an associative array in > - <parameter>tuple</parameter>. > - </para> > - <para> > - The function will return zero (aka. DBPLUS_ERR_NOERR) on success > - or a db++ error code on failure. See > - <function>dbplus_errcode</function> or the introduction to this > - chapter for more information on db++ error codes. > - </para> > - <para> > - See also <function>dbplus_current</function>, > - <function>dbplus_prev</function>, > - <function>dbplus_next</function>, > - and <function>dbplus_last</function>. > - </para> > + <function>dbplus_curr</function> will read the data for the > + first tuple for the given <parameter>relation</parameter>, make > + it the current tuple and pass it back as an associative array in > + <parameter>tuple</parameter>. > + </para> > + <para> > + The function will return zero (aka. DBPLUS_ERR_NOERR) on success > + or a db++ error code on failure. See > + <function>dbplus_errcode</function> or the introduction to this > + chapter for more information on db++ error codes. > + </para> > + <para> > + See also <function>dbplus_current</function>, > + <function>dbplus_prev</function>, > + <function>dbplus_next</function>, > + and <function>dbplus_last</function>. > + </para> > </refsect1> > </refentry> > > @@ -490,15 +490,15 @@ > </funcsynopsis> > &warn.experimental.func; > <para> > - <function>dbplus_flush</function> will write all changes applied > - to <parameter>relation</parameter> since the last flush to disk. > + <function>dbplus_flush</function> will write all changes applied > + to <parameter>relation</parameter> since the last flush to disk. > + </para> > + <para> > + The function will return zero (aka. DBPLUS_ERR_NOERR) on success > + or a db++ error code on failure. See > + <function>dbplus_errcode</function> or the introduction to this > + chapter for more information on db++ error codes. > </para> > - <para> > - The function will return zero (aka. DBPLUS_ERR_NOERR) on success > - or a db++ error code on failure. See > - <function>dbplus_errcode</function> or the introduction to this > - chapter for more information on db++ error codes. > - </para> > </refsect1> > </refentry> > > @@ -512,13 +512,13 @@ > <funcsynopsis> > <funcprototype> > <funcdef>int <function>dbplus_freealllocks</function></funcdef> > - <void/> > + <void/> > </funcprototype> > </funcsynopsis> > &warn.experimental.func; > <para> > - <function>dbplus_freeaalllocks</function> will free all locks held > - by this client. > + <function>dbplus_freeaalllocks</function> will free all locks held > + by this client. > </para> > </refsect1> > </refentry> > @@ -538,8 +538,8 @@ > </funcsynopsis> > &warn.experimental.func; > <para> > - <function>dbplus_freerlocks</function> will free all locks held > - on the given <parameter>relation</parameter>. > + <function>dbplus_freerlocks</function> will free all locks held > + on the given <parameter>relation</parameter>. > </para> > </refsect1> > </refentry> > @@ -581,23 +581,23 @@ > </funcsynopsis> > &warn.experimental.func; > <para> > - <function>dbplus_curr</function> will read the data for the > - last tuple for the given <parameter>relation</parameter>, make > - it the current tuple and pass it back as an associative array in > - <parameter>tuple</parameter>. > - </para> > - <para> > - The function will return zero (aka. DBPLUS_ERR_NOERR) on success > - or a db++ error code on failure. See > - <function>dbplus_errcode</function> or the introduction to this > - chapter for more information on db++ error codes. > - </para> > - <para> > - See also <function>dbplus_first</function>, > - <function>dbplus_current</function>, > - <function>dbplus_prev</function>, > - and <function>dbplus_next</function>. > - </para> > + <function>dbplus_curr</function> will read the data for the > + last tuple for the given <parameter>relation</parameter>, make > + it the current tuple and pass it back as an associative array in > + <parameter>tuple</parameter>. > + </para> > + <para> > + The function will return zero (aka. DBPLUS_ERR_NOERR) on success > + or a db++ error code on failure. See > + <function>dbplus_errcode</function> or the introduction to this > + chapter for more information on db++ error codes. > + </para> > + <para> > + See also <function>dbplus_first</function>, > + <function>dbplus_current</function>, > + <function>dbplus_prev</function>, > + and <function>dbplus_next</function>. > + </para> > </refsect1> > </refentry> > > @@ -636,28 +636,28 @@ > </funcsynopsis> > &warn.experimental.func; > <para> > - <function>dbplus_curr</function> will read the data for the > - next tuple for the given <parameter>relation</parameter>, will > - make it the current tuple and > - will pass it back as an associative array in > - <parameter>tuple</parameter>. > - </para> > - <para> > - The function will return zero (aka. DBPLUS_ERR_NOERR) on success > - or a db++ error code on failure. See > - <function>dbplus_errcode</function> or the introduction to this > - chapter for more information on db++ error codes. > - </para> > - <para> > - See also <function>dbplus_first</function>, > - <function>dbplus_current</function>, > - <function>dbplus_prev</function>, > - and <function>dbplus_last</function>. > - </para> > + <function>dbplus_curr</function> will read the data for the > + next tuple for the given <parameter>relation</parameter>, will > + make it the current tuple and > + will pass it back as an associative array in > + <parameter>tuple</parameter>. > + </para> > + <para> > + The function will return zero (aka. DBPLUS_ERR_NOERR) on success > + or a db++ error code on failure. See > + <function>dbplus_errcode</function> or the introduction to this > + chapter for more information on db++ error codes. > + </para> > + <para> > + See also <function>dbplus_first</function>, > + <function>dbplus_current</function>, > + <function>dbplus_prev</function>, > + and <function>dbplus_last</function>. > + </para> > </refsect1> > </refentry> > > - <refentry id="function.dbplus-open"> > + <refentry id="function.dbplus-open"> > <refnamediv> > <refname>dbplus_open</refname> > <refpurpose>Open relation file</refpurpose> > @@ -667,20 +667,20 @@ > <funcsynopsis> > <funcprototype> > <funcdef>int <function>dbplus_open</function></funcdef> > - <paramdef>string <parameter>name</parameter></paramdef> > - </funcprototype> > - </funcsynopsis> > + <paramdef>string <parameter>name</parameter></paramdef> > + </funcprototype> > + </funcsynopsis> > &warn.experimental.func; > <para> > - The relation file <parameter>name</parameter> will be opened. > - <parameter>name</parameter> can be either a file name or a > - relative or absolute path name. This will be mapped in any case > - to an absolute relation file path on a specific host machine and > - server. > - </para> > - <para> > - On success a relation file handle (cursor) is returned which must be used in any subsequent > - commanads referencing the relation. > + The relation file <parameter>name</parameter> will be opened. > + <parameter>name</parameter> can be either a file name or a > + relative or absolute path name. This will be mapped in any case > + to an absolute relation file path on a specific host machine and > + server. > + </para> > + <para> > + On success a relation file handle (cursor) is returned which must be used in any > subsequent > + commanads referencing the relation. > </para> > </refsect1> > </refentry> > @@ -701,24 +701,24 @@ > </funcsynopsis> > &warn.experimental.func; > <para> > - <function>dbplus_curr</function> will read the data for the > - next tuple for the given <parameter>relation</parameter>, will > - make it the current tuple and > - will pass it back as an associative array in > - <parameter>tuple</parameter>. > - </para> > - <para> > - The function will return zero (aka. DBPLUS_ERR_NOERR) on success > - or a db++ error code on failure. See > - <function>dbplus_errcode</function> or the introduction to this > - chapter for more information on db++ error codes. > - </para> > - <para> > - See also <function>dbplus_first</function>, > - <function>dbplus_current</function>, > - <function>dbplus_next</function>, > - and <function>dbplus_last</function>. > - </para> > + <function>dbplus_curr</function> will read the data for the > + next tuple for the given <parameter>relation</parameter>, will > + make it the current tuple and > + will pass it back as an associative array in > + <parameter>tuple</parameter>. > + </para> > + <para> > + The function will return zero (aka. DBPLUS_ERR_NOERR) on success > + or a db++ error code on failure. See > + <function>dbplus_errcode</function> or the introduction to this > + chapter for more information on db++ error codes. > + </para> > + <para> > + See also <function>dbplus_first</function>, > + <function>dbplus_current</function>, > + <function>dbplus_next</function>, > + and <function>dbplus_last</function>. > + </para> > </refsect1> > </refentry> > > @@ -1058,7 +1058,7 @@ > </funcsynopsis> > &warn.experimental.func; > <para> > - Not implemented yet. > + Not implemented yet. > </para> > </refsect1> > </refentry> > @@ -1080,7 +1080,7 @@ > </funcsynopsis> > &warn.experimental.func; > <para> > - Not implemented yet. > + Not implemented yet. > </para> > </refsect1> > </refentry> > @@ -1101,9 +1101,9 @@ > </funcsynopsis> > &warn.experimental.func; > <para> > - <function>dbplus_freelock</function> will release a write lock on > - the given <parameter>tuple</parameter> previously obtained by > - <function>dbplus_getlock</function>. > + <function>dbplus_freelock</function> will release a write lock on > + the given <parameter>tuple</parameter> previously obtained by > + <function>dbplus_getlock</function>. > </para> > </refsect1> > </refentry> > @@ -1124,17 +1124,17 @@ > </funcsynopsis> > &warn.experimental.func; > <para> > - <function>dbplus_getlock</function> will request a write lock on > - the speified <parameter>tuple</parameter>. It will return zero > - on success or a non-zero error code, especially > - DBPLUS_ERR_WLOCKED, on failure. > - </para> > - <para> > - See also > - <function>dbplus_freelock</function>, > - <function>dbplus_freerlocks</function>, > - and <function>dbplus_freealllocks</function>. > - </para> > + <function>dbplus_getlock</function> will request a write lock on > + the speified <parameter>tuple</parameter>. It will return zero > + on success or a non-zero error code, especially > + DBPLUS_ERR_WLOCKED, on failure. > + </para> > + <para> > + See also > + <function>dbplus_freelock</function>, > + <function>dbplus_freerlocks</function>, > + and <function>dbplus_freealllocks</function>. > + </para> > </refsect1> > </refentry> > > @@ -1154,17 +1154,17 @@ > </funcsynopsis> > &warn.experimental.func; > <para> > - <function>dbplus_getunique</function> will obtain a number > - guaranteed to be unique for the given > - <parameter>relation</parameter> and will pass it back in the > - variable given as <parameter>uniqueid</parameter>. > - </para> > - <para> > - The function will return zero (aka. DBPLUS_ERR_NOERR) on success > - or a db++ error code on failure. See > - <function>dbplus_errcode</function> or the introduction to this > - chapter for more information on db++ error codes. > - </para> > + <function>dbplus_getunique</function> will obtain a number > + guaranteed to be unique for the given > + <parameter>relation</parameter> and will pass it back in the > + variable given as <parameter>uniqueid</parameter>. > + </para> > + <para> > + The function will return zero (aka. DBPLUS_ERR_NOERR) on success > + or a db++ error code on failure. See > + <function>dbplus_errcode</function> or the introduction to this > + chapter for more information on db++ error codes. > + </para> > </refsect1> > </refentry> > > @@ -1186,7 +1186,7 @@ > </funcsynopsis> > &warn.experimental.func; > <para> > - Not implemented yet. > + Not implemented yet. > </para> > </refsect1> > </refentry> > @@ -1208,7 +1208,7 @@ > </funcsynopsis> > &warn.experimental.func; > <para> > - Not implemented yet. > + Not implemented yet. > </para> > </refsect1> > </refentry> > @@ -1230,7 +1230,7 @@ > </funcsynopsis> > &warn.experimental.func; > <para> > - Not implemented yet. > + Not implemented yet. > </para> > </refsect1> > </refentry> > @@ -1252,7 +1252,7 @@ > </funcsynopsis> > &warn.experimental.func; > <para> > - Not implemented yet. > + Not implemented yet. > </para> > </refsect1> > </refentry> > @@ -1273,7 +1273,7 @@ > </funcsynopsis> > &warn.experimental.func; > <para> > - Not implemented yet. > + Not implemented yet. > </para> > </refsect1> > </refentry> > @@ -1294,7 +1294,7 @@ > </funcsynopsis> > &warn.experimental.func; > <para> > - Not implemented yet. > + Not implemented yet. > </para> > </refsect1> > </refentry> > @@ -1309,7 +1309,7 @@ > <funcsynopsis> > <funcprototype> > <funcdef>int <function>dbplus_rquery</function></funcdef> > - <void/> > + <void/> > </funcprototype> > </funcsynopsis> > &warn.experimental.func; > @@ -1335,7 +1335,7 @@ > </funcsynopsis> > &warn.experimental.func; > <para> > - Not implemented yet. > + Not implemented yet. > </para> > </refsect1> > </refentry> > @@ -1357,7 +1357,7 @@ > </funcsynopsis> > &warn.experimental.func; > <para> > - Not implemented yet. > + Not implemented yet. > </para> > </refsect1> > </refentry> > @@ -1378,7 +1378,7 @@ > </funcsynopsis> > &warn.experimental.func; > <para> > - Not implemented yet. > + Not implemented yet. > </para> > </refsect1> > </refentry> > @@ -1400,5 +1400,5 @@ > sgml-local-catalogs:nil > sgml-local-ecat-files:nil > End: > -vim: ts=1 sw=1 et syntax=sgml > +vi: et:ts=1:sw=1:textwidth=78:syntax=sgml > --> -- -- All known books about PHP and related books: http://php.net/books.php Concert Band of the University of Hohenheim: http://www.concert-band.de/ First and second bestselling book in German: http://www.php-buch.de/