From d659f801ef702c37a0d6bcbf6c227fdcc4e75520 Mon Sep 17 00:00:00 2001 From: Marc Cromme Date: Thu, 19 Jan 2006 09:26:59 +0000 Subject: [PATCH] corrected build error by including changes in zenra.xml.in, not in zebra.xml file --- doc/administration.xml | 2 +- doc/alvisxmlrecordmodel.xml | 138 +++++++++++++++++++++++++++++++++++++++++++ doc/architecture.xml | 127 +++++++++++---------------------------- doc/installation.xml | 8 +-- doc/introduction.xml | 10 ++-- doc/recordmodel.xml | 9 ++- doc/server.xml | 6 +- doc/zebra.xml.in | 4 +- doc/zebrasrv-virtual.xml | 16 ++--- 9 files changed, 200 insertions(+), 120 deletions(-) create mode 100644 doc/alvisxmlrecordmodel.xml diff --git a/doc/administration.xml b/doc/administration.xml index e5cdfcd..eca056e 100644 --- a/doc/administration.xml +++ b/doc/administration.xml @@ -1,5 +1,5 @@ - + Administrating Zebra + ALVIS XML Record Model and Filter Module + + + + The record model described in this chapter applies to the fundamental, + structured XML + record type alvis, introduced in + . The ALVIS XML record model + is experimental, and it's inner workings might change in future + releases of the Zebra Information Server. + + + + + + + + ALLVIS Record Filter + + The experimental, loadable Alvis XM/XSLT filter module + mod-alvis.so is packaged in the GNU/Debian package + libidzebra1.4-mod-alvis. + + + + ALLVIS Internal Record Representation + FIXME + + + + ALLVIS Canonical Format + FIXME + + + + + + + + ALLVIS Record Model Configuration + FIXME + + + + + ALLVIS Exchange Formats + FIXME + + + + + + + + + + + + + + diff --git a/doc/architecture.xml b/doc/architecture.xml index dada351..4cb8dae 100644 --- a/doc/architecture.xml +++ b/doc/architecture.xml @@ -1,5 +1,5 @@ - + Overview of Zebra Architecture @@ -106,7 +106,7 @@ This virtual package installs all the necessary packages to start - working with IDZebra - including utility programs, development libraries, + working with Zebra - including utility programs, development libraries, documentation and modules. idzebra1.4 @@ -123,11 +123,11 @@ numbers, and the like internal data to the YAZ server backend API. - This package contains all run-time libraries for IDZebra. + This package contains all run-time libraries for Zebra. libidzebra1.4 - This package includes documentation for IDZebra in PDF and HTML. + This package includes documentation for Zebra in PDF and HTML. idzebra1.4-doc - This package includes common essential IDZebra configuration files + This package includes common essential Zebra configuration files idzebra1.4-common @@ -142,7 +142,7 @@ - creates, updates and drops databases and indexes - This package contains IDZebra utilities such as the zebraidx indexer + This package contains Zebra utilities such as the zebraidx indexer utility and the zebrasrv server. idzebra1.4-utils @@ -154,7 +154,7 @@ the core Zebra searcher/retriever which - This package contains IDZebra utilities such as the zebraidx indexer + This package contains Zebra utilities such as the zebraidx indexer utility and the zebrasrv server, and their associated man pages. idzebra1.4-utils @@ -171,14 +171,14 @@ In addition to Z39.50 requests, the YAZ server frontend acts as HTTP server, honouring - SRW SOAP requests, and SRU REST requests. Moreover, it can - translate inco ming CQL queries to PQF/RPN queries, if + SRW SOAP requests, and SRU REST requests. Moreover, it can + translate inco ming CQL queries to PQF/RPN queries, if correctly configured. YAZ is a toolkit that allows you to develop software using the ANSI Z39.50/ISO23950 standard for information retrieval. - SRW/SRU + SRW/ SRU libyazthread.so libyaz.so libyaz @@ -206,7 +206,7 @@ This virtual package contains all base IDZebra filter modules. EMPTY ??? GRS Record Model and Filter Modules - Chapter + - grs.danbib GRS filters of various kind (*.abs files) IDZebra filter grs.danbib (DBC DanBib records) @@ -233,7 +233,7 @@ IDZebra filter grs.danbib (DBC DanBib records) libidzebra1.4-mod-grs-sgml not packaged yet ?? - grs.xml - This package includes the grs.xml filter which uses Expat to + This package includes the grs.xml filter which uses Expat to parse records in XML and turn them into IDZebra's internal grs node. libidzebra1.4-mod-grs-xml @@ -260,28 +260,29 @@ IDZebra filter grs.danbib (DBC DanBib records) + + Installation @@ -32,7 +32,7 @@ (required) - Zebra uses YAZ to support Z39.50/SRW. Also the memory management + Zebra uses YAZ to support Z39.50/ SRW. Also the memory management utilites from YAZ is used by Zebra. @@ -326,8 +326,8 @@ EXPAT_DIR If HAVE_EXPAT is set to 1, Zebra is compiled - with Expat support. In this configuration, set - ZEBRA_DIR to the Expat source directory. + with Expat support. In this configuration, set + ZEBRA_DIR to the Expat source directory. Windows version of Expat can be downloaded from SourceForge diff --git a/doc/introduction.xml b/doc/introduction.xml index 919e369..f7f67ca 100644 --- a/doc/introduction.xml +++ b/doc/introduction.xml @@ -1,5 +1,5 @@ - + Introduction @@ -440,16 +440,16 @@ construction of applications without requiring Z39.50 tools. Experimental support of the - Search/Retrieve Via URL (SRU) + Search/Retrieve Via URL ( SRU) REST webservice, and the - Search/Retrieve Web Service (SRW) + Search/Retrieve Web Service ( SRW) SOAP Web Service have recently been added to the YAZ/Zebra - combo - including server side Common Query Language (CQL) + combo - including server side Common Query Language (CQL) parsing and configuration. It remains to find a sponsor for further testing, documentation and packaging of this exiting component. diff --git a/doc/recordmodel.xml b/doc/recordmodel.xml index fd52ee0..e30bf10 100644 --- a/doc/recordmodel.xml +++ b/doc/recordmodel.xml @@ -1,5 +1,5 @@ - + GRS Record Model and Filter Modules @@ -87,7 +87,7 @@ grs.xml - This filter reads XML records and uses Expat to + This filter reads XML records and uses Expat to parse them and convert them into IDZebra's internal grs record model. Only one record per file @@ -2072,8 +2072,7 @@ - - SOIF. Support for this syntax is experimental, and is currently @@ -2083,7 +2082,7 @@ level. - --> + diff --git a/doc/server.xml b/doc/server.xml index d42a39e..9c24fd7 100644 --- a/doc/server.xml +++ b/doc/server.xml @@ -1,5 +1,5 @@ - + The Z39.50 Server @@ -23,7 +23,7 @@ boolean search expressions and relevance-ranked free-text queries. - zebrasrv is the Z39.50 and SRW/U frontend + zebrasrv is the Z39.50 and SRW/U frontend server for the Zebra indexer. @@ -84,7 +84,7 @@ http://www.indexdata.dk/yaz/doc/server.vhosts.tkl - Section "Specification of CQL to RPN mappings" in the YAZ manual. + Section "Specification of CQL to RPN mappings" in the YAZ manual. http://www.indexdata.dk/yaz/doc/tools.tkl#tools.cql.map diff --git a/doc/zebra.xml.in b/doc/zebra.xml.in index 30aac53..31ed06b 100644 --- a/doc/zebra.xml.in +++ b/doc/zebra.xml.in @@ -6,6 +6,7 @@ + @@ -29,7 +30,7 @@ '> ]> - + Zebra - User's Guide and Reference @@ -84,6 +85,7 @@ &chap-installation; &chap-quickstart; &chap-examples; + &chap-architecture; &chap-administration; &chap-zebraidx; &chap-server; diff --git a/doc/zebrasrv-virtual.xml b/doc/zebrasrv-virtual.xml index eb3ccf2..da72d6c 100644 --- a/doc/zebrasrv-virtual.xml +++ b/doc/zebrasrv-virtual.xml @@ -1,5 +1,5 @@ @@ -11,9 +11,9 @@ A backend can be configured to execute in a particular working - directory. Or the YAZ frontend may perform CQL to RPN conversion, thus - allowing traditional Z39.50 backends to be offered as a SRW/SRU - service. SRW/SRU Explain information for a particular backend may also + directory. Or the YAZ frontend may perform CQL to RPN conversion, thus + allowing traditional Z39.50 backends to be offered as a SRW/ SRU + service. SRW/ SRU Explain information for a particular backend may also be specified. @@ -128,8 +128,8 @@ element cql2rpn (optional) - Specifies a filename that includes CQL to RPN conversion for this - backend server. See CQL section in YAZ manual. + Specifies a filename that includes CQL to RPN conversion for this + backend server. See CQL section in YAZ manual. If given, the backend server will only "see" a Type-1/RPN query. @@ -138,7 +138,7 @@ element explain (optional) - Specifies SRW/SRU ZeeRex content for this server. Copied verbatim + Specifies SRW/ SRU ZeeRex content for this server. Copied verbatim to the client. As things are now, some of the Explain content seeem redundant because host information, etc. is also stored elsewhere. @@ -194,7 +194,7 @@ elements. - For "server2" elements for CQL to RPN conversion + For "server2" elements for CQL to RPN conversion is supported and explain information has been added (a short one here to keep the example small). -- 1.7.10.4