From 0ec12c344e05f3637af9f48e6aa28a54d99f8343 Mon Sep 17 00:00:00 2001 From: David Crossley Date: Mon, 5 Oct 2015 15:22:20 +1100 Subject: [PATCH] Various minor text tweaks. --- doc/book.xml | 260 +++++++++++++++++++++++++++++----------------------------- 1 file changed, 130 insertions(+), 130 deletions(-) diff --git a/doc/book.xml b/doc/book.xml index 203dd7c..f61011c 100644 --- a/doc/book.xml +++ b/doc/book.xml @@ -3050,7 +3050,7 @@ client-side, into RPN which may be passed to the server. This is useful for servers that don't themselves support CQL, for which ZOOM_query_cql is useless. - `conn' is used only as a place to stash diagnostics if compilation + 'conn' is used only as a place to stash diagnostics if compilation fails; if this information is not needed, a null pointer may be used. The CQL conversion is driven by option cqlfile from connection conn. This specifies a conversion file (e.g. pqf.properties) @@ -3992,7 +3992,7 @@ typedef struct bend_scan_rr { The &asn; module is located in sub directory z39.50. - There you'll find C files that implements encoders and decoders for the + There you'll find C files that implement encoders and decoders for the Z39.50 types. You'll also find the protocol definitions: z3950v3.asn, esupdate.asn, and others. @@ -4036,8 +4036,8 @@ typedef struct bend_scan_rr { for details). When you use odr_malloc(), you can release all of the allocated data in a single operation, independent of any pointers and - relations between the data. odr_malloc() is based on a - "nibble-memory" + relations between the data. The odr_malloc() function + is based on a "nibble-memory" scheme, in which large portions of memory are allocated, and then gradually handed out with each call to odr_malloc(). The next time you call odr_reset(), all of the @@ -4079,7 +4079,7 @@ typedef struct bend_scan_rr { Z_<type> *zget_<type>(ODR o); - eg.: + e.g.: Z_InitRequest *zget_InitRequest(ODR o); @@ -4168,7 +4168,7 @@ typedef struct Z_External octet_aligned arm of the union. - Some servers return ASN.1 structured data values (eg. database + Some servers return ASN.1 structured data values (e.g. database records) as BER-encoded records placed in the octet-aligned branch of the EXTERNAL CHOICE. The ASN-module will not automatically decode @@ -4179,8 +4179,8 @@ typedef struct Z_External Z_ext_typeent *z_ext_gettypebyref(const oid *oid); - Can be used to retrieve information about the known, external data - types. The function return a pointer to a static area, or NULL, if no + can be used to retrieve information about the known, external data + types. The function returns a pointer to a static area, or NULL, if no match for the given direct reference is found. The Z_ext_typeent is defined as: @@ -4214,7 +4214,7 @@ typedef struct Z_ext_typeent If you want to send EXTERNALs containing - ASN.1-structured values in the occtet-aligned branch of the CHOICE, this + ASN.1-structured values in the octet-aligned branch of the CHOICE, this is possible too. However, on the encoding phase, it requires a somewhat involved juggling around of the various buffers involved. @@ -4938,8 +4938,8 @@ typedef struct Z_ext_typeent Introduction &yaz; uses a very simple implementation of - SOAP that only, - currenly, supports what is sufficient to offer SRU SOAP functionality. + SOAP that only + (currently) supports what is sufficient to offer SRU SOAP functionality. The implementation uses the tree API of libxml2 to encode and decode SOAP packages. @@ -5018,7 +5018,7 @@ typedef struct { The fault and soap_error - arms represent both a SOAP fault - struct + arms both represent a SOAP fault - struct Z_SOAP_Fault. Any other generic (valid) package is represented by Z_SOAP_Generic. @@ -5048,18 +5048,18 @@ int z_soap_codec(ODR o, Z_SOAP **pp, When decoding, the z_soap_codec inspects the XML content and tries to match one of the services namespaces of the - supplied handlers. If there is a match a handler function + supplied handlers. If there is a match. a handler function is invoked which decodes that particular SOAP package. If successful, the returned Z_SOAP package will be of type Z_SOAP_Generic. Member no is - set the offset of handler that matched; ns - is set to namespace of matching handler; the void pointer + set the offset of the handler that matched; ns + is set to namespace of the matching handler; the void pointer p is set to the C data structure assocatiated with the handler. - When a NULL namespace is met (member ns bwlow), + When a NULL namespace is met (member ns below), that specifies end-of-list. @@ -5071,9 +5071,9 @@ typedef struct { Z_SOAP_fun f; } Z_SOAP_Handler; - The ns is namespace of service associated with - handler f. client_data - is user-defined data which is passed to handler. + The ns is the namespace of the service associated with + handler f. The client_data + is user-defined data which is passed to the handler. The prototype for a SOAP service handler is: @@ -5086,10 +5086,10 @@ int handler(ODR o, void * ptr, void **handler_data, is a libxml2 tree node pointer (xmlNodePtr) and is a pointer to the Body element of the SOAP package. The handler_data - is an opaque pointer to a C definitions associated with the - SOAP service. client_data is the pointer + is an opaque pointer to C definitions associated with the + SOAP service. The client_data is the pointer which was set as part of the Z_SOAP_handler. - Finally, ns the service namespace. + Finally, ns is the service namespace. @@ -5150,9 +5150,9 @@ typedef struct { Please observe that data of type xsd:string is represented as a char pointer (char *). A null pointer means that the element is absent. - Data of type xsd:integer is representd as a pointer to + Data of type xsd:integer is represented as a pointer to an int (int *). Again, a null pointer - us used for absent elements. + is used for absent elements. The SearchRetrieveResponse has the following definition. @@ -5171,7 +5171,7 @@ typedef struct { } Z_SRW_searchRetrieveResponse; The num_records and num_diagnostics - is number of returned records and diagnostics respectively and also + is number of returned records and diagnostics respectively, and also correspond to the "size of" arrays records and diagnostics. @@ -5204,7 +5204,7 @@ typedef struct { Supporting Tools In support of the service API - primarily the ASN module, which - provides the pro-grammatic interface to the Z39.50 APDUs, &yaz; contains + provides the programmatic interface to the Z39.50 APDUs, &yaz; contains a collection of tools that support the development of applications. @@ -5233,16 +5233,16 @@ typedef struct { - The PQF have been adopted by other parties developing Z39.50 + The PQF has been adopted by other parties developing Z39.50 software. It is often referred to as Prefix Query Notation - PQN. The PQF is defined by the pquery module in the YAZ library. - There are two sets of function that have similar behavior. First + There are two sets of functions that have similar behavior. First set operates on a PQF parser handle, second set doesn't. First set - set of functions are more flexible than the second set. Second set + of functions are more flexible than the second set. Second set is obsolete and is only provided to ensure backwards compatibility. @@ -5266,7 +5266,7 @@ typedef struct { A PQF parser is created and destructed by functions yaz_pqf_create and yaz_pqf_destroy respectively. - Function yaz_pqf_parse parses query given + Function yaz_pqf_parse parses the query given by string qbuf. If parsing was successful, a Z39.50 RPN Query is returned which is created using ODR stream o. If parsing failed, a NULL pointer is @@ -5280,8 +5280,8 @@ typedef struct { Error information for bad queries can be obtained by a call to yaz_pqf_error which returns an error code and modifies *msg to point to an error description, - and modifies *off to the offset within last - query were parsing failed. + and modifies *off to the offset within the last + query where parsing failed. The second set of functions are declared as follows: @@ -5370,9 +5370,9 @@ typedef struct { a sub-query. The attribute type-value pair is packed in one string: an attribute type, an equals sign, and an attribute value, like this: @attr 1=1003. - The type is always an integer but the value may be either an + The type is always an integer, but the value may be either an integer or a string (if it doesn't start with a digit character). - A string attribute-value is encoded as a Type-1 ``complex'' + A string attribute-value is encoded as a Type-1 "complex" attribute with the list of values containing the single string specified, and including no semantic indicators. @@ -5424,7 +5424,7 @@ typedef struct { @prox exclusion distance ordered relation which-code unit-code - in which the meanings of the parameters are as described in in + in which the meanings of the parameters are as described in the standard, and they can take the following values: @@ -5471,11 +5471,11 @@ typedef struct { or k (the unit-code parameter is taken from the well-known list - of alternatives described in below) or + of alternatives described below) or private or p - (the unit-code paramater has semantics specific to an + (the unit-code parameter has semantics specific to an out-of-band agreement such as a profile). @@ -5585,7 +5585,7 @@ typedef struct { - which-code is ``known'', so the standard unit-codes are used + which-code is "known", so the standard unit-codes are used @@ -5596,8 +5596,8 @@ typedef struct { dylan and zimmerman must both occur in the record, in that order, differing in position by three or fewer words (i.e. with two or fewer words between - them.) The query would find ``Bob Dylan, aka. Robert - Zimmerman'', but not ``Bob Dylan, born as Robert Zimmerman'' + them.) The query would find "Bob Dylan, aka. Robert + Zimmerman", but not "Bob Dylan, born as Robert Zimmerman" since the distance in this case is four. @@ -5625,8 +5625,8 @@ typedef struct { access point 2038 indicates West Bounding Coordinate and 2030 indicates East Bounding Coordinate, - so the query is for areas extending from -114 degrees - to no more than -109 degrees. + so the query is for areas extending from -114 degrees longitude + to no more than -109 degrees longitude. @@ -5645,7 +5645,7 @@ typedef struct { CCL Syntax The CCL parser obeys the following grammar for the FIND argument. - The syntax is annotated by in the lines prefixed by + The syntax is annotated using lines prefixed by --. @@ -5711,9 +5711,9 @@ typedef struct { singlechar#mask - Assuming that the qualifiers ti, - au - and date are defined we may use: + Assuming that the qualifiers ti + and au + and date are defined, we may use: ti=self portrait @@ -5757,15 +5757,15 @@ typedef struct { where qualifier-name is the name of the - qualifier to be used (eg. ti), + qualifier to be used (e.g. ti), type is attribute type in the attribute set (Bib-1 is used if no attribute set is given) and val is attribute value. The type can be specified as an - integer or as it be specified either as a single-letter: + integer, or as a single-letter: u for use, - r for relation,p for position, - s for structure,t for truncation + r for relation, p for position, + s for structure,t for truncation, or c for completeness. The attributes for the special qualifier name term are used when no CCL qualifier is given in a query. @@ -5786,7 +5786,7 @@ typedef struct { Use attribute (1). Common use attributes are 1 Personal-name, 4 Title, 7 ISBN, 8 ISSN, 30 Date, - 62 Subject, 1003 Author), 1016 Any. Specify value + 62 Subject, 1003 Author, 1016 Any. Specify value as an integer. @@ -5819,7 +5819,7 @@ typedef struct { t=value Truncation attribute (5). Values: 1 right, 2 left, - 3 left& right, 100 none, 101 process #, 102 regular-1, + 3 left and right, 100 none, 101 process #, 102 regular-1, 103 regular-2, 104 CCL. @@ -5864,13 +5864,13 @@ typedef struct { s=al - Each token in the term is ANDed. (and-list). + Each token in the term is ANDed (and-list). This does not set the structure at all. s=ol - Each token in the term is ORed. (or-list). + Each token in the term is ORed (or-list). This does not set the structure at all. @@ -5893,7 +5893,7 @@ typedef struct { r=o - Allows ranges and the operators greather-than, less-than, ... + Allows ranges and the operators greater-than, less-than, ... equals. This sets Bib-1 relation attribute accordingly (relation ordered). A query construct is only treated as a range if @@ -5919,7 +5919,7 @@ typedef struct { r=omiteq This will omit relation=equals (@attr 2=3) when r=o / r=r - is used. This is useful for servers that somehow breaks + is used. This is useful for servers that somehow break when an explicit relation=equals is used. Omitting the relation is usually safe because "equals" is the default behavior. This tweak was added in YAZ version 5.1.2. @@ -5947,17 +5947,17 @@ typedef struct { t=b - Allows term to be both left&right truncated. + Allows term to be both left-and-right truncated. If term is of the form ?x?, the resulting term is x and trunctation is - set to both left&right. + set to both left and right. t=x Allows masking anywhere in a term, thus fully supporting # (mask one character) and ? (zero or more of any). - If masking is used, trunction is set to 102 (regexp-1 in term) + If masking is used, truncation is set to 102 (regexp-1 in term) and the term is converted accordingly to a regular expression. @@ -5965,7 +5965,7 @@ typedef struct { Allows masking anywhere in a term, thus fully supporting # (mask one character) and ? (zero or more of any). - If masking is used, trunction is set to 104 (Z39.58 in term) + If masking is used, truncation is set to 104 (Z39.58 in term) and the term is converted accordingly to Z39.58 masking term - actually the same truncation as CCL itself. @@ -5992,7 +5992,7 @@ typedef struct { ti sets the use-attribute to 4. au sets the use-attribute to 1. - When no qualifiers are used in the query the structure-attribute is + When no qualifiers are used in the query, the structure-attribute is set to free-form-text (105) (rule for term). The date sets the relation attribute to the relation used in the CCL query and sets the use attribute @@ -6141,7 +6141,7 @@ struct ccl_rpn_node *ccl_find_str(CCL_bibset bibset, const char *str, which takes the CCL profile (bibset) and query (str) as input. Upon successful completion the RPN - tree is returned. If an error occur, such as a syntax error, the integer + tree is returned. If an error occurs, 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. @@ -6261,7 +6261,7 @@ int cql_parser_stream(CQL_parser cp, int cql_parser_stdio(CQL_parser cp, FILE *f); The functions cql_parser_stream and - cql_parser_stdio parses a CQL query + cql_parser_stdio parse a CQL query - just like cql_parser_string. The only difference is that the CQL query can be fed to the parser in different ways. @@ -6273,7 +6273,7 @@ int cql_parser_stdio(CQL_parser cp, FILE *f); CQL tree - The the query string is valid, the CQL parser + If the query string is valid, the CQL parser generates a tree representing the structure of the CQL query. @@ -6281,7 +6281,7 @@ int cql_parser_stdio(CQL_parser cp, FILE *f); struct cql_node *cql_parser_result(CQL_parser cp); - cql_parser_result returns the + cql_parser_result returns a pointer to the root node of the resulting tree. @@ -6439,8 +6439,8 @@ int cql_transform_error(cql_transform_t ct, char **addinfop); error-code and sets the string-pointer at *addinfop to point to a string containing additional information about the error that occurred: for - example, if the error code is 15 (``Illegal or unsupported context - set''), the additional information is the name of the requested + example, if the error code is 15 ("Illegal or unsupported context + set"), the additional information is the name of the requested context set that was not recognised. @@ -6516,7 +6516,7 @@ int cql_transform_FILE(cql_transform_t ct, Typically, the RPN specifies an equivalent use attribute. - For terms not bound by an index the pattern + For terms not bound by an index, the pattern index.cql.serverChoice is used. Here, the prefix cql is defined as http://www.loc.gov/zing/cql/cql-indexes/v1.0/. @@ -6548,7 +6548,7 @@ int cql_transform_FILE(cql_transform_t ct, This pattern specifies how a CQL relation is mapped to RPN. - pattern is name of relation + The pattern is name of relation operator. Since = is used as separator between CQL pattern and RPN, CQL relations including = cannot be @@ -6589,7 +6589,7 @@ int cql_transform_FILE(cql_transform_t ct, This pattern specifies how a CQL structure is mapped to RPN. - Note that this CQL pattern is somewhat to similar to + Note that this CQL pattern is somewhat similar to CQL pattern relation. The type is a CQL relation. @@ -6748,7 +6748,7 @@ int cql_transform_FILE(cql_transform_t ct, Conversion from CQL to XCQL is trivial and does not require a mapping to be defined. - There three functions to choose from depending on the + There are three functions to choose from depending on the way you wish to store the resulting output (XML buffer containing XCQL). @@ -6759,12 +6759,12 @@ void cql_to_xml(struct cql_node *cn, void cql_to_xml_stdio(struct cql_node *cn, FILE *f); Function cql_to_xml_buf converts - to XCQL and stores result in a user supplied buffer of a given + to XCQL and stores the result in a user-supplied buffer of a given max size. cql_to_xml writes the result in - a user defined output stream. + a user-defined output stream. cql_to_xml_stdio writes to a a file. @@ -6805,7 +6805,7 @@ int cql_transform_rpn2cql_wrbuf(cql_transform_t ct, An OID can either be declared as a automatic variable or it can - allocated using the memory utilities or ODR/NMEM. It's + be allocated using the memory utilities or ODR/NMEM. It's guaranteed that an OID can fit in OID_SIZE integers. Create OID on stack @@ -6825,7 +6825,7 @@ int cql_transform_rpn2cql_wrbuf(cql_transform_t ct, And OID may also be filled from a string-based representation using - dots (.). This is achieved by function + dots (.). This is achieved by the function int oid_dotstring_to_oid(const char *name, Odr_oid *oid); @@ -6833,7 +6833,7 @@ int cql_transform_rpn2cql_wrbuf(cql_transform_t ct, Using oid_oiddotstring_to_oid - We can fill the Bib-1 attribute set OID easier with: + We can fill the Bib-1 attribute set OID more easily with: Odr_oid bib1[OID_SIZE]; oid_oiddotstring_to_oid("1.2.840.10003.3.1", bib1); @@ -6841,11 +6841,11 @@ int cql_transform_rpn2cql_wrbuf(cql_transform_t ct, - We can also allocate an OID dynamically on a ODR stream with: + We can also allocate an OID dynamically on an ODR stream with: Odr_oid *odr_getoidbystr(ODR o, const char *str); - This creates an OID from string-based representation using dots. + This creates an OID from a string-based representation using dots. This function take an &odr; stream as parameter. This stream is used to allocate memory for the data elements, which is released on a subsequent call to odr_reset() on that stream. @@ -6853,7 +6853,7 @@ int cql_transform_rpn2cql_wrbuf(cql_transform_t ct, Using odr_getoidbystr - We can create a OID for the Bib-1 attribute set with: + We can create an OID for the Bib-1 attribute set with: Odr_oid *bib1 = odr_getoidbystr(odr, "1.2.840.10003.3.1"); @@ -6871,8 +6871,8 @@ int cql_transform_rpn2cql_wrbuf(cql_transform_t ct, OIDs can be copied with oid_oidcpy which takes - two OID lists as arguments. Alternativly, an OID copy can be allocated - on a ODR stream with: + two OID lists as arguments. Alternatively, an OID copy can be allocated + on an ODR stream with: Odr_oid *odr_oiddup(ODR odr, const Odr_oid *o); @@ -6906,10 +6906,10 @@ int cql_transform_rpn2cql_wrbuf(cql_transform_t ct, A YAZ database handle is of type yaz_oid_db_t. - Actually that's a pointer. You need not think deal with that. + Actually that's a pointer. You need not deal with that. YAZ has a built-in database which can be considered "constant" for most purposes. - We can get hold that by using function yaz_oid_std. + We can get hold of that by using function yaz_oid_std. All functions with prefix yaz_string_to_oid @@ -6940,7 +6940,7 @@ int cql_transform_rpn2cql_wrbuf(cql_transform_t ct, Standard OIDs All the object identifers in the standard OID database as returned - by yaz_oid_std can referenced directly in a + by yaz_oid_std can be referenced directly in a program as a constant OID. Each constant OID is prefixed with yaz_oid_ - followed by OID class (lowercase) - then by OID name (normalized and @@ -6973,7 +6973,7 @@ int cql_transform_rpn2cql_wrbuf(cql_transform_t ct, Z39.50 PDUs and related structures, it is convenient to use the memory-management system of the &odr; subsystem (see ). However, in some circumstances - where you might otherwise benefit from using a simple nibble memory + where you might otherwise benefit from using a simple nibble-memory management system, it may be impractical to use odr_malloc() and odr_reset(). For this purpose, the memory manager which also supports the &odr; @@ -7005,10 +7005,10 @@ int cql_transform_rpn2cql_wrbuf(cql_transform_t ct, allocated on the handle. - The nibble memory pool is shared amongst 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. Function nmem_init() - initializes the nibble memory library and it is called automatically + initializes the nibble-memory library and it is called automatically the first time the YAZ.DLL is loaded. &yaz; uses function DllMain to achieve this. You should not call nmem_init or @@ -7029,7 +7029,7 @@ int cql_transform_rpn2cql_wrbuf(cql_transform_t ct, and implemented in src/log.c. 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 in header file yaz/log.h. + is still available in header file yaz/log.h. The key points of the interface are: @@ -7079,9 +7079,9 @@ int cql_transform_rpn2cql_wrbuf(cql_transform_t ct, passed to yaz_log_init_level for it to take effect. - Each module should check what log bits it should be used, by calling + Each module should check what log bits should be used, by calling yaz_log_module_level with a suitable name for the - module. The name is cleared from a preceding path and an extension, if any, + module. The name is cleared of a preceding path and an extension, if any, so it is quite possible to use __FILE__ for it. If the name has been passed to yaz_log_mask_str, the routine returns a non-zero bitmask, which should then be used in consequent calls @@ -7098,7 +7098,7 @@ int cql_transform_rpn2cql_wrbuf(cql_transform_t ct, malloc, nmem, odr, eventl for internal debugging of yaz itself. Of course, any program using yaz is welcome to define as many new - ones, as it needs. + ones as it needs. By default the log is written to stderr, but this can be changed by a call @@ -7157,7 +7157,7 @@ int cql_transform_rpn2cql_wrbuf(cql_transform_t ct, YAZ provides a fast utility for working with MARC records. Early versions of the MARC utility only allowed decoding of ISO2709. - Today the utility may both encode - and decode to a varity of formats. + Today the utility may both encode - and decode to a variety of formats. @@ -7209,7 +7209,7 @@ int cql_transform_rpn2cql_wrbuf(cql_transform_t ct, by calling yaz_marc_destroy. - All other function operate on a yaz_marc_t handle. + All other functions operate on a yaz_marc_t handle. The output is specified by a call to yaz_marc_xml. The xmlmode must be one of @@ -7218,7 +7218,7 @@ int cql_transform_rpn2cql_wrbuf(cql_transform_t ct, A simple line-by-line format suitable for display but not - recommend for further (machine) processing. + recommended for further (machine) processing. @@ -7269,7 +7269,7 @@ int cql_transform_rpn2cql_wrbuf(cql_transform_t ct, YAZ_MARC_JSON - MARC-in_JSON format. + MARC-in-JSON format. @@ -7279,7 +7279,7 @@ int cql_transform_rpn2cql_wrbuf(cql_transform_t ct, The actual conversion functions are yaz_marc_decode_buf and yaz_marc_decode_wrbuf which decodes and encodes - a MARC record. The former function operates on simple buffers, the + a MARC record. The former function operates on simple buffers, and stores the resulting record in a WRBUF handle (WRBUF is a simple string type). @@ -7313,9 +7313,9 @@ int cql_transform_rpn2cql_wrbuf(cql_transform_t ct, Applications like Pazpar2 uses XSLT to convert an XML encoded MARC record to an internal - representation. This conversion mostly check the tag of a MARC field + representation. This conversion mostly checks the tag of a MARC field to determine the basic rules in the conversion. This check is - costly when that is tag is encoded as an attribute in MARCXML. + costly when that tag is encoded as an attribute in MARCXML. By having the tag value as the element instead, makes processing many times faster (at least for Libxslt). @@ -7350,18 +7350,18 @@ int cql_transform_rpn2cql_wrbuf(cql_transform_t ct, A control field is encoded as element c concatenated with the tag value of the control field if the tag value matches the regular expression [a-zA-Z0-9]*. - If the tag value do not match the regular expression + If the tag value does not match the regular expression [a-zA-Z0-9]* the control field is encoded as element c and attribute code will hold the tag value. - This rule ensure that in the rare cases where a tag value might - result in a non-wellformed XML YAZ encode it as a coded attribute + This rule ensures that in the rare cases where a tag value might + result in a non-well-formed XML, then YAZ will encode it as a coded attribute (as in MARCXML). - The control field content is the the text value of this element. + The control field content is the text value of this element. Indicators are encoded as attribute names - i1, i2, etc.. and + i1, i2, etc. and corresponding values for each indicator. @@ -7370,11 +7370,11 @@ int cql_transform_rpn2cql_wrbuf(cql_transform_t ct, A data field is encoded as element d concatenated with the tag value of the data field or using the attribute code as described in the rules for control fields. - The children of the data field element is subfield elements. + The children of the data field element are subfield elements. Each subfield element is encoded as s concatenated with the sub field code. The text of the subfield element is the contents of the subfield. - Indicators are encoded as attributes for the data field element similar + Indicators are encoded as attributes for the data field element, similar to the encoding for control fields. @@ -7425,8 +7425,8 @@ int cql_transform_rpn2cql_wrbuf(cql_transform_t ct, The Retrieval facility is driven by an XML configuration. The configuration is neither Z39.50 ZeeRex or SRU ZeeRex. But it should be easy to generate both of them from the XML configuration. - (unfortunately the two versions - of ZeeRex differ substantially in this regard). + (Unfortunately the two versions + of ZeeRex differ substantially in this regard.) Retrieval XML format @@ -7458,7 +7458,7 @@ int cql_transform_rpn2cql_wrbuf(cql_transform_t ct, Defines the name of the retrieval format. This can be - any string. For SRU, the value, is equivalent to schema (short-hand); + any string. For SRU, the value is equivalent to schema (short-hand); for Z39.50 it's equivalent to simple element set name. For YAZ 3.0.24 and later this name may be specified as a glob expression with operators @@ -7470,7 +7470,7 @@ int cql_transform_rpn2cql_wrbuf(cql_transform_t ct, Defines the URI schema name of the retrieval format. This can be - any string. For SRU, the value, is equivalent to URI schema. + any string. For SRU, the value is equivalent to URI schema. For Z39.50, there is no equivalent. @@ -7486,13 +7486,13 @@ int cql_transform_rpn2cql_wrbuf(cql_transform_t ct, The attributes, name and syntax - may be specified for the backend element. These + may be specified for the backend element. The semantics of these attributes is equivalent to those for the retrieval. However, these values are passed to the "backend". - The backend element may includes one or more + The backend element may include one or more conversion instructions (as children elements). The supported conversions are: @@ -7511,7 +7511,7 @@ int cql_transform_rpn2cql_wrbuf(cql_transform_t ct, Format of input. Supported values are marc (for ISO2709), xml (MARCXML/MarcXchange) and json - (MARC-in_JSON). + (MARC-in-JSON). @@ -7525,7 +7525,7 @@ int cql_transform_rpn2cql_wrbuf(cql_transform_t ct, marc (ISO2709), marcxhcange (for MarcXchange), or json - (MARC-in_JSON ). + (MARC-in-JSON ). @@ -7669,7 +7669,7 @@ int cql_transform_rpn2cql_wrbuf(cql_transform_t ct, MARCXML backend - SRW/SRU and Solr backends returns records in XML. + SRW/SRU and Solr backends return records in XML. If they return MARCXML or MarcXchange, the retrieval module can convert those into ISO2709 formats, most commonly USMARC (AKA MARC21). @@ -7744,17 +7744,17 @@ int cql_transform_rpn2cql_wrbuf(cql_transform_t ct, In SRU/Solr, however, the model is different. Here, sorting is specified - during the the search operation. Note, however, that SRU might + during the search operation. Note, however, that SRU might perform sort as separate search, by referring to an existing result-set in the query (result-set reference). Using the Z39.50 sort service - yaz-client and the ZOOM API supports the Z39.50 sort facility. In any + yaz-client and the ZOOM API support the Z39.50 sort facility. In any case the sort sequence or sort critiera is using a string notation. This notation is a one-line notation suitable for being manually - entered or generated and allows for easy logging (one liner). + entered or generated, and allows for easy logging (one liner). For the ZOOM API, the sort is specified in the call to ZOOM_query_sortby function. For yaz-client the sort is performed and specified using the sort and sort+ commands. For description of the sort criteria notation @@ -7780,11 +7780,11 @@ int cql_transform_rpn2cql_wrbuf(cql_transform_t ct, critieria is specified along with the search query. - The sort is triggered by the presence of type 7 and the value of type 7 + The sort is triggered by the presence of type 7, and the value of type 7 specifies the sortRelation - + . The value for type 7 is 1 for ascending and 2 for descending. For the @@ -7793,7 +7793,7 @@ int cql_transform_rpn2cql_wrbuf(cql_transform_t ct, only the generic part is handled. If generic sortKey is of type sortField, then attribute type 1 is present and the value is sortField (InternationalString). If generic sortKey is of type - sortAttributes, then the attributes in list is used . generic sortKey + sortAttributes, then the attributes in the list are used. Generic sortKey of type elementSpec is not supported. @@ -7806,7 +7806,7 @@ int cql_transform_rpn2cql_wrbuf(cql_transform_t ct, Facets - YAZ supports facets for in Solr, SRU 2.0 and Z39.50 protocols. + YAZ supports facets in the Solr, SRU 2.0 and Z39.50 protocols. Like Type-1/RPN, YAZ supports a string notation for specifying @@ -7814,8 +7814,8 @@ int cql_transform_rpn2cql_wrbuf(cql_transform_t ct, yaz_pqf_parse_facet_list. - For ZOOM C the facets are given by option "facets" - For yaz-client it is used for the facets command. + For ZOOM C the facets are given by option "facets". + For yaz-client it is used for the 'facets' command. The grammar of this specification is as follows: @@ -7828,7 +7828,7 @@ int cql_transform_rpn2cql_wrbuf(cql_transform_t ct, The notation is inspired by PQF. The string following '@attr' - may not include blanks and is of the form + must not include blanks and is of the form type=value, where type is an integer and value is a string or an integer. @@ -7851,7 +7851,7 @@ int cql_transform_rpn2cql_wrbuf(cql_transform_t ct, 1 - Field-name. This is often a string, eg "Author", "Year", etc. + Field-name. This is often a string, e.g. "Author", "Year", etc. @@ -7994,7 +7994,7 @@ int cql_transform_rpn2cql_wrbuf(cql_transform_t ct, releasing little bits of memory. Rather than managing the individual, small bits of space, the system maintains a free-list of larger chunks of memory, which are handed out in small bits. This scheme is - generally known as a nibble memory system. + generally known as a nibble-memory system. It is very useful for maintaining short-lived constructions such as protocol PDUs. @@ -8222,7 +8222,7 @@ void do_nothing_useful(Odr_int value) The stream_close handler is optional and if NULL for the function is provided, it will not be invoked. The stream_write takes the ODR handle - as parameter, the user defined handle, a type + as parameter, the user-defined handle, a type ODR_OCTETSTRING, ODR_VISIBLESTRING which indicates the type of contents is being written. @@ -8488,7 +8488,7 @@ int odr_octetstring(ODR o, Odr_oct **p, int optional, To make things a little easier, an alternative is given for string - types that are not expected to contain embedded NULL characters (eg. + types that are not expected to contain embedded NULL characters (e.g. VisibleString): @@ -8499,7 +8499,7 @@ int odr_octetstring(ODR o, Odr_oct **p, int optional, null-terminates C strings. - Functions are provided for the derived string types, eg: + Functions are provided for the derived string types, e.g.: int odr_visiblestring(ODR o, char **p, int optional, @@ -8514,7 +8514,7 @@ int odr_bitstring(ODR o, Odr_bitmask **p, int optional, The opaque type Odr_bitmask is only suitable for - holding relatively brief bit strings, eg. for options fields, etc. + holding relatively brief bit strings, e.g. for options fields, etc. The constant ODR_BITMASK_SIZE multiplied by 8 gives the maximum possible number of bits. -- 1.7.10.4