X-Git-Url: http://jsfdemo.indexdata.com/?a=blobdiff_plain;f=doc%2Fpazpar2_conf.xml;h=6eb2032927b289f36ceaad8556f72c5e7376d36d;hb=88c23b56ed1d235c3a3706161233891aded6861d;hp=6b36345f311741b3e46dbf550ef72bfb9b28bfb8;hpb=3438d21c3c7142e236af05139f799a71440eeee3;p=pazpar2-moved-to-github.git
diff --git a/doc/pazpar2_conf.xml b/doc/pazpar2_conf.xml
index 6b36345..6eb2032 100644
--- a/doc/pazpar2_conf.xml
+++ b/doc/pazpar2_conf.xml
@@ -133,7 +133,7 @@
mergekey and facets - for the server. These definitions serves as
default for services that don't have these given. For the meaning
of these settings refer to the
- "icu_chain" element inside service.
+ element inside service.
@@ -269,6 +269,10 @@
elements of this type. The default is '0', which
excludes this element from the rank calculation.
+
+ For Pazpar2 1.6.13 and later, the rank may also defined
+ "per-document", by the normalization stylesheet.
+
@@ -326,6 +330,39 @@
+
+
+ facetrule
+
+
+ Specifies the ICU rule set to be used for normalizing
+ facets. If facetrule is omitted from metadata, the
+ rule set 'facet' is used.
+
+
+
+
+
+ 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
@@ -358,7 +395,21 @@
- icu_chain
+ 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
Specifies a named ICU rule set. The icu_chain element must include
@@ -368,8 +419,10 @@
Rule set 'relevance' is used to normalize
terms for relevance ranking. Rule set 'sort' is used to
normalize terms for sorting. Rule set 'mergekey' is used to
- normalize terms for making a mergekey and, finally, 'facet'
- is used to normalize facet terms (AKA termlists).
+ normalize terms for making a mergekey and, finally. Rule set 'facet'
+ is normally used to normalize facet terms, unless
+ facetrule is given for a
+ metadata field.
The icu_chain element must also include a 'locale'
@@ -496,6 +549,18 @@
+ set
+
+
+ Specifies a variable that will be inherited by all targets defined in settings
+
+ <set name="test" value="en"..<set>
+
+
+
+
+
+
settings
@@ -556,7 +621,7 @@
type="year" merge="range" termlist="yes"/>
-
+
@@ -737,6 +802,11 @@
multiple overlapping settings with the same name and target
value, the 'precedence' attribute determines what happens.
+
+ For Pazpar2 1.6.4 or later, the target ID may be user-defined, in
+ which case, the actual host, port, etc is given by setting
+ .
+
@@ -973,13 +1043,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).
@@ -1038,6 +1116,15 @@
+ pz:presentchunk
+
+
+ Controls the chunk size in present requests. Pazpar2 will
+ make (maxrecs / chunk) request(s). The default is 20.
+
+
+
+
pz:id
@@ -1074,7 +1161,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
@@ -1083,7 +1170,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.
@@ -1095,7 +1182,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.
@@ -1105,7 +1192,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
@@ -1128,6 +1215,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.
+
@@ -1169,7 +1267,6 @@
-
pz:block_timeout
@@ -1179,6 +1276,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
@@ -1190,39 +1310,80 @@
- At this point only SOLR targets have been tested with this
+ At this point only Solr targets have been tested with this
facility.
-
+
pz:limitmap:name
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.
+
+
+
+
+
+
+ pz:url
+
+
+ Specifies URL for the target and overrides the target ID.
+
+
+
+ pz:url is only recognized for
+ Pazpar2 1.6.4 and later.
+
+
+
+
+
+
+ pz:sortmap:field
+
+
+ Specifies native sorting for a target where
+ field is a sort criteria (see command
+ show). The value has to components separated by colon: strategy and
+ native-field. Strategy is one of z3950,
+ type7, cql,
+ sru11, or embed.
+ The second component, native-field, is the field that is recognized
+ by the target.
+
+
+
+ Only supported for Pazpar2 1.6.4 and later.
-
+