</variablelist>
</para>
</refsect2>
-
+
<refsect2 id="command-ping">
<title>ping</title>
<para>
or possibly a wildcard, and value is the desired value for the
setting.
</para>
-
+
<para>
Because the settings command manipulates potentially sensitive
information, it is possible to configure Pazpar2 to only allow access
scripting, which in turn is responsible for authenticating the user,
and possibly determining which resources he has access to, etc.
</para>
-
+
<note>
<para>
As a shortcut, it is also possible to override settings directly in
</settings>
]]></screen>
</para>
-
+
</refsect2>
<refsect2 id="command-search">
<title>search</title>
<listitem>
<para>
Limits the search to a given set of targets specified by the
- filter. The filter consists a comma separated list of
+ filter. The filter consists of a comma separated list of
<emphasis>setting</emphasis>+<emphasis>operator</emphasis>+<emphasis>args</emphasis>
pairs. The <emphasis>setting</emphasis> is a Pazpar2 setting
(such as <literal>pz:id</literal>).
'position'.
</para>
<para>
- If not specified here or as <link linkend="sort-default">sort-default"</link>
- in pazpar2.cfg, Pazpar2 will default to the built-in 'relevance' ranking.
+ If not specified here or as
+ <link linkend="sort-default">sort-default"</link>
+ in pazpar2.cfg, Pazpar2 will default to the built-in
+ 'relevance' ranking.
</para>
<para>
- Having sort criteria at search is important for targets that
- supports native sorting in order to get best results. Pazpar2
- will trigger a new search if search criteria changes from Pazpar2
+ Having sort criteria at search is important for targets that
+ supports native sorting in order to get best results. Pazpar2
+ will trigger a new search if search criteria changes from Pazpar2
to target-based sorting or visa-versa.
</para>
</listitem>
]]></screen>
</para>
</refsect2>
-
+
<refsect2 id="command-stat">
<title>stat</title>
<para>
]]></screen>
</para>
</refsect2>
-
+
<refsect2 id="command-show">
<title>show</title>
<para>
</para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>start</term>
<listitem>
<para>First record to show - 0-indexed.</para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>num</term>
<listitem>
Sort field names can be any field name designated as a sort field
in the pazpar2.cfg file, or the special names 'relevance' and
'position'.
-
- If not specified here or as <link linkend="sort-default">sort-default"</link>
- in pazpar2.cfg, pazpar2 will default to the built-in 'relevance' ranking.
-
- Having sort criteria at search is important for targets that
- supports native sorting in order to get best results. pazpar2
- will trigger a new search if search criteria changes from pazpar2
+ </para>
+ <para>
+ If not specified here or as
+ <link linkend="sort-default">sort-default"</link>
+ in pazpar2.cfg, pazpar2 will default to the built-in
+ 'relevance' ranking.
+ </para>
+ <para>
+ Having sort criteria at search is important for targets that
+ supports native sorting in order to get best results. pazpar2
+ will trigger a new search if search criteria changes from pazpar2
to target-based sorting.
-
</para>
<para>
For targets where If <link linkend="pzsortmap">pz:sortmap</link>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term>snippets</term>
+ <listitem>
+ <para>
+ If specified and set to 1 data will include snippets marked
+ with <match> tags. Otherwise snippets will not be included.
+ </para>
+ <para>
+ This facility, "snippets", appeared in Pazpar2 version
+ 1.6.32.
+ </para>
+ </listitem>
+ </varlistentry>
+
</variablelist>
</para>
<para>
<num>2</num> -- Number of records retrieved
<hit>
<md-title>How to program a computer, by Jack Collins</md-title>
- <count>2</count> -- Number of merged records
+ <count>2</count> -- Number of merged records
<recid>6</recid> -- Record ID for this record
</hit>
<hit>
<refsect2 id="command-record">
<title>record</title>
<para>
- Retrieves a detailed record. Unlike the
- <link linkend="command-show">show</link> command, this command
+ Retrieves a detailed record. Unlike the
+ <link linkend="command-show">show</link> command, this command
returns metadata records before merging takes place. Parameters:
-
+
<variablelist>
<varlistentry>
<term>session</term>
<term>syntax</term>
<listitem>
<para>
- This optional parameter is the record syntax used for raw
+ This optional parameter is the record syntax used for raw
transfer (i.e. when offset is specified). If syntax is not given,
but offset is used, the value of pz:requestsyntax is used.
</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term>snippets</term>
+ <listitem>
+ <para>
+ If specified and set to 1 data will include snippets marked
+ with <match> tags. Otherwise snippets will not be included.
+ </para>
+ <para>
+ This facility, "snippets", appeared in Pazpar2 version
+ 1.6.32.
+ </para>
+ </listitem>
+ </varlistentry>
+
</variablelist>
</para>
- <para>
+ <para>
Example:
<screen><![CDATA[
search.pz2?session=605047297&command=record&id=3
]]></screen>
Example output:
-
+
<screen><![CDATA[
<record>
<md-title>
<title>termlist</title>
<para>
Retrieves term list(s). Parameters:
-
+
<variablelist>
<varlistentry>
<term>session</term>
</termlist>
]]></screen>
</para>
-
+
<para>
For the special termlist name "xtargets", results
are returned about the targets which have returned the most hits.
]]></screen>
</para>
</refsect2>
-
+
<refsect2 id="command-bytarget">
<title>bytarget</title>
</varlistentry>
</variablelist>
</para>
- <para>
+ <para>
Example:
<screen><![CDATA[
search.pz2?session=605047297&command=bytarget&id=3
]]></screen>
-
+
Example output:
-
+
<screen><![CDATA[
<bytarget>
<status>OK</status>
<!-- ... more target nodes below as necessary -->
</bytarget>
]]></screen>
-
+
The following client states are defined: Client_Connecting,
Client_Connected, Client_Idle, Client_Initializing, Client_Searching,
Client_Searching, Client_Presenting, Client_Error, Client_Failed,
projects / pazpar2-moved-to-github.git / blobdiff