From 907e8fda0e0052bd08b333f104344c1a26f2f409 Mon Sep 17 00:00:00 2001 From: Adam Dickmeiss Date: Fri, 12 Jan 2007 14:54:58 +0000 Subject: [PATCH] Copied and reformatted PROTOCOL material to pazpar2_protoxol.xml which becomes pazpar2_protocol(7). Added pazpar2_conf.xml.. Description of config might be moved to pazpar2.xml instead. --- doc/.cvsignore | 2 +- doc/Makefile.am | 14 +- doc/book.xml | 30 ++-- doc/pazpar2.xml | 21 ++- doc/pazpar2_conf.xml | 59 ++++++++ doc/pazpar2_protocol.xml | 350 ++++++++++++++++++++++++++++++++++++++++++++++ 6 files changed, 453 insertions(+), 23 deletions(-) create mode 100644 doc/pazpar2_conf.xml create mode 100644 doc/pazpar2_protocol.xml diff --git a/doc/.cvsignore b/doc/.cvsignore index 9be605d..4b010c0 100644 --- a/doc/.cvsignore +++ b/doc/.cvsignore @@ -9,7 +9,7 @@ pazpar2.pdf *.tkl manpage.links manpage.refs -pazpar2.1 +*.[0-8] local.ent htmlhelp.hhp toc.hhc diff --git a/doc/Makefile.am b/doc/Makefile.am index f483918..f5fd43c 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,19 +1,19 @@ -## $Id: Makefile.am,v 1.1 2007-01-10 09:44:20 adam Exp $ +## $Id: Makefile.am,v 1.2 2007-01-12 14:54:58 adam Exp $ docdir=$(datadir)/doc/@PACKAGE@ SUBDIRS = common -SUFFIXES=.3 .1 .pdf .tkl .esp .xml +SUFFIXES=.1 .7 .pdf .tkl .esp .xml XMLFILES = book.xml manref.xml MAINXML = $(srcdir)/book.xml -XMLMAN = pazpar2.xml +XMLMAN = pazpar2.xml pazpar2_protocol.xml pazpar2_conf.xml SUPPORTFILES = entities.ent local.ent.in -MANFILES = pazpar2.1 +MANFILES = pazpar2.1 pazpar2_protocol.7 pazpar2_conf.5 HTMLFILES = index.html @@ -31,6 +31,12 @@ $(HTMLFILES): $(XMLFILES) $(PNGFILES) .xml.1: $(MAN_COMPILE) $< +.xml.5: + $(MAN_COMPILE) $< + +.xml.7: + $(MAN_COMPILE) $< + index.tkl: $(XMLFILES) $(TKL_COMPILE) $(MAINXML) diff --git a/doc/book.xml b/doc/book.xml index 27256cd..ae0bb46 100644 --- a/doc/book.xml +++ b/doc/book.xml @@ -9,10 +9,10 @@ %common; ]> - + - pazpar2 - User's Guide and Reference + Pazpar2 - User's Guide and Reference SebastianHammer @@ -22,11 +22,11 @@ - pazpar2 - High-performance, user-interface + Pazpar2 - High-performance, user-interface user-interface independtent metasearching middleware. - This document is a guide and reference to pazpar version &version;. + This document is a guide and reference to Pazpar version &version;. @@ -45,19 +45,19 @@ Introduction - pazpar2 is.. To be written. + Pazpar2 is.. To be written. - pazpar2 License + Pazpar2 License To be decided and written. Installation - pazpar2 depends on the following tools/libraries: + Pazpar2 depends on the following tools/libraries: YAZ @@ -70,7 +70,7 @@ - In order to compile pazpar2 an ANSI C compiler is + In order to compile Pazpar2 an ANSI C compiler is required. The requirements should be the same as for YAZ. @@ -78,14 +78,14 @@ Installation on Unix (from Source) Here is a quick step-by-step guide on how to compile the - tools that pazpar2 uses. Only few systems have none of the required + tools that Pazpar2 uses. Only few systems have none of the required tools binary packages. If, for example, Libxml2/libxslt are already - installed as development packages use those (and omit compilation). + installed as development packages use these. Ensure that the development libraries + header files are - available on your system before compiling pazpar2. For installation + available on your system before compiling Pazpar2. For installation of YAZ, refer to the YAZ installation chapter. @@ -101,7 +101,7 @@
Installation on Debian GNU/Linux - All dependencies for pazpar2 are available as + All dependencies for Pazpar2 are available as Debian packages for the sarge (stable in 2005) and etch (testing in 2005) distributions. @@ -115,14 +115,14 @@ With these packages installed, the usual configure + make - procedure can be used for pazpar2 as outlined in + procedure can be used for Pazpar2 as outlined in .
- - Reference guide + + Reference The material in this chapter is drawn directly from the individual manual entries. diff --git a/doc/pazpar2.xml b/doc/pazpar2.xml index 825db7a..ba4286b 100644 --- a/doc/pazpar2.xml +++ b/doc/pazpar2.xml @@ -8,10 +8,10 @@ %common; ]> - + - pazpar2 + Pazpar2 &version; @@ -39,11 +39,26 @@ EXAMPLES - + FILES + + SEE ALSO + + + pazpar2_conf + 5 + + + pazpar2_protocol + 7 + + + + + + + + Pazpar2 + &version; + + + Pazpar2 conf + 5 + + + + pazpar2_conf + Pazpar2 Configuration + + + + + pazpar2.conf + + + + DESCRIPTION + + + OPTIONS + + + EXAMPLES + + + FILES + + + + diff --git a/doc/pazpar2_protocol.xml b/doc/pazpar2_protocol.xml new file mode 100644 index 0000000..2d75c17 --- /dev/null +++ b/doc/pazpar2_protocol.xml @@ -0,0 +1,350 @@ + + %local; + + %entities; + + %common; +]> + + + + Pazpar2 + &version; + + + Pazpar2 protocol + 7 + + + + pazpar2_protocol + The webservice protocol of Pazpar2 + + + DESCRIPTION + + Webservice requests are any that refer to filename "search.pz2". Arguments + are GET-style parameters. Argument 'command' is required and specifies + command. Any request not recognized as a webservice request as described, + are forwarded to the HTTP server specified in option -p. + + + Each command is described in sub sections to follow. + + init + + Initializes a session. + Returns session ID to be used in subsequent requests. + + + Example: + + search.pz2?command=init + + + + Response: + + + OK + 2044502273 + +]]> + + + ping + + Keeps a session alive. An idle session will time out after one minute. + The ping command can be used to keep the session alive absent other + activity. + It is suggested that any browser client have a simple alarm handler which + sends a ping every 50 seconds or so once a session has been initialized. + + + Example: + + + Response: + + OK + +]]> + + + search + + Launches a search, parameters: + + + + session + + + Session ID + + + + + query + + + CCL query + + + + + + + + Example: + + + Response: + + OK + + ]]> + + + + + stat + + Provides status of ongoing search. Parameters: + + + + session + + + Session ID + + + + + + + + Example: + + Output + + 3 + 7 -- Total hitcount + 7 -- Total number of records fetched + 1 -- Total number of associated clients + 0 -- Number of disconnected clients + 0 -- Number of clients in connecting state + 0 -- Number of clients initializing + 0 -- ... searching + 0 -- ... presenting + 1 -- ... idle (not doing anything) + 0 -- ... Connection failed + 0 -- ... Error was produced somewhere + + ]]> + + + + + show + + Shows records retrieved. Parameters: + + + session + + + Session ID + + + + + + start + + First record to show - 0-indexed. + + + + + num + + + Number of records to show If omitted, 20 is used. + + + + + + block + + + If block is set, the command will hang until there are records ready + to display. Use this to show first records rapidly without + requiring rapid polling. + + + + + + + + Example: + + Output: + + OK + 3 + 6 + 7 + 0 + 2 + + How to program a computer, by Jack Collins + 2 + 6 + + + + Computer processing of dynamic images from an Anger scintillation camera : + the proceedings of a workshop / + + 2 + + + ]]> + + + + + record + + Retrieves a detailed record. Parameters: + + + + id + + + record ID as provided by the + show command. + + + + + + + Example: + + + Example output: + + + + The Puget Sound Region : a portfolio of thematic computer maps / + + 1974 + Mairs, John W. + Cartography + + + + + + + termlist + + Retrieves term list(s). Parameters: + +session +name -- comma-separated list of termlist names (default "subject") + + + + Example: + +Output: + + 3 + + + Donald Knuth + 10 + + + Robert Pirsig + 2 + + + + + Computer programming + 10 + + + +]]> + + + + For the special termlist name "xtargets", results + are returned about the targets which have returned the most hits. + The 'term' subtree has additional elements, + specifically a state and diagnostic field (in the example below, a + target ID is returned in place of 'name'. + This may or may not change later. + + + Example + + library2.mcmaster.ca + 11734 + Client_Idle + 0 + +]]> + + + + + + + -- 1.7.10.4