<!ENTITY % common SYSTEM "common/common.ent">
%common;
]>
-<!-- $Id: pazpar2_conf.xml,v 1.7 2007-01-26 18:53:55 quinn Exp $ -->
+<!-- $Id: pazpar2_conf.xml,v 1.17 2007-04-11 02:18:04 quinn Exp $ -->
<refentry id="pazpar2_conf">
<refentryinfo>
<productname>Pazpar2</productname>
If this item is given, pazpar2 will forward all incoming HTTP
requests that do not contain the filename 'search.pz2' to the
host and port specified using the 'host' and 'port'
- attributes. This functionality is crucial if you wish to use
+ attributes. The 'myurl' attribute is required, and should provide
+ the base URL of the server. Generally, the HTTP URL for the host
+ specified in the 'listen' parameter. This functionality is
+ crucial if you wish to use
pazpar2 in conjunction with browser-based code (JS, Flash,
applets, etc.) which operates in a security sandbox. Such code
can only connect to the same server from which the enclosing
</varlistentry>
<varlistentry>
+ <term>zproxy</term>
+ <listitem>
+ <para>
+ If this item is given, pazpar2 will send all Z39.50
+ packages through this Z39.50 proxy server.
+ At least one of the 'host' and 'post' attributes is required.
+ The 'host' attribute may contain both host name and port
+ number, seperated by a colon ':', or only the host name.
+ An empty 'host' attribute sets the Z39.50 host address
+ to 'localhost'.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
<term>service</term>
<listitem>
<para>
This nested element controls the behavior of pazpar2 with
respect to your data model. In pazpar2, incoming records are
- normalized, using XSLT, into an internal representation (see
- the <link
- linkend="config-retrievalprofile">retrievalprofile</link> secion.
+ normalized, using XSLT, into an internal representation.
The 'service' section controls the further processing and
extraction of data from the internal representation, primarily
through the 'metdata' sub-element.
</variablelist> <!-- Data elements in server directive -->
</refsect2>
- <refsect2 id="config-queryprofile"><title>queryprofile</title>
- <para>
- At the moment, this directive is ignored; there is one global
- CCL-mapping file which governs the mapping of queries to Z39.50
- type-1. This file is located in etc/default.bib. This will change
- shortly.
- </para>
- </refsect2>
-
- <refsect2 id="config_retrievalprofile"><title>retrievalprofile</title>
- <para>
- Note: In the present version, there is a single retrieval
- profile. However, in a future release, it will be possible to
- associate unique retrieval profiles with different targets, or to
- generate retrieval profiles using XSLT from the ZeeRex description of
- a target.
- </para>
-
- <para>
- The following data elements are recognized for the retrievalprofile
- directive:
- </para>
-
- <variablelist>
- <varlistentry><term>requestsyntax</term>
- <listitem>
- <para>
- This element specifies the request syntax to be used in queries. It only
- makes sense for Z39.50-type targets.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry><term>nativesyntax</term>
- <listitem>
- <para>
- This element specifies the native syntax and encoding of the
- result records. The default is XML. The following attributes
- are defined:
- </para>
- <variablelist>
- <varlistentry><term>name</term>
- <listitem>
- <para>
- The name of the syntax. Currently recognized values are
- 'iso2709' (MARC), and 'xml'.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry><term>format</term>
- <listitem>
- <para>
- The format, or schema, to be expected. Default is
- 'marc21'.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry><term>encoding</term>
- <listitem>
- <para>
- The encoding of the response record. Typical values for
- MARC records are 'marc8' (general MARC-8), 'marc8s'
- (MARC-8, but maps to precomposed UTF-8 characters, more
- suitable for use in web browsers), 'latin1'.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry><term>mapto</term>
- <listitem>
- <para>
- Specifies the flavor of MARCXML to map results to.
- Default is 'marcxml'. 'marcxchange' is also possible, and
- useful for Danish DANMARC records.
- </para>
- </listitem>
- </varlistentry>
- </variablelist> <!-- parameters to nativesyntax directive -->
- </listitem>
- </varlistentry>
- </variablelist> <!-- sub-elements in retrievalprofile -->
- </refsect2>
-
</refsect1>
<refsect1><title>EXAMPLE</title>
<server>
<listen port="9004"/>
- <proxy host="us1.indexdata.com"/>
+ <proxy host="us1.indexdata.com" myurl="us1.indexdata.com"/>
+
+ <!-- <zproxy host="localhost" port="9000"/> -->
+ <!-- <zproxy host="localhost:9000"/> -->
+ <!-- <zproxy port="9000"/> -->
<service>
<metadata name="title" brief="yes" sortkey="skiparticle" merge="longest" rank="6"/>
</service>
</server>
-<queryprofile/> <!-- Like a CCL profile++ . Can optionally refer to XSLT to
- convert ZeeRex into queryprofile. Multiple profiles can exist. -->
-
-<retrievalprofile>
- <requestsyntax>marc21</requestsyntax>
- <nativesyntax name="iso2709" format="marc21" encoding="marc8s" mapto="marcxml"/>
- <map type="xslt" stylesheet="marc21.xsl"/>
-</retrievalprofile>
-
</pazpar2>
]]></screen>
</para>
</refsect1>
+
+ <refsect1><title>TARGET SETTINGS</title>
+ <para>
+ Pazpar2 features a cunning scheme by which you can associate various
+ kinds of attributes, or settings with search targets. This is done
+ through XML files; each file can associate one or more settings
+ with one or more targets. The file format is generic in nature,
+ designed to support a wide range of application requirements. The
+ settings can be purely technical things, like, how to perform a title
+ search against a given target, or it can associate arbitrary name=value
+ pairs with groups of targets -- for instance, if you would like to
+ place all commercial full-text bases in one group for selection
+ purposes, or you would like to control what targets are accessible to a
+ given user.
+ </para>
+
+ <para>
+ During startup, pazpar2 will recursively read a specified directory
+ (can be identified in the pazpar2.cfg file or on the command line), and
+ process any settings files found therein.
+ </para>
+
+ <refsect2><title>SETTINGS FILE FORMAT</title>
+ <para>
+ Each file contains a root element named <settings>. It may
+ contain one or more <set> elements. The settings and set
+ elements may contain the following attributes. Attributes in set
+ overrides those in the setting root element. Each set node must
+ specify (directly, or inherited from the parent node) at least a
+ target, name, and value.
+ </para>
+
+ <variablelist>
+ <varlistentry>
+ <term>target</term>
+ <listitem>
+ <para>
+ This specifies the search target to which this setting should be
+ applied. Targets are identified by their Z39.50 URL, generally
+ including the host, port, and database name, (e.g.
+ bagel.indexdata.com:210/marc). Two wildcard forms are accepted:
+ * (asterisk) matches all known targets;
+ bagel.indexdata.com:210/* matches all known databases on the given
+ host.
+ </para>
+ <para>
+ A precedence system determines what happens if there are
+ overlapping values for the same setting name for the same
+ target. A setting for a specific target name overrides a
+ setting whch specifies target using a wildcard. This makes it
+ easy to set defaults for all targets, and then override them
+ for specific targets or hosts. If there are
+ multiple overlapping settings with the same name and target
+ value, the 'precedence' attribute determines what happens.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>user</term>
+ <listitem>
+ <para>
+ This specifies the user ID to which this setting applies. A
+ given setting may have values for any number of users, or it
+ may have a 'default' value which is applied when no user is
+ specified, or when no user-specific value is available.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>name</term>
+ <listitem>
+ <para>
+ The name of the setting. This can be anything you like.
+ However, pazpar2 reserves a number of setting names for
+ specific purposes, all starting with 'pz:', and it is a good
+ idea to avoid that prefix if you make up your own setting
+ names. See below for a list of reserved variables.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>value</term>
+ <listitem>
+ <para>
+ The value of the setting. Generally, this can be anything you
+ want -- however, some of the reserved settings may expect
+ specific kinds of values.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>precedence</term>
+ <listitem>
+ <para>
+ This should be an integer. If not provided, the default value
+ is 0. If two (or more) settings have the same content for
+ target and name, the precedence value determines the outcome.
+ If both settings have the same precedence value, they are both
+ applied to the target(s). If one has a higher value, then the
+ value of that setting is applied, and the other one is ignored.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ By setting defaults for user, target, name, or value in the root
+ settings node, you can use the settings files in many different
+ ways. For instance, you can use a single file to set defaults for
+ many different settings, like search fields, retrieval syntaxes,
+ etc. You can have one file per server, which groups settings for
+ that server or target. You could also have one file which associates
+ a number of targets with a given setting, for instance, to associate
+ many databases with a given category or class that makes sense
+ within your application.
+ </para>
+
+ </refsect2>
+
+ <refsect2><title>RESERVED SETTING NAMES</title>
+ <para>
+ The following setting names are reserved by pazpar2 to control the
+ behavior of the client function.
+ </para>
+
+ <variablelist>
+ <varlistentry>
+ <term>pz:cclmap:xxx</term>
+ <listitem>
+ <para>
+ 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.
+ </para>
+ <para>
+ Note that it is easy to etablish a set of default parameters,
+ and then override them individually for a given target.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>pz:requestsyntax</term>
+ <listitem>
+ <para>
+ 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.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>pz:elements</term>
+ <listitem>
+ <para>
+ The element set name to be used when retrieving records from a
+ server.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>pz:piggyback</term>
+ <listitem>
+ <para>
+ 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).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>pz:nativesyntax</term>
+ <listitem>
+ <para>
+ The representation of the retrieval records. Currently
+ recognized values are iso2709 and xml.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>pz:encoding</term>
+ <listitem>
+ <para>
+ The native encoding of retrieval records. Can be anything
+ recognized by conv, but typical values are marc8 and latin1.
+ The default is UTF-8.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>pz:xslt</term>
+ <listitem>
+ <para>
+ Provides the path of an XSLT stylesheet which will be used to
+ map incoming records to the internal representation.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>pz:authentication</term>
+ <listitem>
+ <para>
+ Sets an authentication string for a given server. See the section on
+ authorization and authentication for discussion.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>pz:allow</term>
+ <listitem>
+ <para>
+ 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.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>pz:id</term>
+ <listitem>
+ <para>
+ This setting can't be 'set' -- it contains the ID (normally
+ ZURL) for a given target, and is useful for filtering --
+ specifically when you want to select one or more specific
+ targets in the search command.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect2>
+
+ </refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
projects / pazpar2-moved-to-github.git / blobdiff