From 4641562b204d07a8fca9e1fa94c86593766fa165 Mon Sep 17 00:00:00 2001 From: Adam Dickmeiss Date: Mon, 24 Apr 2006 09:21:35 +0000 Subject: [PATCH] Use URL entities for most link references --- doc/frontend.xml | 8 ++--- doc/installation.xml | 82 ++++++++++++++++++++----------------------- doc/introduction.xml | 35 +++++++++--------- doc/odr.xml | 6 ++-- doc/soap.xml | 8 ++--- doc/tools.xml | 27 ++++++-------- doc/yaz-client-commands.xml | 10 +++--- doc/yaz-client-man.xml | 4 ++- doc/yaz-man.xml | 12 ++++--- doc/yaz.xml.in | 4 ++- doc/zoom.xml | 16 ++++----- 11 files changed, 101 insertions(+), 111 deletions(-) diff --git a/doc/frontend.xml b/doc/frontend.xml index 61f8399..8f590a2 100644 --- a/doc/frontend.xml +++ b/doc/frontend.xml @@ -1,4 +1,4 @@ - + Generic server Introduction @@ -803,10 +803,10 @@ typedef struct bend_scan_rr { Setting up Apache as SRW/SRU Frontend - If you use Apache + If you use Apache as your public web server and want to offer HTTP port 80 access to the YAZ server on 210, you can use the - + ProxyPass directive. If you have virtual host @@ -836,7 +836,7 @@ typedef struct bend_scan_rr { Virtual Hosts - &gfs-virtual; + &gfs-virtual; diff --git a/doc/installation.xml b/doc/installation.xml index 8ea4d78..8c0f7f5 100644 --- a/doc/installation.xml +++ b/doc/installation.xml @@ -1,4 +1,4 @@ - + Compilation and Installation Introduction @@ -6,8 +6,7 @@ The latest version of the software will generally be found at: - - http://ftp.indexdata.dk/pub/yaz/ + We have tried our best to keep the software portable, and on many @@ -17,21 +16,22 @@ The software is regularly tested on - Debian GNU/Linux, - Redhat Linux, - Gentoo Linux, - FreeBSD (i386), - MAC OSX, - - SunOS 5.8 (sparc), - - Windows 2000. + Debian GNU/Linux, + Redhat Linux, + Gentoo Linux, + FreeBSD (i386), + MAC OSX, + SunOS 5.8 (sparc), + , + Windows 2000, + , + Windows 2003 server. Some versions have be known to work on HP/UX, - DEC Unix, NetBSD, - OpenBSD, + DEC Unix, NetBSD, + OpenBSD, IBM AIX, Data General DG/UX (with some CFLAGS tinkering), SGI/IRIX, DDE Supermax, Apple Macintosh (using the Codewarrior programming @@ -50,16 +50,12 @@ We maintain a mailing-list for the purpose of announcing new releases and - bug-fixes, as well as general discussion. Subscribe by sending mail to - - yaz-request@indexdata.dk - or fill-in the form - - here. + bug-fixes, as well as general discussion. Subscribe by + filling-in the form + here. General questions and problems can be directed at - - yaz-help@indexdata.dk - , or the address given at the top of this document. + , or the address given at the top of + this document. @@ -67,9 +63,9 @@ We provide - Debian GNU/Linux + Debian GNU/Linux and - Redhat packages for &yaz;. + Redhat packages for &yaz;. Only i386 binary packages are available. You should be able to create packages for other CPUs by building them from the source package. @@ -81,7 +77,7 @@ Note that if your system doesn't have a native ANSI C compiler, you may have to acquire one separately. We recommend - GCC. + GCC. @@ -89,11 +85,11 @@ are compiling &yaz; for use with Zebra it is a good idea to ensure that the iconv library is installed. Some Unixes today already have it - if not, we suggest - GNU iconv. + GNU libiconv. - The XML C library libxml2 + The XML C library libxml2 is required if &yaz; is to support SRW and SRU. This library is very portable and should compile out-of-the box on virtually all Unix platforms. It is available in binary @@ -102,9 +98,9 @@ The GNU tools - Autoconf, - Automake and - Libtool + Autoconf, + Automake and + Libtool are used to generate Makefiles and configure &yaz; for the system. You do not these tools unless you're using the CVS version of &yaz;. @@ -112,13 +108,13 @@ The CQL parser for &yaz; is built using - GNU Bison. + GNU Bison. This tool is only needed if you're using the CVS version of &yaz;. &yaz; includes a tiny ASN.1 compiler. This compiler is - written in Tcl. + written in Tcl. But as for Bison you do not need it unless you're using CVS version of &yaz; or you're using the compiler to built own codecs for private ASN.1. @@ -161,10 +157,10 @@ --enable-tcpd The front end server will be built using Wietse's - - TCP wrapper library. It allows you to allow/deny - clients depending on IP number. The TCP wrapper library is - often used in Linux/BSD distributions. + TCP wrapper library. + It allows you to allow/deny clients depending on IP number. + The TCP wrapper library is often used in GNU/Linux and + BSD distributions. See hosts_access @@ -217,7 +213,7 @@ --with-xml2[=prefix] Compile &yaz; with - libxml2 in directory + libxml2 in directory prefix. Use this option if you want SOAP support. By default configure will @@ -434,7 +430,7 @@ The easiest way to install YAZ on Windows is by downloading an installer from - here. + here. The installer comes with source too - in case you wish to compile YAZ with different Compiler options etc. @@ -443,7 +439,7 @@ Compiling from Source on WIN32 &yaz; is shipped with "makefiles" for the NMAKE tool that comes - with + with Microsoft Visual Studio. Version 6 and .NET has been tested. We expect that &yaz; compiles with version 5 as well. @@ -492,7 +488,7 @@ A Windows version of GNU Bison is part of - unxutils. + unxutils. @@ -514,14 +510,14 @@ If HAVE_LIBXML2 is set to 1, YAZ is compiled with SRW and SRU support. In this configuration, set LIBXML2_DIR to the - libxml2 source directory + libxml2 source directory and ZLIB_DIR to the zlib directory. Windows versions of libxml2, zlib and iconv can be found - + Igor Zlatković' site. diff --git a/doc/introduction.xml b/doc/introduction.xml index 836a43c..bb6149b 100644 --- a/doc/introduction.xml +++ b/doc/introduction.xml @@ -1,4 +1,4 @@ - + Introduction @@ -11,43 +11,41 @@ Complete - Z39.50 - version 3 support. Amendments and Z39.50-2002 revision is - supported. + Z39.50 version 3 support. + Amendments and Z39.50-2002 revision is supported. Supports - SRW/SRU + SRW/SRU version 1.1 (over HTTP and HTTPS). Includes BER encoders/decoders for the - ISO ILL + ISO ILL protocol. Supports the following transports: BER over TCP/IP - (RFC1729), + (RFC1729), BER over unix local socket, and - HTTP - 1.1. + HTTP 1.1. Secure Socket Layer support using - OpenSSL. + OpenSSL. If enabled, &yaz; uses HTTPS transport (for SOAP) or "Secure BER" (for Z39.50). Offers - ZOOM - C API implementing both Z39.50 and SRW. + ZOOM C API implementing both + Z39.50 and SRW. The &yaz; library offers a set of useful utilities related to the protocols, such as MARC (ISO2709) parser, CCL (ISO8777) parser, - CQL + CQL parser, memory management routines, character set conversion. @@ -158,11 +156,11 @@ The API - The &yaz; + The &yaz; toolkit offers several different levels of access to the - ISO23950/Z39.50, - ILL and - SRW + ISO23950/Z39.50, + ILL and + SRU/SRW protocols. The level that you need to use depends on your requirements, and the role (server or client) that you want to implement. @@ -172,8 +170,7 @@ Server implementers should consider the generic frontend server. None of those high-level APIs support the whole protocol, but - they do include most facilities used in existing Z39.50 - applications. + they do include most facilities used in existing Z39.50 applications. If you're using 'exotic' functionality (meaning anything not included in diff --git a/doc/odr.xml b/doc/odr.xml index 2a5fd7d..2f6bc02 100644 --- a/doc/odr.xml +++ b/doc/odr.xml @@ -1,4 +1,4 @@ - + The ODR Module Introduction @@ -540,9 +540,9 @@ void do_nothing_useful(int value) There is an ASN.1 tutorial available at - this site. + this site. This site also has standards for ASN.1 (X.680) and BER (X.690) - online. + online. diff --git a/doc/soap.xml b/doc/soap.xml index 87a07f7..a2de285 100644 --- a/doc/soap.xml +++ b/doc/soap.xml @@ -1,13 +1,13 @@ - + SOAP and SRW Introduction &yaz; uses a very simple implementation of - SOAP that only, + SOAP that only, currenly, supports what is sufficient to offer SRW functionality. The implementation uses the - tree - API of libxml2 to encode and decode SOAP packages. + tree API of + libxml2 to encode and decode SOAP packages. Like the Z39.50 ASN.1 module, the &yaz; SRW implementation uses diff --git a/doc/tools.xml b/doc/tools.xml index a8291ed..985306b 100644 --- a/doc/tools.xml +++ b/doc/tools.xml @@ -1,4 +1,4 @@ - + Supporting Tools @@ -225,7 +225,7 @@ @and. Its semantics are described in section 3.7.2 (Proximity) of Z39.50 the standard itself, which can be read on-line at - + In PQF, the proximity operation is represented by a sequence @@ -294,7 +294,7 @@ (The numeric values of the relation and well-known unit-code parameters are taken straight from - the ASN.1 of the proximity structure in the standard.) @@ -640,10 +640,8 @@ - The complete list of Bib-1 attributes can be found - - here - . + Refer to the complete + list of Bib-1 attributes It is also possible to specify non-numeric attribute values, @@ -940,10 +938,9 @@ struct ccl_rpn_node *ccl_find_str (CCL_bibset bibset, const char *str, CQL - CQL + CQL - Common Query Language - was defined for the - SRW - protocol. + SRW protocol. In many ways CQL has a similar syntax to CCL. The objective of CQL is different. Where CCL aims to be an end-user language, CQL is the protocol @@ -952,8 +949,7 @@ struct ccl_rpn_node *ccl_find_str (CCL_bibset bibset, const char *str, If you are new to CQL, read the - Gentle - Introduction. + Gentle Introduction. @@ -980,8 +976,7 @@ struct ccl_rpn_node *ccl_find_str (CCL_bibset bibset, const char *str, The parser converts CQL to - - XCQL. + XCQL. XCQL is an XML representation of CQL. XCQL is part of the SRW specification. However, since SRU supports CQL only, we don't expect XCQL to be widely used. @@ -1184,7 +1179,7 @@ int cql_transform_buf(cql_transform_t ct, returns a non-zero SRW error code; otherwise zero is returned (conversion successful). The meanings of the numeric error codes are listed in the SRW specifications at - + If conversion fails, more information can be obtained by calling @@ -1608,7 +1603,7 @@ 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. diff --git a/doc/yaz-client-commands.xml b/doc/yaz-client-commands.xml index 3ef958a..ef750cc 100644 --- a/doc/yaz-client-commands.xml +++ b/doc/yaz-client-commands.xml @@ -1,5 +1,5 @@ @@ -191,7 +191,7 @@ together with the search result. See the + url="http://www.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6"> Z39.50 standard for more details. @@ -207,7 +207,7 @@ the search result. See the + url="http://www.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6"> Z39.50 standard for more details. @@ -223,7 +223,7 @@ lslb and ssub. See the + url="http://www.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6"> Z39.50 standard for more details. @@ -263,7 +263,7 @@ yaz-client supports all the record syntaxes that currently are registered. See + url="http://www.loc.gov/z3950/agency/defns/oids.html#5"> Z39.50 Standard for more details. Commonly used records syntaxes include usmarc, diff --git a/doc/yaz-client-man.xml b/doc/yaz-client-man.xml index aaf4824..16be2f6 100644 --- a/doc/yaz-client-man.xml +++ b/doc/yaz-client-man.xml @@ -1,7 +1,9 @@ + %common; ]> - + diff --git a/doc/yaz-man.xml b/doc/yaz-man.xml index da32252..5d3cb1b 100644 --- a/doc/yaz-man.xml +++ b/doc/yaz-man.xml @@ -1,5 +1,8 @@ - - + + %common; +]> + yaz @@ -84,11 +87,10 @@ prefix/share/doc/yaz) - YAZ home page. + YAZ home page. - Z39.50 Maintenance - Agency Page. + Z39.50 Maintenance Agency Page. diff --git a/doc/yaz.xml.in b/doc/yaz.xml.in index 70752d9..dcaa2a5 100644 --- a/doc/yaz.xml.in +++ b/doc/yaz.xml.in @@ -1,11 +1,13 @@ - + %entities; + + %common; ]> &bookinfo; diff --git a/doc/zoom.xml b/doc/zoom.xml index 09be3d9..f73f321 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 @@ -49,7 +49,7 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn) There are other language bindings available for &yaz;, and still more are in active development. See the - ZOOM web-site for + ZOOM web-site for more information. @@ -258,7 +258,7 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn) If either option lang or charset is set, then - + Character Set and Language Negotiation is in effect. @@ -731,7 +731,7 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn) The record is returned in XML if possible. SRW/SRU and Z39.50 records with transfer syntax XML are returned verbatim. MARC records are returned in - + MARCXML (converted from ISO2709 to MARCXML by YAZ). @@ -749,13 +749,9 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn) Most - - MARC21 - + MARC21 records uses the - - MARC-8 - + MARC-8 character set encoding. An application that wishes to display in Latin-1 would use -- 1.7.10.4