<!ENTITY % common SYSTEM "common/common.ent">
%common;
]>
-<!-- $Id: pazpar2_conf.xml,v 1.11 2007-03-30 01:07:37 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>
<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>
</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>
</listitem>
</varlistentry>
<varlistentry>
- <term>pz:syntax</term>
+ <term>pz:requestsyntax</term>
<listitem>
<para>
This specifies the record syntax to use when requesting
- records from a given server.
+ 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>
</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>
projects / pazpar2-moved-to-github.git / blobdiff