X-Git-Url: http://lists.indexdata.com/cgi-bin?a=blobdiff_plain;f=doc%2Fpazpar2_conf.xml;h=04f6e2a79e931e59adc1682201c2398008ddb520;hb=5cdddaf1ba96608fcbd221421503b609ded909bf;hp=f91a4e09def8fc5959f4f08a616b1017bef021f3;hpb=767abb65f144ddf2f76f96b5a279baadcf54fc04;p=pazpar2-moved-to-github.git

diff --git a/doc/pazpar2_conf.xml b/doc/pazpar2_conf.xml
index f91a4e0..04f6e2a 100644
--- a/doc/pazpar2_conf.xml
+++ b/doc/pazpar2_conf.xml
@@ -121,11 +121,11 @@
     </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>
@@ -415,6 +415,17 @@
        </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>
@@ -726,6 +737,9 @@
   <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"/>
+q
+  <set name="pz:limitmap:title" value="rpn:@attr 1=4 @attr 6=3"/>
+  <set name="pz:limitmap:date" value="ccl:date"/>
 
   <!-- Retrieval settings -->
 
@@ -1055,51 +1069,73 @@
       <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>
+     <term>pz:preferred</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.
+       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:termlist_term_sort</term>
+     <term>pz:block_timeout</term>
      <listitem>
       <para>
-       Specifies how the terms should be sorted. (Not yet implemented)
+       (Not yet implemented). Specifies the time for which a block should be released anyway.      
       </para>
      </listitem>
     </varlistentry>
 
     <varlistentry>
-     <term>pz:preferred</term>
+     <term>pz:facetmap:<replaceable>name</replaceable></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 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:block_timeout</term>
+     <term>pz:limitmap:<replaceable>name</replaceable></term>
      <listitem>
       <para>
-       (Not yet implemented). Specifies the time for which a block should be released anyway.      
+	Specifies attributes for limiting a search to a field - using
+	the limit parameter for search. 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.
       </para>
+	<note>
+	<para>
+	  The limitmap facility is supported for Pazpar2 version 1.6.0.
+	</para>
+      </note>
      </listitem>
     </varlistentry>