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 @@
-
-
-
-
- udm_add_search_limit
- Add various search limits
-
-
- Description
-
- booludm_add_search_limit
- resourceagent
- intvar
- stringval
-
-
- udm_add_search_limit adds search restrictions.
- &return.success;
-
-
- agent - a link to Agent, received after call to
- udm_alloc_agent.
-
-
- var - defines parameter, indicating limit.
-
-
- val - defines the value of the current parameter.
-
-
- Possible var values:
-
-
-
-
- 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.
-
-
-
-
- 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.
-
-
-
-
- UDM_LIMIT_LANG - defines document language limitations.
-
-
-
-
- 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.
-
-
-
-
- UDM_LIMIT_DATE - defines limitation by date the document was modified.
-
-
- Format of parameter value: a string with first character < or >,
- then with no space - date in unixtime format, for example:
-
-
-
-
-
+
+
+
+ udm_add_search_limit
+ Add various search limits
+
+
+
+ &reftitle.description;
+
+ booludm_add_search_limit
+ resourceagent
+ intvar
+ stringval
+
+
+ udm_add_search_limit adds search restrictions.
+
+
+
+
+ &reftitle.parameters;
+
+
+
+ agent
+
+
+ A link to Agent, received after call to
+ udm_alloc_agent.
+
+
+
+
+ var
+
+
+ Defines the parameter, indicating limits.
+ Possible var values:
+
+
+
+ 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.
+
+
+
+
+ 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.
+
+
+
+
+ UDM_LIMIT_LANG - defines document language limitations.
+
+
+
+
+ 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.
+
+
+
+
+ UDM_LIMIT_DATE - defines limitation by date the document was modified.
+
+
+ Format of parameter value: a string with first character < or >,
+ then with no space - date in unixtime format, for example:
+
+
+
+
+
]]>
-
-
-
-
- If > character is used, then the search will be restricted to those
- documents having a modification date greater than entered, if <, then smaller.
-
-
-
-
-
+
+
+
+
+ If > character is used, then the search will be restricted to those
+ documents having a modification date greater than entered, if <, then smaller.
+
+
+
+
+
+
+
+ val
+
+
+ Defines the value of the current parameter.
+
+
+
+
+
+
+
+
+ &reftitle.returnvalues;
+
+ &return.success;
+
+
+
+
+
udm_alloc_agent_array
Allocate mnoGoSearch session
-
- Description
+
+
+ &reftitle.description;
resourceudm_alloc_agent_array
arraydatabases
udm_alloc_agent_array will create an agent
- with multiple database connections. The array
- databases must contain one database URL
- per element, analog to the first parameter of
- udm_alloc_agent.
-
-
- See also: udm_alloc_agent.
+ with multiple database connections.
+
+
+ &reftitle.parameters;
+
+
+
+ databases
+
+
+ The array databases must contain one database
+ URL per element, analog to the first parameter of
+ udm_alloc_agent.
+
+
+
+
+
+
+
+
+ &reftitle.returnvalues;
+
+ Returns a resource link identifier on success, or &false; on failure.
+
+
+
+
+ &reftitle.seealso;
+
+
+ udm_alloc_agent
+
+
+
+
-
-
-
- udm_alloc_agent
- Allocate mnoGoSearch session
-
-
- Description
-
- resourceudm_alloc_agent
- stringdbaddr
- stringdbmode
-
-
- Returns a mnogosearch agent identifier on success, &false; on failure. This
- function creates a session with database parameters.
-
-
-
- dbaddr - 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
- dbaddr:
- DBType:[//[DBUser[:DBPass]@]DBHost[:DBPort]]/DBName/.
- 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 unknown instead.
+
+
+
+ udm_alloc_agent
+ Allocate mnoGoSearch session
+
+
+
+ &reftitle.description;
+
+ resourceudm_alloc_agent
+ stringdbaddr
+ stringdbmode
+
+
+ Allocate a mnoGoSearch session.
-
+
+
+
+ &reftitle.parameters;
+
+
+
+ dbaddr
+
+
+ dbaddr - 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
+ dbaddr:
+ DBType:[//[DBUser[:DBPass]@]DBHost[:DBPort]]/DBName/.
+ 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 unknown instead.
+
+
+
+
+ dbmode
+
+
+ dbmode - You may select the SQL database mode of
+ words storage. Possible values of dbmode are:
+ single, multi, crc,
+ or crc-multi. When single is
+ specified, all words are stored in the same table. If multi
+ is selected, words will be located in different tables depending
+ of their lengths. "multi" mode is usually faster, but requires more tables
+ in 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. crc-multi uses the same storage structure
+ with the "crc" mode, but also stores words in different tables depending on
+ words lengths like in "multi" mode.
+
+
+
+
+
+
- dbmode - You may select the SQL database mode of
- words storage. Possible values of dbmode are:
- single, multi, crc,
- or crc-multi. When single is
- specified, all words are stored in the same table. If multi
- is selected, words will be located in different tables depending
- of their lengths. "multi" mode is usually faster, but requires more tables
- in 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. crc-multi uses the same storage structure
- with the "crc" mode, but also stores words in different tables depending on
- words lengths like in "multi" mode.
+ dbaddr and dbmode must match
+ those used during indexing.
-
-
-
- dbaddr and dbmode must match
- those used during indexing.
-
-
-
-
-
- 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
- udm_find.
-
-
-
-
+
+
+
+
+ &reftitle.returnvalues;
+
+ Returns a mnogosearch agent identifier on success, &false; on failure. This
+ function creates a session with database parameters.
+
+
+
+
+ &reftitle.notes;
+
+
+ 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
+ udm_find.
+
+
+
+
+
-
-
-
- udm_api_version
- Get mnoGoSearch API version
-
-
- Description
-
- intudm_api_version
-
-
-
-
- udm_api_version returns the mnoGoSearch API version
- number. E.g. if mnoGoSearch 3.1.10 API is used, this function will return
- 30110.
-
-
- This function allows the user to identify which API functions are
- available, e.g. udm_get_doc_count function is only
- available in mnoGoSearch 3.1.11 or later.
-
+
+
+
+ udm_api_version
+ Get mnoGoSearch API version
+
+
+
+ &reftitle.description;
+
+ intudm_api_version
+
+
+
+ Gets the mnoGoSearch API version.
+
+
+ This function allows the user to identify which API functions are
+ available, e.g. udm_get_doc_count function is only
+ available in mnoGoSearch 3.1.11 or later.
+
+
+
+ &reftitle.returnvalues;
+
+ udm_api_version returns the mnoGoSearch API version
+ number. E.g. if mnoGoSearch 3.1.10 API is used, this function will return
+ 30110.
+
+
+
+
+ &reftitle.examples;
+
<function>udm_api_version</function> example
@@ -36,8 +46,10 @@ if (udm_api_version() >= 30111) {
]]>
-
-
+
+
+
+
-
-
-
- udm_cat_list
- Get all the categories on the same level with the current one
-
-
- Description
-
- arrayudm_cat_list
- resourceagent
- stringcategory
-
-
-
- Returns an array listing all categories of the same level as the current
- category in the categories tree.
- agent is the agent identifier returned by a previous
- call to >udm_alloc_agent.
-
-
- The function can be useful for developing categories tree browser.
-
-
- The returned array consists of pairs. Elements with even index numbers
- contain the category paths, odd elements contain the corresponding category
- names.
-
-
+
+
+
+ udm_cat_list
+ Get all the categories on the same level with the current one
+
+
+
+ &reftitle.description;
+
+ arrayudm_cat_list
+ resourceagent
+ stringcategory
+
+
+ Gets all the categories on the same level with the current one.
+
+
+ The function can be useful for developing categories tree browser.
+
+
+
+
+ &reftitle.parameters;
+
+
+
+ agent
+
+
+ A link to Agent, received after call to
+ udm_alloc_agent.
+
+
+
+
+ category
+
+
+
+
+
+
+
+
+
+
+ &reftitle.returnvalues;
+
+ Returns an array listing all categories of the same level as the current
+ category in the categories tree.
+
+
+ The returned array consists of pairs. Elements with even index numbers
+ contain the category paths, odd elements contain the corresponding category
+ names.
+
+
-
-
- Following is an example of displaying links of the current level in format:
-
+
+
+
+
+ &reftitle.examples;
+
+ Following is an example of displaying links of the current level in format:
+
-
-
- <function>udm_cat_list</function> example
-
+
+
+ <function>udm_cat_list</function>example
+
]]>
-
-
-
-
- See also udm_cat_path.
-
-
-
+
+
+
+
+
+
+ &reftitle.seealso;
+
+
+ udm_cat_path
+
+
+
+
+
-
-
-
- udm_cat_path
- Get the path to the current category
-
-
- Description
-
- arrayudm_cat_path
- resourceagent
- stringcategory
-
-
- Returns an array describing the path in the categories tree from the tree
- root to the current one, specified by category.
- agent is the agent identifier returned by a previous
- call to >udm_alloc_agent.
-
-
- The returned array consists of pairs. Elements with even index numbers
- contain the category paths, odd elements contain the corresponding category
- names.
-
-
- For example, the call $array=udm_cat_path($agent, '02031D');
- may return the following array:
-
+
+
+
+ udm_cat_path
+ Get the path to the current category
+
+
+
+ &reftitle.description;
+
+ arrayudm_cat_path
+ resourceagent
+ stringcategory
+
+
+ Returns an array describing the path in the categories tree from the tree
+ root to the current one, specified by category.
+
+
+
+
+ &reftitle.parameters;
+
+
+
+ agent
+
+
+ A link to Agent, received after call to
+ udm_alloc_agent.
+
+
+
+
+ category
+
+
+
+
+
+
+
+
+
+
+ &reftitle.returnvalues;
+
+ The returned array consists of pairs. Elements with even index numbers
+ contain the category paths, odd elements contain the corresponding category
+ names.
+
+
+ For example, the call $array=udm_cat_path($agent, '02031D');
+ may return the following array:
+
-
-
-
-
-
- Specifying path to the current category in the following format:
- '> Root > Sport > Auto > Ferrari'
-
-
+
+
+
+
+
+ &reftitle.examples;
+
+
+
+ Specifying path to the current category in the following format:
+ '> Root > Sport > Auto > Ferrari'
+
+
]]>
-
-
-
-
- See also udm_cat_list.
-
-
-
+
+
+
+
+
+
+ &reftitle.seealso;
+
+
+ udm_cat_list
+
+
+
+
+
-
-
-
- udm_check_charset
-
- Check if the given charset is known to mnogosearch
-
-
-
- Description
-
- booludm_check_charset
- resourceagent
- stringcharset
-
-
- &warn.undocumented.func;
-
-
-
+
+
+
+ udm_check_charset
+ Check if the given charset is known to mnogosearch
+
+
+
+ &reftitle.description;
+
+ booludm_check_charset
+ resourceagent
+ stringcharset
+
+
+ &warn.undocumented.func;
+
+
+
+
-
-
-
- udm_check_stored
-
- Check connection to stored
-
-
-
- Description
-
- intudm_check_stored
- resourceagent
- intlink
- stringdoc_id
-
-
- &warn.undocumented.func;
-
-
-
+
+
+
+ udm_check_stored
+ Check connection to stored
+
+
+
+ &reftitle.description;
+
+ intudm_check_stored
+ resourceagent
+ intlink
+ stringdoc_id
+
+
+ &warn.undocumented.func;
+
+
+
+
-
-
-
- udm_clear_search_limits
- Clear all mnoGoSearch search restrictions
-
-
- Description
-
- booludm_clear_search_limits
- resourceagent
-
-
-
- udm_clear_search_limits resets defined search
- limitations and returns &true;.
-
-
- See also udm_add_search_limit.
-
-
-
+
+
+
+ udm_clear_search_limits
+ Clear all mnoGoSearch search restrictions
+
+
+
+ &reftitle.description;
+
+ booludm_clear_search_limits
+ resourceagent
+
+
+ udm_clear_search_limits resets defined search
+ limitations.
+
+
+
+
+ &reftitle.parameters;
+
+
+
+ agent
+
+
+ A link to Agent, received after call to
+ udm_alloc_agent.
+
+
+
+
+
+
+
+
+ &reftitle.returnvalues;
+
+ Returns &true;.
+
+
+
+
+ &reftitle.seealso;
+
+
+ udm_add_search_limit
+
+
+
+
+
-
-
-
- udm_close_stored
-
- Close connection to stored
-
-
-
- Description
-
- intudm_close_stored
- resourceagent
- intlink
-
-
- &warn.undocumented.func;
-
-
-
+
+
+
+ udm_close_stored
+ Close connection to stored
+
+
+
+ &reftitle.description;
+
+ intudm_close_stored
+ resourceagent
+ intlink
+
+
+ &warn.undocumented.func;
+
+
+
+
-
-
-
- udm_crc32
-
- Return CRC32 checksum of given string
-
-
-
- Description
-
- intudm_crc32
- resourceagent
- stringstr
-
-
- &warn.undocumented.func;
-
-
-
+
+
+
+ udm_crc32
+ Return CRC32 checksum of given string
+
+
+
+ &reftitle.description;
+
+ intudm_crc32
+ resourceagent
+ stringstr
+
+
+ &warn.undocumented.func;
+
+
+
+
-
-
-
- udm_errno
- Get mnoGoSearch error number
-
-
-
- Description
-
- intudm_errno
- resourceagent
-
-
-
- udm_errno returns mnoGoSearch error number, zero if no error.
-
-
-
- agent - link to agent identifier, received
- after call to udm_alloc_agent.
-
-
-
- Receiving numeric agent error code.
-
-
-
+
+
+
+ udm_errno
+ Get mnoGoSearch error number
+
+
+
+ &reftitle.description;
+
+ intudm_errno
+ resourceagent
+
+
+ Receiving numeric agent error code.
+
+
+
+
+ &reftitle.parameters;
+
+
+
+ agent
+
+
+ A link to Agent, received after call to
+ udm_alloc_agent.
+
+
+
+
+
+
+
+
+ &reftitle.returnvalues;
+
+ Returns the mnoGoSearch error number, zero if no error.
+
+
+
+
-
-
-
- udm_error
- Get mnoGoSearch error message
-
-
- Description
-
- stringudm_error
- resourceagent
-
-
-
- udm_error returns mnoGoSearch error message,
- empty string if no error.
-
-
-
- agent - link to agent identifier, received
- after call to udm_alloc_agent.
-
-
-
- Receiving agent error message.
-
-
-
-
+
+
+
+ udm_error
+ Get mnoGoSearch error message
+
+
+
+ &reftitle.description;
+
+ stringudm_error
+ resourceagent
+
+
+ Gets the agent error message.
+
+
+
+
+ &reftitle.parameters;
+
+
+
+ agent
+
+
+ A link to Agent, received after call to
+ udm_alloc_agent.
+
+
+
+
+
+
+
+
+ &reftitle.returnvalues;
+
+ udm_error returns mnoGoSearch error message,
+ empty string if no error.
+
+
+
+
-
-
-
- udm_find
- Perform search
-
-
-
- Description
-
- resourceudm_find
- resourceagent
- stringquery
-
-
-
- Returns a result link identifier on success, or &false; on failure.
-
-
-
- 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.
-
-
-
- mnoGoSearch understands the following boolean operators:
-
-
-
- & - logical AND. For example, "mysql &
- odbc". mnoGoSearch will find any URLs that contain both
- "mysql" and "odbc".
-
-
- | - logical OR. For example "mysql|odbc". mnoGoSearch
- will find any URLs, that contain word "mysql" or word
- "odbc".
-
-
- ~ - 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!
-
-
- () - 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.
-
-
-
-
+
+
+
+ udm_find
+ Perform search
+
+
+
+ &reftitle.description;
+
+ resourceudm_find
+ resourceagent
+ stringquery
+
+
+ Performs a search.
+
+
+ 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.
+
+
+
+
+ &reftitle.parameters;
+
+
+
+ agent
+
+
+ A link to Agent, received after call to
+ udm_alloc_agent.
+
+
+
+
+ query
+
+
+ mnoGoSearch understands the following boolean operators:
+
+
+ & - logical AND. For example, "mysql &
+ odbc". mnoGoSearch will find any URLs that contain both
+ "mysql" and "odbc".
+
+
+ | - logical OR. For example "mysql|odbc". mnoGoSearch
+ will find any URLs, that contain word "mysql" or word
+ "odbc".
+
+
+ ~ - 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!
+
+
+ () - 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.
+
+
+
+
+
+
+
+
+ &reftitle.returnvalues;
+
+ Returns a result link identifier on success, or &false; on failure.
+
+
+
+
-
-
-
- udm_free_agent
- Free mnoGoSearch session
-
-
-
- Description
-
- intudm_free_agent
- resourceagent
-
-
-
- &return.success;
-
-
- agent - link to agent identifier, received `
- after call to udm_alloc_agent.
-
-
-
- Freeing up memory allocated for agent session.
-
-
-
-
+
+
+
+ udm_free_agent
+ Free mnoGoSearch session
+
+
+
+ &reftitle.description;
+
+ intudm_free_agent
+ resourceagent
+
+
+ Freeing up memory allocated for agent session.
+
+
+
+
+ &reftitle.parameters;
+
+
+
+ agent
+
+
+ A link to Agent, received after call to
+ udm_alloc_agent.
+
+
+
+
+
+
+
+
+ &reftitle.returnvalues;
+
+ &return.success;
+
+
+
+
-
-
-
- udm_free_ispell_data
- Free memory allocated for ispell data
-
-
-
- Description
-
- booludm_free_ispell_data
- intagent
-
-
+
+
+
+ udm_free_ispell_data
+ Free memory allocated for ispell data
+
+
+
+ &reftitle.description;
+
+ booludm_free_ispell_data
+ intagent
+
+
+ Frees the memory allocated for ispell data.
+
+
+
+
+ &reftitle.parameters;
+
+
+
+ agent
+
+
+ A link to Agent, received after call to
+ udm_alloc_agent.
+
+
+
+
+
+
+
+
+ &reftitle.returnvalues;
+
+ udm_free_ispell_data always returns &true;.
+
+
+
+
+ &reftitle.notes;
+
- udm_free_ispell_data always returns &true;.
+ This function is supported beginning from version 3.1.12 of
+ mnoGoSearch and it does not do anything in previous versions.
-
-
- agent - agent link identifier, received after
- call to udm_alloc_agent.
-
-
-
-
- This function is supported beginning from version 3.1.12 of
- mnoGoSearch and it does not do anything in previous versions.
-
-
-
-
-
+
+
+
+
-
-
-
- udm_free_res
- Free mnoGoSearch result
-
-
-
- Description
-
- booludm_free_res
- resourceres
-
-
-
- &return.success;
-
-
-
- res - a link to result identifier,
- received after call to udm_find.
-
-
-
- Freeing up memory allocated for results.
-
-
-
-
+
+
+
+ udm_free_res
+ Free mnoGoSearch result
+
+
+
+ &reftitle.description;
+
+ booludm_free_res
+ resourceres
+
+
+ Freeing up memory allocated for results.
+
+
+
+
+ &reftitle.parameters;
+
+
+
+ res
+
+
+ A link to a result identifier, received after call to
+ udm_find.
+
+
+
+
+
+
+
+
+ &reftitle.returnvalues;
+
+ &return.success;
+
+
+
+
-
-
-
- udm_get_doc_count
- Get total number of documents in database
-
-
-
- Description
-
- intudm_get_doc_count
- resourceagent
-
-
+
+
+
+ udm_get_doc_count
+ Get total number of documents in database
+
+
+
+
+ &reftitle.description;
+
+ intudm_get_doc_count
+ resourceagent
+
+
+ udm_get_doc_count returns the number of documents in
+ the database.
+
+
+
+
+ &reftitle.parameters;
+
+
+
+ agent
+
+
+ A link to Agent, received after call to
+ udm_alloc_agent.
+
+
+
+
+
+
+
+
+ &reftitle.returnvalues;
+
+ Returns the number of document.
+
+
+
+
+ &reftitle.notes;
+
- udm_get_doc_count returns the number of documents in
- the database.
+ This function is supported only in mnoGoSearch 3.1.11 or later.
-
-
- agent - link to agent identifier, received after
- call to udm_alloc_agent.
-
-
-
-
- This function is supported only in mnoGoSearch 3.1.11 or later.
-
-
-
-
-
+
+
+
+
-
-
-
- udm_get_res_field
- Fetch mnoGoSearch result field
-
-
-
- Description
-
- stringudm_get_res_field
- resourceres
- introw
- intfield
-
-
-
- udm_get_res_field returns result field value on
- success, &false; on error.
-
-
-
- res - a link to result identifier, received
- after call to udm_find.
-
-
-
- row - the number of the link on the current page.
- May have values from 0 to
- UDM_PARAM_NUM_ROWS-1.
-
-
-
- field - field identifier, may have the following values:
-
-
-
-
-
- UDM_FIELD_URL - document URL field
-
-
-
-
- UDM_FIELD_CONTENT - document Content-type field (for example, text/html).
-
-
-
-
- UDM_FIELD_CATEGORY - document category field. Use
- udm_cat_path to get full path to current category
- from the categories tree root. (This parameter is available only in PHP
- 4.0.6 or later).
-
-
-
-
- UDM_FIELD_TITLE - document title field.
-
-
-
-
- UDM_FIELD_KEYWORDS - document keywords field (from META KEYWORDS tag).
-
-
-
-
- UDM_FIELD_DESC - document description field (from META DESCRIPTION tag).
-
-
-
-
- UDM_FIELD_TEXT - document body text (the first couple of lines to give an
- idea of what the document is about).
-
-
-
-
- UDM_FIELD_SIZE - document size.
-
-
-
-
- UDM_FIELD_URLID - unique URL ID of the link.
-
-
-
-
- UDM_FIELD_RATING - page rating (as calculated by mnoGoSearch).
-
-
-
-
- UDM_FIELD_MODIFIED - last-modified field in unixtime format.
-
-
-
-
- UDM_FIELD_ORDER - the number of the current document in set of found documents.
-
-
-
-
- UDM_FIELD_CRC - document CRC.
-
-
-
-
-
-
+
+
+
+ udm_get_res_field
+ Fetch a result field
+
+
+
+ &reftitle.description;
+
+ stringudm_get_res_field
+ resourceres
+ introw
+ intfield
+
+
+ Fetch a mnoGoSearch result field.
+
+
+
+
+ &reftitle.parameters;
+
+
+
+ res
+
+
+ res - a link to result identifier, received
+ after call to udm_find.
+
+
+
+
+ row
+
+
+ row - the number of the link on the current page.
+ May have values from 0 to
+ UDM_PARAM_NUM_ROWS-1.
+
+
+
+
+ field
+
+
+ field - field identifier, may have the following values:
+
+
+
+ UDM_FIELD_URL - document URL field
+
+
+
+
+ UDM_FIELD_CONTENT - document Content-type field (for example, text/html).
+
+
+
+
+ UDM_FIELD_CATEGORY - document category field. Use
+ udm_cat_path to get full path to current category
+ from the categories tree root. (This parameter is available only in PHP
+ 4.0.6 or later).
+
+
+
+
+ UDM_FIELD_TITLE - document title field.
+
+
+
+
+ UDM_FIELD_KEYWORDS - document keywords field (from META KEYWORDS tag).
+
+
+
+
+ UDM_FIELD_DESC - document description field (from META DESCRIPTION tag).
+
+
+
+
+ UDM_FIELD_TEXT - document body text (the first couple of lines to give an
+ idea of what the document is about).
+
+
+
+
+ UDM_FIELD_SIZE - document size.
+
+
+
+
+ UDM_FIELD_URLID - unique URL ID of the link.
+
+
+
+
+ UDM_FIELD_RATING - page rating (as calculated by mnoGoSearch).
+
+
+
+
+ UDM_FIELD_MODIFIED - last-modified field in unixtime format.
+
+
+
+
+ UDM_FIELD_ORDER - the number of the current document in set of found documents.
+
+
+
+
+ UDM_FIELD_CRC - document CRC.
+
+
+
+
+
+
+
+
+
+
+
+ &reftitle.returnvalues;
+
+ udm_get_res_field returns result field value on
+ success, &false; on error.
+
+
+
+
-
-
-
- udm_get_res_param
- Get mnoGoSearch result parameters
-
-
-
- Description
-
- stringudm_get_res_param
- resourceres
- intparam
-
-
-
- udm_get_res_param returns result parameter value on
- success, &false; on error.
-
-
-
- res - a link to result identifier, received after
- call to udm_find.
-
-
-
- param - parameter identifier, may have the following values:
-
-
-
-
-
- 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.
-
-
-
-
- UDM_PARAM_FOUND - total number of results matching the query.
-
-
-
-
- UDM_PARAM_WORDINFO - information on the words found. E.g. search for
- "a good book" will return "a: stopword, good:5637, book: 120"
-
-
-
-
- UDM_PARAM_SEARCHTIME - search time in seconds.
-
-
-
-
- UDM_PARAM_FIRST_DOC - the number of the first document displayed on current page.
-
-
-
-
- UDM_PARAM_LAST_DOC - the number of the last document displayed on current page.
-
-
-
-
-
-
+
+
+
+ udm_get_res_param
+ Get mnoGoSearch result parameters
+
+
+
+ &reftitle.description;
+
+ stringudm_get_res_param
+ resourceres
+ intparam
+
+
+ Gets the mnoGoSearch result parameters.
+
+
+
+
+ &reftitle.parameters;
+
+
+
+ res
+
+
+ res - a link to result identifier, received after
+ call to udm_find.
+
+
+
+
+ param
+
+
+ param - parameter identifier, may have the following values:
+
+
+
+ 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.
+
+
+
+
+ UDM_PARAM_FOUND - total number of results matching the query.
+
+
+
+
+ UDM_PARAM_WORDINFO - information on the words found. E.g. search for
+ "a good book" will return "a: stopword, good:5637, book: 120"
+
+
+
+
+ UDM_PARAM_SEARCHTIME - search time in seconds.
+
+
+
+
+ UDM_PARAM_FIRST_DOC - the number of the first document displayed on current page.
+
+
+
+
+ UDM_PARAM_LAST_DOC - the number of the last document displayed on current page.
+
+
+
+
+
+
+
+
+
+
+
+ &reftitle.returnvalues;
+
+ udm_get_res_param returns result parameter value on
+ success, &false; on error.
+
+
+
+
+
udm_hash32
Return Hash32 checksum of gived string
-
- Description
+
+
+ &reftitle.description;
intudm_hash32
resourceagent
@@ -15,12 +16,51 @@
udm_hash32 will take a string
str and return a quite unique 32-bit hash
- number from it. Requires an allocated agent.
-
-
- See also: udm_alloc_agent.
+ number from it.
+
+
+ &reftitle.parameters;
+
+
+
+ agent
+
+
+ A link to Agent, received after call to
+ udm_alloc_agent.
+
+
+
+
+ str
+
+
+ The input string.
+
+
+
+
+
+
+
+
+ &reftitle.returnvalues;
+
+ Returns a 32-bit hash number.
+
+
+
+
+ &reftitle.seealso;
+
+
+ udm_alloc_agent
+
+
+
+
-
-
-
- udm_load_ispell_data
- Load ispell data
-
-
- Description
-
- booludm_load_ispell_data
- resourceagent
- intvar
- stringval1
- stringval2
- intflag
-
-
- udm_load_ispell_data loads ispell data.
- &return.success;
-
-
- agent - agent link identifier, received after call
- to udm_alloc_agent.
-
-
- var - parameter, indicating the source for ispell
- data. May have the following values:
-
-
- After using this function to free memory allocated for ispell data, please
- use udm_free_ispell_data, even if you use UDM_ISPELL_TYPE_SERVER mode.
-
-
- 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.
-
-
-
-
- UDM_ISPELL_TYPE_DB - indicates that ispell data should be loaded from SQL.
- In this case, parameters val1 and val2
- are ignored and should be left blank. flag
- should be equal to 1.
-
-
+
+
+
+ udm_load_ispell_data
+ Load ispell data
+
+
+
+ &reftitle.description;
+
+ booludm_load_ispell_data
+ resourceagent
+ intvar
+ stringval1
+ stringval2
+ intflag
+
+
+ udm_load_ispell_data loads ispell data.
+
+
+ After using this function to free memory allocated for ispell data, please
+ use udm_free_ispell_data, even if you use UDM_ISPELL_TYPE_SERVER mode.
+
+
+
+
+ &reftitle.parameters;
+
+
+
+ agent
+
- flag 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 udm_load_ispell_data,
- 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 1. 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
- udm_error and udm_errno.
+ A link to Agent, received after call to
+ udm_alloc_agent.
-
-
-
- <function>udm_load_ispell_data</function> example
-
-
-]]>
-
-
-
-
-
-
- UDM_ISPELL_TYPE_AFFIX - indicates that ispell data should be loaded from
- file and initiates loading affixes file. In this case val1
- defines double letter language code for which affixes are loaded,
- and val2 - 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 udm_error and udm_errno,
- since those functions can only return messages associated with SQL. Please,
- see flag parameter description in UDM_ISPELL_TYPE_DB.
-
-
-
- <function>udm_load_ispell_data</function> example
-
+
+
+
+ var
+
+
+ Indicates the source for ispell data. May have the following values:
+
+
+
+ UDM_ISPELL_TYPE_DB - indicates that ispell data should be loaded from SQL.
+ In this case, parameters val1 and val2
+ are ignored and should be left blank. flag
+ should be equal to 1.
+
+
+
+ flag 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 udm_load_ispell_data,
+ 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 1. 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
+ udm_error and udm_errno.
+
+
+
+
+
+ UDM_ISPELL_TYPE_AFFIX - indicates that ispell data should be loaded from
+ file and initiates loading affixes file. In this case val1
+ defines double letter language code for which affixes are loaded,
+ and val2 - 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 udm_error and udm_errno,
+ since those functions can only return messages associated with SQL. Please,
+ see flag parameter description in UDM_ISPELL_TYPE_DB.
+
+
+
+ <function>udm_load_ispell_data</function> example
+
]]>
-
-
-
-
-
- flag is equal to 1 only in the last call.
-
-
-
-
-
- UDM_ISPELL_TYPE_SPELL - indicates that ispell data should be loaded from
- file and initiates loading of ispell dictionary file. In this case
- val1 defines double letter language code for which
- affixes are loaded,
- and val2 - 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 udm_error and
- udm_errno, since those functions can only return messages
- associated with SQL. Please, see flag parameter
- description in UDM_ISPELL_TYPE_DB.
-
-
-
+
+
+
+
+
+ flag is equal to 1 only in the last call.
+
+
+
+
+
+ UDM_ISPELL_TYPE_SPELL - indicates that ispell data should be loaded from
+ file and initiates loading of ispell dictionary file. In this case
+ val1 defines double letter language code for which
+ affixes are loaded,
+ and val2 - 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 udm_error and
+ udm_errno, since those functions can only return messages
+ associated with SQL. Please, see flag parameter
+ description in UDM_ISPELL_TYPE_DB.
+
+
+
]]>
-
-
-
-
- flag is equal to 1 only in the last call.
-
-
-
-
-
- UDM_ISPELL_TYPE_SERVER - enables spell server support.
- val1 parameter indicates
- address of the host running spell server. val2 `
- is not used yet, but in future releases it is going to indicate number
- of port used by spell server. flag parameter in
- this case is not needed since ispell data is stored
- on spellserver already sorted.
-
-
- 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).
-
-
- udm_load_ispell_data 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 udm_find
- 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.
-
-
-
- This function is available in mnoGoSearch 3.1.12 or later.
-
-
- Example:
-
-
+
+
+
+
+ flag is equal to 1 only in the last call.
+
+
+
+
+
+ UDM_ISPELL_TYPE_SERVER - enables spell server support.
+ val1 parameter indicates
+ address of the host running spell server. val2 `
+ is not used yet, but in future releases it is going to indicate number
+ of port used by spell server. flag parameter in
+ this case is not needed since ispell data is stored
+ on spellserver already sorted.
+
+
+ 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).
+
+
+ udm_load_ispell_data 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 udm_find
+ 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.
+
+
+
+ This function is available in mnoGoSearch 3.1.12 or later.
+
+
+ Example:
+
+
]]>
-
-
-
-
-
-
+
+
+
+
+
+
+ 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.
+
+
+
+
+ val1
+
+
+
+
+
+
+ val2
+
+
+
+
+
+
+ flag
+
+
+
+
+
+
+
+
+
+
+ &reftitle.returnvalues;
+
+ &return.success;
+
+
+
+
+ &reftitle.examples;
+
+
+ <function>udm_load_ispell_data</function> example
+
+
+]]>
+
+
+
+
+
+
-
-
-
- udm_open_stored
-
- Open connection to stored
-
-
-
- Description
-
- intudm_open_stored
- resourceagent
- stringstoredaddr
-
-
- &warn.undocumented.func;
-
-
-
+
+
+
+ udm_open_stored
+ Open connection to stored
+
+
+
+ &reftitle.description;
+
+ intudm_open_stored
+ resourceagent
+ stringstoredaddr
+
+
+ &warn.undocumented.func;
+
+
+
+
-
-
-
- udm_set_agent_param
- Set mnoGoSearch agent session parameters
-
-
- Description
-
- booludm_set_agent_param
- resourceagent
- intvar
- stringval
-
-
-
- &return.success; Defines mnoGoSearch session parameters.
-
-
+
+
+
+ udm_set_agent_param
+ Set mnoGoSearch agent session parameters
+
+
+
+ &reftitle.description;
+
+ booludm_set_agent_param
+ resourceagent
+ intvar
+ stringval
+
+
+ Defines mnoGoSearch session parameters.
+
+
+
+
+ &reftitle.parameters;
+
+
+
+ agent
+
+
+ A link to Agent, received after call to
+ udm_alloc_agent.
+
+
+
+
+ var
+
+
+ The following parameters and their values are available:
+
+
+
+ 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).
+
+
+
+
+ UDM_PARAM_PAGE_SIZE - number of search results displayed on one page.
+
+
+
+
+ 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 udm_find
+ for details on boolean search.
+
+
+
+
+ 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.
+
+
+
+
+ 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.
+
+
+
+
+ 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.
+
+
+ Examples of phrase search:
+
+
+ "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
+
+
+
+
+ UDM_PARAM_CHARSET - defines local charset. Available values: set of
+ charsets supported by mnoGoSearch, e.g. koi8-r, cp1251, ...
+
+
+
+
+ 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.)
+
+
+
+
+ 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.
+
+
+
+
+ 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:
+
+
+ URLWeight 1
+ BodyWeight 2
+ TitleWeight 4
+ KeywordWeight 8
+ DescWeight 16
+
+
+
+ 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.
+
+
+
+ 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:
+
+
+ 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)
+
+
+ Examples:
+
+
+ UDM_PARAM_WEIGHT_FACTOR=00001 will search through URLs only.
+
+
+ UDM_PARAM_WEIGHT_FACTOR=00100 will search through Titles only.
+
+
+ UDM_PARAM_WEIGHT_FACTOR=11100 will search through Title,Keywords,Description
+ but not through URL and Body.
+
+
+ UDM_PARAM_WEIGHT_FACTOR=F9421 will search through:
+
+
+ Description with factor 15 (F hex)
+ Keywords with factor 9
+ Title with factor 4
+ Body with factor 2
+ URL with factor 1
+
+
+ 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.
+
+
+
+
+ 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:
+
+ UDM_MATCH_BEGIN - word beginning match;
+ UDM_MATCH_END - word ending match;
+ UDM_MATCH_WORD - whole word match;
+ UDM_MATCH_SUBSTR - word substring match.
+
+
+
+ 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.
+
+
+
+
+ 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 udm_load_ispell_data.
+
+
+
+
+ UDM_PARAM_CROSS_WORDS - enables or disables crosswords support.
+ Possible values: UDM_CROSS_WORDS_ENABLED and UDM_CROSS_WORDS_DISABLED.
+
+
+ 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.
+
+
+
+
+ UDM_PARAM_VARDIR - specifies a custom path to directory where indexer
+ stores data when using built-in database and in cache mode.
+ By default /var directory of
+ mnoGoSearch installation is used. Can have
+ only string values.
+
+
+
+
+
+
+
+ val
+
+
+
+
+
+
+
+
+
+
+ &reftitle.changelog;
+
+
+
+
+
+ &Version;
+ &Description;
+
+
+
+
+ 4.1.0
+
+ UDM_PARAM_VARDIR was added.
+
+
+
+
+
+
+
+
+
+ &reftitle.returnvalues;
+
+ &return.success;
+
+
+
+
+ &reftitle.notes;
+
- The following parameters and their values are available:
+ Crosswords are supported only in mnoGoSearch 3.1.11 or later.
-
-
-
-
- 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).
-
-
-
-
- UDM_PARAM_PAGE_SIZE - number of search results displayed on one page.
-
-
-
-
- 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 udm_find
- for details on boolean search.
-
-
-
-
- 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.
-
-
-
-
- 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.
-
-
-
-
- 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.
-
-
- Examples of phrase search:
-
-
- "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
-
-
-
-
- UDM_PARAM_CHARSET - defines local charset. Available values: set of
- charsets supported by mnoGoSearch, e.g. koi8-r, cp1251, ...
-
-
-
-
- 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.)
-
-
-
-
- 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.
-
-
-
-
- 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:
-
-
- URLWeight 1
- BodyWeight 2
- TitleWeight 4
- KeywordWeight 8
- DescWeight 16
-
-
-
- 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.
-
-
-
- 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:
-
-
- 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)
-
-
- Examples:
-
-
- UDM_PARAM_WEIGHT_FACTOR=00001 will search through URLs only.
-
-
- UDM_PARAM_WEIGHT_FACTOR=00100 will search through Titles only.
-
-
- UDM_PARAM_WEIGHT_FACTOR=11100 will search through Title,Keywords,Description
- but not through URL and Body.
-
-
- UDM_PARAM_WEIGHT_FACTOR=F9421 will search through:
-
-
- Description with factor 15 (F hex)
- Keywords with factor 9
- Title with factor 4
- Body with factor 2
- URL with factor 1
-
-
- 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.
-
-
-
-
- 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:
-
- UDM_MATCH_BEGIN - word beginning match;
- UDM_MATCH_END - word ending match;
- UDM_MATCH_WORD - whole word match;
- UDM_MATCH_SUBSTR - word substring match.
-
-
-
- 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.
-
-
-
-
- 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 udm_load_ispell_data.
-
-
-
-
- UDM_PARAM_CROSS_WORDS - enables or disables crosswords support.
- Possible values: UDM_CROSS_WORDS_ENABLED and UDM_CROSS_WORDS_DISABLED.
-
-
- 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.
-
-
-
- Crosswords are supported only in mnoGoSearch 3.1.11 or later.
-
-
-
-
-
- UDM_PARAM_VARDIR - specifies a custom path to directory where indexer
- stores data when using built-in database and in cache mode.
- By default /var directory of
- mnoGoSearch installation is used. Can have
- only string values. The parameter is available in PHP 4.1.0 or later.
-
-
-
-
-
+
+
+
+