mergekey and facets - for the server. These definitions serves as
default for services that don't have these given. For the meaning
of these settings refer to the
- <xref linkend="icu_chain">"icu_chain"</xref> element inside service.
+ <xref linkend="icuchain"/> element inside service.
</para>
</listitem>
</varlistentry>
elements of this type. The default is '0', which
excludes this element from the rank calculation.
</para>
+ <para>
+ For Pazpar2 1.6.13 and later, the rank may also defined
+ "per-document", by the normalization stylesheet.
+ </para>
</listitem>
</varlistentry>
</varlistentry>
<varlistentry>
- <term id="icu_chain">icu_chain</term>
+ <term id="servicexslt" xreflabel="xslt">xslt</term>
+ <listitem>
+ <para>
+ Defines a XSLT stylesheet. The <literal>xslt</literal>
+ element takes exactly one attribute <literal>id</literal>
+ which names the stylesheet. This can be referred to in target
+ settings <xref linkend="pzxslt"/>.
+ </para>
+ <para>
+ The content of the xslt element is the embedded stylesheet XML
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term id="icuchain" xreflabel="icu_chain">icu_chain</term>
<listitem>
<para>
Specifies a named ICU rule set. The icu_chain element must include
multiple overlapping settings with the same name and target
value, the 'precedence' attribute determines what happens.
</para>
+ <para>
+ For Pazpar2 1.6.4 or later, the target ID may be user-defined, in
+ which case, the actual host, port, etc is given by setting
+ <xref linkend="pzurl"/>.
+ </para>
</listitem>
</varlistentry>
<varlistentry>
</varlistentry>
<varlistentry>
- <term>pz:xslt</term>
+ <term id="pzxslt" xreflabel="pz:xslt">pz:xslt</term>
<listitem>
<para>
- Is a comma separated list of of files that specifies
+ 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).
</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:id</term>
<listitem>
<para>
<listitem>
<para>
This setting enables
- <ulink url="&url.sru;">SRU</ulink>/<ulink url="&url.solr;">SOLR</ulink>
+ <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
the protocol.
</para>
<para>
- A value of 'solr' anables SOLR client support. This is supported
+ A value of 'solr' enables Solr client support. This is supported
for Pazpar version 1.5.0 and later.
</para>
</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
+ to 1.1 or 1.2. For Solr, the current supported/tested version is 1.4 and 3.x.
</para>
</listitem>
</varlistentry>
<listitem>
<para>
Allows you to specify an arbitrary PQF query language substring.
- The provided string is prefixed the user's query after it has been
+ The provided string is prefixed to the user's query after it has been
normalized to PQF internally in pazpar2.
This allows you to attach complex 'filters' to queries for a given
target, sometimes necessary to select sub-catalogs
<literal>@and @attr 1=30 @attr 2=3 %Y %%</literal>
would search for current year combined with the original PQF (%%).
</para>
+ <para>
+ This setting can also be used as more general alternative to
+ pz:pqf_prefix -- a way of embedding the submitted query
+ anywhere in the string rather than appending it to prefix. For
+ example, if it is desired to omit all records satisfying the
+ query <literal>@attr 1=pica.bib 0007</literal> then this
+ subquery can be combined with the submitted query as the second
+ argument of <literal>@andnot</literal> by using the
+ pz:pqf_strftime value <literal>@not %% @attr 1=pica.bib
+ 0007</literal>.
+ </para>
</listitem>
</varlistentry>
</para>
</listitem>
</varlistentry>
-
<varlistentry>
<term>pz:block_timeout</term>
<listitem>
</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term>pz:termlist_term_count</term>
+ <listitem>
+ <para>
+ 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>
+ </varlistentry>
+ <varlistentry>
+ <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.
+ </para>
+ </listitem>
+ </varlistentry>
<varlistentry>
<term>pz:facetmap:<replaceable>name</replaceable></term>
</para>
<note>
<para>
- At this point only SOLR targets have been tested with this
+ At this point only Solr targets have been tested with this
facility.
</para>
</note>
</listitem>
</varlistentry>
- <varlistentry>
+ <varlistentry id="limitmap">
<term>pz:limitmap:<replaceable>name</replaceable></term>
<listitem>
<para>
Specifies attributes for limiting a search to a field - using
- the limit parameter for search. In some cases the mapping of
+ 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 two forms: referral to
- an exisiting CCL field or a raw PQF string. Leading string
- determines type; either <literal>ccl:</literal> for CCL field or
- <literal>rpn:</literal> for PQF/RPN.
+ 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>
<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.
+ </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>
+ <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>
</variablelist>
-
+
</refsect2>
</refsect1>
projects / pazpar2-moved-to-github.git / blobdiff