New setting: pz:pqf_strftime

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

diff --git a/doc/pazpar2_conf.xml b/doc/pazpar2_conf.xml
index 02adacf..9782efb 100644 (file)
--- a/doc/pazpar2_conf.xml
+++ b/doc/pazpar2_conf.xml
@@ -962,6 +962,23 @@
     </varlistentry>
     
     <varlistentry>
+     <term>pz:pqf_strftime</term>
+     <listitem>
+      <para>
+       Allows you to extend a query with dates and operators.
+       The provided string allows certain substitutions and serves as a
+       format string.
+       The special two character sequence '%%' gets converted to the
+       original query. Other characters leading with the percent sign are
+       conversions supported by strftime.
+       All other characters are copied verbatim. For example, the string
+       <literal>@and @attr 1=30 @attr 2=3 %Y %%</literal>
+       would search for current year combined with the original PQF (%%).
+      </para>
+     </listitem>
+    </varlistentry>
+    
+    <varlistentry>
      <term>pz:sort</term>
      <listitem>
       <para>
@@ -970,7 +987,22 @@
       </para>
      </listitem>
     </varlistentry>
+
+    <varlistentry>
+     <term>pz:recordfilter</term>
+     <listitem>
+      <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 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.
+      </para>
+     </listitem>
+    </varlistentry>
    </variablelist>
+
   </refsect2>
   
  </refsect1>