<?xml version="1.0" standalone="no"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
- "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"
+ "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"
[
<!ENTITY % local SYSTEM "local.ent">
%local;
</simpara>
</abstract>
</bookinfo>
-
+
<chapter id="introduction">
<title>Introduction</title>
-
+
<section id="what.pazpar2.is">
<title>What Pazpar2 is</title>
<para>
other <ulink url="&url.xml;">XML</ulink>-structured response format
-- <ulink url="&url.xslt;">XSLT</ulink> is used to normalize and extract
data from retrieval records for display and analysis. It can be used
- against any server which supports the
- <ulink url="&url.z39.50;">Z39.50</ulink>, <ulink url="&url.sru;">SRU/SRW</ulink>
+ against any server which supports the
+ <ulink url="&url.z39.50;">Z39.50</ulink>, <ulink url="&url.sru;">SRU/SRW</ulink>
or <ulink url="&url.solr;">SOLR</ulink> protocol. Proprietary
backend modules can function as connectors between these standard
protocols and any non-standard API, including web-site scraping, to
Greek, Russian, German and French. Pazpar2 uses the ICU
Unicode character conversions, Unicode normalization, case
folding and other fundamental operations needed in
- tokenization, normalization and ranking of records.
+ tokenization, normalization and ranking of records.
</para>
<para>
Compiling, linking, and usage of the ICU libraries is optional,
but strongly recommended for usage in an international
- environment.
+ environment.
</para>
</listitem>
</varlistentry>
For example, if Libxml2/libXSLT libraries
are already installed as development packages, use these.
</para>
-
+
<para>
Ensure that the development libraries and header files are
available on your system before compiling Pazpar2. For installation
</screen>
<para>
The <literal>make install</literal> will install manpages as well as the
- Pazpar2 server, <literal>pazpar2</literal>,
+ Pazpar2 server, <literal>pazpar2</literal>,
in PREFIX<literal>/sbin</literal>.
By default, PREFIX is <literal>/usr/local/</literal> . This can be
changed with configure option <option>--prefix</option>.
</para>
</section>
-
+
<section id="installation.win32">
<title>Installation from source on Windows</title>
<para>
</para>
<para>
The Windows version of Pazpar2 is a console application. It may
- be installed as a Windows Service by adding option
+ be installed as a Windows Service by adding option
<literal>-install</literal> for the pazpar2 program. This will
register Pazpar2 as a service and use the other options provided
in the same invocation. For example:
</screen>
</para>
</section>
-
+
<section id="installation.test1">
<title>Installation of test interfaces</title>
<para>
In this section we show how to make available the set of simple
interfaces that are part of the Pazpar2 source package, and which
- demonstrate some ways to use Pazpar2. (Note that Debian users can
+ demonstrate some ways to use Pazpar2. (Note that Debian users can
save time by just installing the package <literal>pazpar2-test1</literal>.)
</para>
<para>
copy pazpar2.cfg.dist pazpar2.cfg
..\bin\pazpar2 -f pazpar2.cfg
</screen>
- This will start a Pazpar2 listener on port 9004. It will proxy
+ This will start a Pazpar2 listener on port 9004. It will proxy
HTTP requests to port 80 on localhost, which we assume will be the regular
HTTP server on the system. Inspect and modify pazpar2.cfg as needed
if this is to be changed. The pazpar2.cfg file includes settings from the
<para>
The test UIs are located in <literal>www</literal>. Ensure that this
directory is available to the web server by copying
- <literal>www</literal> to the document root,
+ <literal>www</literal> to the document root,
using Apache's <literal>Alias</literal> directive, or
creating a symbolic link: for example, on a Debian or Ubuntu
system with Apache2 installed from the standard package, you might
sudo ln -s `pwd`/www /var/www/pazpar2-demo
</screen>
</para>
-
+
<para>
This makes the test applications visible at
<ulink url="http://localhost/pazpar2-demo/"/>
accessed: <literal>test1</literal>, <literal>test2</literal> and
<literal>jsdemo</literal>
are pure HTML+JavaScript setups, needing no server-side
- intelligence;
+ intelligence;
<literal>demo</literal>
requires PHP on the server.
</para>
</para>
<para>
In order to use Apache as frontend for the interface on port 80
- for public access etc., refer to
+ for public access etc., refer to
<xref linkend="installation.apache2proxy"/>.
</para>
</section>
<ulink url="&url.pazpar2.download.ubuntu;"/>.
</para>
</section>
-
+
<section id="installation.apache2proxy">
<title>Apache 2 Proxy</title>
<para>
- Apache 2 has a
+ Apache 2 has a
<ulink
url="http://httpd.apache.org/docs/2.2/mod/mod_proxy.html">
proxy module
based web service. The Apache 2 proxy must operate in the
<emphasis>Reverse</emphasis> Proxy mode.
</para>
-
+
<para>
On a Debian based Apache 2 system, the relevant modules can
be enabled with:
sudo a2enmod proxy_http proxy_balancer
</screen>
</para>
-
+
<para>
- Traditionally Pazpar2 interprets URL paths with suffix
+ Traditionally Pazpar2 interprets URL paths with suffix
<literal>/search.pz2</literal>.
- The
+ The
<ulink
url="http://httpd.apache.org/docs/2.2/mod/mod_proxy.html#proxypass">
ProxyPass
<screen><![CDATA[
<IfModule mod_proxy.c>
ProxyRequests Off
-
+
<Proxy *>
AddDefaultCharset off
Order deny,allow
Allow from all
</Proxy>
-
+
ProxyPass /myportal/search.pz2 http://localhost:8004/search.pz2
ProxyVia Off
</IfModule>
</para>
</example>
</section>
-
+
</chapter>
-
+
<chapter id="using">
<title>Using Pazpar2</title>
<para>
This chapter provides a general introduction to the use and
- deployment of Pazpar2.
+ deployment of Pazpar2.
</para>
-
+
<section id="architecture">
<title>Pazpar2 and your systems architecture</title>
<para>
with the server from which the enclosing HTML page or object
originated, Pazpar2 is designed so that it can act as a transparent
proxy in front of an existing webserver (see <xref
- linkend="pazpar2_conf"/> for details).
+ linkend="pazpar2_conf"/> for details).
In this mode, all regular
HTTP requests are transparently passed through to your webserver,
while Pazpar2 only intercepts search-related webservice requests.
<!-- ... and so on -->
</record>
]]></screen>
-
+
As you can see, there isn't much to it. There are really only a few
important elements to this file.
</para>
-
+
<para>
Elements should belong to the namespace
<literal>http://www.indexdata.com/pazpar2/1.0</literal>.
The webservice API of Pazpar2 is described in detail in <xref
linkend="pazpar2_protocol"/>.
</para>
-
+
<para>
In brief, you use the 'init' command to create a session, a
temporary workspace which carries information about the current
</para>
<para>
In addition, the ICU tokenization and normalization rules must
- be defined in the master configuration file described in
+ be defined in the master configuration file described in
<xref linkend="config-server"/>.
</para>
</section>
</ulink>
module in your Apache2 installation.
</para>
-
+
<para>
On a Debian based Apache 2 system, the relevant modules can
be enabled with:
could use the following Apache 2 configuration to expose a single
pazpar2 'endpoint' on a standard
(<filename>/pazpar2/search.pz2</filename>) location:
-
+
<screen><![CDATA[
<Proxy *>
AddDefaultCharset off
BalancerMember http://localhost:8007 route=pz4
</Proxy>
- # route is resent in the 'session' param which has the form:
+ # route is resent in the 'session' param which has the form:
# 'sessid.serverid', understandable by the mod_proxy_load_balancer
# this is not going to work if the client tampers with the 'session' param
ProxyPass /pazpar2/search.pz2 balancer://pz2cluster lbmethod=byrequests stickysession=session nofailover=On
]]></screen>
-
+
The 'ProxyPass' line sets up a reverse proxy for request
‘/pazpar2/search.pz2’ and delegates all requests to the load balancer
(virtual worker) with name ‘pz2cluster’.
The ‘Proxy’ section lists all the servers (real workers) which the
load balancer can use.
</para>
-
+
</example>
-
+
</section>
-
+
<section id="relevance_ranking">
<title>Relevance ranking</title>
<para>
fetched form the database. In this case, the rank weigth
<literal>w</literal>, the and rank tweaks <literal>lead</literal>,
<literal>follow</literal> and <literal>length</literal>.
-
+
</para>
<screen><![CDATA[
tf[1,2,..N] = 0;
<appendix id="license">
<title>License</title>
-
+
<para>
Pazpar2,
Copyright © ©right-year; Index Data.
</para>
-
+
<para>
Pazpar2 is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
Software Foundation; either version 2, or (at your option) any later
version.
</para>
-
+
<para>
Pazpar2 is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
</para>
-
+
<para>
You should have received a copy of the GNU General Public License
along with Pazpar2; see the file LICENSE. If not, write to the
- Free Software Foundation,
+ Free Software Foundation,
51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
</para>
-
+
</appendix>
&gpl2;
-
+
</book>
<!-- Keep this comment at the end of the file
<productnumber>&version;</productnumber>
<info><orgname>Index Data</orgname></info>
</refentryinfo>
-
+
<refmeta>
<refentrytitle>Pazpar2 conf</refentrytitle>
<manvolnum>5</manvolnum>
<refmiscinfo class="manual">File formats and conventions</refmiscinfo>
</refmeta>
-
+
<refnamediv>
<refname>pazpar2_conf</refname>
<refpurpose>Pazpar2 Configuration</refpurpose>
</refnamediv>
-
+
<refsynopsisdiv>
<cmdsynopsis>
<command>pazpar2.conf</command>
</cmdsynopsis>
</refsynopsisdiv>
-
+
<refsect1>
<title>DESCRIPTION</title>
<para>
extraction of data elements from incoming result records, for the
purposes of merging, sorting, facet analysis, and display.
</para>
-
+
<para>
The file is specified using the option -f on the Pazpar2 command line.
There is not presently a way to reload the configuration file without
in the future.
</para>
</refsect1>
-
+
<refsect1>
<title>FORMAT</title>
<para>
The configuration file is XML-structured. It must be well-formed XML. All
elements specific to Pazpar2 should belong to the namespace
- <literal>http://www.indexdata.com/pazpar2/1.0</literal>
+ <literal>http://www.indexdata.com/pazpar2/1.0</literal>
(this is assumed in the
following examples). The root element is named "<literal>pazpar2</literal>".
Under the root element are a number of elements which group categories of
information. The categories are described below.
</para>
-
+
<refsect2 id="config-threads">
<title>threads</title>
<para>
</para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>proxy</term>
<listitem>
</para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>relevance / sort / mergekey / facet</term>
<listitem>
</para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>settings</term>
<listitem>
The settings element requires one attribute 'src' which specifies
a settings file or a directory . If a directory is given all
files with suffix <filename>.xml</filename> is read from this
- directory. Refer to
+ directory. Refer to
<xref linkend="target_settings"/> for more information.
</para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term id="service_conf">service</term>
<listitem>
ranking, merging, and display of data elements. It supports
the following attributes:
</para>
-
+
<variablelist> <!-- level 3 -->
<varlistentry>
<term>name</term>
<para>
This is the name of the data element. It is matched
against the 'type' attribute of the
- 'metadata' element
+ 'metadata' element
in the normalized record. A warning is produced if
metadata elements with an unknown name are
- found in the
+ found in the
normalized record. This name is also used to
- represent
+ represent
data elements in the records returned by the
webservice API, and to name sort lists and browse
facets.
</para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>type</term>
<listitem>
</para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>brief</term>
<listitem>
</para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>sortkey</term>
<listitem>
</para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term id="metadata-rank">rank</term>
<listitem>
<para>
Specifies that this element is to be used to
- help rank
+ help rank
records against the user's query (when ranking is
- requested).
- The valus is of the form
+ requested).
+ The valus is of the form
<literallayout>
M [F N]
</literallayout>
</para>
<para>
For Pazpar2 1.6.13 and later, the rank may also defined
- "per-document", by the normalization stylesheet.
+ "per-document", by the normalization stylesheet.
</para>
<para>
The per field rank was introduced in Pazpar2 1.6.15. Earlier
about ranking.
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>termlist</term>
<listitem>
termlist, or browse facet. Values are tabulated from
incoming records, and a highscore of values (with
their associated frequency) is made available to the
- client through the webservice API.
+ client through the webservice API.
The possible values
are 'yes' and 'no' (default).
</para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>merge</term>
<listitem>
</para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>mergekey</term>
<listitem>
</para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term id="limitcluster">limitcluster</term>
<listitem>
</note>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term id="metadata_limitmap">limitmap</term>
<listitem>
<para>
- Specifies a default limitmap for this field. This is to avoid mass
- configuring of targets. However it is important to review/do this on a per
- target since it is usually target-specific. See limitmap for format.
+ Specifies a default limitmap for this field. This is to avoid mass
+ configuring of targets. However it is important to review/do
+ this on a per target since it is usually target-specific.
+ See limitmap for format.
</para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term id="metadata_facetmap">facetmap</term>
<listitem>
<para>
- Specifies a default facetmap for this field. This is to avoid mass
- configuring of targets. However it is important to review/do this on a per
- target since it is usually target-specific. See facetmap for format.
+ Specifies a default facetmap for this field. This is to avoid mass
+ configuring of targets. However it is important to review/do
+ this on a per target since it is usually target-specific.
+ See facetmap for format.
</para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>setting</term>
<listitem>
are allowed. 'no' is the default and doesn't do anything.
'postproc' copies the value of a setting with the same name
into the output of the normalization stylesheet(s). 'parameter'
- makes the value of a setting with the same name available
+ makes the value of a setting with the same name available
as a parameter to the normalization stylesheet, so you
can further process the value inside of the stylesheet, or use
the value to decide how to deal with other data values.
</para>
</listitem>
</varlistentry>
-
+
</variablelist> <!-- attributes to metadata -->
-
+
</listitem>
</varlistentry>
rule set.
Pazpar2 uses the particular rule sets for particular purposes.
Rule set 'relevance' is used to normalize
- terms for relevance ranking. Rule set 'sort' is used to
+ terms for relevance ranking. Rule set 'sort' is used to
normalize terms for sorting. Rule set 'mergekey' is used to
normalize terms for making a mergekey and, finally. Rule set 'facet'
is normally used to normalize facet terms, unless
in any order, except the 'index' element which logically
belongs to the end of the list. The stated tokenization,
transformation and charmapping instructions are performed
- in order from top to bottom.
+ in order from top to bottom.
</para>
<variablelist> <!-- Level 2 -->
<varlistentry>
<para>
The attribute 'rule' defines the direction of the
per-character casemapping, allowed values are "l"
- (lower), "u" (upper), "t" (title).
+ (lower), "u" (upper), "t" (title).
</para>
</listitem>
</varlistentry>
Normalization and transformation of tokens follows
the rules defined in the 'rule' attribute. For
possible values we refer to the extensive ICU
- documentation found at the
+ documentation found at the
<ulink url="&url.icu.transform;">ICU
transformation</ulink> home page. Set filtering
- principles are explained at the
+ principles are explained at the
<ulink url="&url.icu.unicode.set;">ICU set and
filtering</ulink> page.
</para>
'rule' attribute may have the following values:
"s" (sentence), "l" (line-break), "w" (word), and
"c" (character), the later probably not being
- very useful in a pruning Pazpar2 installation.
+ very useful in a pruning Pazpar2 installation.
</para>
</listitem>
</varlistentry>
</para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>relevance</term>
<listitem>
</para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>sort</term>
<listitem>
</para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>mergekey</term>
<listitem>
<para>
Specifies ICU tokenization and transformation rules
- for tokens that are used in Pazpar2's mergekey.
+ for tokens that are used in Pazpar2's mergekey.
The child element of 'mergekey' must be 'icu_chain' and the
'id' attribute of the icu_chain is ignored. This
definition is obsolete and should be replaced by the equivalent
The name and value of the CCL directive is gigen by attributes
'name' and 'value' respectively. Refer to possible list of names
in the
- <ulink
+ <ulink
url="http://www.indexdata.com/yaz/doc/tools.html#ccl.directives.table">
YAZ manual
</ulink>.
</para>
</listitem>
</varlistentry>
-
+
<varlistentry id="sort-default">
<term>sort-default</term>
<listitem>
<para>
Specifies the default sort criteria (default 'relevance'),
- which previous was hard-coded as default criteria in search.
- This is a fix/work-around to avoid re-searching when using
- target-based sorting. In order for this to work efficient,
- the search must also have the sort critera parameter; otherwise
+ which previous was hard-coded as default criteria in search.
+ This is a fix/work-around to avoid re-searching when using
+ target-based sorting. In order for this to work efficient,
+ the search must also have the sort critera parameter; otherwise
pazpar2 will do re-searching on search criteria changes, if
changed between search and show command.
</para>
</listitem>
</varlistentry>
-<!--
+<!--
<varlistentry>
<term>set</term>
<listitem>
</para>
</listitem>
</varlistentry>
--->
+-->
<varlistentry>
<term>settings</term>
<listitem>
<para>
Specifies timeout parameters for this service.
The <literal>timeout</literal>
- element supports the following attributes:
+ element supports the following attributes:
<literal>session</literal>, <literal>z3950_operation</literal>,
<literal>z3950_session</literal> which specifies
'session timeout', 'Z39.50 operation timeout',
</pazpar2>
]]>
</screen>
- </refsect1>
+ </refsect1>
<refsect1 id="config-include">
<title>INCLUDE FACILITY</title>
kinds of attributes, or settings with search targets. This can be done
through XML files which are read at startup; 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
+ 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
to drive sorting, facet/termlist generation, or end-user interface display
logic.
</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>
-
+
<para>
Clients of the Pazpar2 webservice interface can selectively override
settings for individual targets within the scope of one session. This
some search targets in different ways. This, again, can be managed
using an external database or other lookup mechanism. Setting overrides
can be performed either using the
- <link linkend="command-init">init</link> or the
+ <link linkend="command-init">init</link> or the
<link linkend="command-settings">settings</link> webservice
command.
</para>
-
+
<para>
In fact, every setting that applies to a database (except pz:id, which
can only be used for filtering targets to use for a search) can be overridden
- 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.
+ 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.
</para>
<para>
target, name, and value.
</para>
- <variablelist>
+ <variablelist>
<varlistentry>
<term>target</term>
<listitem>
<set name="pz:cclmap:isbn" value="u=7"/>
<set name="pz:cclmap:issn" value="u=8"/>
<set name="pz:cclmap:date" value="u=30 r=r"/>
-
+
<set name="pz:limitmap:title" value="rpn:@attr 1=4 @attr 6=3"/>
<set name="pz:limitmap:date" value="ccl:date"/>
The following setting names are reserved by Pazpar2 to control the
behavior of the client function.
</para>
-
+
<variablelist>
<varlistentry>
<term>pz:cclmap:xxx</term>
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
+ XML is probably not well-formed). The character set may be
specified by adding:
<literal>;charset=</literal><replaceable>charset</replaceable> to
<literal>iso2709</literal>. If omitted, a charset of
<literal>'.xsl'</literal>.
</para>
<para>
- When mapping MARC records, XSLT can be bypassed for increased
+ 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>
500 $ description
773 * citation
</programlisting>
- To map the field value specify a subfield of '$'. To store a
+ To map the field value specify a subfield of '$'. To store a
concatenation of all subfields, specify a subfield of '*'.
</para>
</listitem>
<term>pz:presentchunk</term>
<listitem>
<para>
- Controls the chunk size in present requests. Pazpar2 will
+ Controls the chunk size in present requests. Pazpar2 will
make (maxrecs / chunk) request(s). The default is 20.
</para>
</listitem>
<term>pz:zproxy</term>
<listitem>
<para>
- The 'pz:zproxy' setting has the value syntax
+ 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>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>pz:apdulog</term>
<listitem>
</para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>pz:sru</term>
<listitem>
</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.
+ 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:pqf_prefix</term>
<listitem>
</para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>pz:pqf_strftime</term>
<listitem>
</para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>pz:sort</term>
<listitem>
</para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>pz:preferred</term>
<listitem>
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.
+ which release when one target has returned records.
</para>
</listitem>
</varlistentry>
<listitem>
<para>
(Not yet implemented).
- Specifies the time for which a block should be released anyway.
+ Specifies the time for which a block should be released anyway.
</para>
</listitem>
</varlistentry>
<term>pz:termlist_term_count</term>
<listitem>
<para>
- Specifies number of facet terms to be requested from the target.
+ Specifies number of facet terms to be requested from the target.
The default is unspecified e.g. server-decided. Also see pz:facetmap.
</para>
</listitem>
<term>pz:termlist_term_factor</term>
<listitem>
<para>
- Specifies whether to use a factor for pazpar2 generated facets (1) or not (0).
- When mixing locallly generated (by the downloaded (pz:maxrecs) samples)
- facet with native (target-generated) facets, the later will dominated the dominate the facet list
- since they are generated based on the complete result set.
- By scaling up the facet count using the ratio between total hit count and the sample size,
- the total facet count can be approximated and thus better compared with native facets.
- This is not enabled by default.
+ Specifies whether to use a factor for pazpar2 generated facets (1)
+ or not (0).
+ When mixing locally generated (by the downloaded (pz:maxrecs) samples)
+ facet with native (target-generated) facets, the later will
+ dominated the dominate the facet list since they are generated
+ based on the complete result set.
+ By scaling up the facet count using the ratio between total hit
+ count and the sample size,
+ the total facet count can be approximated and thus better compared
+ with native facets. This is not enabled by default.
</para>
</listitem>
</varlistentry>
<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
+ 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>
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,
+ 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
+ by a field a metadata field (default is to use the name of the
limitmap itself).
</para>
<para>
</note>
</listitem>
</varlistentry>
-
+
</variablelist>
-
+
</refsect2>
</refsect1>
</variablelist>
</para>
</refsect2>
-
+
<refsect2 id="command-ping">
<title>ping</title>
<para>
or possibly a wildcard, and value is the desired value for the
setting.
</para>
-
+
<para>
Because the settings command manipulates potentially sensitive
information, it is possible to configure Pazpar2 to only allow access
scripting, which in turn is responsible for authenticating the user,
and possibly determining which resources he has access to, etc.
</para>
-
+
<note>
<para>
As a shortcut, it is also possible to override settings directly in
</settings>
]]></screen>
</para>
-
+
</refsect2>
<refsect2 id="command-search">
<title>search</title>
'position'.
</para>
<para>
- If not specified here or as <link linkend="sort-default">sort-default"</link>
- in pazpar2.cfg, Pazpar2 will default to the built-in 'relevance' ranking.
+ If not specified here or as
+ <link linkend="sort-default">sort-default"</link>
+ in pazpar2.cfg, Pazpar2 will default to the built-in
+ 'relevance' ranking.
</para>
<para>
- Having sort criteria at search is important for targets that
- supports native sorting in order to get best results. Pazpar2
- will trigger a new search if search criteria changes from Pazpar2
+ Having sort criteria at search is important for targets that
+ supports native sorting in order to get best results. Pazpar2
+ will trigger a new search if search criteria changes from Pazpar2
to target-based sorting or visa-versa.
</para>
</listitem>
]]></screen>
</para>
</refsect2>
-
+
<refsect2 id="command-stat">
<title>stat</title>
<para>
]]></screen>
</para>
</refsect2>
-
+
<refsect2 id="command-show">
<title>show</title>
<para>
</para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>start</term>
<listitem>
<para>First record to show - 0-indexed.</para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>num</term>
<listitem>
Sort field names can be any field name designated as a sort field
in the pazpar2.cfg file, or the special names 'relevance' and
'position'.
-
- If not specified here or as <link linkend="sort-default">sort-default"</link>
- in pazpar2.cfg, pazpar2 will default to the built-in 'relevance' ranking.
-
- Having sort criteria at search is important for targets that
- supports native sorting in order to get best results. pazpar2
- will trigger a new search if search criteria changes from pazpar2
+ </para>
+ <para>
+ If not specified here or as
+ <link linkend="sort-default">sort-default"</link>
+ in pazpar2.cfg, pazpar2 will default to the built-in
+ 'relevance' ranking.
+ </para>
+ <para>
+ Having sort criteria at search is important for targets that
+ supports native sorting in order to get best results. pazpar2
+ will trigger a new search if search criteria changes from pazpar2
to target-based sorting.
-
</para>
<para>
For targets where If <link linkend="pzsortmap">pz:sortmap</link>
<num>2</num> -- Number of records retrieved
<hit>
<md-title>How to program a computer, by Jack Collins</md-title>
- <count>2</count> -- Number of merged records
+ <count>2</count> -- Number of merged records
<recid>6</recid> -- Record ID for this record
</hit>
<hit>
<refsect2 id="command-record">
<title>record</title>
<para>
- Retrieves a detailed record. Unlike the
- <link linkend="command-show">show</link> command, this command
+ Retrieves a detailed record. Unlike the
+ <link linkend="command-show">show</link> command, this command
returns metadata records before merging takes place. Parameters:
-
+
<variablelist>
<varlistentry>
<term>session</term>
<term>syntax</term>
<listitem>
<para>
- This optional parameter is the record syntax used for raw
+ This optional parameter is the record syntax used for raw
transfer (i.e. when offset is specified). If syntax is not given,
but offset is used, the value of pz:requestsyntax is used.
</para>
</variablelist>
</para>
- <para>
+ <para>
Example:
<screen><![CDATA[
search.pz2?session=605047297&command=record&id=3
]]></screen>
Example output:
-
+
<screen><![CDATA[
<record>
<md-title>
<title>termlist</title>
<para>
Retrieves term list(s). Parameters:
-
+
<variablelist>
<varlistentry>
<term>session</term>
</termlist>
]]></screen>
</para>
-
+
<para>
For the special termlist name "xtargets", results
are returned about the targets which have returned the most hits.
]]></screen>
</para>
</refsect2>
-
+
<refsect2 id="command-bytarget">
<title>bytarget</title>
</varlistentry>
</variablelist>
</para>
- <para>
+ <para>
Example:
<screen><![CDATA[
search.pz2?session=605047297&command=bytarget&id=3
]]></screen>
-
+
Example output:
-
+
<screen><![CDATA[
<bytarget>
<status>OK</status>
<!-- ... more target nodes below as necessary -->
</bytarget>
]]></screen>
-
+
The following client states are defined: Client_Connecting,
Client_Connected, Client_Idle, Client_Initializing, Client_Searching,
Client_Searching, Client_Presenting, Client_Error, Client_Failed,
projects / pazpar2-moved-to-github.git / commitdiff