doc/query_rewrite.xml

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
   2     "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd" [
   3  <!ENTITY copyright SYSTEM "copyright.xml">
   4  <!ENTITY % common SYSTEM "common/common.ent">
   5      %common;
   6 ]>
   7 <!-- $Id: query_rewrite.xml,v 1.6 2007-05-09 21:23:08 adam Exp $ -->
   8 <refentry id="ref-query_rewrite">
   9  <refmeta>
  10   <refentrytitle>query_rewrite</refentrytitle>
  11   <manvolnum>3mp</manvolnum>
  12    <refmiscinfo>Metaproxy Module</refmiscinfo>
  13 </refmeta>
  14
  15  <refnamediv>
  16   <refname>query_rewrite</refname>
  17   <refpurpose>Metaproxy RPN Query Rewrite Module</refpurpose>
  18  </refnamediv>
  19
  20  <refsect1><title>DESCRIPTION</title>
  21   <para>
  22    This module allows Z39.50 Type-1 queries to be arbitrarily
  23    rewritten using an XSLT stylesheet to specify the rewrite rules.
  24    This can be useful for several purposes, including the provision of
  25    index aliases (e.g. BIB-1 access-point 1, personal name, rewritten
  26    to access-point 1003, author); and protecting fragile Z39.50 server
  27    from attribute combinations that cause them problems.
  28   </para>
  29   <para>
  30    The Type-1 query is translated into an XML representation,
  31    transformed by an XSLT stylesheet whose path is specified in the
  32    filter configuration's <literal>&lt;xslt&gt;</literal> element,
  33    then translated back into a Type-1 query.
  34   </para>
  35   <para>
  36    ### Describe the XML representation.
  37   </para>
  38  </refsect1>
  39
  40  <refsect1><title>EXAMPLES</title>
  41   <para>
  42    A typical configuration looks like this:
  43    <screen><![CDATA[
  44    <filter type="query_rewrite">
  45     <xslt>pqf2pqf.xsl</xslt>
  46    </filter>
  47 ]]>
  48    </screen>
  49   </para>
  50  </refsect1>
  51
  52  <refsect1><title>SEE ALSO</title>
  53   <para>
  54    <citerefentry>
  55     <refentrytitle>metaproxy</refentrytitle>
  56     <manvolnum>1</manvolnum>
  57    </citerefentry>
  58   </para>
  59  </refsect1>
  60
  61  &copyright;
  62 </refentry>
  63
  64 <!-- Keep this comment at the end of the file
  65 Local variables:
  66 mode: sgml
  67 sgml-omittag:t
  68 sgml-shorttag:t
  69 sgml-minimize-attributes:nil
  70 sgml-always-quote-attributes:t
  71 sgml-indent-step:1
  72 sgml-indent-data:t
  73 sgml-parent-document:nil
  74 sgml-local-catalogs: nil
  75 sgml-namecase-general:t
  76 End:
  77 -->