Apache Rivet

The Rivet Team

The Apache Software Foundation

Table of Contents

Introduction to Apache Rivet
Apache Rivet Installation
Rivet Apache Directives
Rivet Tcl Commands and Variables
var — get the value of a form variable.
upload — handle a file uploaded by a client.
load_response — load form variables into an array.
load_headers — get client request's headers.
load_cookies — get any cookie variables sent by the client.
load_env — get the request's environment variables.
env — Loads a single "environmental variable" into a Tcl variable.
include — includes a file into the output stream without modification.
parse — parses a Rivet template file.
headers — set and parse HTTP headers.
makeurl — construct url's based on hostname, port.
cookie — get and set cookies.
clock_to_rfc850_gmt — create a rfc850 time from [clock seconds].
html — construct html tagged text.
incr0 — increment a variable or set it to 1 if nonexistant.
parray — Tcl's parray with html formatting.
abort_page — Stops outputing data to web page, similar in purpose to PHP's die command.
abort_code — Returns the code passed to abort_page earlier during the request processing
no_body — Prevents Rivet from sending any content.
escape_string — convert a string into escaped characters.
escape_sgml_chars — escape special SGML characters in a string.
escape_shell_command — escape shell metacharacters in a string.
unescape_string — unescape escaped characters in a string.
apache_log_error — log messages to the Apache error log
apache_table — access and manipulate Apache tables in the request structure.
Examples and Usage
Rivet Tcl Packages
DIO - Database Interface Objects
DIO — Database Interface Objects
DIODisplay - Database Interface Objects Display Class
DIODisplay — Database Interface Objects Display Class
Session Package
Introduction
Requirements
Preparing To Use It
Example Usage
Using Sessions From Your Code
Session Configuration Options
Session Methods
Getting Additional Randomness From The Entropy File
Form: An HTML Form Fields Generation Utility
Introduction
form — a Tcl command object for creating HTML forms
Calendar Package
Introduction
Calendar — Utility class the builds and prints a calendar table
XmlCalendar — Prints XML formatted calendar tables
HtmlCalendar — Concrete class derived from XmlCalendar
Resources - How to Get Help
Mailing Lists
Newsgroup
Web Sites
Bug Tracking System
IRC
Editing Rivet Template Files
Rivet Internals
Initialization
RivetChan
The global Command
Page Parsing, Execution and Caching
Debugging Rivet and Apache
Upgrading from mod_dtcl or NeoWebScript
mod_dtcl
NeoWebScript

List of Examples

1. Hello World
2. Generate a Table
3. Variable Access
4. File Upload
5. File Download
6. XML Messages and Ajax
7. A Calendar Utility

Document revision: $Revision: 963677 $, last modified 2011-03-17 21:14:19+01:00$ by $Author: mxmanghi $.


Introduction to Apache Rivet

Apache Rivet is a system for creating dynamic web content via a programming language integrated with Apache Web Server. It is designed to be fast, powerful and extensible, consume few system resources, be easy to learn, and to provide the user with a platform that can also be used for other programming tasks outside the web (GUI's, system administration tasks, text processing, database manipulation, XML, and so on). In order to meet these goals, we have chosen the Tcl programming language to combine with the Apache Web Server.

In this manual, we aim to help get you started, and then writing productive code as quickly as possible, as well as giving you ideas on how to best take advantage of Rivet's architecture to create different styles of web site.

This documentation is a work in progress, and, like everything else about Apache Rivet, it is Free Software. If you see something that needs improving, and have ideas or suggestions, don't hesitate to let us know. If you want to contribute directly, better yet!