zoom doc: spell fix

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

diff --git a/doc/multi.xml b/doc/multi.xml
index 3c819b5..091862d 100644 (file)
--- a/doc/multi.xml
+++ b/doc/multi.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: multi.xml,v 1.9 2007-05-22 11:05:45 adam Exp $ -->
 <refentry id="ref-multi">
+ <refentryinfo>
+  <productname>Metaproxy</productname>
+  <info><orgname>Index Data</orgname></info>
+ </refentryinfo>
+
  <refmeta>
   <refentrytitle>multi</refentrytitle>
   <manvolnum>3mp</manvolnum>
-   <refmiscinfo>Metaproxy Module</refmiscinfo>
-</refmeta>
+  <refmiscinfo class="manual">Metaproxy Module</refmiscinfo>
+ </refmeta>
  
  <refnamediv>
   <refname>multi</refname>
@@ -21,16 +25,16 @@
   <para>
    This filter multiplexes packages.
   </para>
- </refsect1>
- 
- <refsect1><title>EXAMPLES</title>
   <para>
-   A typical configuration looks like this:
-   <screen><![CDATA[
-    <filter type="multi">
-    </filter>
-]]>
-   </screen>
+   The multi filter consists of zero or more
+   <literal>&lt;target&gt;</literal> elements.
+   If a target matches a given target specified as CDATA in the
+   target element, the multi filter will route traffic to the route
+   given by the route attribute.
+  </para>
+  <para>
+   A target element is not required for multi-plexing to work.
+   It merely serves as a way to route differently. 
   </para>
   <para>
    If an empty
@@ -41,6 +45,29 @@
    but simply ignored (unless every one of the databases is
    unavailable).
   </para>
+ </refsect1>
+ 
+ <refsect1><title>SCHEMA</title>
+   <literallayout><xi:include
+                    xi:href="../xml/schema/filter_multi.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:
+   <screen><![CDATA[
+    <filter type="multi">
+     <target route="route1">z3950.loc.gov:7090/voyager</target>
+     <target route="route2">bagel.indexdata.dk/gils</target>
+     <target route="other">*</target>
+    </filter>
+]]>
+   </screen>
+  </para>
+
  </refsect1> 
  
  <refsect1><title>SEE ALSO</title>