Doc: Fix spell of emphasis tag.
[metaproxy-moved-to-github.git] / doc / session_shared.xml
index 480ad35..e903343 100644 (file)
@@ -1,24 +1,36 @@
-<!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 copyright SYSTEM "copyright.xml">
+ <!ENTITY % idcommon SYSTEM "common/common.ent">
+     %idcommon;
 ]>
-<!-- $Id: session_shared.xml,v 1.5 2007-01-18 09:12:00 adam Exp $ -->
-<refentry>
+<refentry id="ref-session_shared">
+ <refentryinfo>
+  <productname>Metaproxy</productname>
+  <info><orgname>Index Data</orgname></info>
+ </refentryinfo>
+
  <refmeta>
   <refentrytitle>session_shared</refentrytitle>
   <manvolnum>3mp</manvolnum>
-  <refmiscinfo>Metaproxy Module</refmiscinfo>
+  <refmiscinfo class="manual">Metaproxy Module</refmiscinfo>
  </refmeta>
  
  <refnamediv>
   <refname>session_shared</refname>
-  <refpurpose>Module for sharing result-sets etc. between threads</refpurpose>
+  <refpurpose> Metaproxy Module for sharing system ressorces between 
+   threads</refpurpose>
  </refnamediv>
  
  <refsect1><title>DESCRIPTION</title>
   <para>
-   This module allows many Z39.50 frontend sessions to share
-   a number of backend sessions. The purpose is this filter is to:
+   This filter implements global sharing of
+   result sets (i.e. between threads and therefore between
+   clients), yielding performance improvements especially when
+   incoming requests are from a stateless environment such as a
+   web-server, in which the client process representing a session
+   might be any one of many.
+   It performs the following actions:
    <itemizedlist>
     <listitem>
      <para>
@@ -27,7 +39,7 @@
     </listitem>
     <listitem>
      <para>
-      Reduce number of Initializations with backend servers.
+      Reduce the number of initializations with backend servers.
      </para>
     </listitem>
     <listitem>
   </para>
  </refsect1>
 
+ <refsect1><title>SCHEMA</title>
+   <literallayout><xi:include
+                    xi:href="../xml/schema/filter_session_shared.rnc"
+                    xi:parse="text"  
+                    xmlns:xi="http://www.w3.org/2001/XInclude" />
+   </literallayout>
+ </refsect1>
  <refsect1><title>EXAMPLES</title>
   <para>
    Configuration: