-<!-- $Id: tools.xml,v 1.2 2001-07-19 23:29:40 adam Exp $ -->
+<!-- $Id: tools.xml,v 1.5 2001-08-13 09:42:54 adam Exp $ -->
<chapter><title>Supporting Tools</title>
-
+
<para>
In support of the service API - primarily the ASN module, which
- provides the programmatic interface to the Z39.50 APDUs, YAZ contains
+ provides the pro-grammatic interface to the Z39.50 APDUs, &yaz; contains
a collection of tools that support the development of applications.
</para>
to provide a memory source (the structure created is released on
the next call to <function>odr_reset()</function> on the stream), a
protocol identifier (one of the constants <token>PROTO_Z3950</token> and
- <token>PROTO_SR</token>), an attribute set
- reference, and finally a null-terminated string holding the query
- string.
+ <token>PROTO_SR</token>), an attribute set reference, and
+ finally a null-terminated string holding the query string.
</para>
<para>
If the parse went well, <function>p_query_rpn()</function> returns a
</para>
<screen>
- Query ::= [ AttSet ] QueryStruct.
+ Query ::= [ '@attrset' AttSet ] QueryStruct.
AttSet ::= string.
- QueryStruct ::= { Attribute } Simple | Complex.
+ QueryStruct ::= [ Attribute ] Simple | Complex.
- Attribute ::= '@attr' AttributeType '=' AttributeValue.
+ Attribute ::= '@attr' [ AttSet ] AttributeType '=' AttributeValue.
AttributeType ::= integer.
@attr 4=1 @attr 1=4 "self portrait"
@prox 0 3 1 2 k 2 dylan zimmerman
+
+ @and @attr 2=4 @attr gils 1=2038 -114 @attr 2=2 @attr gils 1=2039 -109
</screen>
</sect2>
index, such as title (ti) and author indexes (au). The CCL standard
itself doesn't specify a particular set of qualifiers, but it does
suggest a few short-hand notations. You can customize the CCL parser
- to support a particular set of qualifiers to relect the current target
+ to support a particular set of qualifiers to reflect the current target
profile. Traditionally, a qualifier would map to a particular
use-attribute within the BIB-1 attribute set. However, you could also
define qualifiers that would set, for example, the
title-index. In this case, the user could specify
</para>
- <screen>>
+ <screen>
ti,ranked=knuth computer
</screen>
<para>
- and the <literal>ranked</literal> would map to structure=free-form-text
- (4=105) and the <literal>ti</literal> would map to title (1=4).
+ and the <literal>ranked</literal> would map to relation=relevance
+ (2=102) and the <literal>ti</literal> would map to title (1=4).
</para>
<para>
To parse a simple string with a FIND query use the function
</para>
<screen>
- struct ccl_rpn_node *ccl_find_str (CCL_bibset bibset, const char *str,
- int *error, int *pos);
+struct ccl_rpn_node *ccl_find_str (CCL_bibset bibset, const char *str,
+ int *error, int *pos);
</screen>
<para>
which takes the CCL profile (<literal>bibset</literal>) and query
(<literal>str</literal>) as input. Upon successful completion the RPN
- tree is returned. If an error eccur, such as a syntax error, the integer
+ tree is returned. If an error occur, such as a syntax error, the integer
pointed to by <literal>error</literal> holds the error code and
<literal>pos</literal> holds the offset inside query string in which
the parsing failed.
</para>
<para>
- An english representation of the error may be obtained by calling
+ An English representation of the error may be obtained by calling
the <literal>ccl_err_msg</literal> function. The error codes are
listed in <filename>ccl.h</filename>.
</para>
The function
</para>
- <screen><
+ <screen>
oid_value oid_getvalbyname(const char *name);
</screen>
<note>
<para>
- The nibble memory pool is shared amonst threads. POSIX
+ The nibble memory pool is shared amongst threads. POSIX
mutex'es and WIN32 Critical sections are introduced to keep the
module thread safe. On WIN32 function <function>nmem_init()</function>
- initialises the Critical Section handle and should be called once
+ initializes the Critical Section handle and should be called once
before any other nmem function is used.
</para>
</note>
</sect1>
</chapter>
-
+
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml