X-Git-Url: http://lists.indexdata.com/cgi-bin?a=blobdiff_plain;f=doc%2Fpazpar2_conf.xml;h=d7de16fd944949dcc80fd39d1e0e5ae46e5070c1;hb=0393c84c2d2383ec40fe6058325b8b0f5334d16b;hp=f66068e9ac3bd768a00b584e8185a378f80f8911;hpb=687d1431ba75a222ee963d3b9c54efa4ba4f1599;p=pazpar2-moved-to-github.git
diff --git a/doc/pazpar2_conf.xml b/doc/pazpar2_conf.xml
index f66068e..d7de16f 100644
--- a/doc/pazpar2_conf.xml
+++ b/doc/pazpar2_conf.xml
@@ -262,17 +262,33 @@
Specifies that this element is to be used to
help rank
records against the user's query (when ranking is
- requested). The value is an integer, used as a
+ requested).
+ The valus is of the form
+
+ M [F N]
+
+ where M is an integer, used as a
multiplier against the basic TF*IDF score. A value of
- 1 is the base, higher values give additional
- weight to
+ 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.
+ F is a CCL field and N is the multipler for terms
+ that matches those part of the CCL field in search.
+ The F+N combo allows the system to use a different
+ multipler for a certain field. For example, a rank value of
+ "1 au 3" gives a multipler of 3 for
+ all terms part of the au(thor) terms and 1 for everything else.
+
+
For Pazpar2 1.6.13 and later, the rank may also defined
"per-document", by the normalization stylesheet.
+
+ The per field rank was introduced in Pazpar2 1.6.15. Earlier
+ releases only allowed a rank value M (simple integer).
+
@@ -343,6 +359,28 @@
+ limitmap
+
+
+ Specifies a default limitmap for this field. This is to avoid mass
+ configuring of targets. However it is important to review/do this on a per
+ target since it is usually target-specific. See limitmap for format.
+
+
+
+
+
+ facetmap
+
+
+ Specifies a default facetmap for this field. This is to avoid mass
+ configuring of targets. However it is important to review/do this on a per
+ target since it is usually target-specific. See facetmap for format.
+
+
+
+
+
setting
@@ -525,7 +563,71 @@
-
+
+
+ ccldirective
+
+
+ Customizes the CCL parsing (interpretation of query parameter
+ in search).
+ The name and value of the CCL directive is gigen by attributes
+ 'name' and 'value' respectively. Refer to possible list of names
+ in the
+
+ YAZ manual
+ .
+
+
+
+
+
+ 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.
+
+
+ This configuration was added in pazpar2 1.6.18.
+
+
+
+
+
+ sort-default
+
+
+ Specifies the default sort criteria (default 'relevance'),
+ which previous was hard-coded as default criteria in search.
+ This is a fix/work-around to avoid re-searching when using
+ target-based sorting. In order for this to work efficient,
+ the search must also have the sort critera parameter; otherwise
+ pazpar2 will do re-searching on search criteria changes, if
+ changed between search and show command.
+
+
+ This configuration was added in pazpar2 1.6.20.
+
+
+
+
+
settings
@@ -587,7 +689,7 @@
type="year" merge="range" termlist="yes"/>
-
+
@@ -1082,6 +1184,15 @@
+ pz:presentchunk
+
+
+ Controls the chunk size in present requests. Pazpar2 will
+ make (maxrecs / chunk) request(s). The default is 20.
+
+
+
+
pz:id
@@ -1118,7 +1229,7 @@
This setting enables
- SRU/SOLR
+ SRU/Solr
support.
It has four possible settings.
'get', enables SRU access through GET requests. 'post' enables SRU/POST
@@ -1127,7 +1238,7 @@
the protocol.
- A value of 'solr' anables SOLR client support. This is supported
+ A value of 'solr' enables Solr client support. This is supported
for Pazpar version 1.5.0 and later.
@@ -1139,7 +1250,7 @@
This allows SRU version to be specified. If unset Pazpar2
will the default of YAZ (currently 1.2). Should be set
- to 1.1 or 1.2. For SOLR, the current supported/tested version is 1.4
+ to 1.1 or 1.2. For Solr, the current supported/tested version is 1.4 and 3.x.
@@ -1224,7 +1335,6 @@
-
pz:block_timeout
@@ -1234,6 +1344,29 @@
+
+ pz:termlist_term_count
+
+
+ Specifies number of facet terms to be requested from the target.
+ The default is unspecified e.g. server-decided. Also see pz:facetmap.
+
+
+
+
+ pz:termlist_term_factor
+
+
+ Specifies whether to use a factor for pazpar2 generated facets (1) or not (0).
+ When mixing locallly generated (by the downloaded (pz:maxrecs) samples)
+ facet with native (target-generated) facets, the later will dominated the dominate the facet list
+ since they are generated based on the complete result set.
+ By scaling up the facet count using the ratio between total hit count and the sample size,
+ the total facet count can be approximated and thus better compared with native facets.
+ This is not enabled by default.
+
+
+
pz:facetmap:name
@@ -1245,7 +1378,7 @@
- At this point only SOLR targets have been tested with this
+ At this point only Solr targets have been tested with this
facility.