Changes between Version 2 and Version 3 of adeiSEARCH

Author:

csa (IP: 141.52.232.84)

Timestamp:

09/11/09 02:50:19 (15 years ago)

Comment:

--

adeiSEARCH

@@ -3 +3 @@
-ADEI has a modular search subsystem. The search capabilities are provided by the search engines which providing one-or-more search modules. Besides the search term, the search string may specify the search modules to perform search. The module parameters could be specified along with the modules.
-
+
+=== Format of search string ===
+The search string consists of four components:
+ * The first component defines type of the search. Examples are ''item search'', ''channel value search'', ''datetime search''.
+ * Second component provides some options. For example, demands exact or fuzzy match
+ * Third and fourth components are type-dependent and containing search string and additional limits
+
+The format is as follows:
+  {{{ [type/module specification] [global flags] <search string> [limits] }}}
+Everything besides search string is optional. By default if the type is not specified, the search for channel and group names is performed.
+
+The search type is specified in the curly brackets in the beginning of the search string. The search module available in the ''classes/search'' should be indicated (name of the class should be specified). Optional options for the class constructor could be indicated as well. If multiple modules are specified, the multiple searches are performed sequentially. The following format is expected:
+  {{{ {module_name(opt1=value1,opt=value2), another_module(...)} }}}
+
+The global options are going next to the search type and specified in the square brackets. This options then passed to the search modules with the search string and handled by the module code. The following options are supported:
+ * ''='' - Exact match, default behavior is to match 
+ * ''w'' - Word match
+ * ''~'' - Fuzzy match
+
+