X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Ftools.xml;h=d47683fc1d4dbb6bbe05dee6975880f0cb359a1e;hb=9c70253e4c7eedab806490b87a9a58e970998429;hp=d9a57b7712020e97295e718cb01dfae3389c0700;hpb=60a702f390f7e2addfdab79f2328db3ba2897c8b;p=yaz-moved-to-github.git diff --git a/doc/tools.xml b/doc/tools.xml index d9a57b7..d47683f 100644 --- a/doc/tools.xml +++ b/doc/tools.xml @@ -1,4 +1,4 @@ - + Supporting Tools @@ -225,7 +225,7 @@ @and. Its semantics are described in section 3.7.2 (Proximity) of Z39.50 the standard itself, which can be read on-line at - + In PQF, the proximity operation is represented by a sequence @@ -294,7 +294,7 @@ (The numeric values of the relation and well-known unit-code parameters are taken straight from - the ASN.1 of the proximity structure in the standard.) @@ -305,6 +305,7 @@ dylan + "bob dylan" @@ -313,7 +314,9 @@ @or "dylan" "zimmerman" + @and @or dylan zimmerman when + @and when @or dylan zimmerman @@ -322,7 +325,8 @@ @set Result-1 - @and @set seta setb + + @and @set seta @set setb @@ -330,9 +334,13 @@ @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 @@ -632,10 +640,8 @@ - The complete list of Bib-1 attributes can be found - - here - . + Refer to the complete + list of Bib-1 attributes It is also possible to specify non-numeric attribute values, @@ -932,20 +938,18 @@ struct ccl_rpn_node *ccl_find_str (CCL_bibset bibset, const char *str, CQL - CQL + CQL - Common Query Language - was defined for the - SRW - protocol. + SRU 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 the protocol - query language for SRW. + query language for SRU. If you are new to CQL, read the - Gentle - Introduction. + Gentle Introduction. @@ -965,17 +969,16 @@ struct ccl_rpn_node *ccl_find_str (CCL_bibset bibset, const char *str, The parser converts a valid CQL query to PQF, thus providing a - way to use CQL for both SRW/SRU servers and Z39.50 targets at the + way to use CQL for both SRU servers and Z39.50 targets at the same time. The parser converts CQL to - - XCQL. + XCQL. XCQL is an XML representation of CQL. - XCQL is part of the SRW specification. However, since SRU + XCQL is part of the SRU specification. However, since SRU supports CQL only, we don't expect XCQL to be widely used. Furthermore, CQL has the advantage over XCQL that it is easy to read. @@ -1081,6 +1084,8 @@ struct cql_node { If an index is unspecified for a search term, index will be NULL. + + index_uri: index URi for search term or NULL if none could be resolved for the index. @@ -1136,7 +1141,7 @@ struct cql_node { Conversion to PQF (and Z39.50 RPN) is tricky by the fact that the resulting RPN depends on the Z39.50 target capabilities (combinations of supported attributes). - In addition, the CQL and SRW operates on index prefixes + In addition, the CQL and SRU operates on index prefixes (URI or strings), whereas the RPN uses Object Identifiers for attribute sets. @@ -1171,10 +1176,10 @@ int cql_transform_buf(cql_transform_t ct, If conversion failed, cql_transform_buf - returns a non-zero SRW error code; otherwise zero is returned + returns a non-zero SRU error code; otherwise zero is returned (conversion successful). The meanings of the numeric error - codes are listed in the SRW specifications at - + codes are listed in the SRU specifications at + If conversion fails, more information can be obtained by calling @@ -1190,7 +1195,7 @@ int cql_transform_error(cql_transform_t ct, char **addinfop); context set that was not recognised. - The SRW error-codes may be translated into brief human-readable + The SRU error-codes may be translated into brief human-readable error messages using const char *cql_strerror(int code); @@ -1214,7 +1219,7 @@ int cql_transform_FILE(cql_transform_t ct, - Specification of CQL to RPN mapping + Specification of CQL to RPN mappings The file supplied to functions cql_transform_open_FILE, @@ -1598,7 +1603,7 @@ typedef struct oident again, corresponding to the specific OIDs defined by the standard. Refer to the - + Registry of Z39.50 Object Identifiers for the whole list.