From: Adam Dickmeiss <adam@indexdata.dk>
Date: Mon, 12 Sep 2011 12:40:26 +0000 (+0200)
Subject: Describe pz:limitmap
X-Git-Tag: v1.6.0~1
X-Git-Url: http://sru.miketaylor.org.uk/cgi-bin?a=commitdiff_plain;h=5cdddaf1ba96608fcbd221421503b609ded909bf;p=pazpar2-moved-to-github.git

Describe pz:limitmap
---

diff --git a/doc/pazpar2_conf.xml b/doc/pazpar2_conf.xml
index 9e75b48..04f6e2a 100644
--- a/doc/pazpar2_conf.xml
+++ b/doc/pazpar2_conf.xml
@@ -737,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 -->
 
@@ -1111,6 +1114,30 @@
       </note>
      </listitem>
     </varlistentry>
+
+    <varlistentry>
+     <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 
+	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>
     
    </variablelist>
 
diff --git a/doc/pazpar2_protocol.xml b/doc/pazpar2_protocol.xml
index b74e42b..1de2ec2 100644
--- a/doc/pazpar2_protocol.xml
+++ b/doc/pazpar2_protocol.xml
@@ -197,9 +197,12 @@
       <term>limit</term>
       <listitem>
        <para>
-	Narrows the search by one or more facet fields. The limit is
-	sequence of one or more field=value pairs separate by comma.
+	Narrows the search by one or more fields (typicall facets).
+	The limit is sequence of one or more field=value pairs separate
+	by comma.
 	A value that contains a comma should be escaped by backslash (\).
+	The pz:fazetmap configuration item defines how the searches are 
+	mapped to a database.
        </para>
       </listitem>
      </varlistentry>