X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fpazpar2_conf.xml;h=9e75b4810cbd5c3163ac1bd5549857efb21ee3ce;hb=79b268b79710a5e21ce1043c762f0b103f369fa1;hp=17578a9715e373ac86872ef7a14ec2677bebef4e;hpb=f110bc50c58b63a6fe4eaaddf40a4789c27b83bf;p=pazpar2-moved-to-github.git

diff --git a/doc/pazpar2_conf.xml b/doc/pazpar2_conf.xml
index 17578a9..9e75b48 100644
--- a/doc/pazpar2_conf.xml
+++ b/doc/pazpar2_conf.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
- "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd"
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
+ "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"
 [
      <!ENTITY % local SYSTEM "local.ent">
      %local;
@@ -13,10 +13,13 @@
  <refentryinfo>
   <productname>Pazpar2</productname>
   <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>
@@ -118,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>
@@ -412,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>
@@ -988,8 +1002,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>
@@ -1000,7 +1014,7 @@
       <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.
+       to 1.1 or 1.2. For SOLR, the current supported/tested version is 1.4
       </para>
      </listitem>
     </varlistentry>
@@ -1052,13 +1066,52 @@
       <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: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>
+
+    <varlistentry>
+     <term>pz:facetmap:<replaceable>name</replaceable></term>
+     <listitem>
+      <para>
+       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>
+    
    </variablelist>
 
   </refsect2>