X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fpazpar2_conf.xml;h=86dbdc8a7cac68a4f3816bba29d860b327b17879;hb=85b1f355522cc620452552d76fd517f089c98ab2;hp=a7dc4003cac3d05b42008e8bc791a1172987714c;hpb=9e8d657340483f6af7169828917da385f8e6ee9f;p=pazpar2-moved-to-github.git
diff --git a/doc/pazpar2_conf.xml b/doc/pazpar2_conf.xml
index a7dc400..86dbdc8 100644
--- a/doc/pazpar2_conf.xml
+++ b/doc/pazpar2_conf.xml
@@ -73,6 +73,16 @@
in main thread).
+
+ file
+
+ This configuration takes one attribute path which
+ specifies a path to search for local files, such as XSLTs and settings.
+ The path is a colon separated list of directories. Its default value
+ is "." which is equivalent to the location of the
+ main configuration file (where indeed the file element is given).
+
+ server
@@ -252,6 +262,11 @@
articles), and 'no' (no sorting). The default value is
'no'.
+
+ When 'skiparticle' is used, some common articles from the
+ English and German languages are ignored. At present the
+ list is: 'the', 'den', 'der', 'die', 'des', 'an', 'a'.
+
@@ -406,6 +421,29 @@
+ icurule
+
+
+ Specifies the ICU rule set to be used for normalizing
+ metadata text. The "display" part of the rule is kept
+ in the returned metadata record (record+show commands), the
+ end result - normalized text - is used for performing
+ within-cluster merge (unique, longest, etc). If the icurule is
+ omitted, type generic (text) is converted as follows:
+ any of the characters " ,/.:([" are
+ chopped of prefix and suffix of text content
+ unless it includes the
+ characters "://" (URL).
+
+
+
+ Requires Pazpar2 1.9.0 or later.
+
+
+
+
+
+ setting
@@ -606,7 +644,7 @@
-
+ rank
@@ -730,7 +768,7 @@
-
+ timeout
@@ -751,6 +789,10 @@
z3950_operation (30) < session (60) < z3950_session (180) .
The default values are given in parantheses.
+
+ The Z39.50 operation timeout may be set per database. Refer to
+ .
+
@@ -774,6 +816,7 @@
+
@@ -1102,151 +1145,29 @@
-
- pz:cclmap:xxx
-
-
- This establishes a CCL field definition or other setting, for
- the purpose of mapping end-user queries. XXX is the field or
- setting name, and the value of the setting provides parameters
- (e.g. parameters to send to the server, etc.). Please consult
- the YAZ manual for a full overview of the many capabilities of
- the powerful and flexible CCL parser.
-
-
- Note that it is easy to establish a set of default parameters,
- and then override them individually for a given target.
-
-
-
-
- pz:requestsyntax
-
-
- This specifies the record syntax to use when requesting
- records from a given server. The value can be a symbolic name like
- marc21 or xml, or it can be a Z39.50-style dot-separated OID.
-
-
-
-
- pz:elements
-
-
- The element set name to be used when retrieving records from a
- server.
-
-
-
-
- pz:piggyback
-
-
- Piggybacking enables the server to retrieve records from the
- server as part of the search response in Z39.50. Almost all
- servers support this (or fail it gracefully), but a few
- servers will produce undesirable results.
- Set to '1' to enable piggybacking, '0' to disable it. Default
- is 1 (piggybacking enabled).
-
-
-
-
- pz:nativesyntax
-
-
- Specifies how Pazpar2 shoule map retrieved records to XML. Currently
- supported values are xml,
- iso2709 and txml.
-
-
- The value iso2709 makes Pazpar2 convert retrieved
- MARC records to MARCXML. In order to convert to XML, the exact
- chacater set of the MARC must be known (if not, the resulting
- XML is probably not well-formed). The character set may be
- specified by adding:
- ;charset=charset to
- iso2709. If omitted, a charset of
- MARC-8 is assumed. This is correct for most MARC21/USMARC records.
-
-
- The value txml is like iso2709
- except that records are converted to TurboMARC instead of MARCXML.
-
-
- The value xml is used if Pazpar2 retrieves
- records that are already XML (no conversion takes place).
-
-
-
- pz:queryencoding
+ pz:allow
- The encoding of the search terms that a target accepts. Most
- targets do not honor UTF-8 in which case this needs to be specified.
- Each term in a query will be converted if this setting is given.
+ Allows or denies access to the resources it is applied to. Possible
+ values are '0' and '1'.
+ The default is '1' (allow access to this resource).
- pz:negotiation_charset
+ pz:apdulog
- Sets character set for Z39.50 negotiation. Most targets do not support
- this, and some will even close connection if set (crash on server
- side or similar). If set, you probably want to set it to
- UTF-8.
+ If the 'pz:apdulog' setting is defined and has other value than 0,
+ then Z39.50 APDUs are written to the log.
- pz:xslt
-
-
- 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).
-
-
- The special value "auto" will use a file
- which is the pz:requestsyntax's
- value followed by
- '.xsl'.
-
-
- When mapping MARC records, XSLT can be bypassed for increased
- performance with the alternate "MARC map" format. Provide the
- path of a file with extension ".mmap" containing on each line:
-
- <field> <subfield> <metadata element>
- For example:
-
- 245 a title
- 500 $ description
- 773 * citation
-
- To map the field value specify a subfield of '$'. To store a
- concatenation of all subfields, specify a subfield of '*'.
-
-
-
- pz:authentication
@@ -1282,25 +1203,45 @@
+
- pz:allow
+ pz:block_timeout
- Allows or denies access to the resources it is applied to. Possible
- values are '0' and '1'.
- The default is '1' (allow access to this resource).
+ (Not yet implemented).
+ Specifies the time for which a block should be released anyway.
+
- pz:maxrecs
+ pz:cclmap:xxx
- Controls the maximum number of records to be retrieved from a
- server. The default is 100.
+ This establishes a CCL field definition or other setting, for
+ the purpose of mapping end-user queries. XXX is the field or
+ setting name, and the value of the setting provides parameters
+ (e.g. parameters to send to the server, etc.). Please consult
+ the YAZ manual for a full overview of the many capabilities of
+ the powerful and flexible CCL parser.
+
+
+ Note that it is easy to establish a set of default parameters,
+ and then override them individually for a given target.
+
+
+
+
+
+ pz:elements
+
+
+ The element set name to be used when retrieving records from a
+ server.
+
pz:extendrecs
@@ -1321,15 +1262,24 @@
+
- pz:presentchunk
+ pz:facetmap:name
- Controls the chunk size in present requests. Pazpar2 will
- make (maxrecs / chunk) request(s). The default is 20.
+ Specifies that for field name, the target
+ supports (native) facets. The value is the name of the
+ field on the target.
+
+
+ At this point only Solr targets have been tested with this
+ facility.
+
+
+
pz:id
@@ -1341,60 +1291,143 @@
+
+
+ pz:limitmap:name
+
+
+ Specifies attributes for limiting a search to a field - using
+ 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 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).
+
+
+ For Pazpar2 version 1.6.23 and later the limitmap may include multiple
+ specifications, separated by , (comma).
+ For example:
+ ccl:title,local:ltitle,rpn:@attr 1=4.
+
+
+
+ The limitmap facility is supported for Pazpar2 version 1.6.0.
+ Local filtering is supported in Pazpar2 1.6.6.
+
+
+
+
+
- pz:zproxy
+ pz:maxrecs
- The 'pz:zproxy' setting has the value syntax
- 'host.internet.adress:port', it is used to tunnel Z39.50
- requests through the named Z39.50 proxy.
+ Controls the maximum number of records to be retrieved from a
+ server. The default is 100.
- pz:apdulog
+ pz:memcached
- If the 'pz:apdulog' setting is defined and has other value than 0,
- then Z39.50 APDUs are written to the log.
+ If set and non-empty,
+ libMemcached will
+ configured and enabled for the target.
+ The value of this setting is same as the ZOOM option
+ memcached, which in turn is the configuration
+ string passed to the memcached function
+ of libMemcached.
+
+
+ This setting is honored in Pazpar2 1.6.39 or later. Pazpar2 must
+ be using YAZ version 5.0.13 or later.
- pz:sru
+ pz:redis
- This setting enables
- SRU/Solr
- support.
- It has four possible settings.
- 'get', enables SRU access through GET requests. 'post' enables SRU/POST
- support, less commonly supported, but useful if very large requests are
- to be submitted. 'soap' enables the SRW (SRU over SOAP) variation of
- the protocol.
+ If set and non-empty,
+ redis will
+ configured and enabled for the target.
+ The value of this setting is exactly as the redis option for
+ ZOOM C of YAZ.
- A value of 'solr' enables Solr client support. This is supported
- for Pazpar version 1.5.0 and later.
+ This setting is honored in Pazpar2 1.6.43 or later. Pazpar2 must
+ be using YAZ version 5.2.0 or later.
- pz:sru_version
+ pz:nativesyntax
- 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 and 3.x.
+ Specifies how Pazpar2 shoule map retrieved records to XML. Currently
+ supported values are xml,
+ iso2709 and txml.
+
+
+ The value iso2709 makes Pazpar2 convert retrieved
+ MARC records to MARCXML. In order to convert to XML, the exact
+ chacater set of the MARC must be known (if not, the resulting
+ XML is probably not well-formed). The character set may be
+ specified by adding:
+ ;charset to
+ iso2709. If omitted, a charset of
+ MARC-8 is assumed. This is correct for most MARC21/USMARC records.
+
+
+ The value txml is like iso2709
+ except that records are converted to TurboMARC instead of MARCXML.
+
+
+ The value xml is used if Pazpar2 retrieves
+ records that are already XML (no conversion takes place).
+
+
+
+
+
+ pz:negotiation_charset
+
+
+ Sets character set for Z39.50 negotiation. Most targets do not support
+ this, and some will even close connection if set (crash on server
+ side or similar). If set, you probably want to set it to
+ UTF-8.
+ pz:piggyback
+
+
+ Piggybacking enables the server to retrieve records from the
+ server as part of the search response in Z39.50. Almost all
+ servers support this (or fail it gracefully), but a few
+ servers will produce undesirable results.
+ Set to '1' to enable piggybacking, '0' to disable it. Default
+ is 1 (piggybacking enabled).
+
+
+
+ pz:pqf_prefix
@@ -1437,11 +1470,36 @@
- pz:sort
+ pz:preferred
- Specifies sort criteria to be applied to the result set.
- Only works for targets which support the sort service.
+ Specifies that a target is preferred, e.g. possible local, faster
+ target. Using block=preferred on
+ show command will wait for all these
+ targets to return records before releasing the block.
+ If no target is preferred, the block=preferred will identical to
+ block=1, which release when one target has returned records.
+
+
+
+
+
+ pz:present_chunk
+
+
+ Controls the chunk size in present requests. Pazpar2 will
+ make (maxrecs / chunk) request(s). The default is 20.
+
+
+
+
+
+ pz:queryencoding
+
+
+ The encoding of the search terms that a target accepts. Most
+ targets do not honor UTF-8 in which case this needs to be specified.
+ Each term in a query will be converted if this setting is given.
@@ -1462,27 +1520,80 @@
+
+ pz:requestsyntax
+
+
+ This specifies the record syntax to use when requesting
+ records from a given server. The value can be a symbolic name like
+ marc21 or xml, or it can be a Z39.50-style dot-separated OID.
+
+
+
+
- pz:preferred
+ pz:sort
- Specifies that a target is preferred, e.g. possible local, faster
- target. Using block=pref on show command will wait for all these
- targets to return records before releasing the block.
- If no target is preferred, the block=pref will identical to block=1,
- which release when one target has returned records.
+ Specifies sort criteria to be applied to the result set.
+ Only works for targets which support the sort service.
+
+
+
+
+
+ pz:sortmap:field
+
+
+ Specifies native sorting for a target where
+ field is a sort criterion (see command
+ show). The value has two components separated by a 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.
+
+
+
- pz:block_timeout
+ pz:sru
- (Not yet implemented).
- Specifies the time for which a block should be released anyway.
+ This setting enables
+ SRU/Solr
+ support.
+ It has four possible settings.
+ 'get', enables SRU access through GET requests. 'post' enables SRU/POST
+ support, less commonly supported, but useful if very large requests are
+ to be submitted. 'soap' enables the SRW (SRU over SOAP) variation of
+ the protocol.
+
+
+ A value of 'solr' enables Solr client support. This is supported
+ for Pazpar version 1.5.0 and later.
+
+
+
+
+
+ pz:sru_version
+
+
+ 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 and 3.x.
+
pz:termlist_term_count
@@ -1492,6 +1603,7 @@
+
pz:termlist_term_factor
@@ -1510,53 +1622,18 @@
-
- pz:facetmap:name
-
-
- Specifies that for field name, the target
- supports (native) facets. The value is the name of the
- field on the target.
-
-
-
- At this point only Solr targets have been tested with this
- facility.
-
-
-
-
-
- pz:limitmap:name
+
+ pz:timeout
- Specifies attributes for limiting a search to a field - using
- 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 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).
-
-
- For Pazpar2 version 1.6.23 and later the limitmap may include multiple
- specifications, separated by , (comma).
- For example:
- ccl:title,local:ltitle,rpn:@attr 1=4.
+ Specifies timeout for operation (eg search, and fetch) for
+ a database. This overrides the z3650_operation timeout
+ that is given for a service. See .
- The limitmap facility is supported for Pazpar2 version 1.6.0.
- Local filtering is supported in Pazpar2 1.6.6.
+ The timeout facility is supported for Pazpar2 version 1.8.4 and later.
@@ -1577,29 +1654,62 @@
-
- pz:sortmap:field
+
+ pz:xslt
- 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.
+ 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).
+
+
+ The special value "auto" will use a file
+ which is the pz:requestsyntax's
+ value followed by
+ '.xsl'.
+
+
+ When mapping MARC records, XSLT can be bypassed for increased
+ performance with the alternate "MARC map" format. Provide the
+ path of a file with extension ".mmap" containing on each line:
+
+ <field> <subfield> <metadata element>
+ For example:
+
+ 245 a title
+ 500 $ description
+ 773 * citation
+
+ To map the field value specify a subfield of '$'. To store a
+ concatenation of all subfields, specify a subfield of '*'.
-
-
- Only supported for Pazpar2 1.6.4 and later.
-
-
-
+
+ pz:zproxy
+
+
+ The 'pz:zproxy' setting has the value syntax
+ 'host.internet.adress:port', it is used to tunnel Z39.50
+ requests through the named Z39.50 proxy.
+
+
+
+