Document the OR operation for limit parameter

[pazpar2-moved-to-github.git] / doc / pazpar2_protocol.xml

diff --git a/doc/pazpar2_protocol.xml b/doc/pazpar2_protocol.xml
index d332a62..893043a 100644 (file)
--- 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>
@@ -202,12 +205,17 @@ search.pz?command=settings&session=2044502273&pz:allow[search.com:210/db1]=1
       <term>limit</term>
       <listitem>
        <para>
-       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.
+       Narrows the search by one or more fields (typically facets).
+       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>
       </listitem>
      </varlistentry>
@@ -344,7 +352,8 @@ search.pz2?session=2044502273&command=stat
        increasing or decreasing order according to that field. 0==Decreasing is
        the default.
        Sort field names can be any field name designated as a sort field
-        in the pazpar2.cfg file, or the special name 'relevance'.
+        in the pazpar2.cfg file, or the special names 'relevance' and
+       'position'.
        </para>
       </listitem>
      </varlistentry>