X-Git-Url: http://lists.indexdata.com/cgi-bin?a=blobdiff_plain;f=doc%2Fpazpar2_conf.xml;h=8ae9b97cc8ff480587419a6e758366676e4a0632;hb=022710cf16caff9ab16cf3375e222f335b4e4327;hp=1f7501ed7b9c47423e20f239566f0e339ea4f0ba;hpb=5bb55be401f739bf7405a6cb04528e3bc9f93b5f;p=pazpar2-moved-to-github.git
diff --git a/doc/pazpar2_conf.xml b/doc/pazpar2_conf.xml
index 1f7501e..8ae9b97 100644
--- a/doc/pazpar2_conf.xml
+++ b/doc/pazpar2_conf.xml
@@ -15,7 +15,7 @@
&version;
Index Data
-
+
Pazpar2 conf
5
@@ -33,7 +33,8 @@
- DESCRIPTION
+
+ DESCRIPTION
The Pazpar2 configuration file, together with any referenced XSLT files,
govern Pazpar2's behavior as a client, and control the normalization and
@@ -49,7 +50,8 @@
- FORMAT
+
+ FORMAT
The configuration file is XML-structured. It must be well-formed XML. All
elements specific to Pazpar2 should belong to the namespace
@@ -60,24 +62,27 @@
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).
-
+
+ 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
+
+ server
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
+
+ The data
elements are described below. From Pazpar2 version 1.2 this is
a repeatable element.
@@ -119,7 +124,7 @@
-
+
relevance / sort / mergekey / facet
@@ -169,19 +174,21 @@
- metadata
+
+ metadata
One of these elements is required for every data element in
the internal representation of the record (see
. It governs
- subsequent processing as pertains to sorting, relevance
- ranking, merging, and display of data elements. It supports
- the following attributes:
+ subsequent processing as pertains to sorting, relevance
+ ranking, merging, and display of data elements. It supports
+ the following attributes:
- name
+
+ name
This is the name of the data element. It is matched
@@ -199,7 +206,8 @@
- type
+
+ type
The type of data element. This value governs any
@@ -212,7 +220,8 @@
- brief
+
+ brief
If this is set to 'yes', then the data element is
@@ -223,7 +232,8 @@
- sortkey
+
+ sortkey
Specifies that this data element is to be used for
@@ -235,7 +245,8 @@
- rank
+
+ rank
Specifies that this element is to be used to
@@ -251,7 +262,8 @@
- termlist
+
+ termlist
Specifies that this element is to be used as a
@@ -265,7 +277,8 @@
- merge
+
+ merge
This governs whether, and how elements are extracted
@@ -279,8 +292,9 @@
-
- mergekey
+
+
+ mergekey
If set to 'required', the value of this
@@ -302,8 +316,9 @@
-
- setting
+
+
+ setting
This attribute allows you to make use of static database
@@ -347,7 +362,8 @@
in order from top to bottom.
- casemap
+
+ casemap
The attribute 'rule' defines the direction of the
@@ -356,7 +372,8 @@
- transform
+
+ transform
Normalization and transformation of tokens follows
@@ -364,14 +381,15 @@
possible values we refer to the extensive ICU
documentation found at the
ICU
- transformation home page. Set filtering
+ transformation home page. Set filtering
principles are explained at the
ICU set and
- filtering page.
+ filtering page.
- tokenize
+
+ tokenize
Tokenization is the only rule in the ICU chain
@@ -424,7 +442,7 @@
-
+
settings
@@ -458,68 +476,71 @@
-
-
-
-
- EXAMPLE
- Below is a working example configuration:
-
-
-
-
-
-
-
-
+ EXAMPLE
+
+ Below is a working example configuration:
+
+
+
+
+
+
+
+
+
+
-
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- ]]>
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ]]>
+
- INCLUDE FACILITY
+
+ INCLUDE FACILITY
The XML configuration may be partitioned into multiple files by using
the include element which takes a single attribute,
src. The of the src attribute is
regular Shell like glob-pattern. For example,
- ]]>
+
+ ]]>
The include facility requires Pazpar2 version 1.2.
- TARGET SETTINGS
+
+ TARGET SETTINGS
Pazpar2 features a cunning scheme by which you can associate various
kinds of attributes, or settings with search targets. This can be done
@@ -566,7 +587,7 @@
on a per-session basis. This allows the client to override specific CCL fields
for searching, etc., to meet the needs of a session or user.
-
+
Finally, as an extreme case of this, the webservice client can
introduce entirely new targets, on the fly, as part of the
@@ -578,7 +599,7 @@
long as the webservice client is prepared to supply the necessary
information at the beginning of every session.
-
+
The following discussion of practical issues related to session and settings
@@ -586,7 +607,7 @@
technology. It would apply equally well to many other kinds of browser-based logic.
-
+
Typically, a Javascript client is not allowed to directly alter the parameters
of a session. There are two reasons for this. One has to do with access
@@ -598,37 +619,38 @@
webserver. Typically, this can be handled during the session initialization,
as follows:
-
+
Step 1: The Javascript client loads, and asks the webserver for a new Pazpar2
session ID. This can be done using a Javascript call, for instance. Note that
it is possible to submit Ajax HTTPXmlRequest calls either to Pazpar2 or to the
webserver that Pazpar2 is proxying for. See (XXX Insert link to Pazpar2 protocol).
-
-
+
+
Step 2: Code on the webserver authenticates the user, by database lookup,
LDAP access, NCIP, etc. Determines which resources the user has access to,
and any user-specific parameters that are to be applied during this session.
-
+
Step 3: The webserver initializes a new Pazpar2 settings, and sets user-specific
parameters as necessary, using the init webservice command. A new session ID is
returned.
-
+
Step 4: The webserver returns this session ID to the Javascript client, which then
uses the session ID to submit searches, show results, etc.
-
+
Step 5: When the Javascript client ceases to use the session, Pazpar2 destroys
any session-specific information.
- SETTINGS FILE FORMAT
+
+ SETTINGS FILE FORMAT
Each file contains a root element named <settings>. It may
contain one or more <set> elements. The settings and set
@@ -637,7 +659,7 @@
specify (directly, or inherited from the parent node) at least a
target, name, and value.
-
+
target
@@ -700,7 +722,7 @@
-
+
By setting defaults for target, name, or value in the root
settings node, you can use the settings files in many different
@@ -712,80 +734,84 @@
many databases with a given category or class that makes sense
within your application.
-
+
The following examples illustrate uses of the settings system to
associate settings with targets to meet different requirements.
-
+
The example below associates a set of default values that can be
used across many targets. Note the wildcard for targets.
This associates the given settings with all targets for which no
other information is provided.
+
-
+
-
-
+
+
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
-
+
-
-
+
+
-
-
+
+
-
+
-
-
+
+
-
+
- ]]>
+ ]]>
-
+
The next example shows certain settings overridden for one target,
one which returns XML records containing DublinCore elements, and
which furthermore requires a username/password.
-
-
-
+
+
+
+
-
-
- ]]>
+
+
+ ]]>
-
+
The following example associates a specific name/value combination
with a number of targets. The targets below are access-restricted,
and can only be used by users with special credentials.
-
-
-
- ]]>
+
+
+
+
+ ]]>
-
+
-
- RESERVED SETTING NAMES
+
+
+ RESERVED SETTING NAMES
The following setting names are reserved by Pazpar2 to control the
behavior of the client function.
@@ -874,9 +900,9 @@
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.
+ 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.
@@ -916,12 +942,13 @@
performance with the alternate "MARC map" format. Provide the
path of a file with extension ".mmap" containing on each line:
- <field> <subfield> <metadata element>
+ <field> <subfield> <metadata element>
For example:
- 245 a title
- 500 $ description
- 773 * citation
+ 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 '*'.
@@ -941,9 +968,10 @@
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).
- See the manual section on authorization and authentication for discussion
- about how to use this setting.
+ values are '0' and '1'.
+ The default is '1' (allow access to this resource).
+ See the manual section on authorization and authentication for
+ discussion about how to use this setting.
@@ -1002,8 +1030,8 @@
the protocol.
- A value of 'solr' anables SOLR client support. This is supported
- for Pazpar version 1.5.0 and later.
+ A value of 'solr' anables SOLR client support. This is supported
+ for Pazpar version 1.5.0 and later.
@@ -1069,58 +1097,80 @@
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, or matches exactly (=value). If value is omitted all records
- with the named
+ with the named
metadata element present will be included.
- pz:termlist_term_count
+ pz:preferred
- 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.
+ 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:termlist_term_sort
+ pz:block_timeout
- Specifies how the terms should be sorted. (Not yet implemented)
+ (Not yet implemented). Specifies the time for which a block should be released anyway.
- pz:preferred
+ pz:facetmap:name
- 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 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:block_timeout
+ pz:limitmap:name
- (Not yet implemented). Specifies the time for which a block should be released anyway.
+ Specifies attributes for limiting a search to a field - using
+ the limit parameter for search. 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 limitmap facility is supported for Pazpar2 version 1.6.0.
+
+
-
+
- SEE ALSO
+
+ SEE ALSO
pazpar2
@@ -1139,15 +1189,7 @@