From: Dennis Schafroth <dennis@indexdata.com>
Date: Wed, 6 Oct 2010 14:02:00 +0000 (+0200)
Subject: New settings for pazpar2 targets
X-Git-Tag: v1.5.1~21^2~6
X-Git-Url: http://sru.miketaylor.org.uk/cgi-bin?a=commitdiff_plain;h=e4f0434300f7ef15f050ea827f9d615d7624aaad;p=pazpar2-moved-to-github.git

New settings for pazpar2 targets

Documenting pz:termlist_term_count, pz:termlist_term_sort, pz:preferred, and pz:block_timeout
---

diff --git a/doc/pazpar2_conf.xml b/doc/pazpar2_conf.xml
index dd31569..2afd595 100644
--- a/doc/pazpar2_conf.xml
+++ b/doc/pazpar2_conf.xml
@@ -991,8 +991,8 @@
        the protocol.
       </para>
       <para>
-	A value of 'solr' anables SOLR client support. This is supported
-	for Pazpar version 1.5.0 and later.
+	   A value of 'solr' anables SOLR client support. This is supported
+	   for Pazpar version 1.5.0 and later.
       </para>
      </listitem>
     </varlistentry>
@@ -1062,6 +1062,47 @@
       </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>
+     <listitem>
+      <para>
+       Specifies how the terms should be sorted. (Not yet implemented)
+      </para>
+     </listitem>
+    </varlistentry>
+
+    <varlistentry>
+     <term>pz:preferred</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.     
+      </para>
+     </listitem>
+    </varlistentry>
+
+    <varlistentry>
+     <term>pz:block_timeout</term>
+     <listitem>
+      <para>
+       (Not yet implemented). Specifies the time for which a block should be released anyway.      
+      </para>
+     </listitem>
+    </varlistentry>
+    
    </variablelist>
 
   </refsect2>