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