From d7b3888eea331d397bc038bd8c167c544b88385e Mon Sep 17 00:00:00 2001
From: Mehdi Achour <didou@php.net>
Date: Tue, 12 Jun 2007 00:16:12 +0000
Subject: [PATCH] ref.mnogosearch: switch to new style
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@237445 c90b9560-bf6c-de11-be94-00142212c4b1
---
.../functions/udm-add-search-limit.xml | 224 ++++----
.../functions/udm-alloc-agent-array.xml | 50 +-
.../mnogosearch/functions/udm-alloc-agent.xml | 148 +++--
.../mnogosearch/functions/udm-api-version.xml | 64 ++-
.../mnogosearch/functions/udm-cat-list.xml | 131 +++--
.../mnogosearch/functions/udm-cat-path.xml | 129 +++--
.../functions/udm-check-charset.xml | 41 +-
.../functions/udm-check-stored.xml | 43 +-
.../functions/udm-clear-search-limits.xml | 76 ++-
.../functions/udm-close-stored.xml | 41 +-
reference/mnogosearch/functions/udm-crc32.xml | 41 +-
reference/mnogosearch/functions/udm-errno.xml | 72 ++-
reference/mnogosearch/functions/udm-error.xml | 74 ++-
reference/mnogosearch/functions/udm-find.xml | 156 +++---
.../mnogosearch/functions/udm-free-agent.xml | 72 ++-
.../functions/udm-free-ispell-data.xml | 82 +--
.../mnogosearch/functions/udm-free-res.xml | 73 ++-
.../functions/udm-get-doc-count.xml | 83 +--
.../functions/udm-get-res-field.xml | 246 ++++----
.../functions/udm-get-res-param.xml | 154 ++---
.../mnogosearch/functions/udm-hash32.xml | 54 +-
.../functions/udm-load-ispell-data.xml | 399 +++++++------
.../mnogosearch/functions/udm-open-stored.xml | 41 +-
.../functions/udm-set-agent-param.xml | 526 ++++++++++--------
24 files changed, 1766 insertions(+), 1254 deletions(-)
diff --git a/reference/mnogosearch/functions/udm-add-search-limit.xml b/reference/mnogosearch/functions/udm-add-search-limit.xml
index 7ce1ce4021..e52e37cde6 100644
--- a/reference/mnogosearch/functions/udm-add-search-limit.xml
+++ b/reference/mnogosearch/functions/udm-add-search-limit.xml
@@ -1,106 +1,134 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.6 $ -->
-<!-- splitted from ./en/functions/mnogosearch.xml, last change in rev 1.18 -->
- <refentry id="function.udm-add-search-limit">
- <refnamediv>
- <refname>udm_add_search_limit</refname>
- <refpurpose>Add various search limits</refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <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> adds search restrictions.
- &return.success;
- </para>
- <para>
- <parameter>agent</parameter> - a link to Agent, received after call to
- <function>udm_alloc_agent</function>.
- </para>
- <para>
- <parameter>var</parameter> - defines parameter, indicating limit.
- </para>
- <para>
- <parameter>val</parameter> - defines the value of the current parameter.
- </para>
- <para>
- Possible <parameter>var</parameter> values:
- </para>
- <itemizedlist>
- <listitem>
- <simpara>
- 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://www.example.___/catalog
- may stand for http://www.example.com/catalog and http://www.example.net/catalog.
- </simpara>
- </listitem>
- <listitem>
- <simpara>
- UDM_LIMIT_TAG - defines site TAG limitations. In indexer-conf you can
- assign specific TAGs to various sites and parts of a site. Tags in
- mnoGoSearch 3.1.x are lines, that may contain metasymbols % and _.
- Metasymbols allow searching among groups of tags.
- E.g. there are links with tags ABCD and ABCE, and search restriction
- is by ABC_ - the search will be made among both of the tags.
- </simpara>
- </listitem>
- <listitem>
- <simpara>
- UDM_LIMIT_LANG - defines document language limitations.
- </simpara>
- </listitem>
- <listitem>
- <simpara>
- UDM_LIMIT_CAT - defines document category limitations. Categories are
- similar to tag feature, but nested. So you can have one category inside
- another and so on. You have to use two characters for each level. Use a
- hex number going from 0-F or a 36 base number going from 0-Z.
- Therefore a top-level category like 'Auto' would be 01. If it has a
- subcategory like 'Ford', then it would be 01 (the parent category) and then
- 'Ford' which we will give 01. Put those together and you get 0101. If 'Auto'
- had another subcategory named 'VW', then it's id would be 01 because it
- belongs to the 'Ford' category and then 02 because it's the next category.
- So it's id would be 0102. If VW had a sub category called 'Engine' then it's
- id would start at 01 again and it would get the 'VW' id 02 and 'Auto' id of
- 01, making it 010201. If you want to search for sites under that category
- then you pass it cat=010201 in the URL.
- </simpara>
- </listitem>
- <listitem>
- <simpara>
- UDM_LIMIT_DATE - defines limitation by date the document was modified.
- </simpara>
- <simpara>
- Format of parameter value: a string with first character < or >,
- then with no space - date in unixtime format, for example:
- </simpara>
- <para>
- <example>
- <title />
- <programlisting role="php">
+<!-- $Revision: 1.7 $ -->
+<refentry id="function.udm-add-search-limit">
+ <refnamediv>
+ <refname>udm_add_search_limit</refname>
+ <refpurpose>Add various search limits</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <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> adds search restrictions.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>agent</parameter></term>
+ <listitem>
+ <para>
+ A link to Agent, received after call to
+ <function>udm_alloc_agent</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>var</parameter></term>
+ <listitem>
+ <para>
+ Defines the parameter, indicating limits.
+ Possible <parameter>var</parameter> values:
+ <itemizedlist>
+ <listitem>
+ <simpara>
+ <constant>UDM_LIMIT_URL</constant> - 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://www.example.___/catalog
+ may stand for http://www.example.com/catalog and http://www.example.net/catalog.
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ <constant>UDM_LIMIT_TAG</constant> - defines site TAG limitations. In indexer-conf you can
+ assign specific TAGs to various sites and parts of a site. Tags in
+ mnoGoSearch 3.1.x are lines, that may contain metasymbols % and _.
+ Metasymbols allow searching among groups of tags.
+ E.g. there are links with tags ABCD and ABCE, and search restriction
+ is by ABC_ - the search will be made among both of the tags.
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ <constant>UDM_LIMIT_LANG</constant> - defines document language limitations.
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ <constant>UDM_LIMIT_CAT</constant> - defines document category limitations. Categories are
+ similar to tag feature, but nested. So you can have one category inside
+ another and so on. You have to use two characters for each level. Use a
+ hex number going from 0-F or a 36 base number going from 0-Z.
+ Therefore a top-level category like 'Auto' would be 01. If it has a
+ subcategory like 'Ford', then it would be 01 (the parent category) and then
+ 'Ford' which we will give 01. Put those together and you get 0101. If 'Auto'
+ had another subcategory named 'VW', then it's id would be 01 because it
+ belongs to the 'Ford' category and then 02 because it's the next category.
+ So it's id would be 0102. If VW had a sub category called 'Engine' then it's
+ id would start at 01 again and it would get the 'VW' id 02 and 'Auto' id of
+ 01, making it 010201. If you want to search for sites under that category
+ then you pass it cat=010201 in the URL.
+ </simpara>
+ </listitem>
+ <listitem>
+ <para>
+ <constant>UDM_LIMIT_DATE</constant> - defines limitation by date the document was modified.
+ </para>
+ <para>
+ Format of parameter value: a string with first character < or >,
+ then with no space - date in unixtime format, for example:
+ </para>
+ <para>
+ <example>
+ <title />
+ <programlisting role="php">
<![CDATA[
<?php
- Udm_Add_Search_Limit($udm, UDM_LIMIT_DATE, "<908012006");
+udm_add_search_limit($udm, UDM_LIMIT_DATE, "<908012006");
?>
]]>
- </programlisting>
- </example>
- </para>
- <simpara>
- 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>
- </refsect1>
- </refentry>
+ </programlisting>
+ </example>
+ </para>
+ <para>
+ If > character is used, then the search will be restricted to those
+ documents having a modification date greater than entered, if <, then smaller.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>val</parameter></term>
+ <listitem>
+ <para>
+ Defines the value of the current parameter.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.success;
+ </para>
+ </refsect1>
+
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
diff --git a/reference/mnogosearch/functions/udm-alloc-agent-array.xml b/reference/mnogosearch/functions/udm-alloc-agent-array.xml
index 4932a92f14..7ea6a4d856 100644
--- a/reference/mnogosearch/functions/udm-alloc-agent-array.xml
+++ b/reference/mnogosearch/functions/udm-alloc-agent-array.xml
@@ -1,27 +1,57 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<refentry id="function.udm-alloc-agent-array">
<refnamediv>
<refname>udm_alloc_agent_array</refname>
<refpurpose>Allocate mnoGoSearch session</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>udm_alloc_agent_array</methodname>
<methodparam><type>array</type><parameter>databases</parameter></methodparam>
</methodsynopsis>
<para>
<function>udm_alloc_agent_array</function> will create an agent
- with multiple database connections. The array
- <parameter>databases</parameter> must contain one database URL
- per element, analog to the first parameter of
- <function>udm_alloc_agent</function>.
- </para>
- <para>
- See also: <function>udm_alloc_agent</function>.
+ with multiple database connections.
</para>
</refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>databases</parameter></term>
+ <listitem>
+ <para>
+ The array <parameter>databases</parameter> must contain one database
+ URL per element, analog to the first parameter of
+ <function>udm_alloc_agent</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns a resource link identifier on success, or &false; on failure.
+ </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><function>udm_alloc_agent</function></member>
+ </simplelist>
+ </para>
+ </refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
diff --git a/reference/mnogosearch/functions/udm-alloc-agent.xml b/reference/mnogosearch/functions/udm-alloc-agent.xml
index 4a9d26efef..8c7280229d 100644
--- a/reference/mnogosearch/functions/udm-alloc-agent.xml
+++ b/reference/mnogosearch/functions/udm-alloc-agent.xml
@@ -1,68 +1,94 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
-<!-- splitted from ./en/functions/mnogosearch.xml, last change in rev 1.18 -->
- <refentry id="function.udm-alloc-agent">
- <refnamediv>
- <refname>udm_alloc_agent</refname>
- <refpurpose>Allocate mnoGoSearch session</refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <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>
- 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, 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[:DBPass]@]DBHost[: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.
+<!-- $Revision: 1.5 $ -->
+<refentry id="function.udm-alloc-agent">
+ <refnamediv>
+ <refname>udm_alloc_agent</refname>
+ <refpurpose>Allocate mnoGoSearch session</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <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>
+ Allocate a mnoGoSearch session.
</para>
-
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>dbaddr</parameter></term>
+ <listitem>
+ <para>
+ <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[:DBPass]@]DBHost[: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>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>dbmode</parameter></term>
+ <listitem>
+ <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 algorithm 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>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ <note>
<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 algorithm 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.
+ <parameter>dbaddr</parameter> and <parameter>dbmode</parameter> must match
+ those used during indexing.
</para>
-
- <note>
- <para>
- <parameter>dbaddr</parameter> and <parameter>dbmode</parameter> must match
- those used during indexing.
- </para>
- </note>
-
- <note>
- <para>
- 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>
- </refentry>
+ </note>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns a mnogosearch agent identifier on success, &false; on failure. This
+ function creates a session with database parameters.
+ </para>
+ </refsect1>
+
+ <refsect1 role="notes">
+ &reftitle.notes;
+ <note>
+ <para>
+ 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>
+
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
diff --git a/reference/mnogosearch/functions/udm-api-version.xml b/reference/mnogosearch/functions/udm-api-version.xml
index 435f8949dd..dca46dbd93 100644
--- a/reference/mnogosearch/functions/udm-api-version.xml
+++ b/reference/mnogosearch/functions/udm-api-version.xml
@@ -1,29 +1,39 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.8 $ -->
-<!-- splitted from ./en/functions/mnogosearch.xml, last change in rev 1.18 -->
- <refentry id="function.udm-api-version">
- <refnamediv>
- <refname>udm_api_version</refname>
- <refpurpose>Get mnoGoSearch API version</refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>udm_api_version</methodname>
- <void/>
- </methodsynopsis>
-
- <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>
+<!-- $Revision: 1.9 $ -->
+<refentry id="function.udm-api-version">
+ <refnamediv>
+ <refname>udm_api_version</refname>
+ <refpurpose>Get mnoGoSearch API version</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>int</type><methodname>udm_api_version</methodname>
+ <void/>
+ </methodsynopsis>
+ <para>
+ Gets the mnoGoSearch API version.
+ </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>
+ </refsect1>
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <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>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
<example>
<title><function>udm_api_version</function> example</title>
<programlisting role="php">
@@ -36,8 +46,10 @@ if (udm_api_version() >= 30111) {
]]>
</programlisting>
</example>
- </refsect1>
- </refentry>
+ </para>
+ </refsect1>
+
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
diff --git a/reference/mnogosearch/functions/udm-cat-list.xml b/reference/mnogosearch/functions/udm-cat-list.xml
index fcd92dc43c..b03aa8a55d 100644
--- a/reference/mnogosearch/functions/udm-cat-list.xml
+++ b/reference/mnogosearch/functions/udm-cat-list.xml
@@ -1,34 +1,62 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.9 $ -->
-<!-- splitted from ./en/functions/mnogosearch.xml, last change in rev 1.18 -->
- <refentry id="function.udm-cat-list">
- <refnamediv>
- <refname>udm_cat_list</refname>
- <refpurpose>Get all the categories on the same level with the current one</refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <type>array</type><methodname>udm_cat_list</methodname>
- <methodparam><type>resource</type><parameter>agent</parameter></methodparam>
- <methodparam><type>string</type><parameter>category</parameter></methodparam>
- </methodsynopsis>
-
- <para>
- 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>
- The returned array consists of pairs. Elements with even index numbers
- contain the category paths, odd elements contain the corresponding category
- names.
- </para>
- <screen>
+<!-- $Revision: 1.10 $ -->
+<refentry id="function.udm-cat-list">
+ <refnamediv>
+ <refname>udm_cat_list</refname>
+ <refpurpose>Get all the categories on the same level with the current one</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>array</type><methodname>udm_cat_list</methodname>
+ <methodparam><type>resource</type><parameter>agent</parameter></methodparam>
+ <methodparam><type>string</type><parameter>category</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ Gets all the categories on the same level with the current one.
+ </para>
+ <para>
+ The function can be useful for developing categories tree browser.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>agent</parameter></term>
+ <listitem>
+ <para>
+ A link to Agent, received after call to
+ <function>udm_alloc_agent</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>category</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns an array listing all categories of the same level as the current
+ <parameter>category</parameter> in the categories tree.
+ </para>
+ <para>
+ The returned array consists of pairs. Elements with even index numbers
+ contain the category paths, odd elements contain the corresponding category
+ names.
+ </para>
+ <screen>
<![CDATA[
$array[0] will contain '020300'
$array[1] will contain 'Audi'
@@ -39,20 +67,24 @@
...
etc.
]]>
- </screen>
- <para>
- Following is an example of displaying links of the current level in format:
- <screen>
+ </screen>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ Following is an example of displaying links of the current level in format:
+ <screen>
<![CDATA[
Audi
BMW
Opel
...
]]>
- </screen>
- <example>
- <title><function>udm_cat_list</function> example</title>
- <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);
@@ -64,14 +96,21 @@
}
?>
]]>
- </programlisting>
- </example>
- </para>
- <para>
- See also <function>udm_cat_path</function>.
- </para>
- </refsect1>
- </refentry>
+ </programlisting>
+ </example>
+ </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><function>udm_cat_path</function></member>
+ </simplelist>
+ </para>
+ </refsect1>
+
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
diff --git a/reference/mnogosearch/functions/udm-cat-path.xml b/reference/mnogosearch/functions/udm-cat-path.xml
index 8c2373daff..32a1fd2933 100644
--- a/reference/mnogosearch/functions/udm-cat-path.xml
+++ b/reference/mnogosearch/functions/udm-cat-path.xml
@@ -1,33 +1,59 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
-<!-- splitted from ./en/functions/mnogosearch.xml, last change in rev 1.18 -->
- <refentry id="function.udm-cat-path">
- <refnamediv>
- <refname>udm_cat_path</refname>
- <refpurpose>Get the path to the current category</refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <type>array</type><methodname>udm_cat_path</methodname>
- <methodparam><type>resource</type><parameter>agent</parameter></methodparam>
- <methodparam><type>string</type><parameter>category</parameter></methodparam>
- </methodsynopsis>
- <para>
- 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>
- 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:
- <screen>
+<!-- $Revision: 1.6 $ -->
+<refentry id="function.udm-cat-path">
+ <refnamediv>
+ <refname>udm_cat_path</refname>
+ <refpurpose>Get the path to the current category</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>array</type><methodname>udm_cat_path</methodname>
+ <methodparam><type>resource</type><parameter>agent</parameter></methodparam>
+ <methodparam><type>string</type><parameter>category</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ Returns an array describing the path in the categories tree from the tree
+ root to the current one, specified by <parameter>category</parameter>.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>agent</parameter></term>
+ <listitem>
+ <para>
+ A link to Agent, received after call to
+ <function>udm_alloc_agent</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>category</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ 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:
+ <screen>
<![CDATA[
$array[0] will contain ''
$array[1] will contain 'Root'
@@ -38,15 +64,19 @@
$array[4] will contain '02031D'
$array[5] will contain 'Ferrari'
]]>
- </screen>
- </para>
- <para>
- <example>
- <title>
- Specifying path to the current category in the following format:
- '> Root > Sport > Auto > Ferrari'
- </title>
- <programlisting role="php">
+ </screen>
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <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);
@@ -58,14 +88,21 @@
}
?>
]]>
- </programlisting>
- </example>
- </para>
- <para>
- See also <function>udm_cat_list</function>.
- </para>
- </refsect1>
- </refentry>
+ </programlisting>
+ </example>
+ </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><function>udm_cat_list</function></member>
+ </simplelist>
+ </para>
+ </refsect1>
+
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
diff --git a/reference/mnogosearch/functions/udm-check-charset.xml b/reference/mnogosearch/functions/udm-check-charset.xml
index 0a2f8d5631..c02ee6c86b 100644
--- a/reference/mnogosearch/functions/udm-check-charset.xml
+++ b/reference/mnogosearch/functions/udm-check-charset.xml
@@ -1,25 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
-<!-- splitted from ./en/functions/mnogosearch.xml, last change in rev 1.31 -->
- <refentry id='function.udm-check-charset'>
- <refnamediv>
- <refname>udm_check_charset</refname>
- <refpurpose>
- Check if the given charset is known to mnogosearch
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <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>
- &warn.undocumented.func;
- </para>
- </refsect1>
- </refentry>
+<!-- $Revision: 1.4 $ -->
+<refentry id='function.udm-check-charset'>
+ <refnamediv>
+ <refname>udm_check_charset</refname>
+ <refpurpose>Check if the given charset is known to mnogosearch</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <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>
+ &warn.undocumented.func;
+ </para>
+ </refsect1>
+
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
diff --git a/reference/mnogosearch/functions/udm-check-stored.xml b/reference/mnogosearch/functions/udm-check-stored.xml
index 3833e4a9f5..3493272d85 100644
--- a/reference/mnogosearch/functions/udm-check-stored.xml
+++ b/reference/mnogosearch/functions/udm-check-stored.xml
@@ -1,26 +1,25 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
-<!-- splitted from ./en/functions/mnogosearch.xml, last change in rev 1.31 -->
- <refentry id='function.udm-check-stored'>
- <refnamediv>
- <refname>udm_check_stored</refname>
- <refpurpose>
- Check connection to stored
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>udm_check_stored</methodname>
- <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>
- <para>
- &warn.undocumented.func;
- </para>
- </refsect1>
- </refentry>
+<!-- $Revision: 1.4 $ -->
+<refentry id='function.udm-check-stored'>
+ <refnamediv>
+ <refname>udm_check_stored</refname>
+ <refpurpose>Check connection to stored</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>int</type><methodname>udm_check_stored</methodname>
+ <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>
+ <para>
+ &warn.undocumented.func;
+ </para>
+ </refsect1>
+
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
diff --git a/reference/mnogosearch/functions/udm-clear-search-limits.xml b/reference/mnogosearch/functions/udm-clear-search-limits.xml
index 28418f5ac4..e583483a5f 100644
--- a/reference/mnogosearch/functions/udm-clear-search-limits.xml
+++ b/reference/mnogosearch/functions/udm-clear-search-limits.xml
@@ -1,27 +1,57 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
-<!-- splitted from ./en/functions/mnogosearch.xml, last change in rev 1.18 -->
- <refentry id="function.udm-clear-search-limits">
- <refnamediv>
- <refname>udm_clear_search_limits</refname>
- <refpurpose>Clear all mnoGoSearch search restrictions</refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <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>
+<!-- $Revision: 1.4 $ -->
+<refentry id="function.udm-clear-search-limits">
+ <refnamediv>
+ <refname>udm_clear_search_limits</refname>
+ <refpurpose>Clear all mnoGoSearch search restrictions</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <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.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>agent</parameter></term>
+ <listitem>
+ <para>
+ A link to Agent, received after call to
+ <function>udm_alloc_agent</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns &true;.
+ </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><function>udm_add_search_limit</function></member>
+ </simplelist>
+ </para>
+ </refsect1>
+
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
diff --git a/reference/mnogosearch/functions/udm-close-stored.xml b/reference/mnogosearch/functions/udm-close-stored.xml
index 566cc9a1c5..9446614e7b 100644
--- a/reference/mnogosearch/functions/udm-close-stored.xml
+++ b/reference/mnogosearch/functions/udm-close-stored.xml
@@ -1,25 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
-<!-- splitted from ./en/functions/mnogosearch.xml, last change in rev 1.31 -->
- <refentry id='function.udm-close-stored'>
- <refnamediv>
- <refname>udm_close_stored</refname>
- <refpurpose>
- Close connection to stored
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>udm_close_stored</methodname>
- <methodparam><type>resource</type><parameter>agent</parameter></methodparam>
- <methodparam><type>int</type><parameter>link</parameter></methodparam>
- </methodsynopsis>
- <para>
- &warn.undocumented.func;
- </para>
- </refsect1>
- </refentry>
+<!-- $Revision: 1.4 $ -->
+<refentry id='function.udm-close-stored'>
+ <refnamediv>
+ <refname>udm_close_stored</refname>
+ <refpurpose>Close connection to stored</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>int</type><methodname>udm_close_stored</methodname>
+ <methodparam><type>resource</type><parameter>agent</parameter></methodparam>
+ <methodparam><type>int</type><parameter>link</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ &warn.undocumented.func;
+ </para>
+ </refsect1>
+
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
diff --git a/reference/mnogosearch/functions/udm-crc32.xml b/reference/mnogosearch/functions/udm-crc32.xml
index 4fbf5d4a51..1d74f12c98 100644
--- a/reference/mnogosearch/functions/udm-crc32.xml
+++ b/reference/mnogosearch/functions/udm-crc32.xml
@@ -1,25 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
-<!-- splitted from ./en/functions/mnogosearch.xml, last change in rev 1.31 -->
- <refentry id='function.udm-crc32'>
- <refnamediv>
- <refname>udm_crc32</refname>
- <refpurpose>
- Return CRC32 checksum of given string
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>udm_crc32</methodname>
- <methodparam><type>resource</type><parameter>agent</parameter></methodparam>
- <methodparam><type>string</type><parameter>str</parameter></methodparam>
- </methodsynopsis>
- <para>
- &warn.undocumented.func;
- </para>
- </refsect1>
- </refentry>
+<!-- $Revision: 1.5 $ -->
+<refentry id='function.udm-crc32'>
+ <refnamediv>
+ <refname>udm_crc32</refname>
+ <refpurpose>Return CRC32 checksum of given string</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>int</type><methodname>udm_crc32</methodname>
+ <methodparam><type>resource</type><parameter>agent</parameter></methodparam>
+ <methodparam><type>string</type><parameter>str</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ &warn.undocumented.func;
+ </para>
+ </refsect1>
+
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
diff --git a/reference/mnogosearch/functions/udm-errno.xml b/reference/mnogosearch/functions/udm-errno.xml
index 78e4732b37..6679ca2c47 100644
--- a/reference/mnogosearch/functions/udm-errno.xml
+++ b/reference/mnogosearch/functions/udm-errno.xml
@@ -1,33 +1,47 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
-<!-- splitted from ./en/functions/mnogosearch.xml, last change in rev 1.18 -->
- <refentry id="function.udm-errno">
- <refnamediv>
- <refname>udm_errno</refname>
- <refpurpose>Get mnoGoSearch error number</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>udm_errno</methodname>
- <methodparam><type>resource</type><parameter>agent</parameter></methodparam>
- </methodsynopsis>
-
- <para>
- <function>udm_errno</function> returns mnoGoSearch error number, zero if no error.
- </para>
-
- <para>
- <parameter>agent</parameter> - link to agent identifier, received
- after call to <function>udm_alloc_agent</function>.
- </para>
-
- <para>
- Receiving numeric agent error code.
- </para>
- </refsect1>
- </refentry>
+<!-- $Revision: 1.4 $ -->
+<refentry id="function.udm-errno">
+ <refnamediv>
+ <refname>udm_errno</refname>
+ <refpurpose>Get mnoGoSearch error number</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>int</type><methodname>udm_errno</methodname>
+ <methodparam><type>resource</type><parameter>agent</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ Receiving numeric agent error code.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>agent</parameter></term>
+ <listitem>
+ <para>
+ A link to Agent, received after call to
+ <function>udm_alloc_agent</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns the mnoGoSearch error number, zero if no error.
+ </para>
+ </refsect1>
+
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
diff --git a/reference/mnogosearch/functions/udm-error.xml b/reference/mnogosearch/functions/udm-error.xml
index 96a41d40ae..769a488640 100644
--- a/reference/mnogosearch/functions/udm-error.xml
+++ b/reference/mnogosearch/functions/udm-error.xml
@@ -1,34 +1,48 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
-<!-- splitted from ./en/functions/mnogosearch.xml, last change in rev 1.18 -->
- <refentry id="function.udm-error">
- <refnamediv>
- <refname>udm_error</refname>
- <refpurpose>Get mnoGoSearch error message</refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <type>string</type><methodname>udm_error</methodname>
- <methodparam><type>resource</type><parameter>agent</parameter></methodparam>
- </methodsynopsis>
-
- <para>
- <function>udm_error</function> returns mnoGoSearch error message,
- empty string if no error.
- </para>
-
- <para>
- <parameter>agent</parameter> - link to agent identifier, received
- after call to <function>udm_alloc_agent</function>.
- </para>
-
- <para>
- Receiving agent error message.
- </para>
-
- </refsect1>
- </refentry>
+<!-- $Revision: 1.4 $ -->
+<refentry id="function.udm-error">
+ <refnamediv>
+ <refname>udm_error</refname>
+ <refpurpose>Get mnoGoSearch error message</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>string</type><methodname>udm_error</methodname>
+ <methodparam><type>resource</type><parameter>agent</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ Gets the agent error message.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>agent</parameter></term>
+ <listitem>
+ <para>
+ A link to Agent, received after call to
+ <function>udm_alloc_agent</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ <function>udm_error</function> returns mnoGoSearch error message,
+ empty string if no error.
+ </para>
+ </refsect1>
+
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
diff --git a/reference/mnogosearch/functions/udm-find.xml b/reference/mnogosearch/functions/udm-find.xml
index 51ecf78602..6443659150 100644
--- a/reference/mnogosearch/functions/udm-find.xml
+++ b/reference/mnogosearch/functions/udm-find.xml
@@ -1,70 +1,94 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
-<!-- splitted from ./en/functions/mnogosearch.xml, last change in rev 1.18 -->
- <refentry id="function.udm-find">
- <refnamediv>
- <refname>udm_find</refname>
- <refpurpose>Perform search</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <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>
- Returns a result link identifier on success, or &false; on failure.
- </para>
-
- <para>
- The search itself. The first argument - session, the next one -
- query itself. To find something just type words you want to find
- and press SUBMIT button. For example, "mysql odbc". You should
- not use quotes " in query, they are written here only to divide a
- query from other text. mnoGoSearch will find all documents that
- contain word "mysql" and/or word "odbc". Best documents having
- bigger weights will be displayed first. If you use search mode
- ALL, search will return documents that contain both (or more)
- words you entered. In case you use mode ANY, the search will
- return list of documents that contain any of the words you
- entered. If you want more advanced results you may use query
- language. You should select "bool" match mode in the search
- from.
- </para>
-
- <simpara>
- mnoGoSearch understands the following boolean operators:
- </simpara>
-
- <simpara>
- & - logical AND. For example, "mysql &
- odbc". mnoGoSearch will find any URLs that contain both
- "mysql" and "odbc".
- </simpara>
- <simpara>
- | - logical OR. For example "mysql|odbc". mnoGoSearch
- will find any URLs, that contain word "mysql" or word
- "odbc".
- </simpara>
- <simpara>
- ~ - logical NOT. For example "mysql & ~odbc".
- mnoGoSearch will find URLs that contain word "mysql"
- and do not contain word "odbc" at the same time. Note
- that ~ just excludes given word from results. Query
- "~odbc" will find nothing!
- </simpara>
- <simpara>
- () - group command to compose more complex queries. For example
- "(mysql | msql) & ~postgres". Query language is
- simple and powerful at the same time. Just consider query as
- usual boolean expression.
- </simpara>
-
- </refsect1>
- </refentry>
+<!-- $Revision: 1.4 $ -->
+<refentry id="function.udm-find">
+ <refnamediv>
+ <refname>udm_find</refname>
+ <refpurpose>Perform search</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <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>
+ Performs a search.
+ </para>
+ <para>
+ The search itself. The first argument - session, the next one -
+ query itself. To find something just type words you want to find
+ and press SUBMIT button. For example, "mysql odbc". You should
+ not use quotes " in query, they are written here only to divide a
+ query from other text. mnoGoSearch will find all documents that
+ contain word "mysql" and/or word "odbc". Best documents having
+ bigger weights will be displayed first. If you use search mode
+ ALL, search will return documents that contain both (or more)
+ words you entered. In case you use mode ANY, the search will
+ return list of documents that contain any of the words you
+ entered. If you want more advanced results you may use query
+ language. You should select "bool" match mode in the search
+ from.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>agent</parameter></term>
+ <listitem>
+ <para>
+ A link to Agent, received after call to
+ <function>udm_alloc_agent</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>query</parameter></term>
+ <listitem>
+ <para>
+ mnoGoSearch understands the following boolean operators:
+ </para>
+ <para>
+ & - logical AND. For example, "mysql &
+ odbc". mnoGoSearch will find any URLs that contain both
+ "mysql" and "odbc".
+ </para>
+ <para>
+ | - logical OR. For example "mysql|odbc". mnoGoSearch
+ will find any URLs, that contain word "mysql" or word
+ "odbc".
+ </para>
+ <para>
+ ~ - logical NOT. For example "mysql & ~odbc".
+ mnoGoSearch will find URLs that contain word "mysql"
+ and do not contain word "odbc" at the same time. Note
+ that ~ just excludes given word from results. Query
+ "~odbc" will find nothing!
+ </para>
+ <para>
+ () - group command to compose more complex queries. For example
+ "(mysql | msql) & ~postgres". Query language is
+ simple and powerful at the same time. Just consider query as
+ usual boolean expression.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns a result link identifier on success, or &false; on failure.
+ </para>
+ </refsect1>
+
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
diff --git a/reference/mnogosearch/functions/udm-free-agent.xml b/reference/mnogosearch/functions/udm-free-agent.xml
index 3573ad46d6..3a6350934e 100644
--- a/reference/mnogosearch/functions/udm-free-agent.xml
+++ b/reference/mnogosearch/functions/udm-free-agent.xml
@@ -1,33 +1,47 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
-<!-- splitted from ./en/functions/mnogosearch.xml, last change in rev 1.18 -->
- <refentry id="function.udm-free-agent">
- <refnamediv>
- <refname>udm_free_agent</refname>
- <refpurpose>Free mnoGoSearch session</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>udm_free_agent</methodname>
- <methodparam><type>resource</type><parameter>agent</parameter></methodparam>
- </methodsynopsis>
-
- <para>
- &return.success;
- </para>
- <para>
- <parameter>agent</parameter> - link to agent identifier, received `
- after call to <function>udm_alloc_agent</function>.
- </para>
-
- <para>
- Freeing up memory allocated for agent session.
- </para>
-
- </refsect1>
- </refentry>
+<!-- $Revision: 1.4 $ -->
+<refentry id="function.udm-free-agent">
+ <refnamediv>
+ <refname>udm_free_agent</refname>
+ <refpurpose>Free mnoGoSearch session</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>int</type><methodname>udm_free_agent</methodname>
+ <methodparam><type>resource</type><parameter>agent</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ Freeing up memory allocated for agent session.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>agent</parameter></term>
+ <listitem>
+ <para>
+ A link to Agent, received after call to
+ <function>udm_alloc_agent</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.success;
+ </para>
+ </refsect1>
+
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
diff --git a/reference/mnogosearch/functions/udm-free-ispell-data.xml b/reference/mnogosearch/functions/udm-free-ispell-data.xml
index 2b2a585346..2e7c006932 100644
--- a/reference/mnogosearch/functions/udm-free-ispell-data.xml
+++ b/reference/mnogosearch/functions/udm-free-ispell-data.xml
@@ -1,37 +1,57 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
-<!-- splitted from ./en/functions/mnogosearch.xml, last change in rev 1.18 -->
- <refentry id="function.udm-free-ispell-data">
- <refnamediv>
- <refname>udm_free_ispell_data</refname>
- <refpurpose>Free memory allocated for ispell data</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <type>bool</type><methodname>udm_free_ispell_data</methodname>
- <methodparam><type>int</type><parameter>agent</parameter></methodparam>
- </methodsynopsis>
-
+<!-- $Revision: 1.4 $ -->
+<refentry id="function.udm-free-ispell-data">
+ <refnamediv>
+ <refname>udm_free_ispell_data</refname>
+ <refpurpose>Free memory allocated for ispell data</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>bool</type><methodname>udm_free_ispell_data</methodname>
+ <methodparam><type>int</type><parameter>agent</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ Frees the memory allocated for ispell data.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>agent</parameter></term>
+ <listitem>
+ <para>
+ A link to Agent, received after call to
+ <function>udm_alloc_agent</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ <function>udm_free_ispell_data</function> always returns &true;.
+ </para>
+ </refsect1>
+
+ <refsect1 role="notes">
+ &reftitle.notes;
+ <note>
<para>
- <function>udm_free_ispell_data</function> always returns &true;.
+ This function is supported beginning from version 3.1.12 of
+ mnoGoSearch and it does not do anything in previous versions.
</para>
-
- <para>
- <parameter>agent</parameter> - agent link identifier, received after
- call to <function>udm_alloc_agent</function>.
- </para>
-
- <note>
- <para>
- This function is supported beginning from version 3.1.12 of
- mnoGoSearch and it does not do anything in previous versions.
- </para>
- </note>
-
- </refsect1>
- </refentry>
+ </note>
+ </refsect1>
+
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
diff --git a/reference/mnogosearch/functions/udm-free-res.xml b/reference/mnogosearch/functions/udm-free-res.xml
index 6fee91a89f..eef69a927d 100644
--- a/reference/mnogosearch/functions/udm-free-res.xml
+++ b/reference/mnogosearch/functions/udm-free-res.xml
@@ -1,34 +1,47 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
-<!-- splitted from ./en/functions/mnogosearch.xml, last change in rev 1.18 -->
- <refentry id="function.udm-free-res">
- <refnamediv>
- <refname>udm_free_res</refname>
- <refpurpose>Free mnoGoSearch result</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <type>bool</type><methodname>udm_free_res</methodname>
- <methodparam><type>resource</type><parameter>res</parameter></methodparam>
- </methodsynopsis>
-
- <para>
- &return.success;
- </para>
-
- <para>
- <parameter>res</parameter> - a link to result identifier,
- received after call to <function>udm_find</function>.
- </para>
-
- <para>
- Freeing up memory allocated for results.
- </para>
-
- </refsect1>
- </refentry>
+<!-- $Revision: 1.5 $ -->
+<refentry id="function.udm-free-res">
+ <refnamediv>
+ <refname>udm_free_res</refname>
+ <refpurpose>Free mnoGoSearch result</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>bool</type><methodname>udm_free_res</methodname>
+ <methodparam><type>resource</type><parameter>res</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ Freeing up memory allocated for results.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>res</parameter></term>
+ <listitem>
+ <para>
+ A link to a result identifier, received after call to
+ <function>udm_find</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.success;
+ </para>
+ </refsect1>
+
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
diff --git a/reference/mnogosearch/functions/udm-get-doc-count.xml b/reference/mnogosearch/functions/udm-get-doc-count.xml
index d4a84835b1..00971002a8 100644
--- a/reference/mnogosearch/functions/udm-get-doc-count.xml
+++ b/reference/mnogosearch/functions/udm-get-doc-count.xml
@@ -1,37 +1,58 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
-<!-- splitted from ./en/functions/mnogosearch.xml, last change in rev 1.18 -->
- <refentry id="function.udm-get-doc-count">
- <refnamediv>
- <refname>udm_get_doc_count</refname>
- <refpurpose>Get total number of documents in database</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>udm_get_doc_count</methodname>
- <methodparam><type>resource</type><parameter>agent</parameter></methodparam>
- </methodsynopsis>
-
+<!-- $Revision: 1.5 $ -->
+<refentry id="function.udm-get-doc-count">
+ <refnamediv>
+ <refname>udm_get_doc_count</refname>
+ <refpurpose>Get total number of documents in database</refpurpose>
+ </refnamediv>
+
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>int</type><methodname>udm_get_doc_count</methodname>
+ <methodparam><type>resource</type><parameter>agent</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ <function>udm_get_doc_count</function> returns the number of documents in
+ the database.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>agent</parameter></term>
+ <listitem>
+ <para>
+ A link to Agent, received after call to
+ <function>udm_alloc_agent</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns the number of document.
+ </para>
+ </refsect1>
+
+ <refsect1 role="notes">
+ &reftitle.notes;
+ <note>
<para>
- <function>udm_get_doc_count</function> returns the number of documents in
- the database.
+ This function is supported only in mnoGoSearch 3.1.11 or later.
</para>
-
- <para>
- <parameter>agent</parameter> - link to agent identifier, received after
- call to <function>udm_alloc_agent</function>.
- </para>
-
- <note>
- <simpara>
- This function is supported only in mnoGoSearch 3.1.11 or later.
- </simpara>
- </note>
-
- </refsect1>
- </refentry>
+ </note>
+ </refsect1>
+
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
diff --git a/reference/mnogosearch/functions/udm-get-res-field.xml b/reference/mnogosearch/functions/udm-get-res-field.xml
index e0e9a47a4b..1be893e757 100644
--- a/reference/mnogosearch/functions/udm-get-res-field.xml
+++ b/reference/mnogosearch/functions/udm-get-res-field.xml
@@ -1,115 +1,139 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
-<!-- splitted from ./en/functions/mnogosearch.xml, last change in rev 1.18 -->
- <refentry id="function.udm-get-res-field">
- <refnamediv>
- <refname>udm_get_res_field</refname>
- <refpurpose>Fetch mnoGoSearch result field</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <type>string</type><methodname>udm_get_res_field</methodname>
- <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>
-
- <para>
- <function>udm_get_res_field</function> returns result field value on
- success, &false; on error.
- </para>
-
- <para>
- <parameter>res</parameter> - a link to result identifier, received
- after call to <function>udm_find</function>.
- </para>
-
- <para>
- <parameter>row</parameter> - the number of the link on the current page.
- May have values from 0 to
- <parameter>UDM_PARAM_NUM_ROWS-1</parameter>.
- </para>
-
- <para>
- <parameter>field</parameter> - field identifier, may have the following values:
- </para>
-
- <itemizedlist>
- <listitem>
- <simpara>
- UDM_FIELD_URL - document URL field
- </simpara>
- </listitem>
- <listitem>
- <simpara>
- UDM_FIELD_CONTENT - document Content-type field (for example, text/html).
- </simpara>
- </listitem>
- <listitem>
- <simpara>
- UDM_FIELD_CATEGORY - document category field. Use
- <function>udm_cat_path</function> to get full path to current category
- from the categories tree root. (This parameter is available only in PHP
- 4.0.6 or later).
- </simpara>
- </listitem>
- <listitem>
- <simpara>
- UDM_FIELD_TITLE - document title field.
- </simpara>
- </listitem>
- <listitem>
- <simpara>
- UDM_FIELD_KEYWORDS - document keywords field (from META KEYWORDS tag).
- </simpara>
- </listitem>
- <listitem>
- <simpara>
- UDM_FIELD_DESC - document description field (from META DESCRIPTION tag).
- </simpara>
- </listitem>
- <listitem>
- <simpara>
- UDM_FIELD_TEXT - document body text (the first couple of lines to give an
- idea of what the document is about).
- </simpara>
- </listitem>
- <listitem>
- <simpara>
- UDM_FIELD_SIZE - document size.
- </simpara>
- </listitem>
- <listitem>
- <simpara>
- UDM_FIELD_URLID - unique URL ID of the link.
- </simpara>
- </listitem>
- <listitem>
- <simpara>
- UDM_FIELD_RATING - page rating (as calculated by mnoGoSearch).
- </simpara>
- </listitem>
- <listitem>
- <simpara>
- UDM_FIELD_MODIFIED - last-modified field in unixtime format.
- </simpara>
- </listitem>
- <listitem>
- <simpara>
- UDM_FIELD_ORDER - the number of the current document in set of found documents.
- </simpara>
- </listitem>
- <listitem>
- <simpara>
- UDM_FIELD_CRC - document CRC.
- </simpara>
- </listitem>
- </itemizedlist>
-
- </refsect1>
- </refentry>
+<!-- $Revision: 1.4 $ -->
+<refentry id="function.udm-get-res-field">
+ <refnamediv>
+ <refname>udm_get_res_field</refname>
+ <refpurpose>Fetch a result field</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>string</type><methodname>udm_get_res_field</methodname>
+ <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>
+ <para>
+ Fetch a mnoGoSearch result field.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>res</parameter></term>
+ <listitem>
+ <para>
+ <parameter>res</parameter> - a link to result identifier, received
+ after call to <function>udm_find</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>row</parameter></term>
+ <listitem>
+ <para>
+ <parameter>row</parameter> - the number of the link on the current page.
+ May have values from 0 to
+ <parameter>UDM_PARAM_NUM_ROWS-1</parameter>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>field</parameter></term>
+ <listitem>
+ <para>
+ <parameter>field</parameter> - field identifier, may have the following values:
+ <itemizedlist>
+ <listitem>
+ <simpara>
+ UDM_FIELD_URL - document URL field
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ UDM_FIELD_CONTENT - document Content-type field (for example, text/html).
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ UDM_FIELD_CATEGORY - document category field. Use
+ <function>udm_cat_path</function> to get full path to current category
+ from the categories tree root. (This parameter is available only in PHP
+ 4.0.6 or later).
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ UDM_FIELD_TITLE - document title field.
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ UDM_FIELD_KEYWORDS - document keywords field (from META KEYWORDS tag).
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ UDM_FIELD_DESC - document description field (from META DESCRIPTION tag).
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ UDM_FIELD_TEXT - document body text (the first couple of lines to give an
+ idea of what the document is about).
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ UDM_FIELD_SIZE - document size.
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ UDM_FIELD_URLID - unique URL ID of the link.
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ UDM_FIELD_RATING - page rating (as calculated by mnoGoSearch).
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ UDM_FIELD_MODIFIED - last-modified field in unixtime format.
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ UDM_FIELD_ORDER - the number of the current document in set of found documents.
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ UDM_FIELD_CRC - document CRC.
+ </simpara>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ <function>udm_get_res_field</function> returns result field value on
+ success, &false; on error.
+ </para>
+ </refsect1>
+
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
diff --git a/reference/mnogosearch/functions/udm-get-res-param.xml b/reference/mnogosearch/functions/udm-get-res-param.xml
index 5baa8f26d9..4973f3f578 100644
--- a/reference/mnogosearch/functions/udm-get-res-param.xml
+++ b/reference/mnogosearch/functions/udm-get-res-param.xml
@@ -1,71 +1,91 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
-<!-- splitted from ./en/functions/mnogosearch.xml, last change in rev 1.18 -->
- <refentry id="function.udm-get-res-param">
- <refnamediv>
- <refname>udm_get_res_param</refname>
- <refpurpose>Get mnoGoSearch result parameters</refpurpose>
- </refnamediv>
-
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <type>string</type><methodname>udm_get_res_param</methodname>
- <methodparam><type>resource</type><parameter>res</parameter></methodparam>
- <methodparam><type>int</type><parameter>param</parameter></methodparam>
- </methodsynopsis>
-
- <para>
- <function>udm_get_res_param</function> returns result parameter value on
- success, &false; on error.
- </para>
-
- <para>
- <parameter>res</parameter> - a link to result identifier, received after
- call to <function>udm_find</function>.
- </para>
-
- <para>
- <parameter>param</parameter> - parameter identifier, may have the following values:
- </para>
-
- <itemizedlist>
- <listitem>
- <simpara>
- UDM_PARAM_NUM_ROWS - number of received found links on the current page. It is equal to
- UDM_PARAM_PAGE_SIZE for all search pages, on the last page - the rest of links.
- </simpara>
- </listitem>
- <listitem>
- <simpara>
- UDM_PARAM_FOUND - total number of results matching the query.
- </simpara>
- </listitem>
- <listitem>
- <simpara>
- UDM_PARAM_WORDINFO - information on the words found. E.g. search for
- "a good book" will return "a: stopword, good:5637, book: 120"
- </simpara>
- </listitem>
- <listitem>
- <simpara>
- UDM_PARAM_SEARCHTIME - search time in seconds.
- </simpara>
- </listitem>
- <listitem>
- <simpara>
- UDM_PARAM_FIRST_DOC - the number of the first document displayed on current page.
- </simpara>
- </listitem>
- <listitem>
- <simpara>
- UDM_PARAM_LAST_DOC - the number of the last document displayed on current page.
- </simpara>
- </listitem>
- </itemizedlist>
-
- </refsect1>
- </refentry>
+<!-- $Revision: 1.4 $ -->
+<refentry id="function.udm-get-res-param">
+ <refnamediv>
+ <refname>udm_get_res_param</refname>
+ <refpurpose>Get mnoGoSearch result parameters</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>string</type><methodname>udm_get_res_param</methodname>
+ <methodparam><type>resource</type><parameter>res</parameter></methodparam>
+ <methodparam><type>int</type><parameter>param</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ Gets the mnoGoSearch result parameters.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>res</parameter></term>
+ <listitem>
+ <para>
+ <parameter>res</parameter> - a link to result identifier, received after
+ call to <function>udm_find</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>param</parameter></term>
+ <listitem>
+ <para>
+ <parameter>param</parameter> - parameter identifier, may have the following values:
+ <itemizedlist>
+ <listitem>
+ <simpara>
+ UDM_PARAM_NUM_ROWS - number of received found links on the current page. It is equal to
+ UDM_PARAM_PAGE_SIZE for all search pages, on the last page - the rest of links.
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ UDM_PARAM_FOUND - total number of results matching the query.
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ UDM_PARAM_WORDINFO - information on the words found. E.g. search for
+ "a good book" will return "a: stopword, good:5637, book: 120"
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ UDM_PARAM_SEARCHTIME - search time in seconds.
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ UDM_PARAM_FIRST_DOC - the number of the first document displayed on current page.
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ UDM_PARAM_LAST_DOC - the number of the last document displayed on current page.
+ </simpara>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ <function>udm_get_res_param</function> returns result parameter value on
+ success, &false; on error.
+ </para>
+ </refsect1>
+
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
diff --git a/reference/mnogosearch/functions/udm-hash32.xml b/reference/mnogosearch/functions/udm-hash32.xml
index a3a3d7c747..5db60bf5e5 100644
--- a/reference/mnogosearch/functions/udm-hash32.xml
+++ b/reference/mnogosearch/functions/udm-hash32.xml
@@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<refentry id="function.udm-hash32">
<refnamediv>
<refname>udm_hash32</refname>
<refpurpose>Return Hash32 checksum of gived string</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>int</type><methodname>udm_hash32</methodname>
<methodparam><type>resource</type><parameter>agent</parameter></methodparam>
@@ -15,12 +16,51 @@
<para>
<function>udm_hash32</function> will take a string
<parameter>str</parameter> and return a quite unique 32-bit hash
- number from it. Requires an allocated <parameter>agent</parameter>.
- </para>
- <para>
- See also: <function>udm_alloc_agent</function>.
+ number from it.
</para>
</refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>agent</parameter></term>
+ <listitem>
+ <para>
+ A link to Agent, received after call to
+ <function>udm_alloc_agent</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>str</parameter></term>
+ <listitem>
+ <para>
+ The input string.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns a 32-bit hash number.
+ </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><function>udm_alloc_agent</function></member>
+ </simplelist>
+ </para>
+ </refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
diff --git a/reference/mnogosearch/functions/udm-load-ispell-data.xml b/reference/mnogosearch/functions/udm-load-ispell-data.xml
index b5d1db18ce..7c54d45812 100644
--- a/reference/mnogosearch/functions/udm-load-ispell-data.xml
+++ b/reference/mnogosearch/functions/udm-load-ispell-data.xml
@@ -1,99 +1,89 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.9 $ -->
-<!-- splitted from ./en/functions/mnogosearch.xml, last change in rev 1.18 -->
- <refentry id="function.udm-load-ispell-data">
- <refnamediv>
- <refname>udm_load_ispell_data</refname>
- <refpurpose>Load ispell data</refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <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>
- <methodparam><type>int</type><parameter>flag</parameter></methodparam>
- </methodsynopsis>
- <para>
- <function>udm_load_ispell_data</function> loads ispell data.
- &return.success;
- </para>
- <para>
- <parameter>agent</parameter> - agent link identifier, received after call
- to <function>udm_alloc_agent</function>.
- </para>
- <para>
- <parameter>var</parameter> - parameter, indicating the source for ispell
- data. May have the following values:
- </para>
- <para>
- After using this function to free memory allocated for ispell data, please
- use <function>udm_free_ispell_data</function>, even if you use UDM_ISPELL_TYPE_SERVER mode.
- </para>
- <para>
- The fastest mode is UDM_ISPELL_TYPE_SERVER. UDM_ISPELL_TYPE_TEXT is slower
- and UDM_ISPELL_TYPE_DB is the slowest. The above pattern is &true; for
- mnoGoSearch 3.1.10 - 3.1.11. It is planned to speed up DB mode in future
- versions and it is going to be faster than TEXT mode.
- </para>
- <itemizedlist>
- <listitem>
- <simpara>
- UDM_ISPELL_TYPE_DB - indicates that ispell data should be loaded from SQL.
- In this case, parameters <parameter>val1</parameter> and <parameter>val2</parameter>
- are ignored and should be left blank. <parameter>flag</parameter>
- should be equal to <literal>1</literal>.
- </simpara>
- <note>
+<!-- $Revision: 1.10 $ -->
+<refentry id="function.udm-load-ispell-data">
+ <refnamediv>
+ <refname>udm_load_ispell_data</refname>
+ <refpurpose>Load ispell data</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <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>
+ <methodparam><type>int</type><parameter>flag</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ <function>udm_load_ispell_data</function> loads ispell data.
+ </para>
+ <para>
+ After using this function to free memory allocated for ispell data, please
+ use <function>udm_free_ispell_data</function>, even if you use UDM_ISPELL_TYPE_SERVER mode.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>agent</parameter></term>
+ <listitem>
<para>
- <parameter>flag</parameter> indicates that after loading ispell data
- from defined source it should be sorted (it is necessary for correct
- functioning of ispell). In case of loading ispell data from files
- there may be several calls to <function>udm_load_ispell_data</function>,
- and there is no sense to sort data after every call, but only after
- the last one. Since in db mode all the data is loaded by one call,
- this parameter should have the value <literal>1</literal>. In this mode
- in case of error, e.g. if ispell tables are absent, the function will
- return &false; and code and error message will be accessible through
- <function>udm_error</function> and <function>udm_errno</function>.
+ A link to Agent, received after call to
+ <function>udm_alloc_agent</function>.
</para>
- </note>
- <para>
- <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>
- </example>
- </para>
- </listitem>
- <listitem>
- <para>
- UDM_ISPELL_TYPE_AFFIX - indicates that ispell data should be loaded from
- file and initiates loading affixes file. In this case <parameter>val1</parameter>
- defines double letter language code for which affixes are loaded,
- and <parameter>val2</parameter> - file path. Please note, that if
- a relative path entered, the module looks for the file not in UDM_CONF_DIR,
- but in relation to current path, i.e. to the path where the script is executed.
- In case of error in this mode, e.g. if file is absent, the function will return
- &false;, and an error message will be displayed. Error message text cannot be
- accessed through <function>udm_error</function> and <function>udm_errno</function>,
- since those functions can only return messages associated with SQL. Please,
- see <parameter>flag</parameter> parameter description in UDM_ISPELL_TYPE_DB.
- </para>
- <para>
- <example>
- <title><function>udm_load_ispell_data</function> example</title>
- <programlisting role="php">
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>var</parameter></term>
+ <listitem>
+ <para>
+ Indicates the source for ispell data. May have the following values:
+ <itemizedlist>
+ <listitem>
+ <simpara>
+ UDM_ISPELL_TYPE_DB - indicates that ispell data should be loaded from SQL.
+ In this case, parameters <parameter>val1</parameter> and <parameter>val2</parameter>
+ are ignored and should be left blank. <parameter>flag</parameter>
+ should be equal to <literal>1</literal>.
+ </simpara>
+ <note>
+ <para>
+ <parameter>flag</parameter> indicates that after loading ispell data
+ from defined source it should be sorted (it is necessary for correct
+ functioning of ispell). In case of loading ispell data from files
+ there may be several calls to <function>udm_load_ispell_data</function>,
+ and there is no sense to sort data after every call, but only after
+ the last one. Since in db mode all the data is loaded by one call,
+ this parameter should have the value <literal>1</literal>. In this mode
+ in case of error, e.g. if ispell tables are absent, the function will
+ return &false; and code and error message will be accessible through
+ <function>udm_error</function> and <function>udm_errno</function>.
+ </para>
+ </note>
+ </listitem>
+ <listitem>
+ <para>
+ UDM_ISPELL_TYPE_AFFIX - indicates that ispell data should be loaded from
+ file and initiates loading affixes file. In this case <parameter>val1</parameter>
+ defines double letter language code for which affixes are loaded,
+ and <parameter>val2</parameter> - file path. Please note, that if
+ a relative path entered, the module looks for the file not in UDM_CONF_DIR,
+ but in relation to current path, i.e. to the path where the script is executed.
+ In case of error in this mode, e.g. if file is absent, the function will return
+ &false;, and an error message will be displayed. Error message text cannot be
+ accessed through <function>udm_error</function> and <function>udm_errno</function>,
+ since those functions can only return messages associated with SQL. Please,
+ see <parameter>flag</parameter> parameter description in UDM_ISPELL_TYPE_DB.
+ </para>
+ <para>
+ <example>
+ <title><function>udm_load_ispell_data</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
if ((! udm_load_ispell_data($udm, UDM_ISPELL_TYPE_AFFIX, 'en', '/opt/ispell/en.aff', 0)) ||
@@ -104,86 +94,86 @@ if ((! udm_load_ispell_data($udm, UDM_ISPELL_TYPE_AFFIX, 'en', '/opt/ispell/en.a
}
?>
]]>
- </programlisting>
- </example>
- </para>
- <note>
- <para>
- <parameter>flag</parameter> is equal to <literal>1</literal> only in the last call.
- </para>
- </note>
- </listitem>
- <listitem>
- <para>
- UDM_ISPELL_TYPE_SPELL - indicates that ispell data should be loaded from
- file and initiates loading of ispell dictionary file. In this case
- <parameter>val1</parameter> defines double letter language code for which
- affixes are loaded,
- and <parameter>val2</parameter> - file path. Please note, that if a relative
- path entered, the module looks for the file not in UDM_CONF_DIR, but in
- relation to current path, i.e. to the path where the script is executed.
- In case of error in this mode, e.g. if file is absent, the function will
- return &false;, and an error message will be displayed. Error message text
- cannot be accessed through <function>udm_error</function> and
- <function>udm_errno</function>, since those functions can only return messages
- associated with SQL. Please, see <parameter>flag</parameter> parameter
- description in UDM_ISPELL_TYPE_DB.
- </para>
- <informalexample>
- <programlisting role="php">
+ </programlisting>
+ </example>
+ </para>
+ <note>
+ <para>
+ <parameter>flag</parameter> is equal to <literal>1</literal> only in the last call.
+ </para>
+ </note>
+ </listitem>
+ <listitem>
+ <para>
+ UDM_ISPELL_TYPE_SPELL - indicates that ispell data should be loaded from
+ file and initiates loading of ispell dictionary file. In this case
+ <parameter>val1</parameter> defines double letter language code for which
+ affixes are loaded,
+ and <parameter>val2</parameter> - file path. Please note, that if a relative
+ path entered, the module looks for the file not in UDM_CONF_DIR, but in
+ relation to current path, i.e. to the path where the script is executed.
+ In case of error in this mode, e.g. if file is absent, the function will
+ return &false;, and an error message will be displayed. Error message text
+ cannot be accessed through <function>udm_error</function> and
+ <function>udm_errno</function>, since those functions can only return messages
+ associated with SQL. Please, see <parameter>flag</parameter> parameter
+ description in UDM_ISPELL_TYPE_DB.
+ </para>
+ <informalexample>
+ <programlisting role="php">
<![CDATA[
<?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;
- }
+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>
- <note>
- <para>
- <parameter>flag</parameter> is equal to <literal>1</literal> only in the last call.
- </para>
- </note>
- </listitem>
- <listitem>
- <para>
- UDM_ISPELL_TYPE_SERVER - enables spell server support.
- <parameter>val1</parameter> parameter indicates
- address of the host running spell server. <parameter>val2</parameter> `
- is not used yet, but in future releases it is going to indicate number
- of port used by spell server. <parameter>flag</parameter> parameter in
- this case is not needed since ispell data is stored
- on spellserver already sorted.
- </para>
- <para>
- Spelld server reads spell-data from a separate configuration file
- (/usr/local/mnogosearch/etc/spelld.conf by default), sorts it and stores in
- memory. With clients server communicates in two ways: to indexer all the
- data is transferred (so that indexer starts faster), from search.cgi server
- receives word to normalize and then passes over to client (search.cgi) list
- of normalized word forms. This allows fastest, compared to db and text modes
- processing of search queries (by omitting loading and sorting all the spell data).
- </para>
- <para>
- <function>udm_load_ispell_data</function> function in UDM_ISPELL_TYPE_SERVER
- mode does not actually load ispell data, but only defines server address.
- In fact, server is automatically used by <function>udm_find</function>
- function when performing search. In case of errors, e.g. if spellserver
- is not running or invalid host indicated, there are no messages returned
- and ispell conversion does not work.
- </para>
- <note>
- <para>
- This function is available in mnoGoSearch 3.1.12 or later.
- </para>
- </note>
- <simpara>Example:</simpara>
- <informalexample>
- <programlisting role="php">
+ </programlisting>
+ </informalexample>
+ <note>
+ <para>
+ <parameter>flag</parameter> is equal to <literal>1</literal> only in the last call.
+ </para>
+ </note>
+ </listitem>
+ <listitem>
+ <para>
+ UDM_ISPELL_TYPE_SERVER - enables spell server support.
+ <parameter>val1</parameter> parameter indicates
+ address of the host running spell server. <parameter>val2</parameter> `
+ is not used yet, but in future releases it is going to indicate number
+ of port used by spell server. <parameter>flag</parameter> parameter in
+ this case is not needed since ispell data is stored
+ on spellserver already sorted.
+ </para>
+ <para>
+ Spelld server reads spell-data from a separate configuration file
+ (/usr/local/mnogosearch/etc/spelld.conf by default), sorts it and stores in
+ memory. With clients server communicates in two ways: to indexer all the
+ data is transferred (so that indexer starts faster), from search.cgi server
+ receives word to normalize and then passes over to client (search.cgi) list
+ of normalized word forms. This allows fastest, compared to db and text modes
+ processing of search queries (by omitting loading and sorting all the spell data).
+ </para>
+ <para>
+ <function>udm_load_ispell_data</function> function in UDM_ISPELL_TYPE_SERVER
+ mode does not actually load ispell data, but only defines server address.
+ In fact, server is automatically used by <function>udm_find</function>
+ function when performing search. In case of errors, e.g. if spellserver
+ is not running or invalid host indicated, there are no messages returned
+ and ispell conversion does not work.
+ </para>
+ <note>
+ <para>
+ This function is available in mnoGoSearch 3.1.12 or later.
+ </para>
+ </note>
+ <simpara>Example:</simpara>
+ <informalexample>
+ <programlisting role="php">
<![CDATA[
<?php
if (!udm_load_ispell_data($udm, UDM_ISPELL_TYPE_SERVER, '', '', 1)) {
@@ -192,12 +182,71 @@ if (!udm_load_ispell_data($udm, UDM_ISPELL_TYPE_SERVER, '', '', 1)) {
}
?>
]]>
- </programlisting>
- </informalexample>
- </listitem>
- </itemizedlist>
- </refsect1>
- </refentry>
+ </programlisting>
+ </informalexample>
+ </listitem>
+ </itemizedlist>
+ </para>
+ <para>
+ The fastest mode is UDM_ISPELL_TYPE_SERVER. UDM_ISPELL_TYPE_TEXT is slower
+ and UDM_ISPELL_TYPE_DB is the slowest. The above pattern is &true; for
+ mnoGoSearch 3.1.10 - 3.1.11. It is planned to speed up DB mode in future
+ versions and it is going to be faster than TEXT mode.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>val1</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>val2</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>flag</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.success;
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <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>
+ </example>
+ </para>
+ </refsect1>
+
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
diff --git a/reference/mnogosearch/functions/udm-open-stored.xml b/reference/mnogosearch/functions/udm-open-stored.xml
index 8c0ec76877..83ac311d92 100644
--- a/reference/mnogosearch/functions/udm-open-stored.xml
+++ b/reference/mnogosearch/functions/udm-open-stored.xml
@@ -1,25 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
-<!-- splitted from ./en/functions/mnogosearch.xml, last change in rev 1.31 -->
- <refentry id='function.udm-open-stored'>
- <refnamediv>
- <refname>udm_open_stored</refname>
- <refpurpose>
- Open connection to stored
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <type>int</type><methodname>udm_open_stored</methodname>
- <methodparam><type>resource</type><parameter>agent</parameter></methodparam>
- <methodparam><type>string</type><parameter>storedaddr</parameter></methodparam>
- </methodsynopsis>
- <para>
- &warn.undocumented.func;
- </para>
- </refsect1>
- </refentry>
+<!-- $Revision: 1.4 $ -->
+<refentry id='function.udm-open-stored'>
+ <refnamediv>
+ <refname>udm_open_stored</refname>
+ <refpurpose>Open connection to stored</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>int</type><methodname>udm_open_stored</methodname>
+ <methodparam><type>resource</type><parameter>agent</parameter></methodparam>
+ <methodparam><type>string</type><parameter>storedaddr</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ &warn.undocumented.func;
+ </para>
+ </refsect1>
+
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
diff --git a/reference/mnogosearch/functions/udm-set-agent-param.xml b/reference/mnogosearch/functions/udm-set-agent-param.xml
index 9521afe620..78bedcb275 100644
--- a/reference/mnogosearch/functions/udm-set-agent-param.xml
+++ b/reference/mnogosearch/functions/udm-set-agent-param.xml
@@ -1,238 +1,300 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.7 $ -->
-<!-- splitted from ./en/functions/mnogosearch.xml, last change in rev 1.18 -->
- <refentry id="function.udm-set-agent-param">
- <refnamediv>
- <refname>udm_set_agent_param</refname>
- <refpurpose>Set mnoGoSearch agent session parameters</refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <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>
- &return.success; Defines mnoGoSearch session parameters.
- </para>
-
+<!-- $Revision: 1.8 $ -->
+<refentry id="function.udm-set-agent-param">
+ <refnamediv>
+ <refname>udm_set_agent_param</refname>
+ <refpurpose>Set mnoGoSearch agent session parameters</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <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>
+ Defines mnoGoSearch session parameters.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>agent</parameter></term>
+ <listitem>
+ <para>
+ A link to Agent, received after call to
+ <function>udm_alloc_agent</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>var</parameter></term>
+ <listitem>
+ <para>
+ The following parameters and their values are available:
+ <itemizedlist>
+ <listitem>
+ <simpara>
+ UDM_PARAM_PAGE_NUM - used to choose search results page number (results
+ are returned by pages beginning from 0, with UDM_PARAM_PAGE_SIZE results per page).
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ UDM_PARAM_PAGE_SIZE - number of search results displayed on one page.
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ UDM_PARAM_SEARCH_MODE - search mode. The following values available: UDM_MODE_ALL -
+ search for all words; UDM_MODE_ANY - search for any word; UDM_MODE_PHRASE -
+ phrase search; UDM_MODE_BOOL - boolean search. See <function>udm_find</function>
+ for details on boolean search.
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ UDM_PARAM_CACHE_MODE - turns on or off search result cache mode.
+ When enabled, the search engine will store
+ search results to disk. In case a similar search is performed later,
+ the engine will take results from the cache for faster performance.
+ Available values: UDM_CACHE_ENABLED, UDM_CACHE_DISABLED.
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ UDM_PARAM_TRACK_MODE - turns on or off trackquery mode. Since
+ version 3.1.2 mnoGoSearch has a query tracking support.
+ Note that tracking is implemented in SQL version only and not available
+ in built-in database.
+ To use tracking, you have to create tables for tracking support.
+ For MySQL, use create/mysql/track.txt.
+ When doing a search, front-end uses those tables to store query words,
+ a number of found documents and current Unix timestamp in seconds.
+ Available values: UDM_TRACK_ENABLED, UDM_TRACK_DISABLED.
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ UDM_PARAM_PHRASE_MODE - defines whether index database using phrases
+ ("phrase" parameter in indexer.conf).
+ Possible values: UDM_PHRASE_ENABLED and UDM_PHRASE_DISABLED.
+ Please note, that if phrase search is enabled (UDM_PHRASE_ENABLED),
+ it is still possible to do search in any mode (ANY, ALL, BOOL or PHRASE).
+ In 3.1.10 version of mnoGoSearch phrase search is supported only in sql
+ and built-in database modes,
+ while beginning with 3.1.11 phrases are supported in cachemode as well.
+ </simpara>
+ <simpara>
+ Examples of phrase search:
+ </simpara>
+ <simpara>
+ "Arizona desert" - This query returns all indexed documents that contain
+ "Arizona desert" as a phrase. Notice that you need to put double quotes
+ around the phrase
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ UDM_PARAM_CHARSET - defines local charset. Available values: set of
+ charsets supported by mnoGoSearch, e.g. koi8-r, cp1251, ...
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ UDM_PARAM_STOPFILE - Defines name and path
+ to stopwords file. (There is a small difference with mnoGoSearch
+ - while in mnoGoSearch if relative path or no path entered, it
+ looks for this file in relation to UDM_CONF_DIR, the module looks for
+ the file in relation to current path, i.e. to the path where the
+ PHP script is executed.)
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ UDM_PARAM_STOPTABLE - Load stop words from the given SQL table. You may use
+ several StopwordTable commands.
+ This command has no effect when compiled without SQL database support.
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ UDM_PARAM_WEIGHT_FACTOR - represents weight factors for specific document parts.
+ Currently body, title, keywords, description, url are supported.
+ To activate this feature please use degrees of 2 in *Weight commands of
+ the indexer.conf. Let's imagine that we have these weights:
+ </simpara>
+ <literallayout>
+ URLWeight 1
+ BodyWeight 2
+ TitleWeight 4
+ KeywordWeight 8
+ DescWeight 16
+ </literallayout>
+
+ <simpara>
+ As far as indexer uses bit OR operation for word weights when some
+ word presents several time in the same document, it is possible at search
+ time to detect word appearance in different document parts. Word which
+ appears only in the body will have 00000010 aggregate weight (in binary notation).
+ Word used in all document parts will have 00011111 aggregate weight.
+ </simpara>
+
+ <simpara>
+ This parameter's value is a string of hex digits ABCDE. Each digit is a
+ factor for corresponding bit in word weight. For the given above weights
+ configuration:
+ </simpara>
+ <literallayout>
+ E is a factor for weight 1 (URL Weight bit)
+ D is a factor for weight 2 (BodyWeight bit)
+ C is a factor for weight 4 (TitleWeight bit)
+ B is a factor for weight 8 (KeywordWeight bit)
+ A is a factor for weight 16 (DescWeight bit)
+ </literallayout>
+ <simpara>
+ Examples:
+ </simpara>
+ <simpara>
+ UDM_PARAM_WEIGHT_FACTOR=00001 will search through URLs only.
+ </simpara>
+ <simpara>
+ UDM_PARAM_WEIGHT_FACTOR=00100 will search through Titles only.
+ </simpara>
+ <simpara>
+ UDM_PARAM_WEIGHT_FACTOR=11100 will search through Title,Keywords,Description
+ but not through URL and Body.
+ </simpara>
+ <simpara>
+ UDM_PARAM_WEIGHT_FACTOR=F9421 will search through:
+ </simpara>
+ <literallayout>
+ Description with factor 15 (F hex)
+ Keywords with factor 9
+ Title with factor 4
+ Body with factor 2
+ URL with factor 1
+ </literallayout>
+ <simpara>
+ If UDM_PARAM_WEIGHT_FACTOR variable is omitted, original weight value is
+ taken to sort results. For a given above weight configuration it means
+ that document description has a most big weight 16.
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ UDM_PARAM_WORD_MATCH - word match. You may use this parameter to choose
+ word match type. This feature works only in "single" and "multi" modes
+ using SQL based and built-in database. It does not work in cachemode and other modes
+ since they use word CRC and do not support substring search. Available values:
+ </simpara>
+ <simpara>UDM_MATCH_BEGIN - word beginning match;</simpara>
+ <simpara>UDM_MATCH_END - word ending match;</simpara>
+ <simpara>UDM_MATCH_WORD - whole word match;</simpara>
+ <simpara>UDM_MATCH_SUBSTR - word substring match.</simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ UDM_PARAM_MIN_WORD_LEN - defines minimal word length.
+ Any word shorter this limit is considered to be a stopword. Please note
+ that this parameter value is inclusive, i.e. if UDM_PARAM_MIN_WORD_LEN=3,
+ a word 3 characters long will not be considered a stopword, while
+ a word 2 characters long will be. Default value is 1.
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ UDM_PARAM_ISPELL_PREFIXES - Possible values: UDM_PREFIXES_ENABLED and
+ UDM_PREFIXES_DISABLED, that respectively enable or disable using prefixes.
+ E.g. if a word "tested" is in search query, also words like "test",
+ "testing", etc. Only suffixes are supported by default. Prefixes usually
+ change word meanings, for example if somebody is searching for the word "tested"
+ one hardly wants "untested" to be found. Prefixes support may also be
+ found useful for site's spelling checking purposes. In order to enable
+ ispell, you have to load ispell data with <function>udm_load_ispell_data</function>.
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ UDM_PARAM_CROSS_WORDS - enables or disables crosswords support.
+ Possible values: UDM_CROSS_WORDS_ENABLED and UDM_CROSS_WORDS_DISABLED.
+ </simpara>
+ <simpara>
+ The crosswords feature allows to assign words between <a href="xxx"> and </a>
+ also to a document this link leads to. It works in SQL database mode and
+ is not supported in built-in database and Cachemode.
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ UDM_PARAM_VARDIR - specifies a custom path to directory where indexer
+ stores data when using built-in database and in cache mode.
+ By default <literal>/var</literal> directory of
+ mnoGoSearch installation is used. Can have
+ only string values.
+ </simpara>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>val</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="changelog">
+ &reftitle.changelog;
+ <para>
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>4.1.0</entry>
+ <entry>
+ <constant>UDM_PARAM_VARDIR</constant> was added.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.success;
+ </para>
+ </refsect1>
+
+ <refsect1 role="notes">
+ &reftitle.notes;
+ <note>
<simpara>
- The following parameters and their values are available:
+ Crosswords are supported only in mnoGoSearch 3.1.11 or later.
</simpara>
-
- <itemizedlist>
- <listitem>
- <simpara>
- UDM_PARAM_PAGE_NUM - used to choose search results page number (results
- are returned by pages beginning from 0, with UDM_PARAM_PAGE_SIZE results per page).
- </simpara>
- </listitem>
- <listitem>
- <simpara>
- UDM_PARAM_PAGE_SIZE - number of search results displayed on one page.
- </simpara>
- </listitem>
- <listitem>
- <simpara>
- UDM_PARAM_SEARCH_MODE - search mode. The following values available: UDM_MODE_ALL -
- search for all words; UDM_MODE_ANY - search for any word; UDM_MODE_PHRASE -
- phrase search; UDM_MODE_BOOL - boolean search. See <function>udm_find</function>
- for details on boolean search.
- </simpara>
- </listitem>
- <listitem>
- <simpara>
- UDM_PARAM_CACHE_MODE - turns on or off search result cache mode.
- When enabled, the search engine will store
- search results to disk. In case a similar search is performed later,
- the engine will take results from the cache for faster performance.
- Available values: UDM_CACHE_ENABLED, UDM_CACHE_DISABLED.
- </simpara>
- </listitem>
- <listitem>
- <simpara>
- UDM_PARAM_TRACK_MODE - turns on or off trackquery mode. Since
- version 3.1.2 mnoGoSearch has a query tracking support.
- Note that tracking is implemented in SQL version only and not available
- in built-in database.
- To use tracking, you have to create tables for tracking support.
- For MySQL, use create/mysql/track.txt.
- When doing a search, front-end uses those tables to store query words,
- a number of found documents and current Unix timestamp in seconds.
- Available values: UDM_TRACK_ENABLED, UDM_TRACK_DISABLED.
- </simpara>
- </listitem>
- <listitem>
- <simpara>
- UDM_PARAM_PHRASE_MODE - defines whether index database using phrases
- ("phrase" parameter in indexer.conf).
- Possible values: UDM_PHRASE_ENABLED and UDM_PHRASE_DISABLED.
- Please note, that if phrase search is enabled (UDM_PHRASE_ENABLED),
- it is still possible to do search in any mode (ANY, ALL, BOOL or PHRASE).
- In 3.1.10 version of mnoGoSearch phrase search is supported only in sql
- and built-in database modes,
- while beginning with 3.1.11 phrases are supported in cachemode as well.
- </simpara>
- <simpara>
- Examples of phrase search:
- </simpara>
- <simpara>
- "Arizona desert" - This query returns all indexed documents that contain
- "Arizona desert" as a phrase. Notice that you need to put double quotes
- around the phrase
- </simpara>
- </listitem>
- <listitem>
- <simpara>
- UDM_PARAM_CHARSET - defines local charset. Available values: set of
- charsets supported by mnoGoSearch, e.g. koi8-r, cp1251, ...
- </simpara>
- </listitem>
- <listitem>
- <simpara>
- UDM_PARAM_STOPFILE - Defines name and path
- to stopwords file. (There is a small difference with mnoGoSearch
- - while in mnoGoSearch if relative path or no path entered, it
- looks for this file in relation to UDM_CONF_DIR, the module looks for
- the file in relation to current path, i.e. to the path where the
- PHP script is executed.)
- </simpara>
- </listitem>
- <listitem>
- <simpara>
- UDM_PARAM_STOPTABLE - Load stop words from the given SQL table. You may use
- several StopwordTable commands.
- This command has no effect when compiled without SQL database support.
- </simpara>
- </listitem>
- <listitem>
- <simpara>
- UDM_PARAM_WEIGHT_FACTOR - represents weight factors for specific document parts.
- Currently body, title, keywords, description, url are supported.
- To activate this feature please use degrees of 2 in *Weight commands of
- the indexer.conf. Let's imagine that we have these weights:
- </simpara>
- <literallayout>
- URLWeight 1
- BodyWeight 2
- TitleWeight 4
- KeywordWeight 8
- DescWeight 16
- </literallayout>
-
- <simpara>
- As far as indexer uses bit OR operation for word weights when some
- word presents several time in the same document, it is possible at search
- time to detect word appearance in different document parts. Word which
- appears only in the body will have 00000010 aggregate weight (in binary notation).
- Word used in all document parts will have 00011111 aggregate weight.
- </simpara>
-
- <simpara>
- This parameter's value is a string of hex digits ABCDE. Each digit is a
- factor for corresponding bit in word weight. For the given above weights
- configuration:
- </simpara>
- <literallayout>
- E is a factor for weight 1 (URL Weight bit)
- D is a factor for weight 2 (BodyWeight bit)
- C is a factor for weight 4 (TitleWeight bit)
- B is a factor for weight 8 (KeywordWeight bit)
- A is a factor for weight 16 (DescWeight bit)
- </literallayout>
- <simpara>
- Examples:
- </simpara>
- <simpara>
- UDM_PARAM_WEIGHT_FACTOR=00001 will search through URLs only.
- </simpara>
- <simpara>
- UDM_PARAM_WEIGHT_FACTOR=00100 will search through Titles only.
- </simpara>
- <simpara>
- UDM_PARAM_WEIGHT_FACTOR=11100 will search through Title,Keywords,Description
- but not through URL and Body.
- </simpara>
- <simpara>
- UDM_PARAM_WEIGHT_FACTOR=F9421 will search through:
- </simpara>
- <literallayout>
- Description with factor 15 (F hex)
- Keywords with factor 9
- Title with factor 4
- Body with factor 2
- URL with factor 1
- </literallayout>
- <simpara>
- If UDM_PARAM_WEIGHT_FACTOR variable is omitted, original weight value is
- taken to sort results. For a given above weight configuration it means
- that document description has a most big weight 16.
- </simpara>
- </listitem>
- <listitem>
- <simpara>
- UDM_PARAM_WORD_MATCH - word match. You may use this parameter to choose
- word match type. This feature works only in "single" and "multi" modes
- using SQL based and built-in database. It does not work in cachemode and other modes
- since they use word CRC and do not support substring search. Available values:
- </simpara>
- <simpara>UDM_MATCH_BEGIN - word beginning match;</simpara>
- <simpara>UDM_MATCH_END - word ending match;</simpara>
- <simpara>UDM_MATCH_WORD - whole word match;</simpara>
- <simpara>UDM_MATCH_SUBSTR - word substring match.</simpara>
- </listitem>
- <listitem>
- <simpara>
- UDM_PARAM_MIN_WORD_LEN - defines minimal word length.
- Any word shorter this limit is considered to be a stopword. Please note
- that this parameter value is inclusive, i.e. if UDM_PARAM_MIN_WORD_LEN=3,
- a word 3 characters long will not be considered a stopword, while
- a word 2 characters long will be. Default value is 1.
- </simpara>
- </listitem>
- <listitem>
- <simpara>
- UDM_PARAM_ISPELL_PREFIXES - Possible values: UDM_PREFIXES_ENABLED and
- UDM_PREFIXES_DISABLED, that respectively enable or disable using prefixes.
- E.g. if a word "tested" is in search query, also words like "test",
- "testing", etc. Only suffixes are supported by default. Prefixes usually
- change word meanings, for example if somebody is searching for the word "tested"
- one hardly wants "untested" to be found. Prefixes support may also be
- found useful for site's spelling checking purposes. In order to enable
- ispell, you have to load ispell data with <function>udm_load_ispell_data</function>.
- </simpara>
- </listitem>
- <listitem>
- <simpara>
- UDM_PARAM_CROSS_WORDS - enables or disables crosswords support.
- Possible values: UDM_CROSS_WORDS_ENABLED and UDM_CROSS_WORDS_DISABLED.
- </simpara>
- <simpara>
- The crosswords feature allows to assign words between <a href="xxx"> and </a>
- also to a document this link leads to. It works in SQL database mode and
- is not supported in built-in database and Cachemode.
- </simpara>
- <note>
- <simpara>
- Crosswords are supported only in mnoGoSearch 3.1.11 or later.
- </simpara>
- </note>
- </listitem>
- <listitem>
- <simpara>
- UDM_PARAM_VARDIR - specifies a custom path to directory where indexer
- stores data when using built-in database and in cache mode.
- By default <literal>/var</literal> directory of
- mnoGoSearch installation is used. Can have
- only string values. The parameter is available in PHP 4.1.0 or later.
- </simpara>
- </listitem>
- </itemizedlist>
- </refsect1>
- </refentry>
+ </note>
+ </refsect1>
+
+</refentry>
<!-- Keep this comment at the end of the file
Local variables: