From 757c8c0ffb82023c9059d9a5997515f65ad68561 Mon Sep 17 00:00:00 2001 From: Adam Dickmeiss Date: Thu, 5 Oct 2006 08:26:58 +0000 Subject: [PATCH] Supply id on all sections + examples. --- doc/asn.xml | 58 ++++++++++++++++++++++--------------- doc/comstack.xml | 6 ++-- doc/entities.ent | 4 +-- doc/frontend.xml | 21 +++++++------- doc/introduction.xml | 4 +-- doc/odr.xml | 61 +++++++++++++++++++++------------------ doc/tools.xml | 76 ++++++++++++++++++++++++++++++------------------- doc/yaz-ztest-man.xml | 4 +-- doc/zoom.xml | 69 ++++++++++++++++++++++++++------------------ 9 files changed, 177 insertions(+), 126 deletions(-) diff --git a/doc/asn.xml b/doc/asn.xml index 9ef1576..3420e63 100644 --- a/doc/asn.xml +++ b/doc/asn.xml @@ -1,4 +1,4 @@ - + The Z39.50 ASN.1 Module Introduction @@ -347,7 +347,8 @@ typedef struct Z_ext_typeent PDU, as well as their default settings. - Default settings for PDU Initialize Request +
+ Default settings for PDU Initialize Request @@ -397,7 +398,8 @@ typedef struct Z_ext_typeent
- Default settings for PDU Initialize + <table frame="top" id="asn.default.initialize.response"> + <title>Default settings for PDU Initialize Response @@ -448,7 +450,8 @@ typedef struct Z_ext_typeent
- Default settings for PDU Search Request +
+ Default settings for PDU Search Request @@ -510,7 +513,8 @@ typedef struct Z_ext_typeent
- Default settings for PDU Search Response +
+ Default settings for PDU Search Response @@ -559,7 +563,8 @@ typedef struct Z_ext_typeent
- Default settings for PDU Present Request +
+ Default settings for PDU Present Request @@ -612,7 +617,8 @@ typedef struct Z_ext_typeent
- Default settings for PDU Present Response +
+ Default settings for PDU Present Response @@ -647,7 +653,8 @@ typedef struct Z_ext_typeent
- Default settings for Delete Result Set Request + <table frame="top" id="asn.default.delete.result.set.request"> + <title>Default settings for Delete Result Set Request @@ -680,7 +687,8 @@ typedef struct Z_ext_typeent
- Default settings for Delete Result Set Response + <table frame="top" id="asn.default.delete.result.set.response"> + <title>Default settings for Delete Result Set Response @@ -725,7 +733,8 @@ typedef struct Z_ext_typeent
- Default settings for Scan Request + <table frame="top" id="asn.default.scan.request"> + <title>Default settings for Scan Request @@ -770,7 +779,8 @@ typedef struct Z_ext_typeent
- Default settings for Scan Response + <table frame="top" id="asn.default.scan.response"> + <title>Default settings for Scan Response @@ -813,8 +823,8 @@ typedef struct Z_ext_typeent
- Default settings for Trigger Resource - Control Request +
+ Default settings for Trigger Resource Control Request @@ -849,8 +859,8 @@ typedef struct Z_ext_typeent
- Default settings for Resource - Control Request +
+ Default settings for Resource Control Request @@ -889,8 +899,8 @@ typedef struct Z_ext_typeent
- Default settings for Resource - Control Response +
+ Default settings for Resource Control Response @@ -920,8 +930,8 @@ typedef struct Z_ext_typeent
- Default settings for Access - Control Request +
+ Default settings for Access Control Request @@ -951,8 +961,8 @@ typedef struct Z_ext_typeent
- Default settings for Access - Control Response +
+ Default settings for Access Control Response @@ -985,7 +995,8 @@ typedef struct Z_ext_typeent
- Default settings for Segment +
+ Default settings for Segment @@ -1017,7 +1028,8 @@ typedef struct Z_ext_typeent
- Default settings for Close +
+ Default settings for Close diff --git a/doc/comstack.xml b/doc/comstack.xml index b7c2b39..bfec43d 100644 --- a/doc/comstack.xml +++ b/doc/comstack.xml @@ -1,4 +1,4 @@ - + The COMSTACK Module Synopsis (blocking mode) @@ -101,7 +101,7 @@ if (buf) Common Functions - Managing Endpoints + Managing Endpoints COMSTACK cs_create(CS_TYPE type, int blocking, int protocol); @@ -162,7 +162,7 @@ if (buf) - Data Exchange + Data Exchange int cs_put(COMSTACK handle, char *buf, int len); diff --git a/doc/entities.ent b/doc/entities.ent index 74ff152..2c8471e 100644 --- a/doc/entities.ent +++ b/doc/entities.ent @@ -1,4 +1,4 @@ - + @@ -24,5 +24,5 @@ COMSTACK"> ZOOM"> -"> +"> diff --git a/doc/frontend.xml b/doc/frontend.xml index 246cae8..0f83a6e 100644 --- a/doc/frontend.xml +++ b/doc/frontend.xml @@ -1,6 +1,6 @@ - + Generic server - Introduction + Introduction If you aren't into documentation, a good way to learn how the @@ -315,7 +315,7 @@ void statserv_setcontrol(statserv_options_block *block); functions representing the services that you wish to implement. - Init + Init bend_initresult (*bend_init)(bend_initrequest *r); @@ -429,7 +429,7 @@ typedef struct bend_initresult - Search and retrieve + Search and Retrieve We now describe the handlers that are required to support search - and retrieve. You must support two functions - one for search - and one @@ -503,7 +503,7 @@ typedef struct { structure (note that CQL is now part of Z39.50 via an external). To support CQL in existing implementations that only do Type-1, we refer to the CQL-to-PQF tool described - here. + here. @@ -650,7 +650,7 @@ typedef struct { - Delete + Delete For back-ends that supports delete of a result set only one handler @@ -684,7 +684,7 @@ typedef struct bend_delete_rr { - scan + Scan For servers that wish to offer the scan service one handler @@ -779,7 +779,7 @@ typedef struct bend_scan_rr { which causes the server to listen on any local interface. - Running the GFS on Unix + Running the GFS on Unix Assuming the server application appname is started as root, the following will make it listen on port 210. @@ -793,7 +793,7 @@ typedef struct bend_scan_rr { The server will accept Z39.50 requests and offer SRU service on port 210. - Setting up Apache as SRU Frontend + Setting up Apache as SRU Frontend If you use Apache as your public web server and want to offer HTTP port 80 @@ -816,7 +816,8 @@ typedef struct bend_scan_rr { The above for the Apache 1.3 series. - Running a server with local access only + + Running a server with local access only Servers that is only being accessed from the local host should listen on UNIX file socket rather than a Internet socket. To listen on diff --git a/doc/introduction.xml b/doc/introduction.xml index 32b4810..d1a8bc5 100644 --- a/doc/introduction.xml +++ b/doc/introduction.xml @@ -1,4 +1,4 @@ - + Introduction @@ -125,7 +125,7 @@ contains sections for the various tools offered by &yaz;. Scan through the material quickly and see what's relevant to you! SRU implementors - might find the CQL section + might find the CQL section particularly useful. diff --git a/doc/odr.xml b/doc/odr.xml index 6a135e9..38d300e 100644 --- a/doc/odr.xml +++ b/doc/odr.xml @@ -1,4 +1,4 @@ - + The ODR Module Introduction @@ -39,7 +39,7 @@ Using ODR - ODR Streams + ODR Streams Conceptually, the ODR stream is the source of encoded data in the @@ -74,7 +74,7 @@ - Memory Management + Memory Management Two forms of memory management take place in the &odr; system. The first @@ -169,7 +169,7 @@ - Encoding and Decoding Data + Encoding and Decoding Data When encoding data, the ODR stream will write the encoded octet string @@ -260,7 +260,8 @@ z_APDU()). - Encoding and decoding functions + + Encoding and decoding functions int odr_integer(ODR o, int **p, int optional, const char *name); @@ -298,7 +299,8 @@ last call to odr_reset() will be released. - Encoding and decoding of an integer + + Encoding and decoding of an integer The use of the double indirection can be a little confusing at first (its purpose will become clear later on, hopefully), @@ -355,7 +357,7 @@ void do_nothing_useful(int value) - Printing + Printing When an ODR stream is created of type ODR_PRINT the ODR module will print the contents of a PDU in a readable format. @@ -396,7 +398,7 @@ void do_nothing_useful(int value) ar[n] is the last. The last element has the property that ar[n+1] == NULL. - + Element Path for record For a database record part of a PresentResponse the @@ -406,7 +408,7 @@ void do_nothing_useful(int value) - Diagnostics + Diagnostics The encoding/decoding functions all return 0 when an error occurs. @@ -440,7 +442,8 @@ void do_nothing_useful(int value) one of these constants: -
ODR Error codes +
+ ODR Error codes @@ -498,7 +501,8 @@ void do_nothing_useful(int value) - Summary and Synopsis + + Summary and Synopsis #include <odr.h> @@ -568,14 +572,15 @@ void do_nothing_useful(int value) SEQUENCE members which don't exist in XDR. - The Primitive ASN.1 Types + + The Primitive ASN.1 Types ASN.1 defines a number of primitive types (many of which correspond roughly to primitive types in structured programming languages, such as C). - INTEGER + INTEGER The &odr; function for encoding or decoding (or printing) the ASN.1 @@ -633,21 +638,21 @@ void do_nothing_useful(int value) similar manners: - BOOLEAN + BOOLEAN int odr_bool(ODR o, bool_t **p, int optional, const char *name); - REAL + REAL Not defined. - NULL + NULL int odr_null(ODR o, bool_t **p, int optional, const char *name); @@ -660,7 +665,7 @@ int odr_null(ODR o, bool_t **p, int optional, const char *name); - OCTET STRING + OCTET STRING typedef struct odr_oct @@ -707,7 +712,7 @@ int odr_visiblestring(ODR o, char **p, int optional, - BIT STRING + BIT STRING int odr_bitstring(ODR o, Odr_bitmask **p, int optional, @@ -745,7 +750,7 @@ int ODR_MASK_GET(Odr_bitmask *b, int bitno); - OBJECT IDENTIFIER + OBJECT IDENTIFIER int odr_oid(ODR o, Odr_oid **p, int optional, const char *name); @@ -762,7 +767,7 @@ int odr_oid(ODR o, Odr_oid **p, int optional, const char *name); - Tagging Primitive Types + Tagging Primitive Types The simplest way of tagging a type is to use the @@ -813,7 +818,7 @@ int myInt(ODR o, int **p, int optional, const char *name) - Constructed Types + Constructed Types Constructed types are created by combining primitive types. The @@ -900,16 +905,18 @@ int mySequence(ODR o, MySequence **p, int optional, const char *name) - Tagging Constructed Types + + Tagging Constructed Types - See for information on how to tag + See for information on how to tag the primitive types, as well as types that are already defined. - Implicit Tagging + + Implicit Tagging Assume the type above had been defined as @@ -957,7 +964,7 @@ int mySequence(ODR o, MySequence **p, int optional, const char *name) - Explicit Tagging + Explicit Tagging Explicit tagging of constructed types is a little more complicated, @@ -1032,7 +1039,7 @@ int mySequence(ODR o, MySequence **p, int optional, const char *name) - SEQUENCE OF + SEQUENCE OF To handle sequences (arrays) of a specific type, the function @@ -1088,7 +1095,7 @@ int myArray(ODR o, MyArray **p, int optional, const char *name) - CHOICE Types + CHOICE Types The choice type is used fairly often in some ASN.1 definitions, so diff --git a/doc/tools.xml b/doc/tools.xml index d47683f..9ca9e24 100644 --- a/doc/tools.xml +++ b/doc/tools.xml @@ -1,4 +1,4 @@ - + Supporting Tools @@ -301,7 +301,8 @@ PQF queries - PQF queries using simple terms + + PQF queries using simple terms dylan @@ -310,7 +311,8 @@ - PQF boolean operators + + PQF boolean operators @or "dylan" "zimmerman" @@ -321,7 +323,8 @@ - PQF references to result sets + + PQF references to result sets @set Result-1 @@ -330,7 +333,8 @@ - Attributes for terms + + Attributes for terms @attr 1=4 computer @@ -345,7 +349,8 @@ - PQF Proximity queries + + PQF Proximity queries @prox 0 3 1 2 k 2 dylan zimmerman @@ -384,14 +389,16 @@ - PQF specification of search term + + PQF specification of search term type @term string "a UTF-8 string, maybe?" - PQF mixed queries + + PQF mixed queries @or @and bob dylan @set Result-1 @@ -439,7 +446,8 @@ license, it is included as a supplement to &yaz;. - CCL Syntax + + CCL Syntax The CCL parser obeys the following grammar for the FIND argument. @@ -488,7 +496,8 @@ - CCL queries + + CCL queries The following queries are all valid: @@ -522,7 +531,8 @@ - CCL Qualifiers + + CCL Qualifiers Qualifiers are used to direct the search to a particular searchable @@ -544,7 +554,8 @@ lines in a CCL profile: qualifier specification, qualifier alias, comments and directives. - Qualifier specification + + Qualifier specification A qualifier specification is of the form: @@ -569,7 +580,8 @@ 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 +
+ Common Bib-1 attributes @@ -648,7 +660,8 @@ which are used in combination with certain types. The special combinations are: -
Special attribute combos +
+ Special attribute combos @@ -734,7 +747,7 @@
- CCL profile + CCL profile Consider the following definition: @@ -779,7 +792,8 @@ - Qualifier alias + + Qualifier alias A qualifier alias is of the form: @@ -796,20 +810,23 @@ - Comments + + Comments Lines with white space or lines that begin with character # are treated as comments. - Directives + + Directives Directive specifications takes the form @directive value - CCL directives +
+ CCL directives @@ -873,7 +890,8 @@
- CCL API + + CCL API All public definitions can be found in the header file ccl.h. A profile identifier is of type @@ -936,7 +954,7 @@ struct ccl_rpn_node *ccl_find_str (CCL_bibset bibset, const char *str, - CQL + CQL CQL - Common Query Language - was defined for the @@ -986,7 +1004,7 @@ struct ccl_rpn_node *ccl_find_str (CCL_bibset bibset, const char *str, - CQL parsing + CQL parsing A CQL parser is represented by the CQL_parser handle. Its contents should be considered &yaz; internal (private). @@ -1032,7 +1050,7 @@ int cql_parser_stdio(CQL_parser cp, FILE *f); - CQL tree + CQL tree The the query string is valid, the CQL parser generates a tree representing the structure of the @@ -1136,7 +1154,7 @@ struct cql_node { - CQL to PQF conversion + CQL to PQF conversion Conversion to PQF (and Z39.50 RPN) is tricky by the fact that the resulting RPN depends on the Z39.50 target @@ -1218,7 +1236,7 @@ int cql_transform_FILE(cql_transform_t ct, open FILE. - + Specification of CQL to RPN mappings The file supplied to functions @@ -1369,7 +1387,7 @@ int cql_transform_FILE(cql_transform_t ct, - CQL to RPN mapping file + CQL to RPN mapping file This simple file defines two context sets, three indexes and three relations, a position pattern and a default structure. @@ -1424,7 +1442,7 @@ int cql_transform_FILE(cql_transform_t ct, - CQL to XCQL conversion + CQL to XCQL conversion Conversion from CQL to XCQL is trivial and does not require a mapping to be defined. @@ -1950,7 +1968,7 @@ typedef struct oident - MARC + MARC YAZ provides a fast utility that decodes MARC records and @@ -2038,7 +2056,7 @@ typedef struct oident stores the resulting record in a WRBUF handle (WRBUF is a simple string type). - + Display of MARC record The followint program snippet illustrates how the MARC API may diff --git a/doc/yaz-ztest-man.xml b/doc/yaz-ztest-man.xml index 52595f3..9b174b2 100644 --- a/doc/yaz-ztest-man.xml +++ b/doc/yaz-ztest-man.xml @@ -10,7 +10,7 @@ ]> - + YAZ @@ -69,7 +69,7 @@ yaz-<version>/include/yaz/backend.h - SEE ALSO + SEE ALSO yaz diff --git a/doc/zoom.xml b/doc/zoom.xml index ce88f61..a50eb3e 100644 --- a/doc/zoom.xml +++ b/doc/zoom.xml @@ -20,7 +20,7 @@ ZOOM_options_set_int(opt, name, value) ZOOM_connection_scan1 (ZOOM_connection c, ZOOM_query startterm) ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn) --> - + ZOOM &zoom; is an acronym for 'Z39.50 Object-Orientation Model' and is @@ -318,7 +318,8 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn) API cannot tell the outcome (yet). - SRU Protocol behavior + + SRU Protocol behavior The SRU protocol doesn't feature an Inititialize Request, so the connection phase merely establishes a TCP/IP connection @@ -365,7 +366,7 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn) sort criteria using the same string notation for sort as offered by the YAZ client. - Protocol behavior + Protocol behavior The query object is just an interface for the member Query in the SearchRequest. The sortby-function is an interface to the @@ -416,7 +417,8 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn) The number of hits also called result-count is returned by function ZOOM_resultset_size. - ZOOM Result set Options +
ZOOM Result set Options @@ -480,7 +482,8 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn) Read searchresult.size to determine the number of items. -
Search Info Report options +
Search Info Report Options @@ -525,7 +528,7 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
- + Z39.50 Protocol behavior The creation of a result set involves at least a SearchRequest @@ -577,7 +580,7 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn) to specify one elementSetName option rather than three. - + SRU Protocol behavior Current version of &yaz; does not take advantage of a result set id @@ -760,7 +763,8 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn) render; charset=marc8,iso-8859-1 - Z39.50 Protocol behavior + + Z39.50 Protocol behavior The functions ZOOM_resultset_record and ZOOM_resultset_records inspects the client-side @@ -779,7 +783,8 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn) now. - SRU Protocol behavior + + SRU Protocol behavior The ZOOM driver for SRU treats records returned by a SRU server as if they where Z39.50 records with transfer syntax XML and @@ -860,7 +865,8 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn) - ZOOM Scan Set Options +
+ ZOOM Scan Set Options @@ -893,7 +899,7 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
- Extended Services + Extended Services ZOOM offers an interface to a subset of the Z39.50 extended services as well as a few privately defined ones: @@ -902,35 +908,35 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn) Z39.50 Item Order (ILL). - See . + See . Record Update. This allows a client to insert, modify or delete records. - See . + See . Database Create. This a non-standard feature. Allows a client to create a database. - See . + See . Database Drop. This a non-standard feature. Allows a client to delete/drop a database. - See . + See . Commit operation. This a non-standard feature. Allows a client to commit operations. - See . + See . @@ -971,7 +977,8 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn) package type to be sent. - Extended Service Common Options +
+ Extended Service Common Options @@ -1016,13 +1023,14 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
- Item Order + Item Order For Item Order, type must be set to itemorder in ZOOM_package_send. - Item Order Options +
+ Item Order Options @@ -1061,13 +1069,14 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn) - Record Update + Record Update For Record Update, type must be set to update in ZOOM_package_send. -
Record Update Options +
+ Record Update Options @@ -1125,13 +1134,14 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn) - Database Create + Database Create For Database Create, type must be set to create in ZOOM_package_send. -
Database Create Options +
+ Database Create Options @@ -1154,13 +1164,14 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
- Database Drop + Database Drop For Database Drop, type must be set to drop in ZOOM_package_send. - Database Create Options +
+ Database Drop Options @@ -1183,14 +1194,15 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
- Commit Operation + Commit Operation For Commit, type must be set to commit in ZOOM_package_send. - Protocol behavior + + Protocol behavior All the extended services are Z39.50-only. @@ -1269,7 +1281,8 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn) (integer) for the last event. - ZOOM Event IDs +
+ ZOOM Event IDs -- 1.7.10.4