Doc: module ref entries include RelagNG schema

[metaproxy-moved-to-github.git] / doc / load_balance.xml

diff --git a/doc/load_balance.xml b/doc/load_balance.xml
index 5fdf57e..fd8867e 100644 (file)
--- a/doc/load_balance.xml
+++ b/doc/load_balance.xml
@@ -1,16 +1,20 @@
-<!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: load_balance.xml,v 1.4 2007-05-22 11:05:45 adam Exp $ -->
 <refentry id="ref-load_balance">
+ <refentryinfo>
+  <productname>Metaproxy</productname>
+  <info><orgname>Index Data</orgname></info>
+ </refentryinfo>
+
  <refmeta>
   <refentrytitle>load_balance</refentrytitle>
   <manvolnum>3mp</manvolnum>
-   <refmiscinfo>Metaproxy Module</refmiscinfo>
-</refmeta>
+  <refmiscinfo class="manual">Metaproxy Module</refmiscinfo>
+ </refmeta>
  
  <refnamediv>
   <refname>load_balance</refname>
@@ -23,23 +27,43 @@
    This filter balances load among Z39.50 targets based on statistics
    gathered on number of open sessions and number of open package requests. 
   </para>
+  <para>
+   The load balancing is depending on targets to be specified (vhosts).
+   Most Z39.50 clients do not specify that. For this reason, this
+   filter is mostly used as a follower to filter virt_db.
+  </para>
+ </refsect1>
+ 
+ <refsect1><title>SCHEMA</title>
+   <literallayout><xi:include
+                    xi:href="../xml/schema/filter_load_balance.rnc"
+                    xi:parse="text"  
+                    xmlns:xi="http://www.w3.org/2001/XInclude" />
+   </literallayout>
  </refsect1>
  
  <refsect1><title>EXAMPLES</title>
   <para>
-   A typical configuration looks like this:
+   This configuration offers one database, <literal>Default</literal>,
+   which is load-balanced between two backend servers.
    <screen><![CDATA[
+    <filter type="virt_db"/>
+      <database>Default</database>
+      <target>host1:210/Default</target>
+      <target>host2:210/Default</target>
+    </filter>
     <filter type="load_balance"/>
 ]]>
    </screen>
   </para>
+  
  </refsect1> 
  
  <refsect1><title>SEE ALSO</title>
   <para>
    <citerefentry>
-    <refentrytitle>metaproxy</refentrytitle>
-    <manvolnum>1</manvolnum>
+    <refentrytitle>virt_db</refentrytitle>
+    <manvolnum>3mp</manvolnum>
    </citerefentry>
   </para>
  </refsect1>