Describe pz:limitmap

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

diff --git a/doc/pazpar2_protocol.xml b/doc/pazpar2_protocol.xml
index 0c7086f..1de2ec2 100644 (file)
--- a/doc/pazpar2_protocol.xml
+++ b/doc/pazpar2_protocol.xml
@@ -194,6 +194,19 @@
       </listitem>
      </varlistentry>
      <varlistentry>
+      <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.
+       </para>
+      </listitem>
+     </varlistentry>
+     <varlistentry>
       <term>startrecs</term>
       <listitem>
        <para>
@@ -490,6 +503,14 @@ search.pz2?session=605047297&command=record&id=3
        </para>
       </listitem>
      </varlistentry>
+     <varlistentry>
+      <term>num</term>
+      <listitem>
+       <para>
+       maximum number of entries to return - default is 15.
+       </para>
+      </listitem>
+     </varlistentry>
     </variablelist>
    </para>
    <para>