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   <orgname>Index Data</orgname>
  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>SCHEMA</title>
  56    <literallayout><xi:include
  57                      xi:href="../xml/schema/filter_cql_rpn.rnc"
  58                      xi:parse="text"
  59                      xmlns:xi="http://www.w3.org/2001/XInclude" />
  60    </literallayout>
  61  </refsect1>
  62
  63  <refsect1><title>EXAMPLES</title>
  64   <para>
  65    A typical configuration looks like this:
  66    <screen><![CDATA[
  67     <filter id="cql" type="cql_rpn">
  68       <conversion file="etc/cql2pqf.txt"/>
  69     </filter>
  70  ]]>
  71    </screen>
  72   </para>
  73  </refsect1>
  74
  75  <refsect1><title>SEE ALSO</title>
  76   <para>
  77    <citerefentry>
  78     <refentrytitle>metaproxy</refentrytitle>
  79     <manvolnum>1</manvolnum>
  80    </citerefentry>
  81   </para>
  82  </refsect1>
  83
  84  &copyright;
  85 </refentry>
  86
  87 <!-- Keep this comment at the end of the file
  88 Local variables:
  89 mode: nxml
  90 nxml-child-indent: 1
  91 End:
  92 -->