X-Git-Url: http://lists.indexdata.com/cgi-bin?a=blobdiff_plain;f=doc%2Fpazpar2_conf.xml;h=74f778e148ec8cf336406c228e3aaa01c3be5997;hb=f1a8158e4c569736e4380c9c4caeae231dd4b65b;hp=1ad24a2a5bd3a081aa5abcf7153eeede47cf43f2;hpb=319d591dd9d6c3b38775cb4fdfbbd0a92d822f4b;p=pazpar2-moved-to-github.git

diff --git a/doc/pazpar2_conf.xml b/doc/pazpar2_conf.xml
index 1ad24a2..74f778e 100644
--- a/doc/pazpar2_conf.xml
+++ b/doc/pazpar2_conf.xml
@@ -268,7 +268,7 @@
 	      M [F N]
 	     </literallayout>
 	     where M is an integer, used as a
-	     multiplier against the basic TF*IDF score. A value of
+	     weight against the basic TF*IDF score. A value of
 	     1 is the base, higher values give additional weight to
 	     elements of this type. The default is '0', which
 	     excludes this element from the rank calculation.
@@ -289,6 +289,8 @@
 	     The per field rank was introduced in Pazpar2 1.6.15. Earlier
 	     releases only allowed a rank value M (simple integer).
 	    </para>
+	    See <xref linkend="relevance_ranking"/> for more
+	    about ranking.
 	   </listitem>
 	  </varlistentry>
 	  
@@ -320,6 +322,11 @@
 	     all elements), or 'no' (don't merge; this is the
 	     default);
 	    </para>
+	    <para>
+	     Pazpar 1.6.24 also offers a new value for merge, 'first', which
+	     is like 'all' but only takes all from first database that returns
+	     the particular metadata field.
+	    </para>
 	   </listitem>
 	  </varlistentry>
 	  
@@ -359,6 +366,22 @@
 	  </varlistentry>
 	  
 	  <varlistentry>
+	   <term id="limitcluster">limitcluster</term>
+	   <listitem>
+	    <para>
+	     Allow a limit on merged metadata. The value of this attribute
+	     is the name of actual metadata content to be used for matching
+	     (most often same name as metadata name).
+	    </para>
+	    <note>
+	     <para>
+	      Requires Pazpar2 1.6.23 or later.
+	     </para>
+	    </note>
+	   </listitem>
+	  </varlistentry>
+	  
+	  <varlistentry>
 	   <term id="metadata_limitmap">limitmap</term>
 	   <listitem>
 	    <para>
@@ -585,18 +608,85 @@
 	<term>rank</term>
 	<listitem>
 	 <para>
-	  Customizes the ranking (relevance) algorithm.
-	  Attribute 'cluster' is a boolean
-	  that controls whether Pazpar2 should boost ranking for merged
-	  records. Is 'yes' by default. A value of 'no' will make
-	  Pazpar2 avergage ranking of each record in a cluster.
+	  Customizes the ranking (relevance) algorithm. Also known as
+	  rank tweaks. The rank element
+	  accepts the following attributes - all being optional:
+	 </para>
+	 <variablelist>
+	  <varlistentry>
+	   <term>cluster</term>
+	   <listitem>
+	    <para>
+	     Attribute 'cluster' is a boolean
+	     that controls whether Pazpar2 should boost ranking for merged
+	     records. Is 'yes' by default. A value of 'no' will make
+	     Pazpar2 average ranking of each record in a cluster.
+	    </para>
+	   </listitem>
+	  </varlistentry>
+	  <varlistentry>
+	   <term>debug</term>
+	   <listitem>
+	    <para>
+	     Attribute 'debug' is a boolean
+	     that controls whether Pazpar2 should include details
+	     about ranking for each document in the show command's
+	     response. Enable by using value "yes", disable by using
+	     value "no" (default).
+	    </para>
+	   </listitem>
+	  </varlistentry>
+	  <varlistentry>
+	   <term>follow</term>
+	   <listitem>
+	    <para>
+	     Attribute 'follow' is a a floating point number greater than
+	     or equal to 0. A positive number will boost weight for terms
+	     that occur close to each other (proximity, distance).
+	     A value of 1, will double the weight if two terms are in
+	     proximity distance of 1 (next to each other). The default
+	     value of 'follow' is 0 (order will not affect weight).
+	    </para>
+	   </listitem>
+	  </varlistentry>
+	  <varlistentry>
+	   <term>lead</term>
+	   <listitem>
+	    <para>
+	     Attribute 'lead' is a floating point number.
+	     It controls if term weight should be reduced by position
+	     from start in a metadata field. A positive value of 'lead'
+	     will reduce weight as it apperas further away from the lead
+	     of the field. Default value is 0 (no reduction of weight by
+	     position).
+	    </para>
+	   </listitem>
+	  </varlistentry>
+	  <varlistentry>
+	   <term>length</term>
+	   <listitem>
+	    <para>
+	     Attribute 'length' determines how/if term weight should be
+	     divided by lenght of metadata field. A value of "linear"
+	     divide by length. A value of "log" will divide by log2(length).
+	     A value of "none" will leave term weight as is (no division).
+	     Default value is "linear".
+	    </para>
+	   </listitem>
+	  </varlistentry>
+	 </variablelist>
+	 <para>
+	  Refer to <xref linkend="relevance_ranking"/> to see how
+	  these tweaks are used in computation of score.
 	 </para>
 	 <para>
-	  This configuration was added in pazpar2 1.6.18.
+	  Customization of ranking algorithm was introduced with
+	  Pazpar2 1.6.18. The semantics of some of the fields changed
+	  in versions up to 1.6.22.
 	 </para>
 	</listitem>
        </varlistentry>
-
+       
        <varlistentry id="sort-default">
 	<term>sort-default</term>
 	<listitem>
@@ -711,7 +801,7 @@
   <para>
    The XML configuration may be partitioned into multiple files by using
    the <literal>include</literal> element which takes a single attribute,
-   <literal>src</literal>. The of the <literal>src</literal> attribute is
+   <literal>src</literal>. The <literal>src</literal> attribute is
    regular Shell like glob-pattern. For example,
    <screen><![CDATA[
    <include src="/etc/pazpar2/conf.d/*.xml"/>
@@ -1184,6 +1274,26 @@
      </listitem>
     </varlistentry>
     <varlistentry>
+     <term>pz:extendrecs</term>
+     <listitem>
+      <para>
+       If a show command goes to the boundary of a result set for a
+       database - depends on sorting - and pz:extendrecs is set to a positive
+       value. then Pazpar2 wait for show to fetch pz:extendrecs more
+       records. This setting is best used if a database does native
+       sorting, because the result set otherwise may be completely
+       re-sorted during extended fetch.
+       The default value of pz:extendrecs is 0 (no extended fetch).
+      </para>
+      <warning>
+       <para>
+	The pz:extendrecs setting appeared in Pazpar2 version 1.6.26.
+	But the bahavior changed with the release of Pazpar2 1.6.29.
+       </para>
+      </warning>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
      <term>pz:presentchunk</term>
      <listitem>
       <para>
@@ -1405,6 +1515,12 @@
        by a field a metadata field (default is to use the name of the 
        limitmap itself).
       </para>
+      <para>
+       For Pazpar2 version 1.6.23 and later the limitmap may include multiple
+       specifications, separated by <literal>,</literal> (comma).
+       For example:
+       <literal>ccl:title,local:ltitle,rpn:@attr 1=4</literal>.
+      </para>
       <note>
        <para>
 	The limitmap facility is supported for Pazpar2 version 1.6.0.