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 establish a set of default parameters,
- and then override them individually for a given target.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry id="requestsyntax">
- <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>
- Specifies how Pazpar2 shoule map retrieved records to XML. Currently
- supported values are <literal>xml</literal>,
- <literal>iso2709</literal> and <literal>txml</literal>.
- </para>
- <para>
- The value <literal>iso2709</literal> 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:
- <literal>;</literal><replaceable>charset</replaceable> to
- <literal>iso2709</literal>. If omitted, a charset of
- MARC-8 is assumed. This is correct for most MARC21/USMARC records.
- </para>
- <para>
- The value <literal>txml</literal> is like <literal>iso2709</literal>
- except that records are converted to TurboMARC instead of MARCXML.
- </para>
- <para>
- The value <literal>xml</literal> is used if Pazpar2 retrieves
- records that are already XML (no conversion takes place).
- </para>
- </listitem>
- </varlistentry>
-
<varlistentry>
- <term>pz:queryencoding</term>
+ <term>pz:allow</term>
<listitem>
<para>
- 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.
+ 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).
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>pz:negotiation_charset</term>
+ <term>pz:apdulog</term>
<listitem>
<para>
- 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
- <literal>UTF-8</literal>.
+ If the 'pz:apdulog' setting is defined and has other value than 0,
+ then Z39.50 APDUs are written to the log.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term id="pzxslt" xreflabel="pz:xslt">pz:xslt</term>
- <listitem>
- <para>
- Is a comma separated list of of stylesheet names that specifies
- how to convert incoming records to the internal representation.
- </para>
- <para>
- For each name, the embedded stylesheets (XSL) that comes with the
- service definition are consulted first and takes precedence over
- external files; see <xref linkend="servicexslt"/>
- of service definition).
- If the name does not match an embedded stylesheet it is
- considered a filename.
- </para>
- <para>
- The suffix of each file specifies the kind of tranformation.
- Suffix "<literal>.xsl</literal>" makes an XSL transform. Suffix
- "<literal>.mmap</literal>" will use the MMAP transform (described below).
- </para>
- <para>
- The special value "<literal>auto</literal>" will use a file
- which is the <link linkend="requestsyntax">pz:requestsyntax's</link>
- value followed by
- <literal>'.xsl'</literal>.
- </para>
- <para>
- 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:
- <programlisting>
- <field> <subfield> <metadata element></programlisting>
- For example:
- <programlisting>
- 245 a title
- 500 $ description
- 773 * citation
- </programlisting>
- To map the field value specify a subfield of '$'. To store a
- concatenation of all subfields, specify a subfield of '*'.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
<term>pz:authentication</term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
+
<varlistentry>
- <term>pz:allow</term>
+ <term>pz:block_timeout</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).
+ (Not yet implemented).
+ Specifies the time for which a block should be released anyway.
</para>
</listitem>
</varlistentry>
+
<varlistentry>
- <term>pz:maxrecs</term>
+ <term>pz:cclmap:xxx</term>
<listitem>
<para>
- Controls the maximum number of records to be retrieved from a
- server. The default is 100.
+ 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 establish a set of default parameters,
+ and then override them individually for a given target.
+ </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:extendrecs</term>
<listitem>
</warning>
</listitem>
</varlistentry>
+
<varlistentry>
- <term>pz:presentchunk</term>
+ <term>pz:facetmap:<replaceable>name</replaceable></term>
<listitem>
<para>
- Controls the chunk size in present requests. Pazpar2 will
- make (maxrecs / chunk) request(s). The default is 20.
+ Specifies that for field <replaceable>name</replaceable>, the target
+ supports (native) facets. The value is the name of the
+ field on the target.
</para>
+ <note>
+ <para>
+ At this point only Solr targets have been tested with this
+ facility.
+ </para>
+ </note>
</listitem>
</varlistentry>
+
<varlistentry>
<term>pz:id</term>
<listitem>
</para>
</listitem>
</varlistentry>
- <varlistentry>
- <term>pz:zproxy</term>
+
+ <varlistentry id="limitmap">
+ <term>pz:limitmap:<replaceable>name</replaceable></term>
<listitem>
<para>
- The 'pz:zproxy' setting has the value syntax
- 'host.internet.adress:port', it is used to tunnel Z39.50
- requests through the named Z39.50 proxy.
+ Specifies attributes for limiting a search to a field - using
+ the limit parameter for search. It can be used to filter locally
+ or remotely (search in a target). 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).
</para>
+ <para>
+ The value of limitmap may have one of three forms: referral to
+ an existing CCL field, a raw PQF string or a local limit. Leading string
+ determines type; either <literal>ccl:</literal> for CCL field,
+ <literal>rpn:</literal> for PQF/RPN, or <literal>local:</literal>
+ for filtering in Pazpar2. The local filtering may be followed
+ by a field a metadata field (default is to use the name of the
+ limitmap itself).
+ </para>
+ <para>
+ For Pazpar2 version 1.6.23 and later the limitmap may include multiple
+ specifications, separated by <literal>,</literal> (comma).
+ For example:
+ <literal>ccl:title,local:ltitle,rpn:@attr 1=4</literal>.
+ </para>
+ <note>
+ <para>
+ The limitmap facility is supported for Pazpar2 version 1.6.0.
+ Local filtering is supported in Pazpar2 1.6.6.
+ </para>
+ </note>
</listitem>
</varlistentry>
<varlistentry>
- <term>pz:apdulog</term>
+ <term>pz:maxrecs</term>
<listitem>
<para>
- If the 'pz:apdulog' setting is defined and has other value than 0,
- then Z39.50 APDUs are written to the log.
+ Controls the maximum number of records to be retrieved from a
+ server. The default is 100.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>pz:sru</term>
+ <term>pz:nativesyntax</term>
<listitem>
<para>
- This setting enables
- <ulink url="&url.sru;">SRU</ulink>/<ulink url="&url.solr;">Solr</ulink>
- 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. 'soap' enables the SRW (SRU over SOAP) variation of
- the protocol.
+ Specifies how Pazpar2 shoule map retrieved records to XML. Currently
+ supported values are <literal>xml</literal>,
+ <literal>iso2709</literal> and <literal>txml</literal>.
</para>
<para>
- A value of 'solr' enables Solr client support. This is supported
- for Pazpar version 1.5.0 and later.
+ The value <literal>iso2709</literal> 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:
+ <literal>;</literal><replaceable>charset</replaceable> to
+ <literal>iso2709</literal>. If omitted, a charset of
+ MARC-8 is assumed. This is correct for most MARC21/USMARC records.
+ </para>
+ <para>
+ The value <literal>txml</literal> is like <literal>iso2709</literal>
+ except that records are converted to TurboMARC instead of MARCXML.
+ </para>
+ <para>
+ The value <literal>xml</literal> is used if Pazpar2 retrieves
+ records that are already XML (no conversion takes place).
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>pz:sru_version</term>
+ <term>pz:negotiation_charset</term>
<listitem>
<para>
- 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. For Solr, the current supported/tested version
- is 1.4 and 3.x.
+ 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
+ <literal>UTF-8</literal>.
</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:pqf_prefix</term>
<listitem>
<para>
</varlistentry>
<varlistentry>
- <term>pz:sort</term>
+ <term>pz:preferred</term>
<listitem>
<para>
- Specifies sort criteria to be applied to the result set.
- Only works for targets which support the sort service.
+ 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.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>pz:presentchunk</term>
+ <listitem>
+ <para>
+ Controls the chunk size in present requests. Pazpar2 will
+ make (maxrecs / chunk) request(s). The default is 20.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>pz:queryencoding</term>
+ <listitem>
+ <para>
+ 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.
</para>
</listitem>
</varlistentry>
</listitem>
</varlistentry>
+ <variablelist>
+ <varlistentry id="requestsyntax">
+ <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:preferred</term>
+ <term>pz:sort</term>
<listitem>
<para>
- 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 sort criteria to be applied to the result set.
+ Only works for targets which support the sort service.
</para>
</listitem>
</varlistentry>
+
+ <varlistentry id="pzsortmap">
+ <term>pz:sortmap:<replaceable>field</replaceable></term>
+ <listitem>
+ <para>
+ Specifies native sorting for a target where
+ <replaceable>field</replaceable> is a sort criteria (see command
+ show). The value has to components separated by colon: strategy and
+ native-field. Strategy is one of <literal>z3950</literal>,
+ <literal>type7</literal>, <literal>cql</literal>,
+ <literal>sru11</literal>, or <literal>embed</literal>.
+ The second component, native-field, is the field that is recognized
+ by the target.
+ </para>
+ <note>
+ <para>
+ Only supported for Pazpar2 1.6.4 and later.
+ </para>
+ </note>
+ </listitem>
+ </varlistentry>
+
<varlistentry>
- <term>pz:block_timeout</term>
+ <term>pz:sru</term>
<listitem>
<para>
- (Not yet implemented).
- Specifies the time for which a block should be released anyway.
+ This setting enables
+ <ulink url="&url.sru;">SRU</ulink>/<ulink url="&url.solr;">Solr</ulink>
+ 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. 'soap' enables the SRW (SRU over SOAP) variation of
+ the protocol.
+ </para>
+ <para>
+ A value of 'solr' enables Solr client support. This is supported
+ for Pazpar version 1.5.0 and later.
</para>
</listitem>
</varlistentry>
+
+ <varlistentry>
+ <term>pz:sru_version</term>
+ <listitem>
+ <para>
+ 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. For Solr, the current supported/tested version
+ is 1.4 and 3.x.
+ </para>
+ </listitem>
+ </varlistentry>
+
<varlistentry>
<term>pz:termlist_term_count</term>
<listitem>
</para>
</listitem>
</varlistentry>
+
<varlistentry>
<term>pz:termlist_term_factor</term>
<listitem>
</listitem>
</varlistentry>
- <varlistentry>
- <term>pz:facetmap:<replaceable>name</replaceable></term>
+ <varlistentry id="pzurl">
+ <term>pz:url</term>
<listitem>
<para>
- Specifies that for field <replaceable>name</replaceable>, the target
- supports (native) facets. The value is the name of the
- field on the target.
+ Specifies URL for the target and overrides the target ID.
</para>
<note>
<para>
- At this point only Solr targets have been tested with this
- facility.
+ <literal>pz:url</literal> is only recognized for
+ Pazpar2 1.6.4 and later.
</para>
</note>
</listitem>
</varlistentry>
- <varlistentry id="limitmap">
- <term>pz:limitmap:<replaceable>name</replaceable></term>
+ <varlistentry>
+ <term id="pzxslt" xreflabel="pz:xslt">pz:xslt</term>
<listitem>
<para>
- Specifies attributes for limiting a search to a field - using
- the limit parameter for search. It can be used to filter locally
- or remotely (search in a target). 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).
+ Is a comma separated list of of stylesheet names that specifies
+ how to convert incoming records to the internal representation.
</para>
<para>
- The value of limitmap may have one of three forms: referral to
- an existing CCL field, a raw PQF string or a local limit. Leading string
- determines type; either <literal>ccl:</literal> for CCL field,
- <literal>rpn:</literal> for PQF/RPN, or <literal>local:</literal>
- for filtering in Pazpar2. The local filtering may be followed
- by a field a metadata field (default is to use the name of the
- limitmap itself).
+ For each name, the embedded stylesheets (XSL) that comes with the
+ service definition are consulted first and takes precedence over
+ external files; see <xref linkend="servicexslt"/>
+ of service definition).
+ If the name does not match an embedded stylesheet it is
+ considered a filename.
</para>
<para>
- For Pazpar2 version 1.6.23 and later the limitmap may include multiple
- specifications, separated by <literal>,</literal> (comma).
- For example:
- <literal>ccl:title,local:ltitle,rpn:@attr 1=4</literal>.
+ The suffix of each file specifies the kind of tranformation.
+ Suffix "<literal>.xsl</literal>" makes an XSL transform. Suffix
+ "<literal>.mmap</literal>" will use the MMAP transform (described below).
</para>
- <note>
- <para>
- The limitmap facility is supported for Pazpar2 version 1.6.0.
- Local filtering is supported in Pazpar2 1.6.6.
- </para>
- </note>
- </listitem>
- </varlistentry>
-
- <varlistentry id="pzurl">
- <term>pz:url</term>
- <listitem>
<para>
- Specifies URL for the target and overrides the target ID.
+ The special value "<literal>auto</literal>" will use a file
+ which is the <link linkend="requestsyntax">pz:requestsyntax's</link>
+ value followed by
+ <literal>'.xsl'</literal>.
+ </para>
+ <para>
+ 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:
+ <programlisting>
+ <field> <subfield> <metadata element></programlisting>
+ For example:
+ <programlisting>
+ 245 a title
+ 500 $ description
+ 773 * citation
+ </programlisting>
+ To map the field value specify a subfield of '$'. To store a
+ concatenation of all subfields, specify a subfield of '*'.
</para>
- <note>
- <para>
- <literal>pz:url</literal> is only recognized for
- Pazpar2 1.6.4 and later.
- </para>
- </note>
</listitem>
</varlistentry>
- <varlistentry id="pzsortmap">
- <term>pz:sortmap:<replaceable>field</replaceable></term>
+ <varlistentry>
+ <term>pz:zproxy</term>
<listitem>
<para>
- Specifies native sorting for a target where
- <replaceable>field</replaceable> is a sort criteria (see command
- show). The value has to components separated by colon: strategy and
- native-field. Strategy is one of <literal>z3950</literal>,
- <literal>type7</literal>, <literal>cql</literal>,
- <literal>sru11</literal>, or <literal>embed</literal>.
- The second component, native-field, is the field that is recognized
- by the target.
+ The 'pz:zproxy' setting has the value syntax
+ 'host.internet.adress:port', it is used to tunnel Z39.50
+ requests through the named Z39.50 proxy.
</para>
- <note>
- <para>
- Only supported for Pazpar2 1.6.4 and later.
- </para>
- </note>
</listitem>
</varlistentry>
</variablelist>
-
</refsect2>
</refsect1>
projects / pazpar2-moved-to-github.git / commitdiff