X-Git-Url: http://jsfdemo.indexdata.com/?a=blobdiff_plain;f=doc%2Ftools.xml;h=a17b902c4f9f3c105dedadc83e38026c911c0c1d;hb=bd6a2e5050dfc5ea460202106fe396c584c31838;hp=4b2a9a1c5a615732cfb8302e2aa29a89a7c05ac0;hpb=ce853cc4919ab346fd629e7727905d3ee6e1129f;p=yaz-moved-to-github.git diff --git a/doc/tools.xml b/doc/tools.xml index 4b2a9a1..a17b902 100644 --- a/doc/tools.xml +++ b/doc/tools.xml @@ -1,9 +1,9 @@ - + Supporting Tools - + 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. @@ -51,9 +51,8 @@ int p_query_attset (const char *arg); to provide a memory source (the structure created is released on the next call to odr_reset() on the stream), a protocol identifier (one of the constants PROTO_Z3950 and - PROTO_SR), an attribute set - reference, and finally a null-terminated string holding the query - string. + PROTO_SR), an attribute set reference, and + finally a null-terminated string holding the query string. If the parse went well, p_query_rpn() returns a @@ -74,13 +73,13 @@ int p_query_attset (const char *arg); - 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. @@ -139,6 +138,8 @@ int p_query_attset (const char *arg); @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 @@ -252,7 +253,7 @@ int p_query_attset (const char *arg); 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 @@ -264,12 +265,12 @@ int p_query_attset (const char *arg); title-index. In this case, the user could specify - > + ti,ranked=knuth computer - and the ranked would map to structure=free-form-text - (4=105) and the ti would map to title (1=4). + and the ranked would map to relation=relevance + (2=102) and the ti would map to title (1=4). @@ -341,20 +342,20 @@ int p_query_attset (const char *arg); To parse a simple string with a FIND query use the function - 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); which takes the CCL profile (bibset) and query (str) 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 error holds the error code and pos holds the offset inside query string in which the parsing failed. - An english representation of the error may be obtained by calling + An English representation of the error may be obtained by calling the ccl_err_msg function. The error codes are listed in ccl.h. @@ -591,7 +592,7 @@ typedef struct oident The function - < + oid_value oid_getvalbyname(const char *name); @@ -676,17 +677,17 @@ typedef struct oident - 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 nmem_init() - 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. - +