[interchange-docs] xmldocs - docelic modified guides/search.xml

[docs at icdevgroup.org]

User:      docelic
Date:      2008-07-10 18:10:58 GMT
Modified:  guides   search.xml
Log:
* mv_force_coordinate

Revision  Changes    Path
1.24                 xmldocs/guides/search.xml


rev 1.24, prev_rev 1.23
Index: search.xml
===================================================================
RCS file: /var/cvs/xmldocs/guides/search.xml,v
retrieving revision 1.23
retrieving revision 1.24
diff -u -r1.23 -r1.24
--- search.xml	17 May 2008 21:44:39 -0000	1.23
+++ search.xml	10 Jul 2008 18:10:58 -0000	1.24
@@ -218,7 +218,11 @@
 		</para><para>
 		If the number of search fields (<literal>sf</literal> options) equals the
 		number of search specs (<literal>se</literal> options), the search will
-		return only items that match all field-specification pairs.
+		return items that match all or one of the field-specification blocks
+		(controlled with <mv>mv_orsearch</mv>).
+		When the two numbers do not match, coordinated mode will be automatically
+		and silently turned off. To force a coordinated search, see 
+		<mv>mv_force_coordinate</mv>.
 		</para><para>
 		When coordinated searching is used, case sensitivity, substring matching,
 		negation and other options can be specified multiple times and work on a
@@ -325,6 +329,23 @@
 
 		</para>
 		</section>
+		<section id="mv_force_coordinate"><title>
+		<literal>fc &mdash; mv_force_coordinate</literal></title><cmdsynopsis>
+		(<literal>0</literal>/<literal>1</literal>,
+		default <literal>0</literal>)</cmdsynopsis><para>
+		force coordinated search (enabled with <mv>mv_coordinate</mv>).
+		</para><para>
+		Normally, coordinated mode is automatically turned off when the
+		number of search specifications does not match the number of search 
+		fields. With this option, however, instead of disabling coordinated mode,
+		&IC; ensures the number of search specifications does match the
+		number of fields by filling the missing specifications with the last
+		one specified, or by discarding extras.
+		</para><para>
+		This option is useful when you want to search for one string
+		in multiple fields with different options.
+		</para>
+		</section>
 		<section id="mv_field_file"><title>
 		<literal>ff &mdash; mv_field_file</literal></title><cmdsynopsis>
 		(<replaceable>header_filename</replaceable>,