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