DB: Add refentryinfo for man pages
[metaproxy-moved-to-github.git] / doc / cql_rpn.xml
1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN" 
2     "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
3  <!ENTITY copyright SYSTEM "copyright.xml">
4  <!ENTITY % idcommon SYSTEM "common/common.ent">
5      %idcommon;
6 ]>
7 <refentry id="ref-cql_rpn">
8  <refentryinfo>
9   <productname>Metaproxy</productname>
10   <info><orgname>Index Data</orgname></info>
11  </refentryinfo>
12
13  <refmeta>
14   <refentrytitle>cql_rpn</refentrytitle>
15   <manvolnum>3mp</manvolnum>
16   <refmiscinfo class="manual">Metaproxy Module</refmiscinfo>
17 </refmeta>
18  
19  <refnamediv>
20   <refname>cql_rpn</refname>
21   <refpurpose>Metaproxy CQL to RPN Query Language Transforming Module</refpurpose>
22  </refnamediv>
23
24  <refsect1><title>DESCRIPTION</title>
25   <para>
26    A query language transforming filter which catches Z39.50 
27    <literal>searchRequest</literal>
28    packages containing <literal>CQL</literal> queries, transforms
29    those to <literal>RPN</literal> queries,
30    and sends the <literal>searchRequests</literal> on to the next
31    filters.
32   </para>
33   <para>
34    The filter takes only one configuration parameter, namely the path
35    of the standard <literal>YAZ</literal> 
36    <literal>CQL</literal>-to-<literal>CQL</literal> configuration
37    file. See the  <ulink url="&url.yaz;">YAZ</ulink> manual for
38    configuration file syntax and details.
39   </para>
40   <para>
41    A common and wellknown challenge is that the ZeeRex SRU
42    Explain config file used in the <literal>sru_z3950</literal>
43    filter and the <literal>CQL</literal> translation configuration
44    file used in this filter must be kept in syncronization.
45    Syncronization can be eased by using the provided XSLT stylesheet,
46    <literal>xml/xslt/explain2cqlpqftxt.xsl</literal>, which transforms
47    from ZeeReX Explain to the later. The example configurations have
48    been created by running:
49    <screen>
50      xsltproc xml/xslt/explain2cqlpqftxt.xsl etc/explain.xml > etc/cql2pqf.txt
51    </screen> 
52   </para>
53  </refsect1>
54  
55  <refsect1><title>EXAMPLES</title>
56   <para>
57    A typical configuration looks like this:
58    <screen><![CDATA[
59     <filter id="cql" type="cql_rpn">
60       <conversion file="etc/cql2pqf.txt"/>
61     </filter>
62  ]]>
63    </screen>
64   </para>
65  </refsect1> 
66  
67  <refsect1><title>SEE ALSO</title>
68   <para>
69    <citerefentry>
70     <refentrytitle>metaproxy</refentrytitle>
71     <manvolnum>1</manvolnum>
72    </citerefentry>
73   </para>
74  </refsect1>
75  
76  &copyright;
77 </refentry>
78
79 <!-- Keep this comment at the end of the file
80 Local variables:
81 mode: sgml
82 sgml-omittag:t
83 sgml-shorttag:t
84 sgml-minimize-attributes:nil
85 sgml-always-quote-attributes:t
86 sgml-indent-step:1
87 sgml-indent-data:t
88 sgml-parent-document:nil
89 sgml-local-catalogs: nil
90 sgml-namecase-general:t
91 End:
92 -->