</varlistentry>
<varlistentry>
- <term>relevance / sort / mergekey</term>
+ <term>relevance / sort / mergekey / facet</term>
<listitem>
<para>
- Specifies character set normalization for relevancy / sorting
- and the mergekey - for the server. These definitions serves as
+ Specifies character set normalization for relevancy / sorting /
+ 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 "relevance" element inside service.
</para>
</varlistentry>
<varlistentry>
+ <term>facet</term>
+ <listitem>
+ <para>
+ Specifies ICU tokenization and transformation rules
+ for tokens that are used in Pazpar2's facets. The contents
+ is similar to that of <literal>relevance</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
<term>settings</term>
<listitem>
<para>
<para>
Specifies a filter which allows Pazpar2 to only include
records that meet a certain criteria in a result. Unmatched records
- will be ignored. The filter takes the form name[~value] , which
+ will be ignored. The filter takes the form name, name~value, or name=value, which
will include only records with metadata element (name) that has the
- substring (value) given. If value is omitted all records with the
- metadata present will be included.
+ substring (~value) given, or matches exactly (=value). If value is omitted all records
+ with the named
+ metadata element present will be included.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>pz:termlist_term_count</term>
- <listitem>
- <para>
- Specifies that the target should return up to n terms for each facets (where termlist="yes"). This implies
- that the target can return facets on the search command. Requesting facets on targets that doesn't,
- will return unpredictable or error result.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>pz:termlist_term_sort</term>
+ <term>pz:preferred</term>
<listitem>
<para>
- Specifies how the terms should be sorted. (Not yet implemented)
+ 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:preferred</term>
+ <term>pz:block_timeout</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.
+ (Not yet implemented). Specifies the time for which a block should be released anyway.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>pz:block_timeout</term>
+ <term>pz:facetmap:<replaceable>name</replaceable></term>
<listitem>
<para>
- (Not yet implemented). Specifies the time for which a block should be released anyway.
+ 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>