From: Adam Dickmeiss Date: Mon, 13 Aug 2001 09:42:54 +0000 (+0000) Subject: Spell fixes. X-Git-Tag: YAZ.1.8~57 X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=commitdiff_plain;h=3b3deb4d093d747360a5eb0e02c6b4e9c8a89b84;hp=a25b89e9d30e6de573f20d5b591068d49d639a5d Spell fixes. --- diff --git a/doc/asn.xml b/doc/asn.xml index 453e856..4359a02 100644 --- a/doc/asn.xml +++ b/doc/asn.xml @@ -1,4 +1,4 @@ - + The ASN Module Introduction @@ -110,7 +110,7 @@ As well as the individual PDU functions, a function zget_APDU() is provided, which allocates - a toplevel Z-APDU of the type requested: + a top-level Z-APDU of the type requested: diff --git a/doc/client.xml b/doc/client.xml index d7d60e6..54fdee5 100644 --- a/doc/client.xml +++ b/doc/client.xml @@ -1,14 +1,14 @@ - + The YAZ client Introduction - yaz-client is a linemode Z39.50 client. It supports a fair amount + yaz-client is a line-mode Z39.50 client. It supports a fair amount of the functionality of the Z39.50-1995 standard, but some things you - need to enable or disable by recompilation. + need to enable or disable by re-compilation. Its primary purpose is to exercise the package, and verify that the protocol works OK. For the same reason some commands offers more functionality than others. - Commands that exercies common Z39.50 services such as search and present + Commands that exercises common Z39.50 services such as search and present have more features than less common supported services, such as Extended Services (ItemOrder, ItemUpdate,..). @@ -61,7 +61,7 @@ -v level Sets the LOG level to level. - Level is a sequence of tokens separated by comman. Each token + Level is a sequence of tokens separated by comma. Each token is a integer or a named LOG item - one of fatal, debug, @@ -373,7 +373,7 @@ Sends an Item Order Request using the ILL External. - type is either 1 or 2 which correponds to + type is either 1 or 2 which corresponds to ILL-Profile 1 and 2 respectively. The no is the Result Set position of the record to be ordered. @@ -422,7 +422,7 @@ f @attrset Bib-1 @and @attr GILS 1=2008 Washington @attr 1=21 weather - For the full specifiction of the Prefix Query see the section + For the full specification of the Prefix Query see the section Prefix Query Format. diff --git a/doc/comstack.xml b/doc/comstack.xml index 86b88f6..671788a 100644 --- a/doc/comstack.xml +++ b/doc/comstack.xml @@ -1,4 +1,4 @@ - + The COMSTACK Module Synopsis (blocking mode) @@ -116,7 +116,7 @@ if (buf) Closes the connection (as elegantly as the lower layers will permit), - and releases the resouces pointed to by the + and releases the resources pointed to by the handle parameter. The handle @@ -187,7 +187,7 @@ if (buf) The cs_get() function will sometimes (notably in the TCP/IP mode) read more than a single protocol package off the network. When this happens, the extra package is stored - by the subsystem. After callig cs_get(), and before + by the subsystem. After calling cs_get(), and before waiting for more input, You should always call cs_more() to check if there's a full protocol package already read. If @@ -300,7 +300,7 @@ if (buf) Complete a connect operation initiated by cs_connect(). It will return 0 on success; 1 if the operation has not yet completed (in - this case, call the function again later); -1 if an error has occured. + this case, call the function again later); -1 if an error has occurred. @@ -351,7 +351,7 @@ if (buf) - This finalises the server-side association establishment, after + This finalizes the server-side association establishment, after cs_listen has completed successfully. It returns a new connection endpoint, which represents the new association. The application will typically wish to fork off a process to handle the association at this @@ -368,7 +368,7 @@ if (buf) - on an established connection to retrieve the hostname of the remote host. + on an established connection to retrieve the host-name of the remote host. @@ -515,7 +515,7 @@ if (buf) Installing Xtimosi - Although you will have to download Peter Furniss' XTI/mOSI + Although you will have to down-load Peter Furniss' XTI/mOSI implementation for yourself, we've tried to make the integration as simple as possible. @@ -529,7 +529,7 @@ if (buf) - When you have downloaded and unpacked the archive, it will (we assume) + When you have down-loaded and unpacked the archive, it will (we assume) have created a directory called xtimosi. We suggest that you place this directory in the same directory where you unpacked the &yaz; diff --git a/doc/frontend.xml b/doc/frontend.xml index 03ee19a..391ca9d 100644 --- a/doc/frontend.xml +++ b/doc/frontend.xml @@ -1,10 +1,10 @@ - + Making an IR Server for Your Database Introduction If you aren't into documentation, a good way to learn how the - backend interface works is to look at the backend.h + back end interface works is to look at the backend.h file. Then, look at the small dummy-server in ztest/ztest.c. Finally, you can have a look at the seshigh.c file, which is where most of the @@ -34,11 +34,11 @@ The backend interface was designed in anticipation of a specific integration task, while still attempting to achieve some degree of - generality. We realise fully that there are points where the + generality. We realize fully that there are points where the interface can be improved significantly. If you have specific functions or parameters that you think could be useful, send us a mail (or better, sign on to the mailing list referred to in the - toplevel README file). We will try to fit good suggestions into future + top-level README file). We will try to fit good suggestions into future releases, to the extent that it can be done without requiring too many structural changes in existing applications. @@ -111,7 +111,7 @@ will include other files from the include/yaz directory, so you'll probably want to use the -I option of your compiler to tell it where to find the files. When you run - make in the toplevel &yaz; directory, + make in the top-level &yaz; directory, everything you need to create your server is put the lib/libyaz.a library. @@ -269,7 +269,7 @@ statserv_options_block *statserv_getcontrol(void); void (*bend_stop)(struct statserv_options_block *p) - Pointer to function which is called whenver the server + Pointer to function which is called whenever the server has stopped listening for incoming connections. This function pointer has a default value of NULL in which case it isn't called. When the server operates as an NT service this handler is called @@ -412,7 +412,7 @@ typedef struct bend_initresult Search and retrieve We now describe the handlers that are required to support search - - and retrieve. You must support two functions - one for seearch - and one + and retrieve. You must support two functions - one for search - and one for fetch (retrieval of one record). If desirable you can provide a third handler which is called when a present request is received which allows you to optimize retrieval of multiple-records. @@ -604,7 +604,7 @@ typedef struct { Delete - For backends that supports delete of a result set only one handler + For back-ends that supports delete of a result set only one handler must be defined. diff --git a/doc/future.xml b/doc/future.xml index 391f35e..7278081 100644 --- a/doc/future.xml +++ b/doc/future.xml @@ -1,11 +1,11 @@ - + Future Directions - We have a new and better version of the frontend server on the drawing + We have a new and better version of the front-end server on the drawing board. Resources and external commitments will govern when we'll be - able to do something real with it. Fetures should include greater - flexibility, greter support for access/resource control, and easy + able to do something real with it. Features should include greater + flexibility, greater support for access/resource control, and easy support for Explain (possibly with Zebra as an extra database engine). diff --git a/doc/indexdata.xml b/doc/indexdata.xml index 45bf930..4dc2b4e 100644 --- a/doc/indexdata.xml +++ b/doc/indexdata.xml @@ -1,13 +1,13 @@ - + About Index Data Index Data is a consulting and software-development enterprise that - specialises in library and information management systems. Our + specializes in library and information management systems. Our interests and expertise span a broad range of related fields, and one of our primary, long-term objectives is the development of a powerful information management - system with open network interfaces and hypermedia capabilities. + system with open network interfaces and hyper-media capabilities. We make this software available free of charge, on a fairly unrestrictive license; as a service to the networking community, and to further the diff --git a/doc/introduction.xml b/doc/introduction.xml index 785bc82..5222a2d 100644 --- a/doc/introduction.xml +++ b/doc/introduction.xml @@ -1,4 +1,4 @@ - + Introduction @@ -69,7 +69,7 @@ and for exchanging BER-encoded PDUs over that connection. When you create a connection endpoint, you need to specify what transport to use (OSI or TCP/IP), and which protocol you want to use (SR or - Z39.50). For the remainer of the connection's lifetime, you don't have + Z39.50). For the remainder of the connection's lifetime, you don't have to worry about the underlying transport protocol at all - the &comstack; will ensure that the correct mechanism is used. @@ -86,7 +86,7 @@ if you don't like the protocol API provided by &odr;/&asn;, you can use SNACC or BERUtils instead, and still have the benefits of the transparent transport approach of the &comstack; module. Secondly, - we realise that you may have to fit the toolkit into an existing + we realize that you may have to fit the toolkit into an existing event-processing structure, in a way that is incompatible with the &comstack; interface or some other part of &yaz;. diff --git a/doc/odr.xml b/doc/odr.xml index db28c6c..2623c1f 100644 --- a/doc/odr.xml +++ b/doc/odr.xml @@ -1,4 +1,4 @@ - + The ODR Module Introduction @@ -135,7 +135,7 @@ small bits of space, the system maintains a freelist of larger chunks of memory, which are handed out in small bits. This scheme is generally known as a nibble memory system. - It is very useful for maintaing short-lived constructions such + It is very useful for maintaining short-lived constructions such as protocol PDUs. @@ -184,7 +184,7 @@ The integer pointed to by len is set to the length of the encoded data, and a pointer to that data is returned. *size is set to the size of the buffer (unless size is null, - signalling that you are not interested in the size). The next call to + signaling that you are not interested in the size). The next call to a primitive function using the same &odr; stream will overwrite the data, unless a different buffer has been supplied using the call @@ -235,7 +235,7 @@ - It is important to realise that the ODR stream will not release this + It is important to realize that the ODR stream will not release this memory when you call odr_reset(): It will merely update its internal pointers to prepare for the encoding of a new data value. @@ -244,7 +244,7 @@ be released only if the can_grow parameter to odr_setbuf() was nonzero. The can_grow parameter, in other words, is a way of - signalling who is to own the buffer, you or the ODR stream. If you never call + signaling who is to own the buffer, you or the ODR stream. If you never call odr_setbuf() on your encoding stream, which is typically the case, the buffer allocated by the stream will belong to the stream by default. @@ -494,7 +494,7 @@ void do_nothing_useful(int value) type has a dual function. Depending on the settings of the ODR stream which is supplied as a parameter, the function may be used either to encode or decode data. The functions that can be built - using these primitive functions, to represent more complex datatypes, share + using these primitive functions, to represent more complex data types, share this quality. The result is that you only have to enter the definition for a type once - and you have the functionality of encoding, decoding (and pretty-printing) all in one unit. The resulting C source code is @@ -510,7 +510,7 @@ void do_nothing_useful(int value) In many cases, the model of the XDR functions works quite well in this role. In others, it is less elegant. Most of the hassle comes from the optional - SEQUENCE memebers which don't exist in XDR. + SEQUENCE members which don't exist in XDR. The Primitive ASN.1 Types @@ -697,7 +697,7 @@ int odr_oid(ODR o, Odr_oid **p, int optional, const char *name); - The C OID represenation is simply an array of integers, terminated by + The C OID representation is simply an array of integers, terminated by the value -1 (the Odr_oid type is synonymous with the int type). We suggest that you use the OID database module (see section @@ -839,7 +839,7 @@ int mySequence(ODR o, MySequence **p, int optional, const char *name) You could, of course, name your structures, types, and functions any way you please - as long as you're consistent, and your code is easily readable. odr_ok is just that - a predicate that returns the - state of the stream. It is used to ensure that the behaviour of the new + state of the stream. It is used to ensure that the behavior of the new type is compatible with the interface of the primitive types. @@ -963,7 +963,7 @@ int mySequence(ODR o, MySequence **p, int optional, const char *name) Notice that the interface here gets kind of nasty. The reason is simple: Explicitly tagged, constructed types are fairly rare in the protocols that we care about, so the - aesthetic annoyance (not to mention the dangers of a cluttered + esthetic annoyance (not to mention the dangers of a cluttered interface) is less than the time that would be required to develop a better interface. Nevertheless, it is far from satisfying, and it's a point that will be worked on in the future. One option for you would @@ -980,7 +980,7 @@ int mySequence(ODR o, MySequence **p, int optional, const char *name) SEQUENCE OF - To handle sequences (arrays) of a apecific type, the function + To handle sequences (arrays) of a specific type, the function @@ -1185,7 +1185,7 @@ int myChoice(ODR o, MyChoice **p, int optional, const char *name) - The ASN.1 specifictions naturally requires that each member of a + The ASN.1 specifications naturally requires that each member of a CHOICE have a distinct tag, so they can be told apart on decoding. Sometimes it can be useful to define a CHOICE that has multiple types that share the same tag. You'll need some other mechanism, perhaps diff --git a/doc/tools.xml b/doc/tools.xml index 33de66e..a17b902 100644 --- a/doc/tools.xml +++ b/doc/tools.xml @@ -1,9 +1,9 @@ - + Supporting Tools In support of the service API - primarily the ASN module, which - provides the programmatic interface to the Z39.50 APDUs, &yaz; contains + provides the pro-grammatic interface to the Z39.50 APDUs, &yaz; contains a collection of tools that support the development of applications. @@ -253,7 +253,7 @@ int p_query_attset (const char *arg); index, such as title (ti) and author indexes (au). The CCL standard itself doesn't specify a particular set of qualifiers, but it does suggest a few short-hand notations. You can customize the CCL parser - to support a particular set of qualifiers to relect the current target + to support a particular set of qualifiers to reflect the current target profile. Traditionally, a qualifier would map to a particular use-attribute within the BIB-1 attribute set. However, you could also define qualifiers that would set, for example, the @@ -348,14 +348,14 @@ 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 eccur, such as a syntax error, the integer + tree is returned. If an error occur, 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. - An english representation of the error may be obtained by calling + An English representation of the error may be obtained by calling the ccl_err_msg function. The error codes are listed in ccl.h. @@ -677,10 +677,10 @@ typedef struct oident - The nibble memory pool is shared amonst 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. On WIN32 function nmem_init() - initialises the Critical Section handle and should be called once + initializes the Critical Section handle and should be called once before any other nmem function is used.