From: Adam Dickmeiss <adam@indexdata.dk>
Date: Wed, 28 Sep 2011 10:52:40 +0000 (+0200)
Subject: Document the OR operation for limit parameter
X-Git-Tag: v1.6.4~5^2~39
X-Git-Url: http://jsfdemo.indexdata.com/cgi-bin?a=commitdiff_plain;h=4cbdf849a4e20dcbec675e073596b85fd4c4147b;p=pazpar2-moved-to-github.git

Document the OR operation for limit parameter
---

diff --git a/doc/pazpar2_protocol.xml b/doc/pazpar2_protocol.xml
index 80aed16..893043a 100644
--- a/doc/pazpar2_protocol.xml
+++ b/doc/pazpar2_protocol.xml
@@ -188,13 +188,16 @@ search.pz?command=settings&session=2044502273&pz:allow[search.com:210/db1]=1
        <para>
 	Limits the search to a given set of targets specified by the
 	filter. The filter consists a comma separated list of
-	setting+operator+args pairs. The setting is a Pazpar2 setting
+	<emphasis>setting</emphasis>+<emphasis>operator</emphasis>+<emphasis>args</emphasis>
+	pairs. The <emphasis>setting</emphasis> is a Pazpar2 setting
 	(such as <literal>pz:id</literal>).
-	The operator is either = (string match)
-	or ~ (substring match). The args is a list of values separated
-	by | (or , one of the values). The idea is that only targets
-	with a setting matching one of the values given will be included
-	in the search.
+	The <emphasis>operator</emphasis> is either
+	<literal>=</literal> (string match)
+	or <literal>~</literal> (substring match).
+	The <emphasis>args</emphasis> is a list of values separated
+	by <literal>|</literal> (or , one of the values).
+	The idea is that only targets with a setting matching one of
+	the values given will be included in the search.
        </para>
       </listitem>
      </varlistentry>
@@ -203,9 +206,14 @@ search.pz?command=settings&session=2044502273&pz:allow[search.com:210/db1]=1
       <listitem>
        <para>
 	Narrows the search by one or more fields (typically facets).
-	The limit is sequence of one or more name=value pairs separated
-	by comma.
-	A value that contains a comma should be escaped by backslash (\).
+	The limit is sequence of one or more
+	<emphasis>name</emphasis>=<emphasis>args</emphasis> pairs separated
+	by comma. The <emphasis>args</emphasis> is a list of values
+	separated by vertical bar (<literal>|</literal>).
+	The meaning of <literal>|</literal> is alternative, ie OR .
+	A value that contains a comma (<literal>,</literal>),
+	a vertical bar (<literal>|</literal>) or
+	backslash itself must be preceded by backslash (<literal>\</literal>).
 	The <link linkend="limitmap">pz:limitmap</link> configuration
 	item defines how the searches are mapped to a database.
        </para>