New
authorMike Taylor <mike@indexdata.com>
Thu, 30 Mar 2006 13:11:11 +0000 (13:11 +0000)
committerMike Taylor <mike@indexdata.com>
Thu, 30 Mar 2006 13:11:11 +0000 (13:11 +0000)
doc/query_rewrite.xml [new file with mode: 0644]

diff --git a/doc/query_rewrite.xml b/doc/query_rewrite.xml
new file mode 100644 (file)
index 0000000..c22a577
--- /dev/null
@@ -0,0 +1,75 @@
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" 
+    "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd" [
+ <!ENTITY copyright SYSTEM "copyright.xml">
+]>
+<!-- $Id: query_rewrite.xml,v 1.1 2006-03-30 13:11:11 mike Exp $ -->
+<refentry>
+ <refmeta>
+  <refentrytitle>query_rewrite</refentrytitle>
+  <manvolnum>3mp</manvolnum>
+   <refmiscinfo>Metaproxy Module</refmiscinfo>
+</refmeta>
+ <refnamediv>
+  <refname>query_rewrite</refname>
+  <refpurpose>network server</refpurpose>
+ </refnamediv>
+
+ <refsect1><title>DESCRIPTION</title>
+  <para>
+   This module allows Z39.50 Type-1 queries to be arbitrarily
+   rewritten using an XSLT stylesheet to specify the rewrite rules.
+   This can be useful for several purposes, including the provision of
+   index aliases (e.g. BIB-1 access-point 1, personal name, rewritten
+   to access-point 1003, author); and protecting fragile Z39.50 server
+   from attribute combinations that cause them problems.
+  </para>
+  <para>
+   The Type-1 query is translated into an XML representation,
+   transformed by an XSLT stylesheet whose path is specified in the
+   filter configuration's <literal>&lt;xslt&gt;</literal> element,
+   then translated back into a Type-1 query.
+  </para>
+  <para>
+   ### Describe the XML representation.
+  </para>
+ </refsect1>
+ <refsect1><title>EXAMPLES</title>
+  <para>
+   A typical configuration looks as likes:
+   <screen><![CDATA[
+   <filter type="query_rewrite">
+    <xslt>pqf2pqf.xsl</xslt>
+   </filter>
+]]>
+   </screen>
+  </para>
+ </refsect1> 
+ <refsect1><title>SEE ALSO</title>
+  <para>
+   <citerefentry>
+    <refentrytitle>metaproxy</refentrytitle>
+    <manvolnum>1</manvolnum>
+   </citerefentry>
+  </para>
+ </refsect1>
+ &copyright;
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+sgml-parent-document:nil
+sgml-local-catalogs: nil
+sgml-namecase-general:t
+End:
+-->