[PHP-DOC] cvs: phpdoc /en/functions yaz.xml From: Egon Schmid (eschmid <email protected>)
Date: 08/07/00

eschmid Mon Aug 7 13:59:17 2000 EDT

  Modified files:
    /phpdoc/en/functions yaz.xml
  Log:
  More cosmetics.
  
Index: phpdoc/en/functions/yaz.xml
diff -u phpdoc/en/functions/yaz.xml:1.3 phpdoc/en/functions/yaz.xml:1.4
--- phpdoc/en/functions/yaz.xml:1.3 Mon Aug 7 13:52:14 2000
+++ phpdoc/en/functions/yaz.xml Mon Aug 7 13:59:17 2000
@@ -4,23 +4,25 @@
 
   <partintro>
    <simpara>
- The <function>yaz</function> functions wrap the YAZ API. The home page
- of the project is <ulink url="&url.yaz;">&url.yaz;</ulink>. Information
- about the phpyaz module can be found at
- <ulink url="&url.yaz-phpyaz;">&url.yaz-phpyaz;</ulink>.
+ The <function>yaz</function> functions wrap the YAZ API. The home
+ page of the project is <ulink url="&url.yaz;">&url.yaz;</ulink>.
+ Information about the phpyaz module can be found at <ulink
+ url="&url.yaz-phpyaz;">&url.yaz-phpyaz;</ulink>.
    </simpara>
    <simpara>
- PHP/YAZ is much simpler to use than the C API for YAZ but less flexible. The
- intent is to make it easy to build basic client functions. It supports
- persistent stateless connections very similar to those offered by the
- various SQL APIs that are available for PHP. This means that sessions are
- stateless but shared amongst users, thus saving the connect and INIT steps
- in many cases.
+ PHP/YAZ is much simpler to use than the C API for YAZ but less
+ flexible. The intent is to make it easy to build basic client
+ functions. It supports persistent stateless connections very
+ similar to those offered by the various SQL APIs that are
+ available for PHP. This means that sessions are stateless but
+ shared amongst users, thus saving the connect and INIT steps in
+ many cases.
    </simpara>
    <simpara>
- Before compiling PHP with the PHP/YAZ module you'll need the YAZ toolkit.
- Build YAZ and install it. Build PHP with your favourite modules and add
- option --with-yaz. Your task is roughly the following:
+ Before compiling PHP with the PHP/YAZ module you'll need the YAZ
+ toolkit. Build YAZ and install it. Build PHP with your favourite
+ modules and add option --with-yaz. Your task is roughly the
+ following:
    </simpara>
    <informalexample>
     <programlisting>
@@ -37,14 +39,15 @@
     </programlisting>
    </informalexample>
    <simpara>
- PHP/YAZ keeps track of connections with targets (Z-Associations). A positive
- integer represents the ID of a particular association.
+ PHP/YAZ keeps track of connections with targets
+ (Z-Associations). A positive integer represents the ID of a
+ particular association.
    </simpara>
    <simpara>
- The script below demonstrates the parallel searching feature of the API.
- When invoked it either prints a query form (if no arguments are supplied) or
- if there are arguments (term and one or more hosts) it searches the targets
- in array host.
+ The script below demonstrates the parallel searching feature of
+ the API. When invoked it either prints a query form (if no
+ arguments are supplied) or if there are arguments (term and one or
+ more hosts) it searches the targets in array host.
    </simpara>
    <example>
     <title><function>readline</function></title>
@@ -112,9 +115,9 @@
      </funcprototype>
     </funcsynopsis>
     <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). An
+ empty string is returned if last operation was a success or if no
+ additional information was provided by the target.
     </para>
    </refsect1>
   </refentry>
@@ -133,8 +136,8 @@
      </funcprototype>
     </funcsynopsis>
     <para>
- Closes a connection to a target. The application can no longer refer to the
- target with the given id.
+ Closes a connection to a target. The application can no longer
+ refer to the target with the given id.
     </para>
    </refsect1>
   </refentry>
@@ -142,7 +145,9 @@
   <refentry id="function.yaz-connect">
    <refnamediv>
     <refname>yaz_connect</refname>
- <refpurpose>Returns a positive association ID on success; zero on failure</refpurpose>
+ <refpurpose>
+ Returns a positive association ID on success; zero on failure
+ </refpurpose>
    </refnamediv>
    <refsect1>
     <title>Description</title>
@@ -153,12 +158,13 @@
      </funcprototype>
     </funcsynopsis>
     <para>
- <function>yaz_connect</function> prepares for a connection to a Z39.50
- target. The zurl argument takes the form host[:port][/database]. If port is
- omitted 210 is used. If database is omitted Default is used. This function
- is non-blocking and doesn't attempt to establish a socket - it merely
- prepares a connect to be performed later when <function>yaz_wait</function>
- is called.
+ <function>Yaz_connect</function> prepares for a connection to a
+ Z39.50 target. The zurl argument takes the form
+ host[:port][/database]. If port is omitted 210 is used. If
+ database is omitted Default is used. This function is
+ non-blocking and doesn't attempt to establish a socket - it
+ merely prepares a connect to be performed later when
+ <function>yaz_wait</function> is called.
     </para>
    </refsect1>
   </refentry>
@@ -177,15 +183,17 @@
      </funcprototype>
     </funcsynopsis>
     <para>
- Returns error for target (last request). A positive value is returned if
- the target returned a diagnostic code; a value of zero is returned if no
- errors occurred (success); negative value is returned for other errors
- targets didn't indicate the error in question.
+ Returns error for target (last request). A positive value is
+ returned if the target returned a diagnostic code; a value of
+ zero is returned if no errors occurred (success); negative value
+ is returned for other errors targets didn't indicate the error in
+ question.
     </para>
     <para>
- <function>yaz_errno</function> should be called after network activity for
- each target - (after <function>yaz_wait</function> returns) to determine
- the success or failure of the last operation (e.g. search).
+ <function>Yaz_errno</function> should be called after network
+ activity for each target - (after <function>yaz_wait</function>
+ returns) to determine the success or failure of the last
+ operation (e.g. search).
     </para>
    </refsect1>
   </refentry>
@@ -193,7 +201,7 @@
   <refentry id="function.yaz-error">
    <refnamediv>
     <refname>yaz_error</refname>
- <refpurpose>Returns error description.</refpurpose>
+ <refpurpose>Returns error description</refpurpose>
    </refnamediv>
    <refsect1>
     <title>Description</title>
@@ -204,12 +212,13 @@
      </funcprototype>
     </funcsynopsis>
     <para>
- Returns error message for target (last request). An empty string is
- returned if last operation was a success.
+ Returns error message for target (last request). An empty string
+ is returned if last operation was a success.
     </para>
     <para>
- <function>yaz_error</function> returns a english message corresponding to
- the last error number as returned by <function>yaz_errno</function>.
+ <function>Yaz_error</function> returns a english message
+ corresponding to the last error number as returned by
+ <function>yaz_errno</function>.
     </para>
    </refsect1>
   </refentry>
@@ -228,7 +237,8 @@
      </funcprototype>
     </funcsynopsis>
     <para>
- <function>yaz_hits</function> returns number of hits for last search.
+ <function>Yaz_hits</function> returns number of hits for last
+ search.
     </para>
    </refsect1>
   </refentry>
@@ -236,7 +246,9 @@
   <refentry id="function.yaz-range">
    <refnamediv>
     <refname>yaz_range</refname>
- <refpurpose>Specifies the maximum number of records to retrieve</refpurpose>
+ <refpurpose>
+ Specifies the maximum number of records to retrieve
+ </refpurpose>
    </refnamediv>
    <refsect1>
     <title>Description</title>
@@ -249,10 +261,12 @@
      </funcprototype>
     </funcsynopsis>
     <para>
- This function is used in conjunction with <function>yaz_search</function>
- to specify the maximum number of records to retrieve (number) and the first
- record position (start). If this function is not invoked (only
- <function>yaz_search</function>) start is set to 1 and number is set to 10.
+ This function is used in conjunction with
+ <function>yaz_search</function> to specify the maximum number of
+ records to retrieve (number) and the first record position
+ (start). If this function is not invoked (only
+ <function>yaz_search</function>) start is set to 1 and number is
+ set to 10.
     </para>
     <para>
      Returns true on success; false on error.
@@ -276,17 +290,18 @@
      </funcprototype>
     </funcsynopsis>
     <para>
- Returns record at position or empty string if no record exists at given
- position.
+ Returns record at position or empty string if no record exists at
+ 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 argument, type,
- specifies the form of the returned record. If type is "string" the record
- is returned in a string representation suitable for printing (for XML and
- SUTRS). If type is "array" the record is returned as an array
- representation (for structured records).
+ 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 argument, type, specifies the form of the returned
+ record. If type is "string" the record is returned in a string
+ representation suitable for printing (for XML and SUTRS). If type
+ is "array" the record is returned as an array representation (for
+ structured records).
     </para>
    </refsect1>
   </refentry>
@@ -307,12 +322,13 @@
      </funcprototype>
     </funcsynopsis>
     <para>
- <function>yaz_search</function> prepares for a search on the target with
- given id. The type represents the query type - only "rpn" is supported now
- in which case the third argument is a prefix notation query as used by
- YAZ. Like <function>yaz_connect</function> this function is non-blocking
- and only prepares for a search to be executed later when
- <function>yaz_wait</function> is called.
+ <function>Yaz_search</function> prepares for a search on the
+ target with given id. The type represents the query type - only
+ "rpn" is supported now in which case the third argument is a
+ prefix notation query as used by YAZ. Like
+ <function>yaz_connect</function> this function is non-blocking
+ and only prepares for a search to be executed later when
+ <function>yaz_wait</function> is called.
     </para>
    </refsect1>
   </refentry>
@@ -320,7 +336,9 @@
   <refentry id="function.yaz-syntax">
    <refnamediv>
     <refname>yaz_syntax</refname>
- <refpurpose>Specifies the preferred record syntax for retrieval</refpurpose>
+ <refpurpose>
+ Specifies the preferred record syntax for retrieval
+ </refpurpose>
    </refnamediv>
    <refsect1>
     <title>Description</title>
@@ -332,8 +350,9 @@
      </funcprototype>
     </funcsynopsis>
     <para>
- This function is used in conjunction with <function>yaz_search</function>
- to specify the preferred record syntax for retrieval.
+ This function is used in conjunction with
+ <function>yaz_search</function> to specify the preferred record
+ syntax for retrieval.
     </para>
    </refsect1>
   </refentry>
@@ -353,14 +372,16 @@
      </funcprototype>
     </funcsynopsis>
     <para>
- This function carries out networked (blocked) activity for outstanding
- requests which have been prepared by the functions
- <function>yaz_connect</function>, <function>yaz_search</function>.
- <function>yaz_wait</function> returns when all targets have either
- completed all requests or otherwise completed (in case of errors).
+ This function carries out networked (blocked) activity for
+ outstanding requests which have been prepared by the functions
+ <function>yaz_connect</function>,
+ <function>yaz_search</function>. <function>yaz_wait</function>
+ returns when all targets have either completed all requests or
+ otherwise completed (in case of errors).
     </para>
    </refsect1>
   </refentry>
+
  </reference>
 
 <!-- Keep this comment at the end of the file