httpd::doc_error(n) 1.0 "Tcl Web Server"
httpd::doc_error - Commands to generate error and not-found pages
TABLE OF CONTENTS
SYNOPSIS
DESCRIPTION
Public API
SEE ALSO
KEYWORDS
COPYRIGHT
package require httpd::doc_error ?1.0?
The package httpd::doc_error provides a number of commands
for the generation of standard error and not-found pages.
- Doc_NotFoundPage virtual
-
Registers the url (virtual) and thus the file of the not-found
page in the package httpd::doc. The contents of the file are
always subst'ed to generate the actual reply send to the client.
In other words, while there is basic templating for this page via
httpd::subst the full-blown TML is not available
here.
- Doc_ErrorPage virtual
-
See Doc_NotFoundPage above, except for the error page.
- Doc_NotFound sock
-
Called when a page is missing. Looks for a handler page registered
with Doc_NotFoundPage, sets up the substitution context and then
returns the result of the substitution run. The argument sock
specifies the connection and request which asked for the missing page.
A subst handler can retrieve the url which was not found via the
command Doc_UrlNotFound below.
- Doc_Error sock ei
-
Like Doc_NotFound, except that is called when an error occured
while processing the request on connection sock. ei
contains the error information to show in the page. A subst handler
can retrieve this information via Doc_ErrorInfo below.
- Doc_ErrorInfo
-
Returns the error information raised by the package.
- Doc_UrlNotFound
-
Returns the url which was not found.
httpd, httpd::counter, httpd::doc, httpd::log, httpd::subst, httpd::utils
documents, error, files, substitution, templates, web server
Copyright © 2003 Andreas Kupries <andreas_kupries@users.sourceforge.net>