dickmeiss Mon Jan 26 08:42:22 2004 EDT
Modified files:
/phpdoc/en/reference/yaz/functions yaz-addinfo.xml yaz-ccl-conf.xml
yaz-connect.xml yaz-errno.xml
yaz-error.xml
yaz-scan-result.xml yaz-scan.xml
yaz-set-option.xml yaz-wait.xml
Log:
Documentation for yaz_es, yaz_es_result. Use term 'server' rather than
'target'.
http://cvs.php.net/diff.php/phpdoc/en/reference/yaz/functions/yaz-addinfo.xml?r1=1.5&r2=1.6&ty=u
Index: phpdoc/en/reference/yaz/functions/yaz-addinfo.xml
diff -u phpdoc/en/reference/yaz/functions/yaz-addinfo.xml:1.5
phpdoc/en/reference/yaz/functions/yaz-addinfo.xml:1.6
--- phpdoc/en/reference/yaz/functions/yaz-addinfo.xml:1.5 Fri Dec 19 10:50:06
2003
+++ phpdoc/en/reference/yaz/functions/yaz-addinfo.xml Mon Jan 26 08:42:22 2004
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
+<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/yaz.xml, last change in rev 1.1 -->
<refentry id="function.yaz-addinfo">
<refnamediv>
@@ -13,10 +13,10 @@
<methodparam><type>resource</type><parameter>id</parameter></methodparam>
</methodsynopsis>
<para>
- Returns additional error message for target (last request), identified by
+ Returns additional error message for server (last request), identified by
parameter <parameter>id</parameter>. An empty string is returned if the
last operation was successful or if no additional information was provided
- by the target.
+ by the server.
</para>
<para>
See also <function>yaz_error</function>.
http://cvs.php.net/diff.php/phpdoc/en/reference/yaz/functions/yaz-ccl-conf.xml?r1=1.6&r2=1.7&ty=u
Index: phpdoc/en/reference/yaz/functions/yaz-ccl-conf.xml
diff -u phpdoc/en/reference/yaz/functions/yaz-ccl-conf.xml:1.6
phpdoc/en/reference/yaz/functions/yaz-ccl-conf.xml:1.7
--- phpdoc/en/reference/yaz/functions/yaz-ccl-conf.xml:1.6 Mon Dec 15 11:54:30
2003
+++ phpdoc/en/reference/yaz/functions/yaz-ccl-conf.xml Mon Jan 26 08:42:22 2004
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.6 $ -->
+<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/yaz.xml, last change in rev 1.8 -->
<refentry id="function.yaz-ccl-conf">
<refnamediv>
@@ -14,7 +14,7 @@
<methodparam><type>array</type><parameter>config</parameter></methodparam>
</methodsynopsis>
<para>
- This function configures the CCL query parser for a target
+ This function configures the CCL query parser for a server
with definitions of access points (CCL qualifiers) and their
mapping to RPN. To map a specific CCL query to RPN afterwards
call the <function>yaz_ccl_parse</function> function.
http://cvs.php.net/diff.php/phpdoc/en/reference/yaz/functions/yaz-connect.xml?r1=1.6&r2=1.7&ty=u
Index: phpdoc/en/reference/yaz/functions/yaz-connect.xml
diff -u phpdoc/en/reference/yaz/functions/yaz-connect.xml:1.6
phpdoc/en/reference/yaz/functions/yaz-connect.xml:1.7
--- phpdoc/en/reference/yaz/functions/yaz-connect.xml:1.6 Tue Nov 4 09:15:40
2003
+++ phpdoc/en/reference/yaz/functions/yaz-connect.xml Mon Jan 26 08:42:22 2004
@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.6 $ -->
+<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/yaz.xml, last change in rev 1.1 -->
<refentry id="function.yaz-connect">
<refnamediv>
<refname>yaz_connect</refname>
<refpurpose>
- Prepares for a connection to a Z39.50 target (server).
+ Prepares for a connection to a Z39.50 server.
</refpurpose>
</refnamediv>
<refsect1>
@@ -21,11 +21,11 @@
</para>
<para>
<function>yaz_connect</function> prepares for a connection to a
- Z39.50 target. The <parameter>zurl</parameter> argument takes the form
- host[:port][/database]. If port is omitted 210 is used. If
+ Z39.50 server. The <parameter>zurl</parameter> argument takes the form
+ host[:port][/database]. If port is omitted, port 210 is used. If
database is omitted <literal>Default</literal> is used.
This function is non-blocking and does not attempt to establish
- a socket - it merely prepares a connect to be performed later when
+ a connection - it merely prepares a connect to be performed later when
<function>yaz_wait</function> is called.
</para>
<para>
@@ -84,7 +84,7 @@
<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
+ first time fetches of records. However, a few Z39.50 servers do not
support piggyback or they ignore element set names. For those, piggyback
should be disabled.
</simpara>
@@ -101,8 +101,8 @@
<literal>UTF-16</literal>.
</simpara>
<simpara>
- Most Z39.50 targets do not support this feature (and thus,
- this is ignored). Many targets use the ISO-8859-1
+ Most Z39.50 servers do not support this feature (and thus,
+ this is ignored). Many servers use the ISO-8859-1
encoding for queries and messages. MARC21/USMARC records are not
affected by this setting.
</simpara>
http://cvs.php.net/diff.php/phpdoc/en/reference/yaz/functions/yaz-errno.xml?r1=1.4&r2=1.5&ty=u
Index: phpdoc/en/reference/yaz/functions/yaz-errno.xml
diff -u phpdoc/en/reference/yaz/functions/yaz-errno.xml:1.4
phpdoc/en/reference/yaz/functions/yaz-errno.xml:1.5
--- phpdoc/en/reference/yaz/functions/yaz-errno.xml:1.4 Sun Jun 15 11:21:05 2003
+++ phpdoc/en/reference/yaz/functions/yaz-errno.xml Mon Jan 26 08:42:22 2004
@@ -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.1 -->
<refentry id="function.yaz-errno">
<refnamediv>
@@ -13,14 +13,14 @@
<methodparam><type>resource</type><parameter>id</parameter></methodparam>
</methodsynopsis>
<para>
- Returns an errornumber for the target (last request) identified by
+ Returns an errornumber for the server (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
- activity for each target - (after <function>yaz_wait</function>
+ activity for each server - (after <function>yaz_wait</function>
returns) to determine the success or failure of the last
operation (e.g. search). To get a text description of the
error, call <function>yaz_error</function>.
http://cvs.php.net/diff.php/phpdoc/en/reference/yaz/functions/yaz-error.xml?r1=1.5&r2=1.6&ty=u
Index: phpdoc/en/reference/yaz/functions/yaz-error.xml
diff -u phpdoc/en/reference/yaz/functions/yaz-error.xml:1.5
phpdoc/en/reference/yaz/functions/yaz-error.xml:1.6
--- phpdoc/en/reference/yaz/functions/yaz-error.xml:1.5 Fri Dec 19 10:50:06 2003
+++ phpdoc/en/reference/yaz/functions/yaz-error.xml Mon Jan 26 08:42:22 2004
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
+<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/yaz.xml, last change in rev 1.1 -->
<refentry id="function.yaz-error">
<refnamediv>
@@ -13,7 +13,7 @@
<methodparam><type>resource</type><parameter>id</parameter></methodparam>
</methodsynopsis>
<para>
- Returns an error text message for target (last request), identified by
+ Returns an error text message for server (last request), identified by
parameter <parameter>id</parameter>. An empty string is returned if the
last operation was successful.
</para>
http://cvs.php.net/diff.php/phpdoc/en/reference/yaz/functions/yaz-scan-result.xml?r1=1.4&r2=1.5&ty=u
Index: phpdoc/en/reference/yaz/functions/yaz-scan-result.xml
diff -u phpdoc/en/reference/yaz/functions/yaz-scan-result.xml:1.4
phpdoc/en/reference/yaz/functions/yaz-scan-result.xml:1.5
--- phpdoc/en/reference/yaz/functions/yaz-scan-result.xml:1.4 Sun Jun 15 11:21:05
2003
+++ phpdoc/en/reference/yaz/functions/yaz-scan-result.xml Mon Jan 26 08:42:22
2004
@@ -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-scan-result">
<refnamediv>
@@ -15,7 +15,7 @@
</methodsynopsis>
<para>
<function>yaz_scan_result</function> returns terms and associated
- information as received from the target in the last performed
+ information as received from the server 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 the first item is the
http://cvs.php.net/diff.php/phpdoc/en/reference/yaz/functions/yaz-scan.xml?r1=1.8&r2=1.9&ty=u
Index: phpdoc/en/reference/yaz/functions/yaz-scan.xml
diff -u phpdoc/en/reference/yaz/functions/yaz-scan.xml:1.8
phpdoc/en/reference/yaz/functions/yaz-scan.xml:1.9
--- phpdoc/en/reference/yaz/functions/yaz-scan.xml:1.8 Thu Jan 15 07:43:50 2004
+++ phpdoc/en/reference/yaz/functions/yaz-scan.xml Mon Jan 26 08:42:22 2004
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.8 $ -->
+<!-- $Revision: 1.9 $ -->
<!-- splitted from ./en/functions/yaz.xml, last change in rev 1.8 -->
<refentry id="function.yaz-scan">
<refnamediv>
@@ -27,7 +27,7 @@
<literal>number</literal> (number of terms requested),
<literal>position</literal> (preferred position of term) and
<literal>stepSize</literal> (preferred step size).
- To actually transfer the Scan Request to the target and receive the
+ To actually transfer the Scan Request to the server 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
http://cvs.php.net/diff.php/phpdoc/en/reference/yaz/functions/yaz-set-option.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/yaz/functions/yaz-set-option.xml
diff -u phpdoc/en/reference/yaz/functions/yaz-set-option.xml:1.1
phpdoc/en/reference/yaz/functions/yaz-set-option.xml:1.2
--- phpdoc/en/reference/yaz/functions/yaz-set-option.xml:1.1 Thu Jan 16 04:44:49
2003
+++ phpdoc/en/reference/yaz/functions/yaz-set-option.xml Mon Jan 26 08:42:22
2004
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<refentry id="function.yaz-set-option">
<refnamediv>
<refname>yaz_set_option</refname>
@@ -30,15 +30,15 @@
<tbody>
<row>
<entry>implementationName</entry>
- <entry>implementation name of target</entry>
+ <entry>implementation name of server</entry>
</row>
<row>
<entry>implementationVersion</entry>
- <entry>implementation version of target</entry>
+ <entry>implementation version of server</entry>
</row>
<row>
<entry>implementationId</entry>
- <entry>implementation ID of target</entry>
+ <entry>implementation ID of server</entry>
</row>
<row>
<entry>schema</entry>
@@ -56,7 +56,8 @@
<entry>start</entry>
<entry>offset for first record to be retrieved via
<function>yaz_search</function> or <function>yaz_present</function>.
- Records are numbered from zero and upwards.
+ First record is numbered has a start value of 0. Second record has
+ start value 1.
Setting this option in combination with option
<literal>count</literal> has the same effect as calling
<function>yaz_range</function> except that records are
http://cvs.php.net/diff.php/phpdoc/en/reference/yaz/functions/yaz-wait.xml?r1=1.4&r2=1.5&ty=u
Index: phpdoc/en/reference/yaz/functions/yaz-wait.xml
diff -u phpdoc/en/reference/yaz/functions/yaz-wait.xml:1.4
phpdoc/en/reference/yaz/functions/yaz-wait.xml:1.5
--- phpdoc/en/reference/yaz/functions/yaz-wait.xml:1.4 Sun Jun 15 11:21:05 2003
+++ phpdoc/en/reference/yaz/functions/yaz-wait.xml Mon Jan 26 08:42:22 2004
@@ -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.15 -->
<refentry id="function.yaz-wait">
<refnamediv>
@@ -18,7 +18,7 @@
<function>yaz_connect</function>,
<function>yaz_search</function>, <function>yaz_present</function>,
<function>yaz_scan</function> and <function>yaz_itemorder</function>.
- <function>yaz_wait</function> returns when all targets have either
+ <function>yaz_wait</function> returns when all servers have either
completed all requests or aborted (in case of errors).
</para>
<para>
@@ -30,7 +30,7 @@
<term><literal>timeout</literal></term>
<listitem>
<para>
- Sets timeout in seconds. If a target has not responded within
+ Sets timeout in seconds. If a server 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>
