X-Git-Url: http://jsfdemo.indexdata.com/?a=blobdiff_plain;f=doc%2Fpazpar2_conf.xml;h=1f7501ed7b9c47423e20f239566f0e339ea4f0ba;hb=0df08cf93e60b248e8ec8cf44e3fd7b784e6ef78;hp=b0d9a3beed944c50601387751f31dadba366937a;hpb=c82540c12d0e816a16c652bbfe809bbad5871514;p=pazpar2-moved-to-github.git
diff --git a/doc/pazpar2_conf.xml b/doc/pazpar2_conf.xml
index b0d9a3b..1f7501e 100644
--- a/doc/pazpar2_conf.xml
+++ b/doc/pazpar2_conf.xml
@@ -1,6 +1,6 @@
-
%local;
@@ -13,10 +13,13 @@
Pazpar2&version;
+ Index Data
+
Pazpar2 conf5
+ File formats and conventions
@@ -48,18 +51,33 @@
FORMAT
- The configuration file is XML-structured. It must be valid XML. All
+ The configuration file is XML-structured. It must be well-formed XML. All
elements specific to Pazpar2 should belong to the namespace
http://www.indexdata.com/pazpar2/1.0
(this is assumed in the
- following examples). The root element is named pazpar2.
+ following examples). The root element is named "pazpar2".
Under the root element are a number of elements which group categories of
information. The categories are described below.
+ threads
+
+ This section is optional and is supported for Pazpar2 version 1.3.1 and
+ later . It is identified by element "threads" which
+ may include one attribute "number" which specifies
+ the number of worker-threads that the Pazpar2 instance is to use.
+ A value of 0 (zero) disables worker-threads (all work is carried out
+ in main thread).
+
+ server
- This section governs overall behavior of the server. The data
+ This section governs overall behavior of a server endpoint. It is identified
+ by the element "server" which takes an optional attribute, "id", which
+ identifies this particular Pazpar2 server. Any string value for "id"
+ may be given.
+
+ The data
elements are described below. From Pazpar2 version 1.2 this is
a repeatable element.
@@ -103,11 +121,11 @@
- relevance / sort / mergekey
+ relevance / sort / mergekey / facet
- Specifies character set normalization for relevancy / sorting
- and the mergekey - for the server. These definitions serves as
+ Specifies character set normalization for relevancy / sorting /
+ 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 "relevance" element inside service.
@@ -397,6 +415,17 @@
+ facet
+
+
+ Specifies ICU tokenization and transformation rules
+ for tokens that are used in Pazpar2's facets. The contents
+ is similar to that of relevance.
+
+
+
+
+ settings
@@ -445,6 +474,7 @@
+
@@ -779,7 +809,7 @@
-
+ pz:requestsyntax
@@ -815,16 +845,27 @@
pz:nativesyntax
- The representation (syntax) of the retrieval records. Currently
- recognized values are iso2709 and xml.
+ 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.
- For iso2709, can also specify a native character set, e.g. "iso2709;latin-1".
- If no character set is provided, MARC-8 is assumed.
+ The value txml is like iso2709
+ except that records are converted to TurboMARC instead of MARCXML.
- If pz:nativesyntax is not specified, pazpar2 will attempt to determine
- the value based on the response from the server.
+ The value xml is used if Pazpar2 retrieves
+ records that are already XML (no conversion takes place).
@@ -841,14 +882,37 @@
+ 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:xslt
- Provides the path of an XSLT stylesheet which will be used to
- map incoming records to the internal representation.
+ Is a comma separated list of of files that specifies
+ how to convert incoming records to the internal representation.
+
+
+ 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).
- When mapping MARC XML records, XSLT can be bypassed for increased
+ 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:
@@ -928,10 +992,18 @@
pz:sru
- This setting enables SRU/SRW support. It has three possible settings.
+ 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. 'srw' enables the SRW variation of the protocol.
+ to be submitted. 'srw' enables the SRW (SRU over SOAP) variation of
+ the protocol.
+
+
+ A value of 'solr' anables SOLR client support. This is supported
+ for Pazpar version 1.5.0 and later.
@@ -942,7 +1014,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.
+ to 1.1 or 1.2. For SOLR, the current supported/tested version is 1.4
@@ -962,6 +1034,23 @@
+ pz:pqf_strftime
+
+
+ Allows you to extend a query with dates and operators.
+ The provided string allows certain substitutions and serves as a
+ format string.
+ The special two character sequence '%%' gets converted to the
+ original query. Other characters leading with the percent sign are
+ conversions supported by strftime.
+ All other characters are copied verbatim. For example, the string
+ @and @attr 1=30 @attr 2=3 %Y %%
+ would search for current year combined with the original PQF (%%).
+
+
+
+
+ pz:sort
@@ -977,13 +1066,55 @@
Specifies a filter which allows Pazpar2 to only include
records that meet a certain criteria in a result. Unmatched records
- will be ignored. The filter takes the form name[~value] , which
+ will be ignored. The filter takes the form name, name~value, or name=value, which
will include only records with metadata element (name) that has the
- substring (value) given. If value is omitted all records with the
- metadata present will be included.
+ substring (~value) given, or matches exactly (=value). If value is omitted all records
+ with the named
+ metadata element present will be included.
+
+
+
+
+
+ pz:termlist_term_count
+
+
+ Specifies that the target should return up to n terms for each facets (where termlist="yes"). This implies
+ that the target can return facets on the search command. Requesting facets on targets that doesn't,
+ will return unpredictable or error result.
+
+
+
+
+
+ pz:termlist_term_sort
+
+
+ Specifies how the terms should be sorted. (Not yet implemented)
+
+
+
+
+
+ pz:preferred
+
+
+ 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.
+
+
+ pz:block_timeout
+
+
+ (Not yet implemented). Specifies the time for which a block should be released anyway.
+
+
+
+