From 69311f02def2748959c8a5404df056cbd0466dd4 Mon Sep 17 00:00:00 2001
From: Sergey Kartashoff <gluke@php.net>
Date: Fri, 16 Feb 2001 13:55:22 +0000
Subject: [PATCH] Documentation update.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@41315 c90b9560-bf6c-de11-be94-00142212c4b1
---
 functions/mnogosearch.xml | 69 +++++++++++++++++++++++++++++++++++++--
 1 file changed, 67 insertions(+), 2 deletions(-)

diff --git a/functions/mnogosearch.xml b/functions/mnogosearch.xml
index 541caeb8f5..739c0a3ed8 100644
--- a/functions/mnogosearch.xml
+++ b/functions/mnogosearch.xml
@@ -161,7 +161,73 @@
 	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>
+	   <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>
+	<simpara>URLWeight     1</simpara>
+	<simpara>BodyWeight    2</simpara>
+	<simpara>TitleWeight   4</simpara>
+    <simpara>KeywordWeight 8</simpara> 
+    <simpara>DescWeight    16</simpara>
+	<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 argegate 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>
+     <simpara>E is a factor for weight 1  (URL Weight bit)</simpara>
+     <simpara>D is a factor for weight 2  (BodyWeight bit)</simpara>
+     <simpara>C is a factor for weight 4  (TitleWeight bit)</simpara>
+     <simpara>B is a factor for weight 8  (KeywordWeight bit)</simpara>
+     <simpara>A is a factor for weight 16 (DescWeight bit)</simpara>
+     <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,Desctription but not through URL and Body.
+	 </simpara>
+	 <simpara>
+     UDM_PARAM_WEIGHT_FACTOR=F9421 will search through:
+      </simpara>
+      <simpara>Description with factor 15  (F hex)</simpara>
+      <simpara>Keywords with factor 9</simpara>
+      <simpara>Title with factor  4</simpara>
+      <simpara>Body with factor 2</simpara>
+      <simpara>URL with factor 1</simpara>
+      <simpara>
+	If UDM_PARAM_WEIGHT_FACTOR variable is ommited, 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>  
      </itemizedlist>
     </refsect1>
   </refentry>
@@ -599,4 +665,3 @@ sgml-local-catalogs:nil
 sgml-local-ecat-files:nil
 End:
 -->
-