-<!-- $Id: tools.xml,v 1.42 2004-11-23 14:11:03 heikki Exp $ -->
+<!-- $Id: tools.xml,v 1.49 2006-04-25 11:25:08 marc Exp $ -->
<chapter id="tools"><title>Supporting Tools</title>
<para>
<literal>@and</literal>. Its semantics are described in
section 3.7.2 (Proximity) of Z39.50 the standard itself, which
can be read on-line at
- <ulink url="http://lcweb.loc.gov/z3950/agency/markup/09.html"/>
+ <ulink url="&url.z39.50.proximity;"/>
</para>
<para>
In PQF, the proximity operation is represented by a sequence
</itemizedlist>
(The numeric values of the relation and well-known unit-code
parameters are taken straight from
- <ulink url="http://lcweb.loc.gov/z3950/agency/asn1.html#ProximityOperator"
+ <ulink url="&url.z39.50.proximity.asn1;"
>the ASN.1</ulink> of the proximity structure in the standard.)
</para>
</sect3>
<para>
<screen>
dylan
+
"bob dylan"
</screen>
</para>
<para>
<screen>
@or "dylan" "zimmerman"
+
@and @or dylan zimmerman when
+
@and when @or dylan zimmerman
</screen>
</para>
<para>
<screen>
@set Result-1
- @and @set seta setb
+
+ @and @set seta @set setb
</screen>
</para>
</example>
<para>
<screen>
@attr 1=4 computer
+
@attr 1=4 @attr 4=1 "self portrait"
+
@attrset exp1 @attr 1=1 CategoryList
+
@attr gils 1=2008 Copenhagen
+
@attr 1=/book/title computer
</screen>
</para>
</table>
</para>
<para>
- The complete list of Bib-1 attributes can be found
- <ulink url="http://lcweb.loc.gov/z3950/agency/defns/bib1.html">
- here
- </ulink>.
+ Refer to the complete
+ <ulink url="&url.z39.50.attset.bib1;">list of Bib-1 attributes</ulink>
</para>
<para>
It is also possible to specify non-numeric attribute values,
</sect2>
<sect2 id="tools.cql"><title>CQL</title>
<para>
- <ulink url="http://www.loc.gov/z3950/agency/zing/cql/">CQL</ulink>
+ <ulink url="&url.cql;">CQL</ulink>
- Common Query Language - was defined for the
- <ulink url="http://www.loc.gov/z3950/agency/zing/srw/">SRW</ulink>
- protocol.
+ <ulink url="&url.srw;">SRW</ulink> protocol.
In many ways CQL has a similar syntax to CCL.
The objective of CQL is different. Where CCL aims to be
an end-user language, CQL is <emphasis>the</emphasis> protocol
<tip>
<para>
If you are new to CQL, read the
- <ulink url="http://zing.z3950.org/cql/intro.html">Gentle
- Introduction</ulink>.
+ <ulink url="&url.cql.intro;">Gentle Introduction</ulink>.
</para>
</tip>
<para>
<listitem>
<para>
The parser converts CQL to
- <ulink url="http://www.loc.gov/z3950/agency/zing/cql/xcql.html">
- XCQL</ulink>.
+ <ulink url="&url.xcql;">XCQL</ulink>.
XCQL is an XML representation of CQL.
XCQL is part of the SRW specification. However, since SRU
supports CQL only, we don't expect XCQL to be widely used.
If an index is unspecified for a search term,
<literal>index</literal> will be NULL.
</para>
+ </listitem>
+ <listitem>
<para>
<literal>index_uri</literal>: index URi for search term
or NULL if none could be resolved for the index.
returns a non-zero SRW error code; otherwise zero is returned
(conversion successful). The meanings of the numeric error
codes are listed in the SRW specifications at
- <ulink url="http://www.loc.gov/srw/diagnostic-list.html"/>
+ <ulink url="&url.sru.diagnostics.list;"/>
</para>
<para>
If conversion fails, more information can be obtained by calling
</para>
</sect3>
<sect3 id="tools.cql.map">
- <title>Specification of CQL to RPN mapping</title>
+ <title>Specification of CQL to RPN mappings</title>
<para>
The file supplied to functions
<function>cql_transform_open_FILE</function>,
<para>
again, corresponding to the specific OIDs defined by the standard.
Refer to the
- <ulink url="http://lcweb.loc.gov/z3950/agency/defns/oids.html">
+ <ulink url="&url.z39.50.oids;">
Registry of Z39.50 Object Identifiers</ulink> for the
whole list.
</para>
production use of those applications.
</para>
<para>
- The log functions are declared in header <filename>yaz/ylog.h</filename>
+ The log functions are declared in header <filename>yaz/log.h</filename>
and implemented in <filename>src/log.c</filename>.
Due to name clash with syslog and some math utilities the logging
interface has been modified as of YAZ 2.0.29. The obsolete interface
- is still available if the application includes
- <filename>yaz/log.h</filename>. The key points of the interface are:
+ is still available if in header file <filename>yaz/log.h</filename>.
+ The key points of the interface are:
</para>
<screen>
void yaz_log(int level, const char *fmt, ...)
#define YAZ_MARC_OAIMARC 2
#define YAZ_MARC_MARCXML 3
#define YAZ_MARC_ISO2709 4
+ #define YAZ_MARC_XCHANGE 5
/* supply iconv handle for character set conversion .. */
void yaz_marc_iconv(yaz_marc_t mt, yaz_iconv_t cd);