From: Adam Dickmeiss <adam@indexdata.dk>
Date: Tue, 26 Jan 2010 13:42:55 +0000 (+0100)
Subject: Document server ID attribute
X-Git-Tag: v1.4.0~161
X-Git-Url: http://sru.miketaylor.org.uk/?a=commitdiff_plain;h=c46a98ec5fdcb2da46f3263e182ca3ec31bc03a3;p=pazpar2-moved-to-github.git

Document server ID attribute
---

diff --git a/doc/pazpar2_conf.xml b/doc/pazpar2_conf.xml
index 0614ada..013b264 100644
--- a/doc/pazpar2_conf.xml
+++ b/doc/pazpar2_conf.xml
@@ -48,7 +48,7 @@
  
  <refsect1><title>FORMAT</title>
   <para>
-   The configuration file is XML-structured. It must be valid XML. All
+   The configuration file is XML-structured. It must be well-formed XML. All
    elements specific to Pazpar2 should belong to the namespace
    <literal>http://www.indexdata.com/pazpar2/1.0</literal> 
    (this is assumed in the
@@ -59,7 +59,12 @@
   
   <refsect2 id="config-server"><title>server</title>
    <para>
-    This section governs overall behavior of the server. The data
+    This section governs overall behavior of the server. It is identified
+    by the element "server" which takes an optional attribute, "id", which
+    identifies this particular Pazpar2 server. Any string value for "id"
+    may be given.
+   </para>
+   <para>The data
     elements are described below. From Pazpar2 version 1.2 this is
     a repeatable element.
    </para>
diff --git a/doc/pazpar2_protocol.xml b/doc/pazpar2_protocol.xml
index 009635b..7655d1c 100644
--- a/doc/pazpar2_protocol.xml
+++ b/doc/pazpar2_protocol.xml
@@ -41,7 +41,9 @@
   <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: