X-Git-Url: http://lists.indexdata.dk/cgi-bin?a=blobdiff_plain;f=doc%2Fweb.sgml;h=cb50078382170bb77b135f69bae7c386ab4afcbc;hb=86560b2bfc5db8d1166bd42973c3bb5baf28e27e;hp=442c9ec8ea24a321c31ab75619d1583784c65145;hpb=3141eb0fa635c964fbe1302daaf23093e3b3ff5c;p=egate.git diff --git a/doc/web.sgml b/doc/web.sgml index 442c9ec..cb50078 100644 --- a/doc/web.sgml +++ b/doc/web.sgml @@ -1,13 +1,14 @@
Web/Z39.50 gateway guide -<author>Europagate, 1996 -<date>$Revision: 1.1 $ +<author>Europagate, 1996 <htmlurl url="http://europagate.dtv.dk" + name="http://europagate.dtv.dk"> +<date>$Revision: 1.3 $ <abstract> This document describes a Web server that provides access to the Z39.50 protocol. @@ -18,7 +19,8 @@ Z39.50 protocol. <sect>Introduction <p> -The EUROPAGATE project developed two Z39.50 gatways that served as +The <htmlurl url="http://europagate.dtv.dk" name="EUROPAGATE"> +project developed two Z39.50 gatways that served as Z39.50 clients: an email gateway and a web gateway. This document describes how to compile and install the web gateway. For information about the email gateway see the document egate.txt. @@ -65,7 +67,8 @@ If the compilation succeeds, you should install the software in target directories, by issuing: <tt/make install.web/. A HTML file called <tt/egwindex.html/ should be installed in your -<tt/HTDOCS/ directory. Read it with your browser and click on the +<tt/HTDOCS/ directory. The page contains miscellaneous starting links +to the Z39.50 gateway. Read it with your browser and click on the <it>single target</it> button to test it out. <sect>Overview of the system @@ -128,10 +131,10 @@ IrTcl library. The <tt/z39util.tcl/ file declares a lot of Tcl functions to facilitate Z39.50 communication as well as other utilities. -<tag/*.egw/ Web scripts with embedded Tcl - located in the <tt/EGWDIR/ -directory. Normally, each script correspond to one type of Web -page. For example, the <tt/query.egw/ script contacts a single -target and displays a search form; the <tt/search.egw/ script +<tag/*.egw/ HTML files with embedded Tcl - located in the <tt/EGWDIR/ +directory. Normally, each file correspond to one type of Web +page. For example, the <tt/query.egw/ file contacts a single +target and displays a search form; the <tt/search.egw/ file makes a Z39.50 search/present and displays the result. <tag/ztargets.conf/ Target configuration file. A sort of profile is @@ -157,6 +160,41 @@ variables. only includes information about Z39.50 communication. </descrip> +<sect1>Tcl Scripts + +<p> + +The scripts with the extension <tt/egw/ are HTML files with embedded Tcl. +Tcl code is initiated with a left curly brace <tt/{/ and is terminated +with a right curly brace <tt/}/. The Tcl code is executed on the +top level, i.e. variables are accessed in the global scope. +Standard Tcl commands, IrTcl commands (for Z39.50 communication), and +an extra set of "gateway" commands are available in the embedded Tcl code. +The extra set of commands are used to communicate with the Europagate +software: + +<descrip> +<tag/html/ Concatenates the arguments and transfers them to the HTTP server. +The data may be cached. They are not written until the <tt/egw_flush/ is +invoked. +<tag/egw_form/ Inspects CGI form variables. +<tag/egw_parms/ Inspects URL variables. +<tag/egw_flush/ Flushes all HTML output. +<tag/egw_log/ Logs messages. +<tag/egw_enc/ Encodes URL data. +<tag/egw_wait/ Waits for events. One of the following events +will terminate this command: data from a Z39.50 server, +data from the CGI module, or timeout. +</descrip> + +Note, that except from the <tt/html/ command all commands have a +<tt/egw_/ - prefix. +Apart from the new commands, the following global variables are set: +<descrip> +<tag/sessionId/ ID of the current user session (integer). +<tag/env/ Array of environment variables - standard Tcl really. +</descrip> + <sect>LICENSE <p>