Schema and beginnings of man page for zoom filter

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

diff --git a/doc/virt_db.xml b/doc/virt_db.xml
index c0a305b..d662688 100644 (file)
--- a/doc/virt_db.xml
+++ b/doc/virt_db.xml
@@ -1,15 +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;
 ]>
 <refentry id="ref-virt_db">
+ <refentryinfo>
+  <productname>Metaproxy</productname>
+  <info><orgname>Index Data</orgname></info>
+ </refentryinfo>
+
  <refmeta>
   <refentrytitle>virt_db</refentrytitle>
   <manvolnum>3mp</manvolnum>
-   <refmiscinfo>Metaproxy Module</refmiscinfo>
-</refmeta>
+  <refmiscinfo class="manual">Metaproxy Module</refmiscinfo>
+ </refmeta>
  
  <refnamediv>
   <refname>virt_db</refname>
@@ -38,7 +43,10 @@
   <para>
    Following that is one or more <literal>&lt;target&gt;</literal>
    elements with the identifier of each target that the virtual database
-   maps to.
+   maps to. If a database is given for a target (following a slash), that
+   database name is used as Z39.50 database for this target. If the
+   database is omitted for the target, the original (virtual) database
+   is used as Z39.50 database.
   </para>
   <para>
    If multiple targets are given that has special meaning depending on the
@@ -58,6 +66,13 @@
   </para>
  </refsect1>
  
+ <refsect1><title>SCHEMA</title>
+   <literallayout><xi:include
+                    xi:href="../xml/schema/filter_virt_db.rnc" xi:parse="text"
+                    xmlns:xi="http://www.w3.org/2001/XInclude" />
+   </literallayout>
+ </refsect1>
+ 
  <refsect1><title>EXAMPLES</title>
   <para>
    Consider this virt_db configuration:
@@ -82,7 +97,7 @@
       </virtual>
       <virtual>
         <database>*</database><!-- default -->
-        <target>localhost:9999</target>
+        <target>localhost:9999</target><-- database not altered -->
       </virtual>
     </filter>
 ]]>