projects
/
pazpar2-moved-to-github.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Follow style of previous NEWS entries
[pazpar2-moved-to-github.git]
/
doc
/
pazpar2_protocol.xml
diff --git
a/doc/pazpar2_protocol.xml
b/doc/pazpar2_protocol.xml
index
009635b
..
e90b5c4
100644
(file)
--- a/
doc/pazpar2_protocol.xml
+++ b/
doc/pazpar2_protocol.xml
@@
-1,6
+1,6
@@
<?xml version="1.0" standalone="no"?>
<?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
- "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd"
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
+ "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"
[
<!ENTITY % local SYSTEM "local.ent">
%local;
[
<!ENTITY % local SYSTEM "local.ent">
%local;
@@
-13,10
+13,12
@@
<refentryinfo>
<productname>Pazpar2</productname>
<productnumber>&version;</productnumber>
<refentryinfo>
<productname>Pazpar2</productname>
<productnumber>&version;</productnumber>
+ <info><orgname>Index Data</orgname></info>
</refentryinfo>
<refmeta>
<refentrytitle>Pazpar2 protocol</refentrytitle>
<manvolnum>7</manvolnum>
</refentryinfo>
<refmeta>
<refentrytitle>Pazpar2 protocol</refentrytitle>
<manvolnum>7</manvolnum>
+ <refmiscinfo class="manual">Conventions and miscellaneous</refmiscinfo>
</refmeta>
<refnamediv>
</refmeta>
<refnamediv>
@@
-32,7
+34,7
@@
request is forwarded to the HTTP server specified in the configuration
using the proxy setting.
This way, a regular webserver can host the user interface (itself dynamic
request is forwarded to the HTTP server specified in the configuration
using the proxy setting.
This way, a regular webserver can host the user interface (itself dynamic
- or static HTML), and AJAX-style calls can be used from JS (or any other client-based
+ or static HTML), and Ajax-style calls can be used from JS (or any other client-based
scripting environment) to interact with the search logic in Pazpar2.
</para>
<para>
scripting environment) to interact with the search logic in Pazpar2.
</para>
<para>
@@
-41,7
+43,9
@@
<refsect2 id="command-init"><title>init</title>
<para>
Initializes a session.
<refsect2 id="command-init"><title>init</title>
<para>
Initializes a session.
- Returns session ID to be used in subsequent requests.
+ Returns session ID to be used in subsequent requests. If
+ a server ID is given in the Pazpar2 server section, then a
+ period (.) and the server ID is appended to the session ID.
</para>
<para>
Example:
</para>
<para>
Example:
@@
-486,6
+490,14
@@
search.pz2?session=605047297&command=record&id=3
</para>
</listitem>
</varlistentry>
</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term>num</term>
+ <listitem>
+ <para>
+ maximum number of entries to return - default is 15.
+ </para>
+ </listitem>
+ </varlistentry>
</variablelist>
</para>
<para>
</variablelist>
</para>
<para>