betz Sun Jun 29 15:51:33 2003 EDT
Modified files:
/phpdoc/en/reference/mnogosearch/functions udm-add-search-limit.xml
udm-alloc-agent.xml
udm-api-version.xml
udm-cat-list.xml
udm-cat-path.xml
udm-check-charset.xml
udm-check-stored.xml
udm-clear-search-limits.xml
udm-close-stored.xml
udm-crc32.xml
udm-errno.xml
udm-error.xml
udm-find.xml
udm-free-agent.xml
udm-free-ispell-data.xml
udm-free-res.xml
udm-get-doc-count.xml
udm-get-res-field.xml
udm-get-res-param.xml
udm-load-ispell-data.xml
udm-open-stored.xml
udm-set-agent-param.xml
Log:
proto corrections, a few see also's, grammar, rewording
use of entities
Index: phpdoc/en/reference/mnogosearch/functions/udm-add-search-limit.xml
diff -u phpdoc/en/reference/mnogosearch/functions/udm-add-search-limit.xml:1.2
phpdoc/en/reference/mnogosearch/functions/udm-add-search-limit.xml:1.3
--- phpdoc/en/reference/mnogosearch/functions/udm-add-search-limit.xml:1.2 Wed
Apr 17 02:40:43 2002
+++ phpdoc/en/reference/mnogosearch/functions/udm-add-search-limit.xml Sun Jun 29
15:51:33 2003
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/mnogosearch.xml, last change in rev 1.18 -->
<refentry id="function.udm-add-search-limit">
<refnamediv>
@@ -9,14 +9,14 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
- <type>int</type><methodname>udm_add_search_limit</methodname>
- <methodparam><type>int</type><parameter>agent</parameter></methodparam>
+ <type>bool</type><methodname>udm_add_search_limit</methodname>
+ <methodparam><type>resource</type><parameter>agent</parameter></methodparam>
<methodparam><type>int</type><parameter>var</parameter></methodparam>
<methodparam><type>string</type><parameter>val</parameter></methodparam>
</methodsynopsis>
<para>
- <function>udm_add_search_limit</function> returns &true; on success,
- &false; on error. Adds search restrictions.
+ <function>udm_add_search_limit</function> adds search restrictions.
+ &return.success;
</para>
<para>
<parameter>agent</parameter> - a link to Agent, received after call to
@@ -26,7 +26,7 @@
<parameter>var</parameter> - defines parameter, indicating limit.
</para>
<para>
- <parameter>val</parameter> - defines value of the current parameter.
+ <parameter>val</parameter> - defines the value of the current parameter.
</para>
<para>
Possible <parameter>var</parameter> values:
@@ -34,8 +34,8 @@
<itemizedlist>
<listitem>
<simpara>
- UDM_LIMIT_URL - defines document URL limitations to limit search
- through subsection of database. It supports SQL % and _ LIKE wildcards,
+ UDM_LIMIT_URL - defines document URL limitations to limit the search
+ through subsection of the database. It supports SQL % and _ LIKE wildcards,
where % matches any number of characters, even zero characters,
and _ matches exactly one character. E.g. http://my.domain.__/catalog
may stand for http://my.domain.ru/catalog and http://my.domain.ua/catalog.
@@ -75,7 +75,7 @@
</listitem>
<listitem>
<simpara>
- UDM_LIMIT_DATE - defines limitation by date document was modified.
+ UDM_LIMIT_DATE - defines limitation by date the document was modified.
</simpara>
<simpara>
Format of parameter value: a string with first character < or >,
@@ -85,8 +85,8 @@
Udm_Add_Search_Limit($udm,UDM_LIMIT_DATE,"<908012006");
</simpara>
<simpara>
- If > character is used, then search will be restricted to those
- documents having modification date greater than entered. If <, then smaller.
+ If > character is used, then the search will be restricted to those
+ documents having a modification date greater than entered, if <, then
smaller.
</simpara>
</listitem>
</itemizedlist>
Index: phpdoc/en/reference/mnogosearch/functions/udm-alloc-agent.xml
diff -u phpdoc/en/reference/mnogosearch/functions/udm-alloc-agent.xml:1.2
phpdoc/en/reference/mnogosearch/functions/udm-alloc-agent.xml:1.3
--- phpdoc/en/reference/mnogosearch/functions/udm-alloc-agent.xml:1.2 Wed Apr 17
02:40:44 2002
+++ phpdoc/en/reference/mnogosearch/functions/udm-alloc-agent.xml Sun Jun 29
15:51:33 2003
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/mnogosearch.xml, last change in rev 1.18 -->
<refentry id="function.udm-alloc-agent">
<refnamediv>
@@ -9,37 +9,42 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
- <type>int</type><methodname>udm_alloc_agent</methodname>
+ <type>resource</type><methodname>udm_alloc_agent</methodname>
<methodparam><type>string</type><parameter>dbaddr</parameter></methodparam>
<methodparam
choice="opt"><type>string</type><parameter>dbmode</parameter></methodparam>
</methodsynopsis>
- <para><function>udm_alloc_agent</function> returns mnogosearch agent
- identifier on success, &false; on error. This function creates a
- session with database parameters.
+ <para>
+ Returns a mnogosearch agent identifier on success, &false; on failure. This
+ function creates a session with database parameters.
</para>
<para>
- <parameter>dbaddr</parameter> - URL-style database description.
- Options (type, host, database name, port, user and password) to connect
- to SQL database. Do not matter for built-in text files support. Format:
- DBAddr DBType:[//[DBUser[:[EMAIL PROTECTED]:DBPort]]/DBName/ Currently
- supported DBType values are: mysql, pgsql, msql, solid, mssql, oracle,
- ibase. Actually, it does not matter for native libraries support.
- But ODBC users should specify one of supported values. If your database
- type is not supported, you may use "unknown" instead.
+ <parameter>dbaddr</parameter> - URL-style database description, with
+ options (type, host, database name, port, user and password) to connect
+ to SQL database. Do not matter for built-in text files support. Format for
+ <parameter>dbaddr</parameter>:
+ <literal>DBType:[//[DBUser[:[EMAIL PROTECTED]:DBPort]]/DBName/</literal>.
+ Currently supported DBType values are: mysql, pgsql, msql, solid, mssql, oracle,
+ and ibase. Actually, it does not matter for native libraries support, but
+ ODBC users should specify one of the supported values. If your database
+ type is not supported, you may use <literal>unknown</literal> instead.
</para>
<para>
- <parameter>dbmode</parameter> - You may select SQL database mode of
- words storage. When "single" is specified, all words are stored in the same
- table. If "multi" is selected, words will be located in different tables
- depending of their lengths. "multi" mode is usually faster but requires
- more tables in database. If "crc" mode is selected, mnoGoSearch will
- store 32 bit integer word IDs calculated by CRC32 algorythm instead of
- words. This mode requres less disk space and it is faster comparing with "single"
- and "multi" modes. "crc-multi" uses the same storage structure with the
- "crc" mode, but also stores words in different tables depending on
- words lengths like "multi" mode. Format: DBMode single/multi/crc/crc-multi</para>
+ <parameter>dbmode</parameter> - You may select the SQL database mode of
+ words storage. Possible values of <parameter>dbmode</parameter> are:
+ <literal>single</literal>, <literal>multi</literal>, <literal>crc</literal>,
+ or <literal>crc-multi</literal>. When <literal>single</literal> is
+ specified, all words are stored in the same table. If <literal>multi
+ </literal> is selected, words will be located in different tables depending
+ of their lengths. "multi" mode is usually faster, but requires more tables
+ in the database. If "crc" mode is selected, mnoGoSearch will store 32 bit
+ integer word IDs calculated by CRC32 algorythm instead of words. This mode
+ requires less disk space and it is faster comparing with "single" and
+ "multi" modes. <literal>crc-multi</literal> uses the same storage structure
+ with the "crc" mode, but also stores words in different tables depending on
+ words lengths like in "multi" mode.
+ </para>
<note>
<para>
@@ -50,9 +55,10 @@
<note>
<para>
- In fact this function does not open connection to database and
- thus does not check entered login and password. Actual connection to
- database and login/password verification is done by
<function>udm_find</function>.
+ In fact this function does not open a connection to the database and
+ thus does not check the entered login and password. Establishing a
+ connection to the database and login/password verification is done by
+ <function>udm_find</function>.
</para>
</note>
</refsect1>
Index: phpdoc/en/reference/mnogosearch/functions/udm-api-version.xml
diff -u phpdoc/en/reference/mnogosearch/functions/udm-api-version.xml:1.2
phpdoc/en/reference/mnogosearch/functions/udm-api-version.xml:1.3
--- phpdoc/en/reference/mnogosearch/functions/udm-api-version.xml:1.2 Wed Apr 17
02:40:44 2002
+++ phpdoc/en/reference/mnogosearch/functions/udm-api-version.xml Sun Jun 29
15:51:33 2003
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/mnogosearch.xml, last change in rev 1.18 -->
<refentry id="function.udm-api-version">
<refnamediv>
@@ -13,22 +13,29 @@
<void/>
</methodsynopsis>
- <para><function>udm_api_version</function> returns mnoGoSearch API version number.
E.g. if
- mnoGoSearch 3.1.10 API is used, this function will return
<literal>30110</literal>.</para>
-
- <para>This function allows user to identify which API functions are available, e.g.
- <function>udm_get_doc_count</function> function is only available in mnoGoSearch
3.1.11 or later. </para>
-
- <simpara>Example:</simpara>
- <informalexample>
+ <para>
+ <function>udm_api_version</function> returns the mnoGoSearch API version
+ number. E.g. if mnoGoSearch 3.1.10 API is used, this function will return
+ <literal>30110</literal>.
+ </para>
+ <para>
+ This function allows the user to identify which API functions are
+ available, e.g. <function>udm_get_doc_count</function> function is only
+ available in mnoGoSearch 3.1.11 or later.
+ </para>
+
+ <example>
+ <title><function>udm_api_version</function> example</title>
<programlisting role="php">
<![CDATA[
- if (udm_api_version() >= 30111) {
- print "Total number of urls in database: ".udm_get_doc_count($udm)."<br>\n";
- }
+<?php
+if (udm_api_version() >= 30111) {
+ print "Total number of urls in database: ".udm_get_doc_count($udm)."<br \>\n";
+}
+?>
]]>
</programlisting>
- </informalexample>
+ </example>
</refsect1>
</refentry>
Index: phpdoc/en/reference/mnogosearch/functions/udm-cat-list.xml
diff -u phpdoc/en/reference/mnogosearch/functions/udm-cat-list.xml:1.2
phpdoc/en/reference/mnogosearch/functions/udm-cat-list.xml:1.3
--- phpdoc/en/reference/mnogosearch/functions/udm-cat-list.xml:1.2 Wed Apr 17
02:40:44 2002
+++ phpdoc/en/reference/mnogosearch/functions/udm-cat-list.xml Sun Jun 29 15:51:33
2003
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/mnogosearch.xml, last change in rev 1.18 -->
<refentry id="function.udm-cat-list">
<refnamediv>
@@ -10,28 +10,25 @@
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>udm_cat_list</methodname>
- <methodparam><type>int</type><parameter>agent</parameter></methodparam>
+ <methodparam><type>resource</type><parameter>agent</parameter></methodparam>
<methodparam><type>string</type><parameter>category</parameter></methodparam>
</methodsynopsis>
<para>
- <function>udm_cat_list</function> returns array listing all categories of the
same
- level as current category in the categories tree.
+ Returns an array listing all categories of the same level as the current
+ <parameter>category</parameter> in the categories tree.
+ <parameter>agent</parameter> is the agent identifier returned by a previous
+ call to <function>>udm_alloc_agent</function>.
</para>
-
<para>
The function can be useful for developing categories tree browser.
</para>
<para>
- Returns array with the following format:
- </para>
-
- <para>
- The array consists of pairs. Elements with even index numbers contain category
- paths, odd elements contain corresponding category names.
+ The returnded array consists of pairs. Elements with even index numbers
+ contain the category paths, odd elements contain the corresponding category
+ names.
</para>
-
- <literallayout>
+ <screen>
<![CDATA[
$array[0] will contain '020300'
$array[1] will contain 'Audi'
@@ -42,30 +39,37 @@
...
etc.
]]>
- </literallayout>
- <literallayout>
-Following is an example of displaying links of the current level in format:
+ </screen>
+ <para>
+ Following is an example of displaying links of the current level in format:
+ <screen>
+<![CDATA[
Audi
BMW
Opel
...
- </literallayout>
- <informalexample>
- <programlisting role="php">
+]]>
+ </screen>
+ <example>
+ <title><function>udm_cat_list</function>example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$cat_list_arr = udm_cat_list($udm_agent,$cat);
$cat_list = '';
for ($i=0; $i<count($cat_list_arr); $i+=2) {
- $path = $cat_list_arr[$i];
- $name = $cat_list_arr[$i+1];
- $cat_list .= "<a href=\"$PHP_SELF?cat=$path\">$name</a><br>";
+ $path = $cat_list_arr[$i];
+ $name = $cat_list_arr[$i+1];
+ $cat_list .= "<a href=\"$_SERVER[PHP_SELF]?cat=$path\">$name</a><br>";
}
?>
]]>
- </programlisting>
- </informalexample>
-
+ </programlisting>
+ </example>
+ </para>
+ <para>
+ See also <function>udm_cat_path</function>.
+ </para>
</refsect1>
</refentry>
Index: phpdoc/en/reference/mnogosearch/functions/udm-cat-path.xml
diff -u phpdoc/en/reference/mnogosearch/functions/udm-cat-path.xml:1.2
phpdoc/en/reference/mnogosearch/functions/udm-cat-path.xml:1.3
--- phpdoc/en/reference/mnogosearch/functions/udm-cat-path.xml:1.2 Wed Apr 17
02:40:44 2002
+++ phpdoc/en/reference/mnogosearch/functions/udm-cat-path.xml Sun Jun 29 15:51:33
2003
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/mnogosearch.xml, last change in rev 1.18 -->
<refentry id="function.udm-cat-path">
<refnamediv>
@@ -10,36 +10,24 @@
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>udm_cat_path</methodname>
- <methodparam><type>int</type><parameter>agent</parameter></methodparam>
+ <methodparam><type>resource</type><parameter>agent</parameter></methodparam>
<methodparam><type>string</type><parameter>category</parameter></methodparam>
</methodsynopsis>
<para>
- <function>udm_cat_path</function> returns array describing path in the
- categories tree from the tree root to the current category.
+ Returns an array describing the path in the categories tree from the tree
+ root to the current one, specified by <parameter>category</parameter>.
+ <parameter>agent</parameter> is the agent identifier returned by a previous
+ call to <function>>udm_alloc_agent</function>.
</para>
-
<para>
- <parameter>agent</parameter> - agent link identifier.
- </para>
-
- <para>
- <parameter>category</parameter> - current category - the one to get path to.
- </para>
-
- <para>
- Returns array with the following format:
- </para>
-
- <para>
- The array consists of pairs. Elements with even index numbers contain category
- paths, odd elements contain corresponding category names.
+ The returned array consists of pairs. Elements with even index numbers
+ contain the category paths, odd elements contain the corresponding category
+ names.
</para>
<para>
For example, the call <literal>$array=udm_cat_path($agent, '02031D');</literal>
may return the following array:
- </para>
-
- <literallayout>
+ <screen>
<![CDATA[
$array[0] will contain ''
$array[1] will contain 'Root'
@@ -50,13 +38,15 @@
$array[4] will contain '02031D'
$array[5] will contain 'Ferrari'
]]>
- </literallayout>
- <example>
- <title>
- Specifying path to the current category in the following format:
- '> Root > Sport > Auto > Ferrari'
- </title>
- <programlisting role="php">
+ </screen>
+ </para>
+ <para>
+ <example>
+ <title>
+ Specifying path to the current category in the following format:
+ '> Root > Sport > Auto > Ferrari'
+ </title>
+ <programlisting role="php">
<![CDATA[
<?php
$cat_path_arr = udm_cat_path($udm_agent,$cat);
@@ -64,12 +54,16 @@
for ($i=0; $i<count($cat_path_arr); $i+=2) {
$path = $cat_path_arr[$i];
$name = $cat_path_arr[$i+1];
- $cat_path .= " > <a href=\"$PHP_SELF?cat=$path\">$name</a> ";
+ $cat_path .= " > <a href=\"$_SERVER[PHP_SELF]?cat=$path\">$name</a> ";
}
?>
]]>
- </programlisting>
- </example>
+ </programlisting>
+ </example>
+ </para>
+ <para>
+ See also <function>udm_cat_list</function>.
+ </para>
</refsect1>
</refentry>
Index: phpdoc/en/reference/mnogosearch/functions/udm-check-charset.xml
diff -u phpdoc/en/reference/mnogosearch/functions/udm-check-charset.xml:1.2
phpdoc/en/reference/mnogosearch/functions/udm-check-charset.xml:1.3
--- phpdoc/en/reference/mnogosearch/functions/udm-check-charset.xml:1.2 Wed Apr 17
02:40:44 2002
+++ phpdoc/en/reference/mnogosearch/functions/udm-check-charset.xml Sun Jun 29
15:51:33 2003
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/mnogosearch.xml, last change in rev 1.31 -->
<refentry id='function.udm-check-charset'>
<refnamediv>
@@ -11,8 +11,8 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
- <type>int</type><methodname>udm_check_charset</methodname>
- <methodparam><type>int</type><parameter>agent</parameter></methodparam>
+ <type>bool</type><methodname>udm_check_charset</methodname>
+ <methodparam><type>resource</type><parameter>agent</parameter></methodparam>
<methodparam><type>string</type><parameter>charset</parameter></methodparam>
</methodsynopsis>
<para>
Index: phpdoc/en/reference/mnogosearch/functions/udm-check-stored.xml
diff -u phpdoc/en/reference/mnogosearch/functions/udm-check-stored.xml:1.2
phpdoc/en/reference/mnogosearch/functions/udm-check-stored.xml:1.3
--- phpdoc/en/reference/mnogosearch/functions/udm-check-stored.xml:1.2 Wed Apr 17
02:40:44 2002
+++ phpdoc/en/reference/mnogosearch/functions/udm-check-stored.xml Sun Jun 29
15:51:33 2003
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/mnogosearch.xml, last change in rev 1.31 -->
<refentry id='function.udm-check-stored'>
<refnamediv>
@@ -12,7 +12,7 @@
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>udm_check_stored</methodname>
- <methodparam><type>int</type><parameter>agent</parameter></methodparam>
+ <methodparam><type>resource</type><parameter>agent</parameter></methodparam>
<methodparam><type>int</type><parameter>link</parameter></methodparam>
<methodparam><type>string</type><parameter>doc_id</parameter></methodparam>
</methodsynopsis>
Index: phpdoc/en/reference/mnogosearch/functions/udm-clear-search-limits.xml
diff -u phpdoc/en/reference/mnogosearch/functions/udm-clear-search-limits.xml:1.2
phpdoc/en/reference/mnogosearch/functions/udm-clear-search-limits.xml:1.3
--- phpdoc/en/reference/mnogosearch/functions/udm-clear-search-limits.xml:1.2 Wed
Apr 17 02:40:45 2002
+++ phpdoc/en/reference/mnogosearch/functions/udm-clear-search-limits.xml Sun
Jun 29 15:51:33 2003
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/mnogosearch.xml, last change in rev 1.18 -->
<refentry id="function.udm-clear-search-limits">
<refnamediv>
@@ -9,13 +9,16 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
- <type>int</type><methodname>udm_clear_search_limits</methodname>
- <methodparam><type>int</type><parameter>agent</parameter></methodparam>
+ <type>bool</type><methodname>udm_clear_search_limits</methodname>
+ <methodparam><type>resource</type><parameter>agent</parameter></methodparam>
</methodsynopsis>
<para>
<function>udm_clear_search_limits</function> resets defined search
limitations and returns &true;.
+ </para>
+ <para>
+ See also <function>udm_add_search_limit</function>.
</para>
</refsect1>
</refentry>
Index: phpdoc/en/reference/mnogosearch/functions/udm-close-stored.xml
diff -u phpdoc/en/reference/mnogosearch/functions/udm-close-stored.xml:1.2
phpdoc/en/reference/mnogosearch/functions/udm-close-stored.xml:1.3
--- phpdoc/en/reference/mnogosearch/functions/udm-close-stored.xml:1.2 Wed Apr 17
02:40:45 2002
+++ phpdoc/en/reference/mnogosearch/functions/udm-close-stored.xml Sun Jun 29
15:51:33 2003
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/mnogosearch.xml, last change in rev 1.31 -->
<refentry id='function.udm-close-stored'>
<refnamediv>
@@ -12,7 +12,7 @@
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>udm_close_stored</methodname>
- <methodparam><type>int</type><parameter>agent</parameter></methodparam>
+ <methodparam><type>resource</type><parameter>agent</parameter></methodparam>
<methodparam><type>int</type><parameter>link</parameter></methodparam>
</methodsynopsis>
<para>
Index: phpdoc/en/reference/mnogosearch/functions/udm-crc32.xml
diff -u phpdoc/en/reference/mnogosearch/functions/udm-crc32.xml:1.2
phpdoc/en/reference/mnogosearch/functions/udm-crc32.xml:1.3
--- phpdoc/en/reference/mnogosearch/functions/udm-crc32.xml:1.2 Wed Apr 17 02:40:45
2002
+++ phpdoc/en/reference/mnogosearch/functions/udm-crc32.xml Sun Jun 29 15:51:33
2003
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/mnogosearch.xml, last change in rev 1.31 -->
<refentry id='function.udm-crc32'>
<refnamediv>
@@ -12,7 +12,7 @@
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>udm_crc32</methodname>
- <methodparam><type>int</type><parameter>agent</parameter></methodparam>
+ <methodparam><type>resource</type><parameter>agent</parameter></methodparam>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
</methodsynopsis>
<para>
Index: phpdoc/en/reference/mnogosearch/functions/udm-errno.xml
diff -u phpdoc/en/reference/mnogosearch/functions/udm-errno.xml:1.2
phpdoc/en/reference/mnogosearch/functions/udm-errno.xml:1.3
--- phpdoc/en/reference/mnogosearch/functions/udm-errno.xml:1.2 Wed Apr 17 02:40:45
2002
+++ phpdoc/en/reference/mnogosearch/functions/udm-errno.xml Sun Jun 29 15:51:33
2003
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/mnogosearch.xml, last change in rev 1.18 -->
<refentry id="function.udm-errno">
<refnamediv>
@@ -11,7 +11,7 @@
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>udm_errno</methodname>
- <methodparam><type>int</type><parameter>agent</parameter></methodparam>
+ <methodparam><type>resource</type><parameter>agent</parameter></methodparam>
</methodsynopsis>
<para>
Index: phpdoc/en/reference/mnogosearch/functions/udm-error.xml
diff -u phpdoc/en/reference/mnogosearch/functions/udm-error.xml:1.2
phpdoc/en/reference/mnogosearch/functions/udm-error.xml:1.3
--- phpdoc/en/reference/mnogosearch/functions/udm-error.xml:1.2 Wed Apr 17 02:40:45
2002
+++ phpdoc/en/reference/mnogosearch/functions/udm-error.xml Sun Jun 29 15:51:33
2003
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/mnogosearch.xml, last change in rev 1.18 -->
<refentry id="function.udm-error">
<refnamediv>
@@ -10,7 +10,7 @@
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>udm_error</methodname>
- <methodparam><type>int</type><parameter>agent</parameter></methodparam>
+ <methodparam><type>resource</type><parameter>agent</parameter></methodparam>
</methodsynopsis>
<para>
Index: phpdoc/en/reference/mnogosearch/functions/udm-find.xml
diff -u phpdoc/en/reference/mnogosearch/functions/udm-find.xml:1.2
phpdoc/en/reference/mnogosearch/functions/udm-find.xml:1.3
--- phpdoc/en/reference/mnogosearch/functions/udm-find.xml:1.2 Wed Apr 17 02:40:45
2002
+++ phpdoc/en/reference/mnogosearch/functions/udm-find.xml Sun Jun 29 15:51:33
2003
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/mnogosearch.xml, last change in rev 1.18 -->
<refentry id="function.udm-find">
<refnamediv>
@@ -10,14 +10,13 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
- <type>int</type><methodname>udm_find</methodname>
- <methodparam><type>int</type><parameter>agent</parameter></methodparam>
+ <type>resource</type><methodname>udm_find</methodname>
+ <methodparam><type>resource</type><parameter>agent</parameter></methodparam>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
<para>
- <function>udm_find</function> returns result link identifier on
- success, &false; on error.
+ Returns a result link identifier on success, or &false; on failure.
</para>
<para>
Index: phpdoc/en/reference/mnogosearch/functions/udm-free-agent.xml
diff -u phpdoc/en/reference/mnogosearch/functions/udm-free-agent.xml:1.2
phpdoc/en/reference/mnogosearch/functions/udm-free-agent.xml:1.3
--- phpdoc/en/reference/mnogosearch/functions/udm-free-agent.xml:1.2 Wed Apr 17
02:40:45 2002
+++ phpdoc/en/reference/mnogosearch/functions/udm-free-agent.xml Sun Jun 29
15:51:33 2003
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/mnogosearch.xml, last change in rev 1.18 -->
<refentry id="function.udm-free-agent">
<refnamediv>
@@ -11,11 +11,11 @@
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>udm_free_agent</methodname>
- <methodparam><type>int</type><parameter>agent</parameter></methodparam>
+ <methodparam><type>resource</type><parameter>agent</parameter></methodparam>
</methodsynopsis>
<para>
- <function>udm_free_agent</function> returns &true; on success, &false; on error.
+ &return.success;
</para>
<para>
<parameter>agent</parameter> - link to agent identifier, received `
Index: phpdoc/en/reference/mnogosearch/functions/udm-free-ispell-data.xml
diff -u phpdoc/en/reference/mnogosearch/functions/udm-free-ispell-data.xml:1.2
phpdoc/en/reference/mnogosearch/functions/udm-free-ispell-data.xml:1.3
--- phpdoc/en/reference/mnogosearch/functions/udm-free-ispell-data.xml:1.2 Wed
Apr 17 02:40:45 2002
+++ phpdoc/en/reference/mnogosearch/functions/udm-free-ispell-data.xml Sun Jun 29
15:51:33 2003
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/mnogosearch.xml, last change in rev 1.18 -->
<refentry id="function.udm-free-ispell-data">
<refnamediv>
@@ -10,7 +10,7 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
- <type>int</type><methodname>udm_free_ispell_data</methodname>
+ <type>bool</type><methodname>udm_free_ispell_data</methodname>
<methodparam><type>int</type><parameter>agent</parameter></methodparam>
</methodsynopsis>
Index: phpdoc/en/reference/mnogosearch/functions/udm-free-res.xml
diff -u phpdoc/en/reference/mnogosearch/functions/udm-free-res.xml:1.2
phpdoc/en/reference/mnogosearch/functions/udm-free-res.xml:1.3
--- phpdoc/en/reference/mnogosearch/functions/udm-free-res.xml:1.2 Wed Apr 17
02:40:45 2002
+++ phpdoc/en/reference/mnogosearch/functions/udm-free-res.xml Sun Jun 29 15:51:33
2003
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/mnogosearch.xml, last change in rev 1.18 -->
<refentry id="function.udm-free-res">
<refnamediv>
@@ -10,12 +10,12 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
- <type>int</type><methodname>udm_free_res</methodname>
- <methodparam><type>int</type><parameter>res</parameter></methodparam>
+ <type>bool</type><methodname>udm_free_res</methodname>
+ <methodparam><type>resurce</type><parameter>res</parameter></methodparam>
</methodsynopsis>
<para>
- <function>udm_free_res</function> returns &true; on success, &false; on error.
+ &return.success;
</para>
<para>
Index: phpdoc/en/reference/mnogosearch/functions/udm-get-doc-count.xml
diff -u phpdoc/en/reference/mnogosearch/functions/udm-get-doc-count.xml:1.2
phpdoc/en/reference/mnogosearch/functions/udm-get-doc-count.xml:1.3
--- phpdoc/en/reference/mnogosearch/functions/udm-get-doc-count.xml:1.2 Wed Apr 17
02:40:45 2002
+++ phpdoc/en/reference/mnogosearch/functions/udm-get-doc-count.xml Sun Jun 29
15:51:33 2003
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/mnogosearch.xml, last change in rev 1.18 -->
<refentry id="function.udm-get-doc-count">
<refnamediv>
@@ -11,11 +11,12 @@
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>udm_get_doc_count</methodname>
- <methodparam><type>int</type><parameter>agent</parameter></methodparam>
+ <methodparam><type>resource</type><parameter>agent</parameter></methodparam>
</methodsynopsis>
<para>
- <function>udm_get_doc_count</function> returns number of documents in database.
+ <function>udm_get_doc_count</function> returns the number of documents in
+ the database.
</para>
<para>
Index: phpdoc/en/reference/mnogosearch/functions/udm-get-res-field.xml
diff -u phpdoc/en/reference/mnogosearch/functions/udm-get-res-field.xml:1.2
phpdoc/en/reference/mnogosearch/functions/udm-get-res-field.xml:1.3
--- phpdoc/en/reference/mnogosearch/functions/udm-get-res-field.xml:1.2 Wed Apr 17
02:40:46 2002
+++ phpdoc/en/reference/mnogosearch/functions/udm-get-res-field.xml Sun Jun 29
15:51:33 2003
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/mnogosearch.xml, last change in rev 1.18 -->
<refentry id="function.udm-get-res-field">
<refnamediv>
@@ -11,7 +11,7 @@
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>udm_get_res_field</methodname>
- <methodparam><type>int</type><parameter>res</parameter></methodparam>
+ <methodparam><type>resource</type><parameter>res</parameter></methodparam>
<methodparam><type>int</type><parameter>row</parameter></methodparam>
<methodparam><type>int</type><parameter>field</parameter></methodparam>
</methodsynopsis>
Index: phpdoc/en/reference/mnogosearch/functions/udm-get-res-param.xml
diff -u phpdoc/en/reference/mnogosearch/functions/udm-get-res-param.xml:1.2
phpdoc/en/reference/mnogosearch/functions/udm-get-res-param.xml:1.3
--- phpdoc/en/reference/mnogosearch/functions/udm-get-res-param.xml:1.2 Wed Apr 17
02:40:46 2002
+++ phpdoc/en/reference/mnogosearch/functions/udm-get-res-param.xml Sun Jun 29
15:51:33 2003
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/mnogosearch.xml, last change in rev 1.18 -->
<refentry id="function.udm-get-res-param">
<refnamediv>
@@ -11,7 +11,7 @@
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>udm_get_res_param</methodname>
- <methodparam><type>int</type><parameter>res</parameter></methodparam>
+ <methodparam><type>resource</type><parameter>res</parameter></methodparam>
<methodparam><type>int</type><parameter>param</parameter></methodparam>
</methodsynopsis>
Index: phpdoc/en/reference/mnogosearch/functions/udm-load-ispell-data.xml
diff -u phpdoc/en/reference/mnogosearch/functions/udm-load-ispell-data.xml:1.2
phpdoc/en/reference/mnogosearch/functions/udm-load-ispell-data.xml:1.3
--- phpdoc/en/reference/mnogosearch/functions/udm-load-ispell-data.xml:1.2 Wed
Apr 17 02:40:46 2002
+++ phpdoc/en/reference/mnogosearch/functions/udm-load-ispell-data.xml Sun Jun 29
15:51:33 2003
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/mnogosearch.xml, last change in rev 1.18 -->
<refentry id="function.udm-load-ispell-data">
<refnamediv>
@@ -10,8 +10,8 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
- <type>int</type><methodname>udm_load_ispell_data</methodname>
- <methodparam><type>int</type><parameter>agent</parameter></methodparam>
+ <type>bool</type><methodname>udm_load_ispell_data</methodname>
+ <methodparam><type>resource</type><parameter>agent</parameter></methodparam>
<methodparam><type>int</type><parameter>var</parameter></methodparam>
<methodparam><type>string</type><parameter>val1</parameter></methodparam>
<methodparam><type>string</type><parameter>val2</parameter></methodparam>
@@ -19,8 +19,8 @@
</methodsynopsis>
<para>
- <function>udm_load_ispell_data</function> loads ispell data. Returns &true;
- on success, &false; on error.
+ <function>udm_load_ispell_data</function> loads ispell data.
+ &return.success;
</para>
<para>
@@ -68,18 +68,19 @@
<function>udm_error</function> and <function>udm_errno</function>.
</para>
</note>
-
- <simpara>Example:</simpara>
- <informalexample>
- <programlisting role="php">
+ <example>
+ <title><function>udm_load_ispell_data</function>example</title>
+ <programlisting role="php">
<![CDATA[
+<?php
if (! udm_load_ispell_data($udm,UDM_ISPELL_TYPE_DB,'','',1)) {
printf("Error #%d: '%s'\n", udm_errno($udm), udm_error($udm));
exit;
}
+?>
]]>
- </programlisting>
- </informalexample>
+ </programlisting>
+ </example>
</listitem>
<listitem>
<para>
@@ -95,20 +96,23 @@
since those functions can only return messages associated with SQL. Please,
see <parameter>flag</parameter> parameter description in UDM_ISPELL_TYPE_DB.
</para>
-
- <simpara>Example:</simpara>
- <informalexample>
- <programlisting role="php">
+ <para>
+ <example>
+ <title><function>udm_load_ispell_data</function> example</title>
+ <programlisting role="php">
<![CDATA[
- if ((!
udm_load_ispell_data($udm,UDM_ISPELL_TYPE_AFFIX,'en','/opt/ispell/en.aff',0)) ||
- (!
udm_load_ispell_data($udm,UDM_ISPELL_TYPE_AFFIX,'ru','/opt/ispell/ru.aff',0)) ||
- (!
udm_load_ispell_data($udm,UDM_ISPELL_TYPE_SPELL,'en','/opt/ispell/en.dict',0)) ||
- (!
udm_load_ispell_data($udm,UDM_ISPELL_TYPE_SPELL,'ru','/opt/ispell/ru.dict',1))) {
- exit;
- }
+<?php
+if ((! udm_load_ispell_data($udm,UDM_ISPELL_TYPE_AFFIX,'en','/opt/ispell/en.aff',0))
||
+ (! udm_load_ispell_data($udm,UDM_ISPELL_TYPE_AFFIX,'ru','/opt/ispell/ru.aff',0))
||
+ (! udm_load_ispell_data($udm,UDM_ISPELL_TYPE_SPELL,'en','/opt/ispell/en.dict',0))
||
+ (!
udm_load_ispell_data($udm,UDM_ISPELL_TYPE_SPELL,'ru','/opt/ispell/ru.dict',1))) {
+ exit;
+}
+?>
]]>
- </programlisting>
- </informalexample>
+ </programlisting>
+ </example>
+ </para>
<note>
<para>
<parameter>flag</parameter> is equal to <literal>1</literal> only in the last
call.
Index: phpdoc/en/reference/mnogosearch/functions/udm-open-stored.xml
diff -u phpdoc/en/reference/mnogosearch/functions/udm-open-stored.xml:1.2
phpdoc/en/reference/mnogosearch/functions/udm-open-stored.xml:1.3
--- phpdoc/en/reference/mnogosearch/functions/udm-open-stored.xml:1.2 Wed Apr 17
02:40:46 2002
+++ phpdoc/en/reference/mnogosearch/functions/udm-open-stored.xml Sun Jun 29
15:51:33 2003
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/mnogosearch.xml, last change in rev 1.31 -->
<refentry id='function.udm-open-stored'>
<refnamediv>
@@ -12,7 +12,7 @@
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>udm_open_stored</methodname>
- <methodparam><type>int</type><parameter>agent</parameter></methodparam>
+ <methodparam><type>resource</type><parameter>agent</parameter></methodparam>
<methodparam><type>string</type><parameter>storedaddr</parameter></methodparam>
</methodsynopsis>
<para>
Index: phpdoc/en/reference/mnogosearch/functions/udm-set-agent-param.xml
diff -u phpdoc/en/reference/mnogosearch/functions/udm-set-agent-param.xml:1.2
phpdoc/en/reference/mnogosearch/functions/udm-set-agent-param.xml:1.3
--- phpdoc/en/reference/mnogosearch/functions/udm-set-agent-param.xml:1.2 Wed
Apr 17 02:40:46 2002
+++ phpdoc/en/reference/mnogosearch/functions/udm-set-agent-param.xml Sun Jun 29
15:51:33 2003
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/mnogosearch.xml, last change in rev 1.18 -->
<refentry id="function.udm-set-agent-param">
<refnamediv>
@@ -9,15 +9,14 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
- <type>int</type><methodname>udm_set_agent_param</methodname>
- <methodparam><type>int</type><parameter>agent</parameter></methodparam>
+ <type>bool</type><methodname>udm_set_agent_param</methodname>
+ <methodparam><type>resource</type><parameter>agent</parameter></methodparam>
<methodparam><type>int</type><parameter>var</parameter></methodparam>
<methodparam><type>string</type><parameter>val</parameter></methodparam>
</methodsynopsis>
<para>
- <function>udm_set_agent_param</function> returns &true; on success,
- &false; on error. Defines mnoGoSearch session parameters.
+ &return.success; Defines mnoGoSearch session parameters.
</para>
<simpara>
--
PHP Documentation Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
