From: Adam Dickmeiss Date: Fri, 20 Jun 2003 10:18:05 +0000 (+0000) Subject: More on CCL profiles X-Git-Tag: YAZ.2.0.3~4 X-Git-Url: http://sru.miketaylor.org.uk/cgi-bin?a=commitdiff_plain;h=2b63bef2ba80986b0d0431edddfa662580734897;p=yaz-moved-to-github.git More on CCL profiles --- diff --git a/doc/tools.xml b/doc/tools.xml index 450b3fc..656210c 100644 --- a/doc/tools.xml +++ b/doc/tools.xml @@ -1,4 +1,4 @@ - + Supporting Tools @@ -16,7 +16,7 @@ Z_RPNQuery structure. Some programmers will prefer to construct the query manually, perhaps using odr_malloc() to simplify memory management. - The &yaz; distribution includes two separate, query-generating tools + The &yaz; distribution includes three separate, query-generating tools that may be of use to you. @@ -548,82 +548,153 @@ or c for completeness. The attributes for the special qualifier name term are used when no CCL qualifier is given in a query. + Common Bib-1 attributes + + + + + + Type + Description + + + + + u=value + + Use attribute. Common use attributes are + 1 Personal-name, 4 Title, 7 ISBN, 8 ISSN, 30 Date, + 62 Subject, 1003 Author), 1016 Any. Specify value + as an integer. + + + + + r=value + + Relation attribute. Common values are + 1 <, 2 <=, 3 =, 4 >=, 5 >, 6 <>, + 100 phonetic, 101 stem, 102 relevance, 103 always matches. + + + + + p=value + + Position attribute. Values: 1 first in field, 2 + first in any subfield, 3 any position in field. + + + + + s=value + + Structure attribute. Values: 1 phrase, 2 word, + 3 key, 4 year, 5 date, 6 word list, 100 date (un), + 101 name (norm), 102 name (un), 103 structure, 104 urx, + 105 free-form-text, 106 document-text, 107 local-number, + 108 string, 109 numeric string. + + + + + t=value + + Truncation attribute. Values: 1 right, 2 left, + 3 left& right, 100 none, 101 process #, 102 regular-1, + 103 regular-2, 104 CCL. + + + + + c=value + + Completeness attribute. Values: 1 incomplete subfield, + 2 complete subfield, 3 complete field. + + + + + +
- The attribute value val may be - specified as in integer. It is also possible to specify - non-numeric values, however, which are used in combination with - certain types. The special combinations are: - - s=pw - - The structure is set to either word or phrase depending - on the number of tokens in a term (phrase-word). - - - - - s=al - - 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). - This does not set the structure at all. - - - - - r=o - - Allows operators greather-than, less-than, ... equals and - sets relation attribute accordingly (relation ordered). - - - - - t=l - - Allows term to be left-truncated. - If term is of the form ?x, the resulting - Type-1 term is x and truncation is left. - - - - - t=r - - Allows term to be right-truncated. - If term is of the form x?, the resulting - Type-1 term is x and truncation is right. - - - - - t=n - - If term is does not include ?, the - truncation attribute is set to none (100). - - - - - t=b - - Allows term to be both left&right truncated. - If term is of the form ?x?, the - resulting term is x and trunctation is - set to both left&right. - - - - - + The complete list of Bib-1 attributes can be found + + here + . + + + It is also possible to specify non-numeric attribute values, + which are used in combination with certain types. + The special combinations are: + + Special attribute combos + + + + + + Name + Description + + + + + s=pw + The structure is set to either word or phrase depending + on the number of tokens in a term (phrase-word). + + + + s=al + 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). + This does not set the structure at all. + + + + r=o + Allows operators greather-than, less-than, ... equals and + sets relation attribute accordingly (relation ordered). + + + + t=l + Allows term to be left-truncated. + If term is of the form ?x, the resulting + Type-1 term is x and truncation is left. + + + + t=r + Allows term to be right-truncated. + If term is of the form x?, the resulting + Type-1 term is x and truncation is right. + + + + t=n + If term is does not include ?, the + truncation attribute is set to none (100). + + + + t=b + Allows term to be both left&right truncated. + If term is of the form ?x?, the + resulting term is x and trunctation is + set to both left&right. + + + + +
CCL profile @@ -635,26 +706,43 @@ au u=1 s=1 term s=105 ranked r=102 + date u=30 r=o - Three qualifiers are defined, ti, - au and ranked. + Four qualifiers are defined - ti, + au, ranked and + date. + + ti and au both set structure attribute to phrase (s=1). 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 - set to free-form-text (105). - + 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 + to 30 (Bib-1 Date). + You can combine attributes. To Search for "ranked title" you can do ti,ranked=knuth computer - which will use "relation is ranked", "use is title", "structure is - phrase". + which will set relation=ranked, use=title, structure=phrase. + + + Query + + year > 1980 + + is a valid query, while + + ti > 1980 + + is invalid. @@ -690,9 +778,9 @@ CCL directives - - - + + + Name @@ -1415,15 +1503,13 @@ typedef struct oident PROTO_Z3950 - PROTO_SR + PROTO_GENERAL - If you don't care about talking to SR-based implementations (few - exist, and they may become fewer still if and when the ISO SR and ANSI - Z39.50 documents are merged into a single standard), you can ignore - this field on incoming packages, and always set it to PROTO_Z3950 - for outgoing packages. + Use PROTO_Z3950 for Z39.50 Object Identifers, + PROTO_GENERAL for other types (such as + those associated with ILL). @@ -1510,6 +1596,10 @@ 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.