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