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