X-Git-Url: http://jsfdemo.indexdata.com/?a=blobdiff_plain;f=doc%2Fpazpar2_protocol.xml;h=e8985667782a1e2ba06d3ff86b9847207f17eebd;hb=6d01755305a7afba15ed4bc90ac9c149ee7d130e;hp=fd10f677a20351bde429eb2884f159092f91477a;hpb=22ae3398d1153b29cdba238f1a5f21e7b3cf35e3;p=pazpar2-moved-to-github.git

diff --git a/doc/pazpar2_protocol.xml b/doc/pazpar2_protocol.xml
index fd10f67..e898566 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>
@@ -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>
@@ -347,6 +355,11 @@ search.pz2?session=2044502273&command=stat
         in the pazpar2.cfg file, or the special names 'relevance' and
 	'position'.
        </para>
+       <para>
+	For targets where If <link linkend="pz:sortmap">pz:sortmap</link>
+	is defined, a sort operation will be executed (possibly including
+	extending the search).
+       </para>
       </listitem>
      </varlistentry>
      
@@ -415,15 +428,16 @@ search.pz2?session=2044502273&command=show&start=0&num=2&sort=title:1
       <listitem>
        <para>
 	This optional parameter is an integer which, when given, makes
-	Pazpar2 return the raw record for a target. The raw record
-	from first target is numbered 0, second numbered 1, etc.
-	When a raw record is returned Pazpar2 will XSLT transform the
-	record but an XML version is returned. All ISO2709 records are
-	returned as MARCXML. OPAC records are returned as YAZ'
-	OPAC with an MARCXML sibling.
+	Pazpar2 return the original record for a specific target.
+	The record set from first target is numbered 0,
+	second record set is numbered 1, etc.
+	The nativesyntax setting, as usual, is used to determine how to
+	create XML from the original record - unless parameter
+	<literal>binary</literal> is given in which the record is
+	fetched as "raw" from ZOOM C (raw, original record).
        </para>
        <para>
-	When offset is not given the Pazpar2 metadata for the record
+	When offset is not given, the Pazpar2 metadata for the record
 	is returned and with metadata for each targets' data specified
 	in a 'location' list.
        </para>
@@ -431,6 +445,17 @@ search.pz2?session=2044502273&command=show&start=0&num=2&sort=title:1
      </varlistentry>
 
      <varlistentry>
+      <term>nativesyntax</term>
+      <listitem>
+       <para>
+	This optional parameter can be used to override	pz:nativesyntax
+	as given for the target. This allow an alternative nativesyntax
+	to be used for original records (see parameteroffset above).
+       </para>
+      </listitem>
+     </varlistentry>
+
+     <varlistentry>
       <term>syntax</term>
       <listitem>
        <para>
@@ -458,9 +483,9 @@ search.pz2?session=2044502273&command=show&start=0&num=2&sort=title:1
       <listitem>
        <para>
 	This optional parameter enables "binary" response for retrieval
-	of a raw record (i.e. when offset is specified). For binary
-	responses the record is <emphasis>not</emphasis> converted to
-	XML and the HTTP content type is application/octet-stream.
+	of a original record (i.e. when offset is specified). For binary
+	response the record by default is fetched from ZOOM C using
+	the "raw" option or by parameter nativesyntax if given.
        </para>
       </listitem>
      </varlistentry>
@@ -506,7 +531,8 @@ search.pz2?session=605047297&command=record&id=3
       <term>name</term>
       <listitem>
        <para>
-	comma-separated list of termlist names (default "subject")
+	comma-separated list of termlist names. If omitted,
+	all termlists are returned.
        </para>
       </listitem>
      </varlistentry>