cvs: phpdoc /en/reference/yaz reference.xml /en/reference/yaz/functions yaz-addinfo.xml yaz-ccl-conf.xml yaz-ccl-parse.xml yaz-close.xml
yaz-connect.xml yaz-database.xml yaz-element.xml yaz-errno.xml yaz-error.xml yaz-get-option.xml yaz-hits.xml yaz-itemorder.xml yaz-range.xml
yaz-record.xml yaz-scan-result.xml yaz-scan.xml yaz-search.xml yaz-sort.xml yaz-wait.xml
| From: | Friedhelm Betz | Date: | Sun, 15 Jun 2003 15:21:05 +0000 |
| Subject: | cvs: phpdoc /en/reference/yaz reference.xml /en/reference/yaz/functions yaz-addinfo.xml yaz-ccl-conf.xml yaz-ccl-parse.xml yaz-close.xml yaz-connect.xml yaz-database.xml yaz-element.xml yaz-errno.xml yaz-error.xml yaz-get-option.xml yaz-hits.xml yaz-itemorder.xml yaz-range.xml yaz-record.xml yaz-scan-result.xml yaz-scan.xml yaz-search.xml yaz-sort.xml yaz-wait.xml |
||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969354482@lists.php.net to get a copy of this message | ||
betz Sun Jun 15 11:21:05 2003 EDT
Modified files:
/phpdoc/en/reference/yaz reference.xml
/phpdoc/en/reference/yaz/functions yaz-addinfo.xml yaz-ccl-conf.xml
yaz-ccl-parse.xml yaz-close.xml
yaz-connect.xml yaz-database.xml
yaz-element.xml yaz-errno.xml
yaz-error.xml yaz-get-option.xml
yaz-hits.xml yaz-itemorder.xml
yaz-range.xml yaz-record.xml
yaz-scan-result.xml yaz-scan.xml
yaz-search.xml yaz-sort.xml
yaz-wait.xml
Log:
param corrections, grammar, php tags, some rewording, entities
Index: phpdoc/en/reference/yaz/reference.xml diff -u phpdoc/en/reference/yaz/reference.xml:1.10 phpdoc/en/reference/yaz/reference.xml:1.11 --- phpdoc/en/reference/yaz/reference.xml:1.10 Wed Jun 11 18:03:09 2003 +++ phpdoc/en/reference/yaz/reference.xml Sun Jun 15 11:21:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.10 $ --> +<!-- $Revision: 1.11 $ --> <reference id="ref.yaz"> <title>YAZ functions</title> <titleabbrev>YAZ</titleabbrev> @@ -63,6 +63,7 @@ <title>Parallel searching using Yaz</title> <programlisting role="php"> <![CDATA[ +<?php $num_hosts = count ($host); if (empty($term) || count($host) == 0) { echo '<form method="GET"> @@ -108,6 +109,7 @@ echo '</dl>'; } } +?> ]]> </programlisting> </example> @@ -138,4 +140,3 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> - Index: phpdoc/en/reference/yaz/functions/yaz-addinfo.xml diff -u phpdoc/en/reference/yaz/functions/yaz-addinfo.xml:1.3 phpdoc/en/reference/yaz/functions/yaz-addinfo.xml:1.4 --- phpdoc/en/reference/yaz/functions/yaz-addinfo.xml:1.3 Thu Jan 16 04:44:49 2003 +++ phpdoc/en/reference/yaz/functions/yaz-addinfo.xml Sun Jun 15 11:21:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/yaz.xml, last change in rev 1.1 --> <refentry id="function.yaz-addinfo"> <refnamediv> @@ -13,9 +13,13 @@ <methodparam><type>resource</type><parameter>id</parameter></methodparam> </methodsynopsis> <para> - Returns additional error message for target (last request). An - empty string is returned if last operation was a success or if no - additional information was provided by the target. + Returns additional error message for target (last request), identified by + parameter <parameter>id</parameter>. An empty string is returned if the + last operation was succesful or if no additional information was provided + by the target. + </para> + <para> + See also <function>yaz_error</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/yaz/functions/yaz-ccl-conf.xml diff -u phpdoc/en/reference/yaz/functions/yaz-ccl-conf.xml:1.3 phpdoc/en/reference/yaz/functions/yaz-ccl-conf.xml:1.4 --- phpdoc/en/reference/yaz/functions/yaz-ccl-conf.xml:1.3 Thu Jan 16 04:44:49 2003 +++ phpdoc/en/reference/yaz/functions/yaz-ccl-conf.xml Sun Jun 15 11:21:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/yaz.xml, last change in rev 1.8 --> <refentry id="function.yaz-ccl-conf"> <refnamediv> @@ -37,10 +37,12 @@ </simpara> <programlisting> <![CDATA[ +<?php $fields["ti"] = "1=4"; $fields["au"] = "1=1"; $fields["isbn"] = "1=7"; yaz_ccl_conf($id,$fields); +?> ]]> </programlisting> </example> Index: phpdoc/en/reference/yaz/functions/yaz-ccl-parse.xml diff -u phpdoc/en/reference/yaz/functions/yaz-ccl-parse.xml:1.3 phpdoc/en/reference/yaz/functions/yaz-ccl-parse.xml:1.4 --- phpdoc/en/reference/yaz/functions/yaz-ccl-parse.xml:1.3 Thu Jan 16 04:44:49 2003 +++ phpdoc/en/reference/yaz/functions/yaz-ccl-parse.xml Sun Jun 15 11:21:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/yaz.xml, last change in rev 1.1 --> <refentry id="function.yaz-ccl-parse"> <refnamediv> @@ -9,7 +9,7 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>int</type><methodname>yaz_ccl_parse</methodname> + <type>bool</type><methodname>yaz_ccl_parse</methodname> <methodparam><type>resource</type><parameter>id</parameter></methodparam> <methodparam><type>string</type><parameter>query</parameter></methodparam> <methodparam><type>array &</type><parameter>result</parameter></methodparam> @@ -27,18 +27,19 @@ If the query could not be converted (because of invalid syntax, unknown field, etc.) this function returns &false; and three indexes are set in the resulting array to indicate the cause - of failure: <literal>errorcode</literal>CCL error code (integer), - <literal>errorstring</literal>CCL error string, and - <literal>errorpos</literal>approximate position in query of failure + of failure: <literal>errorcode</literal> CCL error code (integer), + <literal>errorstring</literal> CCL error string, and + <literal>errorpos</literal> approximate position in query of failure (integer is character position). </para> <example> <title>CCL Parsing</title> - <para>We'll try to search using CCL. In the example below, + <para>We will try to search using CCL. In the example below, <literal>$ccl</literal> is a CCL query. </para> <programlisting> <![CDATA[ +<?php yaz_ccl_conf($id,$fields); // see example for yaz_ccl_conf if (!yaz_ccl_parse($id, $ccl, &$cclresult) { echo 'Error: ' . $cclresult["errorstring"]; @@ -46,6 +47,7 @@ $rpn = $cclresult["rpn"]; yaz_search($id,"rpn",$rpn); } +?> ]]> </programlisting> </example> Index: phpdoc/en/reference/yaz/functions/yaz-close.xml diff -u phpdoc/en/reference/yaz/functions/yaz-close.xml:1.3 phpdoc/en/reference/yaz/functions/yaz-close.xml:1.4 --- phpdoc/en/reference/yaz/functions/yaz-close.xml:1.3 Thu Jan 16 04:44:49 2003 +++ phpdoc/en/reference/yaz/functions/yaz-close.xml Sun Jun 15 11:21:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/yaz.xml, last change in rev 1.1 --> <refentry id="function.yaz-close"> <refnamediv> @@ -9,13 +9,16 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>int</type><methodname>yaz_close</methodname> + <type>bool</type><methodname>yaz_close</methodname> <methodparam><type>resource</type><parameter>id</parameter></methodparam> </methodsynopsis> <para> - Closes connection given by <parameter>id</parameter>. + Closes the connection given by parameter <parameter>id</parameter>. The <parameter>id</parameter> is a connection resource as returned - by a previous <function>yaz_connect</function> call. + by a previous call to <function>yaz_connect</function>. + </para> + <para> + &return.success; </para> </refsect1> </refentry> Index: phpdoc/en/reference/yaz/functions/yaz-connect.xml diff -u phpdoc/en/reference/yaz/functions/yaz-connect.xml:1.3 phpdoc/en/reference/yaz/functions/yaz-connect.xml:1.4 --- phpdoc/en/reference/yaz/functions/yaz-connect.xml:1.3 Thu Jan 16 04:44:49 2003 +++ phpdoc/en/reference/yaz/functions/yaz-connect.xml Sun Jun 15 11:21:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/yaz.xml, last change in rev 1.1 --> <refentry id="function.yaz-connect"> <refnamediv> @@ -14,9 +14,9 @@ <type>resource</type><methodname>yaz_connect</methodname> <methodparam><type>string</type><parameter>zurl</parameter></methodparam> <methodparam choice="opt"><type>mixed</type><parameter>options</parameter></methodparam> - </methodsynopsis> + </methodsynopsis> <para> - This function returns a connection resource on success; zero on + This function returns a connection resource on success;, zero on failure. </para> <para> @@ -24,7 +24,7 @@ Z39.50 target. The <parameter>zurl</parameter> argument takes the form host[:port][/database]. If port is omitted 210 is used. If database is omitted <literal>Default</literal> is used. - This function is non-blocking and doesn't attempt to establish + This function is non-blocking and does not attempt to establish a socket - it merely prepares a connect to be performed later when <function>yaz_wait</function> is called. </para> @@ -40,49 +40,65 @@ <variablelist> <title><function>yaz_connect</function> options</title> - <varlistentry><term>user</term><listitem> - <simpara>Username for authentication. - </simpara></listitem> - </varlistentry> - <varlistentry><term>group</term><listitem> - <simpara>Group for authentication. - </simpara></listitem> - </varlistentry> - <varlistentry><term>password</term><listitem> - <simpara>Password for authentication. - </simpara></listitem> - </varlistentry> - <varlistentry><term>cookie</term><listitem> - <simpara>Cookie for session (YAZ proxy). - </simpara></listitem> - </varlistentry> - <varlistentry><term>proxy</term><listitem> - <simpara>Proxy for connection (YAZ proxy). - </simpara></listitem> - </varlistentry> - <varlistentry><term>persistent</term><listitem> - <simpara>A boolean. If &true; the connection is persistent; If -&false; the connection is not persistent. By default connections are -persistent. - </simpara></listitem> - </varlistentry> - <varlistentry><term>piggyback</term><listitem> - <simpara>A boolean. If &true; piggyback is enabled for -searches; If &false; piggyback is disabled. -By default piggyback is enabled. Enabling piggyback is more efficient -and usually saves a network-round-trip for first time fetches of records. -However, a few Z39.50 targets doesn't support piggyback or they ignore -element set names. For those, piggyback should be disabled. - </simpara></listitem> + <varlistentry> + <term>user</term> + <listitem> + <simpara>Username for authentication.</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term>group</term> + <listitem> + <simpara>Group for authentication.</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term>password</term> + <listitem> + <simpara>Password for authentication.</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term>cookie</term> + <listitem> + <simpara>Cookie for session (YAZ proxy).</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term>proxy</term> + <listitem> + <simpara>Proxy for connection (YAZ proxy).</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term>persistent</term> + <listitem> + <simpara>A boolean. If &true; the connection is persistent; If &false; + the connection is not persistent. By default connections are persistent. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term>piggyback</term> + <listitem> + <simpara>A boolean. If &true; piggyback is enabled for searches; If + &false; piggyback is disabled. By default piggyback is enabled. Enabling + piggyback is more efficient and usually saves a network-round-trip for + first time fetches of records. However, a few Z39.50 targets do not + support piggyback or they ignore element set names. For those, piggyback + should be disabled. + </simpara> + </listitem> </varlistentry> </variablelist> </para> - <note> - <para>The use of a proxy often improves performance. A Z39.50 proxy - is part of the free <ulink url="&url.yaz-proxy;">YAZ++</ulink> - package. - </para> - </note> + <para> + <note> + <para>The use of a proxy often improves performance. A Z39.50 proxy + is part of the free <ulink url="&url.yaz-proxy;">YAZ++</ulink> package. + </para> + </note> + </para> </refsect1> </refentry> Index: phpdoc/en/reference/yaz/functions/yaz-database.xml diff -u phpdoc/en/reference/yaz/functions/yaz-database.xml:1.3 phpdoc/en/reference/yaz/functions/yaz-database.xml:1.4 --- phpdoc/en/reference/yaz/functions/yaz-database.xml:1.3 Thu Jan 16 04:44:49 2003 +++ phpdoc/en/reference/yaz/functions/yaz-database.xml Sun Jun 15 11:21:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/yaz.xml, last change in rev 1.7 --> <refentry id="function.yaz-database"> <refnamediv> @@ -11,7 +11,7 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>int</type><methodname>yaz_database</methodname> + <type>bool</type><methodname>yaz_database</methodname> <methodparam><type>resource</type><parameter>id</parameter></methodparam> <methodparam><type>string</type><parameter>databases</parameter></methodparam> </methodsynopsis> @@ -26,7 +26,7 @@ a session. </para> <para> - Returns &true; on success; &false; on error. + &return.success; </para> </refsect1> </refentry> Index: phpdoc/en/reference/yaz/functions/yaz-element.xml diff -u phpdoc/en/reference/yaz/functions/yaz-element.xml:1.3 phpdoc/en/reference/yaz/functions/yaz-element.xml:1.4 --- phpdoc/en/reference/yaz/functions/yaz-element.xml:1.3 Thu Jan 16 04:44:49 2003 +++ phpdoc/en/reference/yaz/functions/yaz-element.xml Sun Jun 15 11:21:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/yaz.xml, last change in rev 1.11 --> <refentry id="function.yaz-element"> <refnamediv> @@ -11,7 +11,7 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>int</type><methodname>yaz_element</methodname> + <type>bool</type><methodname>yaz_element</methodname> <methodparam><type>resource</type><parameter>id</parameter></methodparam> <methodparam><type>string</type><parameter>elementset</parameter></methodparam> </methodsynopsis> @@ -24,7 +24,7 @@ <literal>B</literal> (for brief records). </para> <para> - Returns &true; on success; &false; on error. + &return.success; </para> </refsect1> </refentry> Index: phpdoc/en/reference/yaz/functions/yaz-errno.xml diff -u phpdoc/en/reference/yaz/functions/yaz-errno.xml:1.3 phpdoc/en/reference/yaz/functions/yaz-errno.xml:1.4 --- phpdoc/en/reference/yaz/functions/yaz-errno.xml:1.3 Thu Jan 16 04:44:49 2003 +++ phpdoc/en/reference/yaz/functions/yaz-errno.xml Sun Jun 15 11:21:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/yaz.xml, last change in rev 1.1 --> <refentry id="function.yaz-errno"> <refnamediv> @@ -13,10 +13,10 @@ <methodparam><type>resource</type><parameter>id</parameter></methodparam> </methodsynopsis> <para> - Returns error for target (last request). The error code is either - a Z39.50 diagnostic code (usually a Bib-1 diagnostic) or a - client side error code which is generated by PHP/YAZ itself, such - as "Connect failed", "Init Rejected", etc. + Returns an errornumber for the target (last request) identified by + <parameter>id</parameter>. The error code is either a Z39.50 diagnostic + code (usually a Bib-1 diagnostic) or a client side error code which is + generated by PHP/YAZ itself, such as "Connect failed", "Init Rejected", etc. </para> <para> <function>yaz_errno</function> should be called after network Index: phpdoc/en/reference/yaz/functions/yaz-error.xml diff -u phpdoc/en/reference/yaz/functions/yaz-error.xml:1.3 phpdoc/en/reference/yaz/functions/yaz-error.xml:1.4 --- phpdoc/en/reference/yaz/functions/yaz-error.xml:1.3 Thu Jan 16 04:44:49 2003 +++ phpdoc/en/reference/yaz/functions/yaz-error.xml Sun Jun 15 11:21:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/yaz.xml, last change in rev 1.1 --> <refentry id="function.yaz-error"> <refnamediv> @@ -13,8 +13,9 @@ <methodparam><type>resource</type><parameter>id</parameter></methodparam> </methodsynopsis> <para> - Returns error text message for target (last request). An empty string - is returned if last operation was a success. + Returns an error text message for target (last request), identified by + parameter <parameter>id</parameter>. An empty string is returned if the + last operation was successful. </para> <para> <function>yaz_error</function> returns an english text message Index: phpdoc/en/reference/yaz/functions/yaz-get-option.xml diff -u phpdoc/en/reference/yaz/functions/yaz-get-option.xml:1.1 phpdoc/en/reference/yaz/functions/yaz-get-option.xml:1.2 --- phpdoc/en/reference/yaz/functions/yaz-get-option.xml:1.1 Thu Jan 16 04:44:49 2003 +++ phpdoc/en/reference/yaz/functions/yaz-get-option.xml Sun Jun 15 11:21:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.yaz-get-option"> <refnamediv> <refname>yaz_get_option</refname> @@ -13,11 +13,11 @@ <methodparam><type>string</type><parameter>name</parameter></methodparam> </methodsynopsis> <para> - Returns value of option with the <parameter>name</parameter> specified. - If option is unset, an empty string is returned. + Returns the value of the option specified with <parameter>name</parameter>. + If an option is not set, an empty string is returned. </para> <para> - See description of <function>yaz_set_option</function> for + See the description of <function>yaz_set_option</function> for available options. </para> </refsect1> Index: phpdoc/en/reference/yaz/functions/yaz-hits.xml diff -u phpdoc/en/reference/yaz/functions/yaz-hits.xml:1.3 phpdoc/en/reference/yaz/functions/yaz-hits.xml:1.4 --- phpdoc/en/reference/yaz/functions/yaz-hits.xml:1.3 Sun Jan 19 22:27:19 2003 +++ phpdoc/en/reference/yaz/functions/yaz-hits.xml Sun Jun 15 11:21:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/yaz.xml, last change in rev 1.1 --> <refentry id="function.yaz-hits"> <refnamediv> @@ -13,7 +13,7 @@ <methodparam><type>resource</type><parameter>id</parameter></methodparam> </methodsynopsis> <para> - <function>yaz_hits</function> returns number of hits for last + <function>yaz_hits</function> returns the number of hits for the last search. </para> </refsect1> Index: phpdoc/en/reference/yaz/functions/yaz-itemorder.xml diff -u phpdoc/en/reference/yaz/functions/yaz-itemorder.xml:1.4 phpdoc/en/reference/yaz/functions/yaz-itemorder.xml:1.5 --- phpdoc/en/reference/yaz/functions/yaz-itemorder.xml:1.4 Thu Jan 16 04:44:49 2003 +++ phpdoc/en/reference/yaz/functions/yaz-itemorder.xml Sun Jun 15 11:21:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/yaz.xml, last change in rev 1.8 --> <refentry id="function.yaz-itemorder"> <refnamediv> @@ -23,9 +23,9 @@ and the <ulink url="&url.yaz.specs;"> specification</ulink>. - The args parameter must be a hash array with information about the - Item Order request to be sent. The key of the hash is the name - of the corresponding ASN.1 tag path. For example, the ISBN below + The <parameter>args</parameter> parameter must be a hash array with + information about the Item Order request to be sent. The key of the hash is + the name of the corresponding ASN.1 tag path. For example, the ISBN below the Item-ID has the key item-id,ISBN. </para> <para> Index: phpdoc/en/reference/yaz/functions/yaz-range.xml diff -u phpdoc/en/reference/yaz/functions/yaz-range.xml:1.3 phpdoc/en/reference/yaz/functions/yaz-range.xml:1.4 --- phpdoc/en/reference/yaz/functions/yaz-range.xml:1.3 Thu Jan 16 04:44:49 2003 +++ phpdoc/en/reference/yaz/functions/yaz-range.xml Sun Jun 15 11:21:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/yaz.xml, last change in rev 1.1 --> <refentry id="function.yaz-range"> <refnamediv> @@ -11,7 +11,7 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>int</type><methodname>yaz_range</methodname> + <type>bool</type><methodname>yaz_range</methodname> <methodparam><type>resource</type><parameter>id</parameter></methodparam> <methodparam><type>int</type><parameter>start</parameter></methodparam> <methodparam><type>int</type><parameter>number</parameter></methodparam> @@ -20,13 +20,13 @@ This function should be called before either <function>yaz_search</function> or <function>yaz_present</function> to specify a range of records to be retrieved. - The <parameter>start</parameter> specifies position of first record - to be retrieved and <parameter>number</parameter> is the number - records. Records in a result set are numbered 1, 2, ... $hits where - $hits is the count returned by <function>yaz_hits</function>. + The parameter <parameter>start</parameter> specifies the position of the + first record to be retrieved and parameter <parameter>number</parameter> is + the number of records. Records in a result set are numbered 1, 2, ... $hits + where $hits is the count returned by <function>yaz_hits</function>. </para> <para> - Returns &true; on success; &false; on error. + &return.success; </para> </refsect1> </refentry> Index: phpdoc/en/reference/yaz/functions/yaz-record.xml diff -u phpdoc/en/reference/yaz/functions/yaz-record.xml:1.3 phpdoc/en/reference/yaz/functions/yaz-record.xml:1.4 --- phpdoc/en/reference/yaz/functions/yaz-record.xml:1.3 Thu Jan 16 04:44:49 2003 +++ phpdoc/en/reference/yaz/functions/yaz-record.xml Sun Jun 15 11:21:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/yaz.xml, last change in rev 1.1 --> <refentry id="function.yaz-record"> <refnamediv> @@ -15,15 +15,15 @@ <methodparam><type>string</type><parameter>type</parameter></methodparam> </methodsynopsis> <para> - Returns record at position <parameter>pos</parameter> or empty - string if no record exists at given position. + Returns the record at position <parameter>pos</parameter> or an empty + string if no record exists at the given position. </para> <para> - The <function>yaz_record</function> function inspects a record in - the current result set at the position specified. If no database - record exists at the given position an empty string is - returned. The <parameter>type</parameter> specifies the form of - the returned record. + The <function>yaz_record</function> function inspects a record in the + current result set at the position specified by parameter + <parameter>pos</parameter>. If no database record exists at the given + position an empty string is returned. The <parameter>type</parameter> + specifies the form of the returned record. </para> <para> If type is <literal>"string"</literal> the record is Index: phpdoc/en/reference/yaz/functions/yaz-scan-result.xml diff -u phpdoc/en/reference/yaz/functions/yaz-scan-result.xml:1.3 phpdoc/en/reference/yaz/functions/yaz-scan-result.xml:1.4 --- phpdoc/en/reference/yaz/functions/yaz-scan-result.xml:1.3 Thu Jan 16 04:44:49 2003 +++ phpdoc/en/reference/yaz/functions/yaz-scan-result.xml Sun Jun 15 11:21:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/yaz.xml, last change in rev 1.8 --> <refentry id="function.yaz-scan-result"> <refnamediv> @@ -18,10 +18,10 @@ information as received from the target in the last performed <function>yaz_scan</function>. This function returns an array (0..n-1) where n is the number - of terms returned. Each value is a pair where first item is - term, second item is result-count. - If the <parameter>result</parameter> is given it will be modified to hold - additional information taken from the Scan Response: + of terms returned. Each value is a pair where the first item is the + term, and the second item is the result-count. + If the optional parameter <parameter>result</parameter> is given it will be + modified to hold additional information taken from the Scan Response: <literal>number</literal> (number of entries returned), <literal>stepsize</literal> (Step-size), <literal>position</literal> (position of term), Index: phpdoc/en/reference/yaz/functions/yaz-scan.xml diff -u phpdoc/en/reference/yaz/functions/yaz-scan.xml:1.3 phpdoc/en/reference/yaz/functions/yaz-scan.xml:1.4 --- phpdoc/en/reference/yaz/functions/yaz-scan.xml:1.3 Thu Jan 16 04:44:49 2003 +++ phpdoc/en/reference/yaz/functions/yaz-scan.xml Sun Jun 15 11:21:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/yaz.xml, last change in rev 1.8 --> <refentry id="function.yaz-scan"> <refnamediv> @@ -16,12 +16,12 @@ <methodparam choice="opt"><type>array</type><parameter>flags</parameter></methodparam> </methodsynopsis> <para> - This function prepares for a Z39.50 Scan Request. Argument + This function prepares for a Z39.50 Scan Request, where parameter <parameter>id</parameter> specifies connection. Starting term point for the scan is given by <parameter>startterm</parameter>. - The form in which is the starting term is specified is given by - <parameter>type</parameter>. Currently type <literal>rpn</literal> - is supported. The optional <parameter>flags</parameter> + The form in which the starting term is specified is given by parameter + <parameter>type</parameter>. Currently only type <literal>rpn</literal> + is supported. The optional parameter <parameter>flags</parameter> specifies additional information to control the behaviour of the scan request. Three indexes are currently read from the flags: <literal>number</literal> (number of terms requested), @@ -30,13 +30,13 @@ To actually tranfer the Scan Request to the target and receive the Scan Response, <function>yaz_wait</function> must be called. Upon completion of <function>yaz_wait</function> call - <function>yaz_error</function> and - <function>yaz_scan_result</function> to handle the response. + <function>yaz_error</function> and <function>yaz_scan_result</function> to + handle the response. </para> <para> The syntax of <parameter>startterm</parameter> is similar to the RPN query as described in <function>yaz_search</function>. The - startterm consists of zero or more <literal>@attr</literal>-operator + startterm consists of zero or more <literal>@attr</literal>-operator specifications, then followed by exactly one token. </para> <para> @@ -44,6 +44,7 @@ <title>PHP function that scans titles</title> <programlisting> <![CDATA[ +<?php function scan_titles($id, $startterm) { yaz_scan($id,"rpn", "@attr 1=4 " . $startterm); yaz_wait(); @@ -66,6 +67,7 @@ echo "Scan failed. Error: " . yaz_error($id) . "<br>"; } } +?> ]]> </programlisting> </example> Index: phpdoc/en/reference/yaz/functions/yaz-search.xml diff -u phpdoc/en/reference/yaz/functions/yaz-search.xml:1.3 phpdoc/en/reference/yaz/functions/yaz-search.xml:1.4 --- phpdoc/en/reference/yaz/functions/yaz-search.xml:1.3 Thu Jan 16 04:44:49 2003 +++ phpdoc/en/reference/yaz/functions/yaz-search.xml Sun Jun 15 11:21:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/yaz.xml, last change in rev 1.1 --> <refentry id="function.yaz-search"> <refnamediv> @@ -16,8 +16,8 @@ </methodsynopsis> <para> <function>yaz_search</function> prepares for a search on the - connection given by <parameter>id</parameter>. - The <parameter>type</parameter> represents the query type - only + connection given by parameter <parameter>id</parameter>. + The parameter <parameter>type</parameter> represents the query type - only <literal>"rpn"</literal> is supported now in which case the third argument specifies a Type-1 query in prefix query notation. Like <function>yaz_connect</function> this @@ -32,9 +32,9 @@ defined by the Z39.50 standard. However, in the text representation as used by YAZ a prefix notation is used, that is the operater precedes the operands. The query string is a sequence of tokens where - white space is ignored is ignored unless surrounded by double - quotes. Tokens beginning with an at-character (<literal>@</literal>) - are considered operators, otherwise they are treated as search terms. + white space is ignored unless surrounded by double quotes. Tokens beginning + with an at-character (<literal>@</literal>) are considered operators, + otherwise they are treated as search terms. </para> <table> <title>RPN Operators</title> Index: phpdoc/en/reference/yaz/functions/yaz-sort.xml diff -u phpdoc/en/reference/yaz/functions/yaz-sort.xml:1.3 phpdoc/en/reference/yaz/functions/yaz-sort.xml:1.4 --- phpdoc/en/reference/yaz/functions/yaz-sort.xml:1.3 Thu Jan 16 04:44:49 2003 +++ phpdoc/en/reference/yaz/functions/yaz-sort.xml Sun Jun 15 11:21:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/yaz.xml, last change in rev 1.1 --> <refentry id="function.yaz-sort"> <refnamediv> @@ -17,23 +17,22 @@ This function sets sorting criteria and enables Z39.50 Sort. Call this function <emphasis>before</emphasis> <function>yaz_search</function>. - Using this function alone doesn't have any effect. - When in conjunction with <function>yaz_search</function>, - a Z39.50 Sort will be sent after - a search response has been received and before any records are - retrieved with Z39.50 Present. The <parameter>criteria</parameter> - takes the form + Using this function alone does not have any effect. When used in conjunction + with <function>yaz_search</function>, a Z39.50 Sort will be sent after a + search response has been received and before any records are retrieved with + Z39.50 Present (<function>yaz_present</function>. The parameter + <parameter>criteria</parameter> takes the form </para> <para> <replaceable>field1 flags1 field2 flags2</replaceable> ... </para> <para> - where field1 specifies primary attributes for sort, field2 seconds, - etc.. The field specifies either numerical attribute combinations consisting + where field1 specifies the primary attributes for sort, field2 seconds, + etc.. The field specifies either a numerical attribute combinations consisting of type=value pairs separated by comma (e.g. <literal>1=4,2=1</literal>) ; or the field may specify a plain string criteria - (e.g. <literal>title</literal>. The flags is a sequnce of the - following characters which may not be separated by any white space. + (e.g. <literal>title</literal>. The flags is a sequnce of the following + characters which may not be separated by any white space. </para> <variablelist> <title>Sort Flags</title> @@ -54,14 +53,14 @@ <title>Sort Criterias</title> <para> To sort on Bib1 attribute title, case insensitive, - and ascending you'd use the following sort criteria: + and ascending you would use the following sort criteria: <screen> 1=4 ia </screen> </para> <para> If the secondary sorting criteria should be author, case sensitive - and ascending you'd use: + and ascending you would use: <screen> 1=4 ia 1=1003 sa </screen> Index: phpdoc/en/reference/yaz/functions/yaz-wait.xml diff -u phpdoc/en/reference/yaz/functions/yaz-wait.xml:1.3 phpdoc/en/reference/yaz/functions/yaz-wait.xml:1.4 --- phpdoc/en/reference/yaz/functions/yaz-wait.xml:1.3 Fri Dec 13 22:31:52 2002 +++ phpdoc/en/reference/yaz/functions/yaz-wait.xml Sun Jun 15 11:21:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/yaz.xml, last change in rev 1.15 --> <refentry id="function.yaz-wait"> <refnamediv> @@ -26,11 +26,15 @@ options that change the behaviour of <function>yaz_wait</function>. </para> <variablelist> - <varlistentry><term><literal>timeout</literal></term><listitem> - <para>Sets timeout in seconds. If a target hasn't responded within - the timeout it is considered dead and <function>yaz_wait</function> - returns. The default value for timeout is 15 seconds. - </para></listitem> + <varlistentry> + <term><literal>timeout</literal></term> + <listitem> + <para> + Sets timeout in seconds. If a target has not responded within + the timeout it is considered dead and <function>yaz_wait</function> + returns. The default value for timeout is 15 seconds. + </para> + </listitem> </varlistentry> </variablelist> </refsect1>
Index: phpdoc/en/reference/yaz/reference.xml diff -u phpdoc/en/reference/yaz/reference.xml:1.10 phpdoc/en/reference/yaz/reference.xml:1.11 --- phpdoc/en/reference/yaz/reference.xml:1.10 Wed Jun 11 18:03:09 2003 +++ phpdoc/en/reference/yaz/reference.xml Sun Jun 15 11:21:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.10 $ --> +<!-- $Revision: 1.11 $ --> <reference id="ref.yaz"> <title>YAZ functions</title> <titleabbrev>YAZ</titleabbrev> @@ -63,6 +63,7 @@ <title>Parallel searching using Yaz</title> <programlisting role="php"> <![CDATA[ +<?php $num_hosts = count ($host); if (empty($term) || count($host) == 0) { echo '<form method="GET"> @@ -108,6 +109,7 @@ echo '</dl>'; } } +?> ]]> </programlisting> </example> @@ -138,4 +140,3 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> - Index: phpdoc/en/reference/yaz/functions/yaz-addinfo.xml diff -u phpdoc/en/reference/yaz/functions/yaz-addinfo.xml:1.3 phpdoc/en/reference/yaz/functions/yaz-addinfo.xml:1.4 --- phpdoc/en/reference/yaz/functions/yaz-addinfo.xml:1.3 Thu Jan 16 04:44:49 2003 +++ phpdoc/en/reference/yaz/functions/yaz-addinfo.xml Sun Jun 15 11:21:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/yaz.xml, last change in rev 1.1 --> <refentry id="function.yaz-addinfo"> <refnamediv> @@ -13,9 +13,13 @@ <methodparam><type>resource</type><parameter>id</parameter></methodparam> </methodsynopsis> <para> - Returns additional error message for target (last request). An - empty string is returned if last operation was a success or if no - additional information was provided by the target. + Returns additional error message for target (last request), identified by + parameter <parameter>id</parameter>. An empty string is returned if the + last operation was succesful or if no additional information was provided + by the target. + </para> + <para> + See also <function>yaz_error</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/yaz/functions/yaz-ccl-conf.xml diff -u phpdoc/en/reference/yaz/functions/yaz-ccl-conf.xml:1.3 phpdoc/en/reference/yaz/functions/yaz-ccl-conf.xml:1.4 --- phpdoc/en/reference/yaz/functions/yaz-ccl-conf.xml:1.3 Thu Jan 16 04:44:49 2003 +++ phpdoc/en/reference/yaz/functions/yaz-ccl-conf.xml Sun Jun 15 11:21:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/yaz.xml, last change in rev 1.8 --> <refentry id="function.yaz-ccl-conf"> <refnamediv> @@ -37,10 +37,12 @@ </simpara> <programlisting> <![CDATA[ +<?php $fields["ti"] = "1=4"; $fields["au"] = "1=1"; $fields["isbn"] = "1=7"; yaz_ccl_conf($id,$fields); +?> ]]> </programlisting> </example> Index: phpdoc/en/reference/yaz/functions/yaz-ccl-parse.xml diff -u phpdoc/en/reference/yaz/functions/yaz-ccl-parse.xml:1.3 phpdoc/en/reference/yaz/functions/yaz-ccl-parse.xml:1.4 --- phpdoc/en/reference/yaz/functions/yaz-ccl-parse.xml:1.3 Thu Jan 16 04:44:49 2003 +++ phpdoc/en/reference/yaz/functions/yaz-ccl-parse.xml Sun Jun 15 11:21:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/yaz.xml, last change in rev 1.1 --> <refentry id="function.yaz-ccl-parse"> <refnamediv> @@ -9,7 +9,7 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>int</type><methodname>yaz_ccl_parse</methodname> + <type>bool</type><methodname>yaz_ccl_parse</methodname> <methodparam><type>resource</type><parameter>id</parameter></methodparam> <methodparam><type>string</type><parameter>query</parameter></methodparam> <methodparam><type>array &</type><parameter>result</parameter></methodparam> @@ -27,18 +27,19 @@ If the query could not be converted (because of invalid syntax, unknown field, etc.) this function returns &false; and three indexes are set in the resulting array to indicate the cause - of failure: <literal>errorcode</literal>CCL error code (integer), - <literal>errorstring</literal>CCL error string, and - <literal>errorpos</literal>approximate position in query of failure + of failure: <literal>errorcode</literal> CCL error code (integer), + <literal>errorstring</literal> CCL error string, and + <literal>errorpos</literal> approximate position in query of failure (integer is character position). </para> <example> <title>CCL Parsing</title> - <para>We'll try to search using CCL. In the example below, + <para>We will try to search using CCL. In the example below, <literal>$ccl</literal> is a CCL query. </para> <programlisting> <![CDATA[ +<?php yaz_ccl_conf($id,$fields); // see example for yaz_ccl_conf if (!yaz_ccl_parse($id, $ccl, &$cclresult) { echo 'Error: ' . $cclresult["errorstring"]; @@ -46,6 +47,7 @@ $rpn = $cclresult["rpn"]; yaz_search($id,"rpn",$rpn); } +?> ]]> </programlisting> </example> Index: phpdoc/en/reference/yaz/functions/yaz-close.xml diff -u phpdoc/en/reference/yaz/functions/yaz-close.xml:1.3 phpdoc/en/reference/yaz/functions/yaz-close.xml:1.4 --- phpdoc/en/reference/yaz/functions/yaz-close.xml:1.3 Thu Jan 16 04:44:49 2003 +++ phpdoc/en/reference/yaz/functions/yaz-close.xml Sun Jun 15 11:21:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/yaz.xml, last change in rev 1.1 --> <refentry id="function.yaz-close"> <refnamediv> @@ -9,13 +9,16 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>int</type><methodname>yaz_close</methodname> + <type>bool</type><methodname>yaz_close</methodname> <methodparam><type>resource</type><parameter>id</parameter></methodparam> </methodsynopsis> <para> - Closes connection given by <parameter>id</parameter>. + Closes the connection given by parameter <parameter>id</parameter>. The <parameter>id</parameter> is a connection resource as returned - by a previous <function>yaz_connect</function> call. + by a previous call to <function>yaz_connect</function>. + </para> + <para> + &return.success; </para> </refsect1> </refentry> Index: phpdoc/en/reference/yaz/functions/yaz-connect.xml diff -u phpdoc/en/reference/yaz/functions/yaz-connect.xml:1.3 phpdoc/en/reference/yaz/functions/yaz-connect.xml:1.4 --- phpdoc/en/reference/yaz/functions/yaz-connect.xml:1.3 Thu Jan 16 04:44:49 2003 +++ phpdoc/en/reference/yaz/functions/yaz-connect.xml Sun Jun 15 11:21:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/yaz.xml, last change in rev 1.1 --> <refentry id="function.yaz-connect"> <refnamediv> @@ -14,9 +14,9 @@ <type>resource</type><methodname>yaz_connect</methodname> <methodparam><type>string</type><parameter>zurl</parameter></methodparam> <methodparam choice="opt"><type>mixed</type><parameter>options</parameter></methodparam> - </methodsynopsis> + </methodsynopsis> <para> - This function returns a connection resource on success; zero on + This function returns a connection resource on success;, zero on failure. </para> <para> @@ -24,7 +24,7 @@ Z39.50 target. The <parameter>zurl</parameter> argument takes the form host[:port][/database]. If port is omitted 210 is used. If database is omitted <literal>Default</literal> is used. - This function is non-blocking and doesn't attempt to establish + This function is non-blocking and does not attempt to establish a socket - it merely prepares a connect to be performed later when <function>yaz_wait</function> is called. </para> @@ -40,49 +40,65 @@ <variablelist> <title><function>yaz_connect</function> options</title> - <varlistentry><term>user</term><listitem> - <simpara>Username for authentication. - </simpara></listitem> - </varlistentry> - <varlistentry><term>group</term><listitem> - <simpara>Group for authentication. - </simpara></listitem> - </varlistentry> - <varlistentry><term>password</term><listitem> - <simpara>Password for authentication. - </simpara></listitem> - </varlistentry> - <varlistentry><term>cookie</term><listitem> - <simpara>Cookie for session (YAZ proxy). - </simpara></listitem> - </varlistentry> - <varlistentry><term>proxy</term><listitem> - <simpara>Proxy for connection (YAZ proxy). - </simpara></listitem> - </varlistentry> - <varlistentry><term>persistent</term><listitem> - <simpara>A boolean. If &true; the connection is persistent; If -&false; the connection is not persistent. By default connections are -persistent. - </simpara></listitem> - </varlistentry> - <varlistentry><term>piggyback</term><listitem> - <simpara>A boolean. If &true; piggyback is enabled for -searches; If &false; piggyback is disabled. -By default piggyback is enabled. Enabling piggyback is more efficient -and usually saves a network-round-trip for first time fetches of records. -However, a few Z39.50 targets doesn't support piggyback or they ignore -element set names. For those, piggyback should be disabled. - </simpara></listitem> + <varlistentry> + <term>user</term> + <listitem> + <simpara>Username for authentication.</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term>group</term> + <listitem> + <simpara>Group for authentication.</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term>password</term> + <listitem> + <simpara>Password for authentication.</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term>cookie</term> + <listitem> + <simpara>Cookie for session (YAZ proxy).</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term>proxy</term> + <listitem> + <simpara>Proxy for connection (YAZ proxy).</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term>persistent</term> + <listitem> + <simpara>A boolean. If &true; the connection is persistent; If &false; + the connection is not persistent. By default connections are persistent. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term>piggyback</term> + <listitem> + <simpara>A boolean. If &true; piggyback is enabled for searches; If + &false; piggyback is disabled. By default piggyback is enabled. Enabling + piggyback is more efficient and usually saves a network-round-trip for + first time fetches of records. However, a few Z39.50 targets do not + support piggyback or they ignore element set names. For those, piggyback + should be disabled. + </simpara> + </listitem> </varlistentry> </variablelist> </para> - <note> - <para>The use of a proxy often improves performance. A Z39.50 proxy - is part of the free <ulink url="&url.yaz-proxy;">YAZ++</ulink> - package. - </para> - </note> + <para> + <note> + <para>The use of a proxy often improves performance. A Z39.50 proxy + is part of the free <ulink url="&url.yaz-proxy;">YAZ++</ulink> package. + </para> + </note> + </para> </refsect1> </refentry> Index: phpdoc/en/reference/yaz/functions/yaz-database.xml diff -u phpdoc/en/reference/yaz/functions/yaz-database.xml:1.3 phpdoc/en/reference/yaz/functions/yaz-database.xml:1.4 --- phpdoc/en/reference/yaz/functions/yaz-database.xml:1.3 Thu Jan 16 04:44:49 2003 +++ phpdoc/en/reference/yaz/functions/yaz-database.xml Sun Jun 15 11:21:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/yaz.xml, last change in rev 1.7 --> <refentry id="function.yaz-database"> <refnamediv> @@ -11,7 +11,7 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>int</type><methodname>yaz_database</methodname> + <type>bool</type><methodname>yaz_database</methodname> <methodparam><type>resource</type><parameter>id</parameter></methodparam> <methodparam><type>string</type><parameter>databases</parameter></methodparam> </methodsynopsis> @@ -26,7 +26,7 @@ a session. </para> <para> - Returns &true; on success; &false; on error. + &return.success; </para> </refsect1> </refentry> Index: phpdoc/en/reference/yaz/functions/yaz-element.xml diff -u phpdoc/en/reference/yaz/functions/yaz-element.xml:1.3 phpdoc/en/reference/yaz/functions/yaz-element.xml:1.4 --- phpdoc/en/reference/yaz/functions/yaz-element.xml:1.3 Thu Jan 16 04:44:49 2003 +++ phpdoc/en/reference/yaz/functions/yaz-element.xml Sun Jun 15 11:21:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/yaz.xml, last change in rev 1.11 --> <refentry id="function.yaz-element"> <refnamediv> @@ -11,7 +11,7 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>int</type><methodname>yaz_element</methodname> + <type>bool</type><methodname>yaz_element</methodname> <methodparam><type>resource</type><parameter>id</parameter></methodparam> <methodparam><type>string</type><parameter>elementset</parameter></methodparam> </methodsynopsis> @@ -24,7 +24,7 @@ <literal>B</literal> (for brief records). </para> <para> - Returns &true; on success; &false; on error. + &return.success; </para> </refsect1> </refentry> Index: phpdoc/en/reference/yaz/functions/yaz-errno.xml diff -u phpdoc/en/reference/yaz/functions/yaz-errno.xml:1.3 phpdoc/en/reference/yaz/functions/yaz-errno.xml:1.4 --- phpdoc/en/reference/yaz/functions/yaz-errno.xml:1.3 Thu Jan 16 04:44:49 2003 +++ phpdoc/en/reference/yaz/functions/yaz-errno.xml Sun Jun 15 11:21:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/yaz.xml, last change in rev 1.1 --> <refentry id="function.yaz-errno"> <refnamediv> @@ -13,10 +13,10 @@ <methodparam><type>resource</type><parameter>id</parameter></methodparam> </methodsynopsis> <para> - Returns error for target (last request). The error code is either - a Z39.50 diagnostic code (usually a Bib-1 diagnostic) or a - client side error code which is generated by PHP/YAZ itself, such - as "Connect failed", "Init Rejected", etc. + Returns an errornumber for the target (last request) identified by + <parameter>id</parameter>. The error code is either a Z39.50 diagnostic + code (usually a Bib-1 diagnostic) or a client side error code which is + generated by PHP/YAZ itself, such as "Connect failed", "Init Rejected", etc. </para> <para> <function>yaz_errno</function> should be called after network Index: phpdoc/en/reference/yaz/functions/yaz-error.xml diff -u phpdoc/en/reference/yaz/functions/yaz-error.xml:1.3 phpdoc/en/reference/yaz/functions/yaz-error.xml:1.4 --- phpdoc/en/reference/yaz/functions/yaz-error.xml:1.3 Thu Jan 16 04:44:49 2003 +++ phpdoc/en/reference/yaz/functions/yaz-error.xml Sun Jun 15 11:21:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/yaz.xml, last change in rev 1.1 --> <refentry id="function.yaz-error"> <refnamediv> @@ -13,8 +13,9 @@ <methodparam><type>resource</type><parameter>id</parameter></methodparam> </methodsynopsis> <para> - Returns error text message for target (last request). An empty string - is returned if last operation was a success. + Returns an error text message for target (last request), identified by + parameter <parameter>id</parameter>. An empty string is returned if the + last operation was successful. </para> <para> <function>yaz_error</function> returns an english text message Index: phpdoc/en/reference/yaz/functions/yaz-get-option.xml diff -u phpdoc/en/reference/yaz/functions/yaz-get-option.xml:1.1 phpdoc/en/reference/yaz/functions/yaz-get-option.xml:1.2 --- phpdoc/en/reference/yaz/functions/yaz-get-option.xml:1.1 Thu Jan 16 04:44:49 2003 +++ phpdoc/en/reference/yaz/functions/yaz-get-option.xml Sun Jun 15 11:21:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.yaz-get-option"> <refnamediv> <refname>yaz_get_option</refname> @@ -13,11 +13,11 @@ <methodparam><type>string</type><parameter>name</parameter></methodparam> </methodsynopsis> <para> - Returns value of option with the <parameter>name</parameter> specified. - If option is unset, an empty string is returned. + Returns the value of the option specified with <parameter>name</parameter>. + If an option is not set, an empty string is returned. </para> <para> - See description of <function>yaz_set_option</function> for + See the description of <function>yaz_set_option</function> for available options. </para> </refsect1> Index: phpdoc/en/reference/yaz/functions/yaz-hits.xml diff -u phpdoc/en/reference/yaz/functions/yaz-hits.xml:1.3 phpdoc/en/reference/yaz/functions/yaz-hits.xml:1.4 --- phpdoc/en/reference/yaz/functions/yaz-hits.xml:1.3 Sun Jan 19 22:27:19 2003 +++ phpdoc/en/reference/yaz/functions/yaz-hits.xml Sun Jun 15 11:21:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/yaz.xml, last change in rev 1.1 --> <refentry id="function.yaz-hits"> <refnamediv> @@ -13,7 +13,7 @@ <methodparam><type>resource</type><parameter>id</parameter></methodparam> </methodsynopsis> <para> - <function>yaz_hits</function> returns number of hits for last + <function>yaz_hits</function> returns the number of hits for the last search. </para> </refsect1> Index: phpdoc/en/reference/yaz/functions/yaz-itemorder.xml diff -u phpdoc/en/reference/yaz/functions/yaz-itemorder.xml:1.4 phpdoc/en/reference/yaz/functions/yaz-itemorder.xml:1.5 --- phpdoc/en/reference/yaz/functions/yaz-itemorder.xml:1.4 Thu Jan 16 04:44:49 2003 +++ phpdoc/en/reference/yaz/functions/yaz-itemorder.xml Sun Jun 15 11:21:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/yaz.xml, last change in rev 1.8 --> <refentry id="function.yaz-itemorder"> <refnamediv> @@ -23,9 +23,9 @@ and the <ulink url="&url.yaz.specs;"> specification</ulink>. - The args parameter must be a hash array with information about the - Item Order request to be sent. The key of the hash is the name - of the corresponding ASN.1 tag path. For example, the ISBN below + The <parameter>args</parameter> parameter must be a hash array with + information about the Item Order request to be sent. The key of the hash is + the name of the corresponding ASN.1 tag path. For example, the ISBN below the Item-ID has the key item-id,ISBN. </para> <para> Index: phpdoc/en/reference/yaz/functions/yaz-range.xml diff -u phpdoc/en/reference/yaz/functions/yaz-range.xml:1.3 phpdoc/en/reference/yaz/functions/yaz-range.xml:1.4 --- phpdoc/en/reference/yaz/functions/yaz-range.xml:1.3 Thu Jan 16 04:44:49 2003 +++ phpdoc/en/reference/yaz/functions/yaz-range.xml Sun Jun 15 11:21:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/yaz.xml, last change in rev 1.1 --> <refentry id="function.yaz-range"> <refnamediv> @@ -11,7 +11,7 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>int</type><methodname>yaz_range</methodname> + <type>bool</type><methodname>yaz_range</methodname> <methodparam><type>resource</type><parameter>id</parameter></methodparam> <methodparam><type>int</type><parameter>start</parameter></methodparam> <methodparam><type>int</type><parameter>number</parameter></methodparam> @@ -20,13 +20,13 @@ This function should be called before either <function>yaz_search</function> or <function>yaz_present</function> to specify a range of records to be retrieved. - The <parameter>start</parameter> specifies position of first record - to be retrieved and <parameter>number</parameter> is the number - records. Records in a result set are numbered 1, 2, ... $hits where - $hits is the count returned by <function>yaz_hits</function>. + The parameter <parameter>start</parameter> specifies the position of the + first record to be retrieved and parameter <parameter>number</parameter> is + the number of records. Records in a result set are numbered 1, 2, ... $hits + where $hits is the count returned by <function>yaz_hits</function>. </para> <para> - Returns &true; on success; &false; on error. + &return.success; </para> </refsect1> </refentry> Index: phpdoc/en/reference/yaz/functions/yaz-record.xml diff -u phpdoc/en/reference/yaz/functions/yaz-record.xml:1.3 phpdoc/en/reference/yaz/functions/yaz-record.xml:1.4 --- phpdoc/en/reference/yaz/functions/yaz-record.xml:1.3 Thu Jan 16 04:44:49 2003 +++ phpdoc/en/reference/yaz/functions/yaz-record.xml Sun Jun 15 11:21:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/yaz.xml, last change in rev 1.1 --> <refentry id="function.yaz-record"> <refnamediv> @@ -15,15 +15,15 @@ <methodparam><type>string</type><parameter>type</parameter></methodparam> </methodsynopsis> <para> - Returns record at position <parameter>pos</parameter> or empty - string if no record exists at given position. + Returns the record at position <parameter>pos</parameter> or an empty + string if no record exists at the given position. </para> <para> - The <function>yaz_record</function> function inspects a record in - the current result set at the position specified. If no database - record exists at the given position an empty string is - returned. The <parameter>type</parameter> specifies the form of - the returned record. + The <function>yaz_record</function> function inspects a record in the + current result set at the position specified by parameter + <parameter>pos</parameter>. If no database record exists at the given + position an empty string is returned. The <parameter>type</parameter> + specifies the form of the returned record. </para> <para> If type is <literal>"string"</literal> the record is Index: phpdoc/en/reference/yaz/functions/yaz-scan-result.xml diff -u phpdoc/en/reference/yaz/functions/yaz-scan-result.xml:1.3 phpdoc/en/reference/yaz/functions/yaz-scan-result.xml:1.4 --- phpdoc/en/reference/yaz/functions/yaz-scan-result.xml:1.3 Thu Jan 16 04:44:49 2003 +++ phpdoc/en/reference/yaz/functions/yaz-scan-result.xml Sun Jun 15 11:21:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/yaz.xml, last change in rev 1.8 --> <refentry id="function.yaz-scan-result"> <refnamediv> @@ -18,10 +18,10 @@ information as received from the target in the last performed <function>yaz_scan</function>. This function returns an array (0..n-1) where n is the number - of terms returned. Each value is a pair where first item is - term, second item is result-count. - If the <parameter>result</parameter> is given it will be modified to hold - additional information taken from the Scan Response: + of terms returned. Each value is a pair where the first item is the + term, and the second item is the result-count. + If the optional parameter <parameter>result</parameter> is given it will be + modified to hold additional information taken from the Scan Response: <literal>number</literal> (number of entries returned), <literal>stepsize</literal> (Step-size), <literal>position</literal> (position of term), Index: phpdoc/en/reference/yaz/functions/yaz-scan.xml diff -u phpdoc/en/reference/yaz/functions/yaz-scan.xml:1.3 phpdoc/en/reference/yaz/functions/yaz-scan.xml:1.4 --- phpdoc/en/reference/yaz/functions/yaz-scan.xml:1.3 Thu Jan 16 04:44:49 2003 +++ phpdoc/en/reference/yaz/functions/yaz-scan.xml Sun Jun 15 11:21:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/yaz.xml, last change in rev 1.8 --> <refentry id="function.yaz-scan"> <refnamediv> @@ -16,12 +16,12 @@ <methodparam choice="opt"><type>array</type><parameter>flags</parameter></methodparam> </methodsynopsis> <para> - This function prepares for a Z39.50 Scan Request. Argument + This function prepares for a Z39.50 Scan Request, where parameter <parameter>id</parameter> specifies connection. Starting term point for the scan is given by <parameter>startterm</parameter>. - The form in which is the starting term is specified is given by - <parameter>type</parameter>. Currently type <literal>rpn</literal> - is supported. The optional <parameter>flags</parameter> + The form in which the starting term is specified is given by parameter + <parameter>type</parameter>. Currently only type <literal>rpn</literal> + is supported. The optional parameter <parameter>flags</parameter> specifies additional information to control the behaviour of the scan request. Three indexes are currently read from the flags: <literal>number</literal> (number of terms requested), @@ -30,13 +30,13 @@ To actually tranfer the Scan Request to the target and receive the Scan Response, <function>yaz_wait</function> must be called. Upon completion of <function>yaz_wait</function> call - <function>yaz_error</function> and - <function>yaz_scan_result</function> to handle the response. + <function>yaz_error</function> and <function>yaz_scan_result</function> to + handle the response. </para> <para> The syntax of <parameter>startterm</parameter> is similar to the RPN query as described in <function>yaz_search</function>. The - startterm consists of zero or more <literal>@attr</literal>-operator + startterm consists of zero or more <literal>@attr</literal>-operator specifications, then followed by exactly one token. </para> <para> @@ -44,6 +44,7 @@ <title>PHP function that scans titles</title> <programlisting> <![CDATA[ +<?php function scan_titles($id, $startterm) { yaz_scan($id,"rpn", "@attr 1=4 " . $startterm); yaz_wait(); @@ -66,6 +67,7 @@ echo "Scan failed. Error: " . yaz_error($id) . "<br>"; } } +?> ]]> </programlisting> </example> Index: phpdoc/en/reference/yaz/functions/yaz-search.xml diff -u phpdoc/en/reference/yaz/functions/yaz-search.xml:1.3 phpdoc/en/reference/yaz/functions/yaz-search.xml:1.4 --- phpdoc/en/reference/yaz/functions/yaz-search.xml:1.3 Thu Jan 16 04:44:49 2003 +++ phpdoc/en/reference/yaz/functions/yaz-search.xml Sun Jun 15 11:21:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/yaz.xml, last change in rev 1.1 --> <refentry id="function.yaz-search"> <refnamediv> @@ -16,8 +16,8 @@ </methodsynopsis> <para> <function>yaz_search</function> prepares for a search on the - connection given by <parameter>id</parameter>. - The <parameter>type</parameter> represents the query type - only + connection given by parameter <parameter>id</parameter>. + The parameter <parameter>type</parameter> represents the query type - only <literal>"rpn"</literal> is supported now in which case the third argument specifies a Type-1 query in prefix query notation. Like <function>yaz_connect</function> this @@ -32,9 +32,9 @@ defined by the Z39.50 standard. However, in the text representation as used by YAZ a prefix notation is used, that is the operater precedes the operands. The query string is a sequence of tokens where - white space is ignored is ignored unless surrounded by double - quotes. Tokens beginning with an at-character (<literal>@</literal>) - are considered operators, otherwise they are treated as search terms. + white space is ignored unless surrounded by double quotes. Tokens beginning + with an at-character (<literal>@</literal>) are considered operators, + otherwise they are treated as search terms. </para> <table> <title>RPN Operators</title> Index: phpdoc/en/reference/yaz/functions/yaz-sort.xml diff -u phpdoc/en/reference/yaz/functions/yaz-sort.xml:1.3 phpdoc/en/reference/yaz/functions/yaz-sort.xml:1.4 --- phpdoc/en/reference/yaz/functions/yaz-sort.xml:1.3 Thu Jan 16 04:44:49 2003 +++ phpdoc/en/reference/yaz/functions/yaz-sort.xml Sun Jun 15 11:21:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/yaz.xml, last change in rev 1.1 --> <refentry id="function.yaz-sort"> <refnamediv> @@ -17,23 +17,22 @@ This function sets sorting criteria and enables Z39.50 Sort. Call this function <emphasis>before</emphasis> <function>yaz_search</function>. - Using this function alone doesn't have any effect. - When in conjunction with <function>yaz_search</function>, - a Z39.50 Sort will be sent after - a search response has been received and before any records are - retrieved with Z39.50 Present. The <parameter>criteria</parameter> - takes the form + Using this function alone does not have any effect. When used in conjunction + with <function>yaz_search</function>, a Z39.50 Sort will be sent after a + search response has been received and before any records are retrieved with + Z39.50 Present (<function>yaz_present</function>. The parameter + <parameter>criteria</parameter> takes the form </para> <para> <replaceable>field1 flags1 field2 flags2</replaceable> ... </para> <para> - where field1 specifies primary attributes for sort, field2 seconds, - etc.. The field specifies either numerical attribute combinations consisting + where field1 specifies the primary attributes for sort, field2 seconds, + etc.. The field specifies either a numerical attribute combinations consisting of type=value pairs separated by comma (e.g. <literal>1=4,2=1</literal>) ; or the field may specify a plain string criteria - (e.g. <literal>title</literal>. The flags is a sequnce of the - following characters which may not be separated by any white space. + (e.g. <literal>title</literal>. The flags is a sequnce of the following + characters which may not be separated by any white space. </para> <variablelist> <title>Sort Flags</title> @@ -54,14 +53,14 @@ <title>Sort Criterias</title> <para> To sort on Bib1 attribute title, case insensitive, - and ascending you'd use the following sort criteria: + and ascending you would use the following sort criteria: <screen> 1=4 ia </screen> </para> <para> If the secondary sorting criteria should be author, case sensitive - and ascending you'd use: + and ascending you would use: <screen> 1=4 ia 1=1003 sa </screen> Index: phpdoc/en/reference/yaz/functions/yaz-wait.xml diff -u phpdoc/en/reference/yaz/functions/yaz-wait.xml:1.3 phpdoc/en/reference/yaz/functions/yaz-wait.xml:1.4 --- phpdoc/en/reference/yaz/functions/yaz-wait.xml:1.3 Fri Dec 13 22:31:52 2002 +++ phpdoc/en/reference/yaz/functions/yaz-wait.xml Sun Jun 15 11:21:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/yaz.xml, last change in rev 1.15 --> <refentry id="function.yaz-wait"> <refnamediv> @@ -26,11 +26,15 @@ options that change the behaviour of <function>yaz_wait</function>. </para> <variablelist> - <varlistentry><term><literal>timeout</literal></term><listitem> - <para>Sets timeout in seconds. If a target hasn't responded within - the timeout it is considered dead and <function>yaz_wait</function> - returns. The default value for timeout is 15 seconds. - </para></listitem> + <varlistentry> + <term><literal>timeout</literal></term> + <listitem> + <para> + Sets timeout in seconds. If a target has not responded within + the timeout it is considered dead and <function>yaz_wait</function> + returns. The default value for timeout is 15 seconds. + </para> + </listitem> </varlistentry> </variablelist> </refsect1>