From d6f09c50ab4d498c8fef6f50feb90329b88a5c13 Mon Sep 17 00:00:00 2001 From: Adam Dickmeiss Date: Fri, 9 Aug 1996 15:42:12 +0000 Subject: [PATCH] Updated doc. --- doc/egate.sgml | 12 +++++++----- doc/web.sgml | 53 +++++++++++++++++++++++++++++++++++++++++++++-------- 2 files changed, 52 insertions(+), 13 deletions(-) diff --git a/doc/egate.sgml b/doc/egate.sgml index edee040..06d222e 100644 --- a/doc/egate.sgml +++ b/doc/egate.sgml @@ -1,13 +1,14 @@
-Email/Z39.50 gateway guide -<author>Europagate, 1996 -<date>$Revision: 1.10 $ +<title>Email/Z39.50 gateway guide +<author>Europagate, 1996 <htmlurl url="http://europagate.dtv.dk" + name="http://europagate.dtv.dk"> +<date>$Revision: 1.11 $ <abstract> This document describes a Email server that provides access to the Z39.50 protocol. @@ -19,7 +20,8 @@ Z39.50 protocol. <p> This document describes an email server (ES) system developed -within the EUROPAGATE project. The first part of this document +within the <htmlurl url="http://europagate.dtv.dk" name="EUROPAGATE"> +project. The first part of this document serves as an administrators guide, while the second part is a follow-up on the Design deliverable (WP4.1) that outlines the deviations from the design. Also, the second part contains diff --git a/doc/web.sgml b/doc/web.sgml index d3d48a0..cb50078 100644 --- a/doc/web.sgml +++ b/doc/web.sgml @@ -1,13 +1,14 @@ <!doctype linuxdoc system> <!-- - $Id: web.sgml,v 1.2 1996/06/06 10:34:34 adam Exp $ + $Id: web.sgml,v 1.3 1996/08/09 15:42:13 adam Exp $ --> <article> <title>Web/Z39.50 gateway guide -<author>Europagate, 1996 -<date>$Revision: 1.2 $ +<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. @@ -129,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 @@ -158,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> -- 1.7.10.4