From e188a76cd21e6223a91b7edc25945bf569b644ad Mon Sep 17 00:00:00 2001 From: Mehdi Achour Date: Tue, 5 Apr 2005 16:17:59 +0000 Subject: [PATCH] WS, preparing for new style git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@183678 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/yaz/functions/yaz-addinfo.xml | 47 ++-- reference/yaz/functions/yaz-ccl-conf.xml | 83 ++++--- reference/yaz/functions/yaz-ccl-parse.xml | 85 ++++--- reference/yaz/functions/yaz-close.xml | 45 ++-- reference/yaz/functions/yaz-connect.xml | 233 +++++++++--------- reference/yaz/functions/yaz-database.xml | 59 +++-- reference/yaz/functions/yaz-element.xml | 57 +++-- reference/yaz/functions/yaz-errno.xml | 55 ++--- reference/yaz/functions/yaz-error.xml | 49 ++-- reference/yaz/functions/yaz-es-result.xml | 34 +-- reference/yaz/functions/yaz-get-option.xml | 46 ++-- reference/yaz/functions/yaz-hits.xml | 37 ++- reference/yaz/functions/yaz-itemorder.xml | 83 ++++--- reference/yaz/functions/yaz-present.xml | 51 ++-- reference/yaz/functions/yaz-range.xml | 61 +++-- reference/yaz/functions/yaz-record.xml | 7 +- reference/yaz/functions/yaz-scan-result.xml | 59 +++-- reference/yaz/functions/yaz-scan.xml | 91 ++++--- reference/yaz/functions/yaz-schema.xml | 52 ++-- reference/yaz/functions/yaz-search.xml | 257 ++++++++++---------- reference/yaz/functions/yaz-set-option.xml | 174 ++++++------- reference/yaz/functions/yaz-sort.xml | 137 ++++++----- reference/yaz/functions/yaz-syntax.xml | 49 ++-- reference/yaz/functions/yaz-wait.xml | 79 +++--- 24 files changed, 955 insertions(+), 975 deletions(-) diff --git a/reference/yaz/functions/yaz-addinfo.xml b/reference/yaz/functions/yaz-addinfo.xml index 7cb80d628d..5b2c46dbe6 100644 --- a/reference/yaz/functions/yaz-addinfo.xml +++ b/reference/yaz/functions/yaz-addinfo.xml @@ -1,28 +1,27 @@ - - - - - yaz_addinfo - Returns additional error information - - - Description - - stringyaz_addinfo - resourceid - - - Returns additional error message for server (last request), identified by - parameter id. An empty string is returned if the - last operation was successful or if no additional information was provided - by the server. - - - See also yaz_error. - - - + + + + yaz_addinfo + Returns additional error information + + + Description + + stringyaz_addinfo + resourceid + + + Returns additional error message for server (last request), identified by + parameter id. An empty string is returned if the + last operation was successful or if no additional information was provided + by the server. + + + See also yaz_error. + + + - - - - yaz_ccl_conf - Configure CCL parser - - - Description - - intyaz_ccl_conf - resourceid - arrayconfig - - - This function configures the CCL query parser for a server - with definitions of access points (CCL qualifiers) and their - mapping to RPN. To map a specific CCL query to RPN afterwards - call the yaz_ccl_parse function. - Each index of the array config is the - name of a CCL field and the corresponding value holds a string - that specifies a mapping to RPN. - The mapping is a sequence of attribute-type, attribute-value - pairs. Attribute-type and attribute-value is separated by an equal - sign (=). Each pair is separated by white space. - - - - CCL configuration - - In the example below, the CCL parser is configured to support - three CCL fields: ti, au and - isbn. Each field is mapped to their BIB-1 - equivalent. It is assumed that variable $id is the - connection ID. - - + + + + yaz_ccl_conf + Configure CCL parser + + + Description + + intyaz_ccl_conf + resourceid + arrayconfig + + + This function configures the CCL query parser for a server + with definitions of access points (CCL qualifiers) and their + mapping to RPN. To map a specific CCL query to RPN afterwards + call the yaz_ccl_parse function. + Each index of the array config is the + name of a CCL field and the corresponding value holds a string + that specifies a mapping to RPN. + The mapping is a sequence of attribute-type, attribute-value + pairs. Attribute-type and attribute-value is separated by an equal + sign (=). Each pair is separated by white space. + + + + CCL configuration + + In the example below, the CCL parser is configured to support + three CCL fields: ti, au and + isbn. Each field is mapped to their BIB-1 + equivalent. It is assumed that variable $id is the + connection ID. + + ]]> - - - - - + + + + + - - - - yaz_ccl_parse - Invoke CCL Parser - - - Description - - boolyaz_ccl_parse - resourceid - stringquery - arrayresult - - - This function invokes a CCL parser. It converts a given - CCL FIND query to an RPN query which may be passed to the - yaz_search function to perform a search. - To define a set of valid CCL fields call - yaz_ccl_conf prior to this function. - If the supplied query was successfully - converted to RPN, this function returns &true;, and the index - rpn of the supplied array - result holds a valid RPN query. - If the query could not be converted (because of invalid syntax, - unknown field, etc.) this function returns &false; and three - indexes are set in the resulting array to indicate the cause - of failure: errorcode CCL error code (integer), - errorstring CCL error string, and - errorpos approximate position in query of failure - (integer is character position). - - - CCL Parsing - We will try to search using CCL. In the example below, - $ccl is a CCL query. - - + + + + yaz_ccl_parse + Invoke CCL Parser + + + Description + + boolyaz_ccl_parse + resourceid + stringquery + arrayresult + + + This function invokes a CCL parser. It converts a given + CCL FIND query to an RPN query which may be passed to the + yaz_search function to perform a search. + To define a set of valid CCL fields call + yaz_ccl_conf prior to this function. + If the supplied query was successfully + converted to RPN, this function returns &true;, and the index + rpn of the supplied array + result holds a valid RPN query. + If the query could not be converted (because of invalid syntax, + unknown field, etc.) this function returns &false; and three + indexes are set in the resulting array to indicate the cause + of failure: errorcode CCL error code (integer), + errorstring CCL error string, and + errorpos approximate position in query of failure + (integer is character position). + + + CCL Parsing + We will try to search using CCL. In the example below, + $ccl is a CCL query. + + ]]> - - - - + + + + - - - - yaz_close - Close YAZ connection - - - Description - - boolyaz_close - resourceid - - - Closes the connection given by parameter id. - The id is a connection resource as returned - by a previous call to yaz_connect. - - - &return.success; - - - + + + + yaz_close + Close YAZ connection + + + Description + + boolyaz_close + resourceid + + + Closes the connection given by parameter id. + The id is a connection resource as returned + by a previous call to yaz_connect. + + + &return.success; + + + - - - - yaz_connect - - Prepares for a connection to a Z39.50 server - - - - Description - - resourceyaz_connect - stringzurl - mixedoptions - - - This function returns a connection resource on success, zero on - failure. - - - yaz_connect prepares for a connection to a - Z39.50 server. The zurl argument takes the form - host[:port][/database]. If port is omitted, port 210 is used. If - database is omitted Default is used. - This function is non-blocking and does not attempt to establish - a connection - it merely prepares a connect to be performed later when - yaz_wait is called. - - - If the second argument, options, is given as - a string it is treated as the Z39.50 V2 authentication string - (OpenAuth). - - - If options is given as an array the contents - of the array serves as options. Note that array options are only - supported for PHP 4.1.0 and later. + + + + yaz_connect + + Prepares for a connection to a Z39.50 server + + + + Description + + resourceyaz_connect + stringzurl + mixedoptions + + + This function returns a connection resource on success, zero on + failure. + + + yaz_connect prepares for a connection to a + Z39.50 server. The zurl argument takes the form + host[:port][/database]. If port is omitted, port 210 is used. If + database is omitted Default is used. + This function is non-blocking and does not attempt to establish + a connection - it merely prepares a connect to be performed later when + yaz_wait is called. + + + If the second argument, options, is given as + a string it is treated as the Z39.50 V2 authentication string + (OpenAuth). + + + If options is given as an array the contents + of the array serves as options. Note that array options are only + supported for PHP 4.1.0 and later. - - <function>yaz_connect</function> options - - user - - Username for authentication. - - - - group - - Group for authentication. - - - - password - - Password for authentication. - - - - cookie - - Cookie for session (YAZ proxy). - - - - proxy - - Proxy for connection (YAZ proxy). - - - - persistent - - A boolean. If &true; the connection is persistent; If &false; - the connection is not persistent. By default connections are persistent. - - - - - piggyback - - A boolean. If &true; piggyback is enabled for searches; If - &false; piggyback is disabled. By default piggyback is enabled. Enabling - piggyback is more efficient and usually saves a network-round-trip for - first time fetches of records. However, a few Z39.50 servers do not - support piggyback or they ignore element set names. For those, piggyback - should be disabled. - - - + + <function>yaz_connect</function> options + + user + + Username for authentication. + + + + group + + Group for authentication. + + + + password + + Password for authentication. + + + + cookie + + Cookie for session (YAZ proxy). + + + + proxy + + Proxy for connection (YAZ proxy). + + + + persistent + + A boolean. If &true; the connection is persistent; If &false; + the connection is not persistent. By default connections are persistent. + + + + + piggyback + + A boolean. If &true; piggyback is enabled for searches; If + &false; piggyback is disabled. By default piggyback is enabled. Enabling + piggyback is more efficient and usually saves a network-round-trip for + first time fetches of records. However, a few Z39.50 servers do not + support piggyback or they ignore element set names. For those, piggyback + should be disabled. + + + - - charset - - A string that specifies character set to be used - in Z39.50 language and character set negotiation. - Use strings such as: - ISO-8859-1, UTF-8, - UTF-16. - - - Most Z39.50 servers do not support this feature (and thus, - this is ignored). Many servers use the ISO-8859-1 - encoding for queries and messages. MARC21/USMARC records are not - affected by this setting. - - - + + charset + + A string that specifies character set to be used + in Z39.50 language and character set negotiation. + Use strings such as: + ISO-8859-1, UTF-8, + UTF-16. + + + Most Z39.50 servers do not support this feature (and thus, + this is ignored). Many servers use the ISO-8859-1 + encoding for queries and messages. MARC21/USMARC records are not + affected by this setting. + + + - - + + + + - - - The YAZ proxy is a - freely available Z39.50 proxy. - - + The YAZ proxy is a + freely available Z39.50 proxy. - - + + + + - - - - yaz_database - - Specifies the databases within a session - - - - Description - - boolyaz_database - resourceid - stringdatabases - - - This function specifies one or more databases to be used in search, - retrieval, etc. - overriding databases specified in call to - yaz_connect. Multiple databases are - separated by a plus sign +. - - - This function allows you to change databases within a session. - - - &return.success; - - - + + + + yaz_database + + Specifies the databases within a session + + + + Description + + boolyaz_database + resourceid + stringdatabases + + + This function specifies one or more databases to be used in search, + retrieval, etc. - overriding databases specified in call to + yaz_connect. Multiple databases are + separated by a plus sign +. + + + This function allows you to change databases within a session. + + + &return.success; + + + - - - - yaz_element - - Specifies Element-Set Name for retrieval - - - - Description - - boolyaz_element - resourceid - stringelementset - - - This function sets the element set name for retrieval. - Call this function before yaz_search or - yaz_present - to specify the element set name for records to be retrieved. - Most servers support F (for full records) and - B (for brief records). - - - &return.success; - - - + + + + yaz_element + + Specifies Element-Set Name for retrieval + + + + Description + + boolyaz_element + resourceid + stringelementset + + + This function sets the element set name for retrieval. + Call this function before yaz_search or + yaz_present + to specify the element set name for records to be retrieved. + Most servers support F (for full records) and + B (for brief records). + + + &return.success; + + + - - - - yaz_errno - Returns error number - - - Description - - intyaz_errno - resourceid - - - Returns an errornumber for the server (last request) identified by - id. The error code is either a Z39.50 diagnostic - code (usually a Bib-1 diagnostic) or a client side error code which is - generated by PHP/YAZ itself, such as "Connect failed", "Init Rejected", etc. - - - yaz_errno should be called after network - activity for each server - (after yaz_wait - returns) to determine the success or failure of the last - operation (e.g. search). To get a text description of the - error, call yaz_error. - - - + + + + yaz_errno + Returns error number + + + Description + + intyaz_errno + resourceid + + + Returns an errornumber for the server (last request) identified by + id. The error code is either a Z39.50 diagnostic + code (usually a Bib-1 diagnostic) or a client side error code which is + generated by PHP/YAZ itself, such as "Connect failed", "Init Rejected", etc. + + + yaz_errno should be called after network + activity for each server - (after yaz_wait + returns) to determine the success or failure of the last + operation (e.g. search). To get a text description of the + error, call yaz_error. + + + - - - - yaz_error - Returns error description - - - Description - - stringyaz_error - resourceid - - - Returns an error text message for server (last request), identified by - parameter id. An empty string is returned if the - last operation was successful. - - - yaz_error returns an English text message - corresponding to the last error number as returned by - yaz_errno. - - - + + + + yaz_error + Returns error description + + + Description + + stringyaz_error + resourceid + + + Returns an error text message for server (last request), identified by + parameter id. An empty string is returned if the + last operation was successful. + + + yaz_error returns an English text message + corresponding to the last error number as returned by + yaz_errno. + + + - - - yaz_es_result - - Inspects Extended Services Result - - - - Description - - arrayyaz_es_result - resourceid - + + + + yaz_es_result + + Inspects Extended Services Result + + + + Description + + arrayyaz_es_result + resourceid + - &warn.undocumented.func; + &warn.undocumented.func; - - + + - - - yaz_get_option - Returns value of option for connection - - - Description - - stringyaz_get_option - resourceid - stringname - - - Returns the value of the option specified with name. - If an option is not set, an empty string is returned. - - - See the description of yaz_set_option for - available options. - - - + + + + yaz_get_option + Returns value of option for connection + + + Description + + stringyaz_get_option + resourceid + stringname + + + Returns the value of the option specified with name. + If an option is not set, an empty string is returned. + + + See the description of yaz_set_option for + available options. + + + - - - - yaz_hits - Returns number of hits for last search - - - Description - - intyaz_hits - resourceid - - - yaz_hits returns the number of hits for the last - search. - - - + + + + yaz_hits + Returns number of hits for last search + + + Description + + intyaz_hits + resourceid + + + yaz_hits returns the number of hits for the last + search. + + + - - - - yaz_itemorder - - Prepares for Z39.50 Item Order with an ILL-Request package - - - - Description - - intyaz_itemorder - resourceid - arrayargs - - - This function prepares for an Extended Services request using the - Profile for the Use of Z39.50 Item Order Extended Service to - Transport ILL (Profile/1). See - this - and the - - specification. - The args parameter must be a hash array with - information about the Item Order request to be sent. The key of the hash is - the name of the corresponding ASN.1 tag path. For example, the ISBN below - the Item-ID has the key item-id,ISBN. - - - The ILL-Request parameters are: - - + + + + yaz_itemorder + + Prepares for Z39.50 Item Order with an ILL-Request package + + + + Description + + intyaz_itemorder + resourceid + arrayargs + + + This function prepares for an Extended Services request using the + Profile for the Use of Z39.50 Item Order Extended Service to + Transport ILL (Profile/1). See + this + and the + + specification. + The args parameter must be a hash array with + information about the Item Order request to be sent. The key of the hash is + the name of the corresponding ASN.1 tag path. For example, the ISBN below + the Item-ID has the key item-id,ISBN. + + + The ILL-Request parameters are: + + protocol-version-num transaction-id,initial-requester-id,person-or-institution-symbol,person transaction-id,initial-requester-id,person-or-institution-symbol,institution @@ -113,21 +112,21 @@ retry-flag forward-flag requester-note forward-note - - - There are also a few parameters that are part of the Extended - Services Request package and the ItemOrder package: - - + + + There are also a few parameters that are part of the Extended + Services Request package and the ItemOrder package: + + package-name user-id contact-name contact-phone contact-email itemorder-item - - - + + + - - - - yaz_present - - Prepares for retrieval (Z39.50 present) - - - - Description - - boolyaz_present - resourceid - - - This function prepares for retrieval of records after - a successful search. The yaz_range should - be called prior to this function to specify the range of - records to be retrieved. - - - &return.success; - - - + + + + yaz_present + + Prepares for retrieval (Z39.50 present) + + + + Description + + boolyaz_present + resourceid + + + This function prepares for retrieval of records after + a successful search. The yaz_range should + be called prior to this function to specify the range of + records to be retrieved. + + + &return.success; + + + - - - - yaz_range - - Specifies the maximum number of records to retrieve - - - - Description - - boolyaz_range - resourceid - intstart - intnumber - - - This function should be called before either - yaz_search or yaz_present - to specify a range of records to be retrieved. - The parameter start specifies the position of the - first record to be retrieved and parameter number is - the number of records. Records in a result set are numbered 1, 2, ... $hits - where $hits is the count returned by yaz_hits. - - - &return.success; - - - + + + + yaz_range + + Specifies the maximum number of records to retrieve + + + + Description + + boolyaz_range + resourceid + intstart + intnumber + + + This function should be called before either + yaz_search or yaz_present + to specify a range of records to be retrieved. + The parameter start specifies the position of the + first record to be retrieved and parameter number is + the number of records. Records in a result set are numbered 1, 2, ... $hits + where $hits is the count returned by yaz_hits. + + + &return.success; + + + - - + + yaz_record Returns a record @@ -247,7 +246,7 @@ print $res; - + - - - - yaz_scan_result - Returns Scan Response result - - - Description - - arrayyaz_scan_result - resourceid - arrayresult - - - yaz_scan_result returns terms and associated - information as received from the server in the last performed - yaz_scan. - This function returns an array (0..n-1) where n is the number - of terms returned. Each value is a pair where the first item is the - term, and the second item is the result-count. - If the optional parameter result is given it will be - modified to hold additional information taken from the Scan Response: - number (number of entries returned), - stepsize (Step-size), - position (position of term), - status (Scan Status). - - - + + + + yaz_scan_result + Returns Scan Response result + + + Description + + arrayyaz_scan_result + resourceid + arrayresult + + + yaz_scan_result returns terms and associated + information as received from the server in the last performed + yaz_scan. + This function returns an array (0..n-1) where n is the number + of terms returned. Each value is a pair where the first item is the + term, and the second item is the result-count. + If the optional parameter result is given it will be + modified to hold additional information taken from the Scan Response: + number (number of entries returned), + stepsize (Step-size), + position (position of term), + status (Scan Status). + + + - - - - yaz_scan - Prepares for a scan - - - Description - - intyaz_scan - resourceid - stringtype - stringstartterm - arrayflags - - - This function prepares for a Z39.50 Scan Request, where parameter - id specifies connection. Starting term - point for the scan is given by startterm. - The form in which the starting term is specified is given by parameter - type. Currently only type rpn - is supported. The optional parameter flags - specifies additional information to control the behaviour of the - scan request. Three indexes are currently read from the flags: - number (number of terms requested), - position (preferred position of term) and - stepSize (preferred step size). - To actually transfer the Scan Request to the server and receive the - Scan Response, yaz_wait must be called. Upon - completion of yaz_wait call - yaz_error and yaz_scan_result to - handle the response. - - - The syntax of startterm is similar to the - RPN query as described in yaz_search. The - startterm consists of zero or more @attr-operator - specifications, then followed by exactly one token. - - - + + + + yaz_scan + Prepares for a scan + + + Description + + intyaz_scan + resourceid + stringtype + stringstartterm + arrayflags + + + This function prepares for a Z39.50 Scan Request, where parameter + id specifies connection. Starting term + point for the scan is given by startterm. + The form in which the starting term is specified is given by parameter + type. Currently only type rpn + is supported. The optional parameter flags + specifies additional information to control the behaviour of the + scan request. Three indexes are currently read from the flags: + number (number of terms requested), + position (preferred position of term) and + stepSize (preferred step size). + To actually transfer the Scan Request to the server and receive the + Scan Response, yaz_wait must be called. Upon + completion of yaz_wait call + yaz_error and yaz_scan_result to + handle the response. + + + The syntax of startterm is similar to the + RPN query as described in yaz_search. The + startterm consists of zero or more @attr-operator + specifications, then followed by exactly one token. + + + PHP function that scans titles ]]> - - - - + + + + - - - yaz_schema - - Specifies schema for retrieval - - - - Description - - intyaz_schema - resourceid - stringschema - - - The schema must be specified as an OID (Object Identifier) in a - raw dot-notation (like 1.2.840.10003.13.4) or - as one of the known registered schemas: - GILS-schema, Holdings, - Zthes, ... - This function should be called before - yaz_search or yaz_present. - - - + + + + yaz_schema + + Specifies schema for retrieval + + + + Description + + intyaz_schema + resourceid + stringschema + + + The schema must be specified as an OID (Object Identifier) in a + raw dot-notation (like 1.2.840.10003.13.4) or + as one of the known registered schemas: + GILS-schema, Holdings, + Zthes, ... + This function should be called before + yaz_search or yaz_present. + + + - - - - yaz_search - Prepares for a search - - - Description - - intyaz_search - resourceid - stringtype - stringquery - - - yaz_search prepares for a search on the - connection given by parameter id. - The parameter type represents the query type - only - "rpn" is supported now in which case the - third argument specifies a Type-1 query in prefix query notation. - Like yaz_connect this - function is non-blocking and only prepares for a search to be - executed later when yaz_wait is called. - - - - The RPN query - - The RPN query is a textual representation of the Type-1 query as - defined by the Z39.50 standard. However, in the text representation - as used by YAZ a prefix notation is used, that is the operator - precedes the operands. The query string is a sequence of tokens where - white space is ignored unless surrounded by double quotes. Tokens beginning - with an at-character (@) are considered operators, - otherwise they are treated as search terms. - - - RPN Operators - - - - - - Construct - Description - - - - - @and query1 query2 - intersection of query1 and query2 - - - @or query1 query2 - union of query1 and query2 - - - @not query1 query2 - query1 and not query2 - - - @set name - result set reference - - - @attrset set query - specifies attribute-set for query. This construction is only - allowed once - in the beginning of the whole query - - - @attr [set] type=value query - applies attribute to query. The type and value are - integers specifying the attribute-type and attribute-value - respectively. The set, if given, specifies the - attribute-set. - - - -
- - Query Examples - - You can search for simple terms, like this - computer - which matches documents where "computer" occur. - No attributes are specified. - - - The Query - "knuth donald" - matches documents where "knuth donald" occur (provided that the - server supports phrase search). - - - This query applies two attributes for the same phrase. - @attr 1=1003 @attr 4=1 "knuth donald" - First attribute is type 1 (Bib-1 use), attribute value is 1003 - (Author). - Second attribute has is type 4 (structure), value 1 (phrase), - so this should match documents where Donald Knuth is author. - - - This query - @and @or a b @not @or c d e - would in infix notation look like - (a or b) and ((c or d) not e). - - - Another, more complex, one: + + + + yaz_search + Prepares for a search + + + Description + + intyaz_search + resourceid + stringtype + stringquery + + + yaz_search prepares for a search on the + connection given by parameter id. + The parameter type represents the query type - only + "rpn" is supported now in which case the + third argument specifies a Type-1 query in prefix query notation. + Like yaz_connect this + function is non-blocking and only prepares for a search to be + executed later when yaz_wait is called. + + + + The RPN query + + The RPN query is a textual representation of the Type-1 query as + defined by the Z39.50 standard. However, in the text representation + as used by YAZ a prefix notation is used, that is the operator + precedes the operands. The query string is a sequence of tokens where + white space is ignored unless surrounded by double quotes. Tokens beginning + with an at-character (@) are considered operators, + otherwise they are treated as search terms. + + + RPN Operators + + + + + + Construct + Description + + + + + @and query1 query2 + intersection of query1 and query2 + + + @or query1 query2 + union of query1 and query2 + + + @not query1 query2 + query1 and not query2 + + + @set name + result set reference + + + @attrset set query + specifies attribute-set for query. This construction is only + allowed once - in the beginning of the whole query + + + @attr [set] type=value query + applies attribute to query. The type and value are + integers specifying the attribute-type and attribute-value + respectively. The set, if given, specifies the + attribute-set. + + + +
+ + Query Examples + + You can search for simple terms, like this + computer + which matches documents where "computer" occur. + No attributes are specified. + + + The Query + "knuth donald" + matches documents where "knuth donald" occur (provided that the + server supports phrase search). + + + This query applies two attributes for the same phrase. + @attr 1=1003 @attr 4=1 "knuth donald" + First attribute is type 1 (Bib-1 use), attribute value is 1003 + (Author). + Second attribute has is type 4 (structure), value 1 (phrase), + so this should match documents where Donald Knuth is author. + + + This query + @and @or a b @not @or c d e + would in infix notation look like + (a or b) and ((c or d) not e). + + + Another, more complex, one: @attrset gils @and @attr 1=4 art @attr 1=2000 company - The query as a whole uses the GILS attributeset. The query matches - documents where art occur in the title (GILS,BIB-1) - and in which company occur as Distributor (GILS). - - - - You can find information about attributes at the - Z39.50 Maintenance Agency - site. - - - - If you would like to use a more friendly notation, - use the CCL parser - functions yaz_ccl_conf and - yaz_ccl_parse. - - - - + The query as a whole uses the GILS attributeset. The query matches + documents where art occur in the title (GILS,BIB-1) + and in which company occur as Distributor (GILS). + + + + You can find information about attributes at the + Z39.50 Maintenance Agency + site. + + + + If you would like to use a more friendly notation, + use the CCL parser - functions yaz_ccl_conf and + yaz_ccl_parse. + + + + - - - yaz_set_option - Sets one or more options for connection - - - Description - - stringyaz_set_option - resourceid - stringname - stringvalue - - - stringyaz_set_option - resourceid - arrayoptions - - - Sets option name to value. - - - PYP/YAZ Connection Options - - - - - - Name - Description - - - - - implementationName - implementation name of server - - - implementationVersion - implementation version of server - - - implementationId - implementation ID of server - - - schema - schema for retrieval. By default, no - schema is used. Setting this option is equivalent to - using function yaz_schema - - - preferredRecordSyntax - record syntax for retrieval. By default, no - syntax is used. Setting this option is equivalent to - using function yaz_syntax - - - start - offset for first record to be retrieved via - yaz_search or yaz_present. - First record is numbered has a start value of 0. Second record has - start value 1. - Setting this option in combination with option - count has the same effect as calling - yaz_range except that records are - numbered from 1 in yaz_range - - - - count - maximum number of records to be retrieved via - yaz_search or yaz_present. - - - - elementSetName - element-set-name for retrieval. Setting this option is - equivalent to calling yaz_element. - - - - -
- - + + + + yaz_set_option + Sets one or more options for connection + + + Description + + stringyaz_set_option + resourceid + stringname + stringvalue + + + stringyaz_set_option + resourceid + arrayoptions + + + Sets option name to value. + + + PYP/YAZ Connection Options + + + + + + Name + Description + + + + + implementationName + implementation name of server + + + implementationVersion + implementation version of server + + + implementationId + implementation ID of server + + + schema + schema for retrieval. By default, no + schema is used. Setting this option is equivalent to + using function yaz_schema + + + preferredRecordSyntax + record syntax for retrieval. By default, no + syntax is used. Setting this option is equivalent to + using function yaz_syntax + + + start + offset for first record to be retrieved via + yaz_search or yaz_present. + First record is numbered has a start value of 0. Second record has + start value 1. + Setting this option in combination with option + count has the same effect as calling + yaz_range except that records are + numbered from 1 in yaz_range + + + + count + maximum number of records to be retrieved via + yaz_search or yaz_present. + + + + elementSetName + element-set-name for retrieval. Setting this option is + equivalent to calling yaz_element. + + + + +
+ + - - - - yaz_sort - Sets sorting criteria - - - Description - - intyaz_sort - resourceid - stringcriteria - - - This function sets sorting criteria and enables Z39.50 Sort. - Call this function before - yaz_search. - Using this function alone does not have any effect. When used in conjunction - with yaz_search, a Z39.50 Sort will be sent after a - search response has been received and before any records are retrieved with - Z39.50 Present (yaz_present. The parameter - criteria takes the form - - - field1 flags1 field2 flags2 ... - - - where field1 specifies the primary attributes for sort, field2 seconds, - etc.. The field specifies either a numerical attribute combinations consisting - of type=value pairs separated by comma (e.g. 1=4,2=1) - ; or the field may specify a plain string criteria - (e.g. title. The flags is a sequence of the following - characters which may not be separated by any white space. - - - Sort Flags - a - Sort ascending - - d - Sort descending - - i - Case insensitive sorting - - s - Case sensitive sorting - - - - Sort Criterias - - To sort on Bib1 attribute title, case insensitive, - and ascending you would use the following sort criteria: - - 1=4 ia - - - - If the secondary sorting criteria should be author, case sensitive - and ascending you would use: - - 1=4 ia 1=1003 sa - - - - - + + + + yaz_sort + Sets sorting criteria + + + Description + + intyaz_sort + resourceid + stringcriteria + + + This function sets sorting criteria and enables Z39.50 Sort. + Call this function before + yaz_search. + Using this function alone does not have any effect. When used in conjunction + with yaz_search, a Z39.50 Sort will be sent after a + search response has been received and before any records are retrieved with + Z39.50 Present (yaz_present. The parameter + criteria takes the form + + + field1 flags1 field2 flags2 ... + + + where field1 specifies the primary attributes for sort, field2 seconds, + etc.. The field specifies either a numerical attribute combinations consisting + of type=value pairs separated by comma (e.g. 1=4,2=1) + ; or the field may specify a plain string criteria + (e.g. title. The flags is a sequence of the following + characters which may not be separated by any white space. + + + Sort Flags + a + Sort ascending + + d + Sort descending + + i + Case insensitive sorting + + s + Case sensitive sorting + + + + Sort Criterias + + To sort on Bib1 attribute title, case insensitive, + and ascending you would use the following sort criteria: + + 1=4 ia + + + + If the secondary sorting criteria should be author, case sensitive + and ascending you would use: + + 1=4 ia 1=1003 sa + + + + + - - - - yaz_syntax - - Specifies the preferred record syntax for retrieval - - - - Description - - intyaz_syntax - resourceid - stringsyntax - - - The syntax must be specified as an OID (Object Identifier) in a - raw dot-notation (like 1.2.840.10003.5.10) or - as one of the known registered record syntaxes (sutrs, usmarc, grs1, - xml, etc.). This function should be called before - yaz_search or yaz_present. - - - + + + + yaz_syntax + + Specifies the preferred record syntax for retrieval + + + + Description + + intyaz_syntax + resourceid + stringsyntax + + + The syntax must be specified as an OID (Object Identifier) in a + raw dot-notation (like 1.2.840.10003.5.10) or + as one of the known registered record syntaxes (sutrs, usmarc, grs1, + xml, etc.). This function should be called before + yaz_search or yaz_present. + + + - - - - yaz_wait - Wait for Z39.50 requests to complete - - - Description - - intyaz_wait - arrayoptions - - - This function carries out networked (blocked) activity for - outstanding requests which have been prepared by the functions - yaz_connect, - yaz_search, yaz_present, - yaz_scan and yaz_itemorder. - yaz_wait returns when all servers have either - completed all requests or aborted (in case of errors). - - - If the options array is given that holds - options that change the behaviour of yaz_wait. - - - - timeout - - - Sets timeout in seconds. If a server has not responded within - the timeout it is considered dead and yaz_wait - returns. The default value for timeout is 15 seconds. - - - - - - + + + + yaz_wait + Wait for Z39.50 requests to complete + + + Description + + intyaz_wait + arrayoptions + + + This function carries out networked (blocked) activity for + outstanding requests which have been prepared by the functions + yaz_connect, + yaz_search, yaz_present, + yaz_scan and yaz_itemorder. + yaz_wait returns when all servers have either + completed all requests or aborted (in case of errors). + + + If the options array is given that holds + options that change the behaviour of yaz_wait. + + + + timeout + + + Sets timeout in seconds. If a server has not responded within + the timeout it is considered dead and yaz_wait + returns. The default value for timeout is 15 seconds. + + + + + +