X-Git-Url: http://lists.indexdata.com/cgi-bin?a=blobdiff_plain;f=doc%2Fpazpar2_conf.xml;h=cbad09d6575c7543cd4a529daa5f93f78e2ace7a;hb=383965c54b667bba902d92d86b9eef4f3fa1810f;hp=e558c65d954ba87207c64cf971dc6844fd5e2663;hpb=14830963a2f89b0ce47d4b9d9549ce6a1aae3e5e;p=pazpar2-moved-to-github.git
diff --git a/doc/pazpar2_conf.xml b/doc/pazpar2_conf.xml
index e558c65..cbad09d 100644
--- a/doc/pazpar2_conf.xml
+++ b/doc/pazpar2_conf.xml
@@ -262,13 +262,35 @@
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
- multiplier against the basic TF*IDF score. A value of
- 1 is the base, higher values give additional
- weight to
+ requested).
+ The valus is of the form
+
+ M [F N]
+
+ where M is an integer, used as a
+ 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.
+
+ 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).
+
+ See for more
+ about ranking.
@@ -339,6 +361,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
@@ -369,6 +413,20 @@
+ xslt
+
+
+ Defines a XSLT stylesheet. The xslt
+ element takes exactly one attribute id
+ which names the stylesheet. This can be referred to in target
+ settings .
+
+
+ The content of the xslt element is the embedded stylesheet XML
+
+
+
+
icu_chain
@@ -507,7 +565,138 @@
+
+
+ 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. 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".
+
+
+
+
+
+ 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
+
+
+ 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
@@ -569,7 +758,7 @@
type="year" merge="range" termlist="yes"/>
-
+
@@ -991,13 +1180,21 @@
- pz:xslt
+ pz:xslt
- Is a comma separated list of of files that specifies
+ Is a comma separated list of of stylesheet names that specifies
how to convert incoming records to the internal representation.
+ For each name, the embedded stylesheets (XSL) that comes with the
+ service definition are consulted first and takes precedence over
+ external files; see
+ of service definition).
+ If the name does not match an embedded stylesheet it is
+ considered a filename.
+
+
The suffix of each file specifies the kind of tranformation.
Suffix ".xsl" makes an XSL transform. Suffix
".mmap" will use the MMAP transform (described below).
@@ -1056,6 +1253,15 @@
+ pz:presentchunk
+
+
+ Controls the chunk size in present requests. Pazpar2 will
+ make (maxrecs / chunk) request(s). The default is 20.
+
+
+
+
pz:id
@@ -1092,7 +1298,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
@@ -1101,7 +1307,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.
@@ -1113,7 +1319,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.
@@ -1123,7 +1329,7 @@
Allows you to specify an arbitrary PQF query language substring.
- The provided string is prefixed the user's query after it has been
+ The provided string is prefixed to the user's query after it has been
normalized to PQF internally in pazpar2.
This allows you to attach complex 'filters' to queries for a given
target, sometimes necessary to select sub-catalogs
@@ -1146,6 +1352,17 @@
@and @attr 1=30 @attr 2=3 %Y %%
would search for current year combined with the original PQF (%%).
+
+ This setting can also be used as more general alternative to
+ pz:pqf_prefix -- a way of embedding the submitted query
+ anywhere in the string rather than appending it to prefix. For
+ example, if it is desired to omit all records satisfying the
+ query @attr 1=pica.bib 0007 then this
+ subquery can be combined with the submitted query as the second
+ argument of @andnot by using the
+ pz:pqf_strftime value @not %% @attr 1=pica.bib
+ 0007.
+
@@ -1187,7 +1404,6 @@
-
pz:block_timeout
@@ -1197,6 +1413,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
@@ -1208,7 +1447,7 @@
- At this point only SOLR targets have been tested with this
+ At this point only Solr targets have been tested with this
facility.
@@ -1220,20 +1459,25 @@
Specifies attributes for limiting a search to a field - using
- the limit parameter for search. In some cases the mapping of
+ the limit parameter for search. It can be used to filter locally
+ or remotely (search in a target). In some cases the mapping of
a field to a value is identical to an existing cclmap field; in
other cases the field must be specified in a different way - for
example to match a complete field (rather than parts of a subfield).
- The value of limitmap may have one of two forms: referral to
- an exisiting CCL field or a raw PQF string. Leading string
- determines type; either ccl: for CCL field or
- rpn: for PQF/RPN.
+ The value of limitmap may have one of three forms: referral to
+ an existing CCL field, a raw PQF string or a local limit. Leading string
+ determines type; either ccl: for CCL field,
+ rpn: for PQF/RPN, or local:
+ for filtering in Pazpar2. The local filtering may be followed
+ by a field a metadata field (default is to use the name of the
+ limitmap itself).
The limitmap facility is supported for Pazpar2 version 1.6.0.
+ Local filtering is supported in Pazpar2 1.6.6.