X-Git-Url: http://lists.indexdata.dk/cgi-bin?a=blobdiff_plain;f=doc%2Fpazpar2_conf.xml;h=dd31569bab6d6e5e6d886161b6ae851bcd507991;hb=29bc82de1fdccea64abe8dec2fd9926aac257cd9;hp=7997c66c3f5c6951f440e26114b8e96b4b5f5362;hpb=46dfee528ed8d8b304918491799e36f112e05cda;p=pazpar2-moved-to-github.git
diff --git a/doc/pazpar2_conf.xml b/doc/pazpar2_conf.xml
index 7997c66..dd31569 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 conf
5
+ 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.
@@ -445,6 +463,7 @@
+
@@ -815,16 +834,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.
- 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 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.
- If pz:nativesyntax is not specified, pazpar2 will attempt to determine
- the value based on the response from the server.
+ 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).
@@ -846,7 +876,8 @@
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, the value is most likely to be "UTF-8".
+ side or similar). If set, you probably want to set it to
+ UTF-8.
@@ -950,10 +981,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.