X-Git-Url: http://lists.indexdata.com/cgi-bin?a=blobdiff_plain;f=doc%2Fpazpar2_conf.xml;h=cbad09d6575c7543cd4a529daa5f93f78e2ace7a;hb=383965c54b667bba902d92d86b9eef4f3fa1810f;hp=d7de16fd944949dcc80fd39d1e0e5ae46e5070c1;hpb=d2a22d5dfa784f062c66fc06571f6d898dd6a8b4;p=pazpar2-moved-to-github.git
diff --git a/doc/pazpar2_conf.xml b/doc/pazpar2_conf.xml
index d7de16f..cbad09d 100644
--- a/doc/pazpar2_conf.xml
+++ b/doc/pazpar2_conf.xml
@@ -268,7 +268,7 @@
M [F N]
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).
+ See for more
+ about ranking.
@@ -585,18 +587,85 @@
rank
- 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 average 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:
+
+
+ cluster
+
+
+ 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.
+
+
+
+
+ debug
+
+
+ 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).
+
+
+
+
+ follow
+
+
+ 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).
+
+
+
+
+ lead
+
+
+ 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).
+
+
+
+
+ length
+
+
+ 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".
+
+
+
+
- This configuration was added in pazpar2 1.6.18.
+ Refer to to see how
+ these tweaks are used in computation of score.
+
+
+ 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.21.
-
+
sort-default