You are viewing a plain text version of this content. The canonical link for it is here.
Posted to site-cvs@tcl.apache.org by da...@apache.org on 2002/10/20 19:08:42 UTC
cvs commit: tcl-site/rivet/docs commands.html examples.html help.html index.html installation.html internals.html upgrading.html
davidw 2002/10/20 10:08:42
Modified: rivet/docs commands.html examples.html help.html index.html
installation.html internals.html upgrading.html
Log:
Updated docs, thanks to Makoto SATOH.
Revision Changes Path
1.5 +7 -3 tcl-site/rivet/docs/commands.html
Index: commands.html
===================================================================
RCS file: /home/cvs/tcl-site/rivet/docs/commands.html,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- commands.html 18 Oct 2002 07:05:53 -0000 1.4
+++ commands.html 20 Oct 2002 17:08:42 -0000 1.5
@@ -5,11 +5,15 @@
The <span style="font-family:monospace"><b>var</b></span> command manipulates variables
set by the user.
</div><div class="variablelist"><dl><dt><span class="term">
- <div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline">get</span> <span style="font-family:monospace; text-decoration:underline"><i><tt>varname</tt></i></span></span></div>
+ <div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline">get</span> <span style="font-family:monospace; text-decoration:underline"><i><tt>varname</tt></i></span> <span style="font-family:monospace; text-decoration:underline"><i><tt>?default?</tt></i></span></span></div>
</span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
Returns the value of variable
- <tt><span style="text-decoration:underline"><i><tt>varname</tt></i></span></tt> as a
- string (even if there are multiple values).
+ <tt><span style="text-decoration:underline"><i><tt>varname</tt></i></span></tt>
+ as a string (even if there are multiple values). If
+ the variable doesn't exist as a GET or POST
+ variable, the
+ <tt><span style="text-decoration:underline"><i><tt>?default?</tt></i></span></tt>
+ value is returned, otherwise an error is thrown.
</div></div></dd><dt><span class="term">
<div class="cmdsynopsis" style="width:80%"><span style="background:#bbbbff ; margin:1ex ; padding:.4ex ; word-spacing:1ex "><span style="font-family:monospace; text-decoration:underline">list</span> <span style="font-family:monospace; text-decoration:underline"><i><tt>varname</tt></i></span></span></div>
</span></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
1.2 +1 -1 tcl-site/rivet/docs/examples.html
Index: examples.html
===================================================================
RCS file: /home/cvs/tcl-site/rivet/docs/examples.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- examples.html 18 Oct 2002 07:05:53 -0000 1.1
+++ examples.html 20 Oct 2002 17:08:42 -0000 1.2
@@ -128,5 +128,5 @@
</p><div style="background:#bbffbb ; width:90ex ; margin: 2ex ; padding: 1ex; border: solid black 1px ; white-space: pre; font-family:monospace ; " class="programlisting"><?
upload save MyUpload /tmp/uploadfiles/file1
puts "Saved file [upload filename MyUpload] \
- ([upload size MyUploadto] bytes) to server"
+ ([upload size MyUpload] bytes) to server"
?></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="commands.html">Prev</a>�</td><td width="20%" align="center"><a accesskey="u" href="index.html">Up</a></td><td width="40%" align="right">�<a accesskey="n" href="help.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Rivet Tcl Commands and Variables�</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">�Resources - How to Get Help</td></tr></table></div></body></html>
1.5 +2 -2 tcl-site/rivet/docs/help.html
Index: help.html
===================================================================
RCS file: /home/cvs/tcl-site/rivet/docs/help.html,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- help.html 18 Oct 2002 07:05:53 -0000 1.4
+++ help.html 20 Oct 2002 17:08:42 -0000 1.5
@@ -1,5 +1,5 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
-<html><head><meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type"><title>Resources - How to Get Help</title><meta name="generator" content="DocBook XSL Stylesheets V1.50.0"><link rel="home" href="index.html" title="Apache Rivet"><link rel="up" href="index.html" title="Apache Rivet"><link rel="previous" href="examples.html" title="Examples and Usage"><link rel="next" href="internals.html" title="Rivet Internals"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Resources - How to Get Help</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="examples.html">Prev</a>�</td><th width="60%" align="center">�</th><td width="20%" align="right">�<a accesskey="n" href="internals.html">Next</a></td></tr></table><hr></div><div class="section"><div class="titlepage"><div><hr><h2 class="title" style="clear: both"><a name="help"></a>Resources - How to Get Help</h2></div></div><div class="section"><div class="titlepage"><div><h3 class="title"><a name="id5347738"></a>Mailing Lists</h3></div></div><p style="width:90%">
+<html><head><meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type"><title>Resources - How to Get Help</title><meta name="generator" content="DocBook XSL Stylesheets V1.50.0"><link rel="home" href="index.html" title="Apache Rivet"><link rel="up" href="index.html" title="Apache Rivet"><link rel="previous" href="examples.html" title="Examples and Usage"><link rel="next" href="internals.html" title="Rivet Internals"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Resources - How to Get Help</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="examples.html">Prev</a>�</td><th width="60%" align="center">�</th><td width="20%" align="right">�<a accesskey="n" href="internals.html">Next</a></td></tr></table><hr></div><div class="section"><div class="titlepage"><div><hr><h2 class="title" style="clear: both"><a name="help"></a>Resources - How to Get Help</h2></div></div><div class="section"><div class="titlepage"><div><h3 class="title"><a name="id5347754"></a>Mailing Lists</h3></div></div><p style="width:90%">
The Rivet mailing list is the first place you should turn for
help, if you haven't found the solution to your problem in the
documentation. Send email to
@@ -27,7 +27,7 @@
</div></li><li><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">
<a href="http://wiki.tcl.tk" target="_top">http://wiki.tcl.tk</a> is the Tcl'ers Wiki, a
free-form place to search for answers and ask for help.
- </div></li></ul></div></div><div class="section"><div class="titlepage"><div><h3 class="title"><a name="id5347888"></a>Bug Tracking System</h3></div></div><p style="width:90%">
+ </div></li></ul></div></div><div class="section"><div class="titlepage"><div><h3 class="title"><a name="id5347904"></a>Bug Tracking System</h3></div></div><p style="width:90%">
Apache Rivet uses the Apache Bug Tracking system at <a href="http://nagoya.apache.org/bugzilla/" target="_top">http://nagoya.apache.org/bugzilla/</a>. Here,
you can report problems, or check and see if existing issues
are already known and being dealt with.
1.6 +1 -1 tcl-site/rivet/docs/index.html
Index: index.html
===================================================================
RCS file: /home/cvs/tcl-site/rivet/docs/index.html,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- index.html 18 Oct 2002 07:05:53 -0000 1.5
+++ index.html 20 Oct 2002 17:08:42 -0000 1.6
@@ -3,7 +3,7 @@
<tt><<a href="mailto:davidw@apache.org">davidw@apache.org</a>></tt>
</p></div></div></div></div><div><div class="author"><h3 class="author">Damon Courtney</h3><div class="affiliation"><div class="address"><p>
<tt><<a href="mailto:damonc@apache.org">damonc@apache.org</a>></tt>
- </p></div></div></div></div><div><p class="copyright">Copyright � 2002 Apache Software Foundation</p></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><a href="index.html#id5342961">Introduction to Apache Rivet</a></dt><dt><a href="installation.html">Apache Rivet Installation</a></dt><dt><a href="directives.html">Rivet Apache Directives</a></dt><dt><a href="commands.html">Rivet Tcl Commands and Variables</a></dt><dt><a href="examples.html">Examples and Usage</a></dt><dt><a href="help.html">Resources - How to Get Help</a></dt><dd><dl><dt><a href="help.html#id5347738">Mailing Lists</a></dt><dt><a href="help.html#websites">Web Sites</a></dt><dt><a href="help.html#id5347888">Bug Tracking System</a></dt></dl></dd><dt><a href="internals.html">Rivet Internals</a></dt><dd><dl><dt><a href="internals.html#id5347938">Initialization</a></dt><dt><a href="internals.html#id5347974">RivetChan</a></dt><dt><a href="internals.html#id5348003">Page Parsing, Execution and Cacheing</a></dt></dl></dd><dt><a href="upgrading.html">Upgrading from mod_dtcl or NeoWebScript</a></dt><dd><dl><dt><a href="upgrading.html#id5348082">mod_dtcl</a></dt><dt><a href="upgrading.html#id5347491">NeoWebScript</a></dt></dl></dd></dl></div><div class="section"><div class="titlepage"><div><hr><h2 class="title" style="clear: both"><a name="id5342961"></a>Introduction to Apache Rivet</h2></div></div><p style="width:90%">
+ </p></div></div></div></div><div><p class="copyright">Copyright � 2002 Apache Software Foundation</p></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><a href="index.html#id5342961">Introduction to Apache Rivet</a></dt><dt><a href="installation.html">Apache Rivet Installation</a></dt><dt><a href="directives.html">Rivet Apache Directives</a></dt><dt><a href="commands.html">Rivet Tcl Commands and Variables</a></dt><dt><a href="examples.html">Examples and Usage</a></dt><dt><a href="help.html">Resources - How to Get Help</a></dt><dd><dl><dt><a href="help.html#id5347754">Mailing Lists</a></dt><dt><a href="help.html#websites">Web Sites</a></dt><dt><a href="help.html#id5347904">Bug Tracking System</a></dt></dl></dd><dt><a href="internals.html">Rivet Internals</a></dt><dd><dl><dt><a href="internals.html#id5347954">Initialization</a></dt><dt><a href="internals.html#id5347989">RivetChan</a></dt><dt><a href="internals.html#id5348018">Page Parsing, Execution and Cacheing</a></dt></dl></dd><dt><a href="upgrading.html">Upgrading from mod_dtcl or NeoWebScript</a></dt><dd><dl><dt><a href="upgrading.html#id5348090">mod_dtcl</a></dt><dt><a href="upgrading.html#id5347507">NeoWebScript</a></dt></dl></dd></dl></div><div class="section"><div class="titlepage"><div><hr><h2 class="title" style="clear: both"><a name="id5342961"></a>Introduction to Apache Rivet</h2></div></div><p style="width:90%">
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
1.2 +2 -2 tcl-site/rivet/docs/installation.html
Index: installation.html
===================================================================
RCS file: /home/cvs/tcl-site/rivet/docs/installation.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- installation.html 18 Oct 2002 07:05:53 -0000 1.1
+++ installation.html 20 Oct 2002 17:08:42 -0000 1.2
@@ -37,11 +37,11 @@
if it's successful.
</p></li><li><p style="width:90%">At this point, you are ready to run the build
system:</p><div style="background:#bbffbb ; width:90ex ; margin: 2ex ; padding: 1ex; border: solid black 1px ; white-space: pre; font-family:monospace ; " class="programlisting">cd src/
- ./make.tcl <i><tt>option</tt></i></div><p style="width:90%">where <i><tt>option</tt></i> can be
+./make.tcl <i><tt>option</tt></i></div><p style="width:90%">where <i><tt>option</tt></i> can be
either <tt><span style="text-decoration:underline">shared</span></tt> or
<tt><span style="text-decoration:underline">static</span></tt>.
</p></li><li><p class="title"><b>Install</b></p><p style="width:90%">
- Now, you are ready to run the <span style="font-family:monospace"><b>./make
+ Now, you are ready to run the <span style="font-family:monospace"><b>./make.tcl
install</b></span> command to install the resulting
files. This should copy the shared object (like
<tt>mod_rivet.so</tt>, if one was
1.3 +3 -3 tcl-site/rivet/docs/internals.html
Index: internals.html
===================================================================
RCS file: /home/cvs/tcl-site/rivet/docs/internals.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- internals.html 18 Oct 2002 07:05:53 -0000 1.2
+++ internals.html 20 Oct 2002 17:08:42 -0000 1.3
@@ -4,7 +4,7 @@
code is removed, and changes are made. The best place to look
is the source code itself. If you are interested in the changes
themselves FIXME.
- </p><div class="section"><div class="titlepage"><div><h3 class="title"><a name="id5347938"></a>Initialization</h3></div></div><p style="width:90%">
+ </p><div class="section"><div class="titlepage"><div><h3 class="title"><a name="id5347954"></a>Initialization</h3></div></div><p style="width:90%">
When Apache is started, (or when child Apache processes are
started if a threaded Tcl is used),
<tt>Rivet_InitTclStuff</tt> is called, which
@@ -15,7 +15,7 @@
executes Rivet's <tt>init.tcl</tt>. The caching
system is also set up, and if there is a
<span style="font-family:monospace"><b>GlobalInitScript</b></span>, it is run.
- </p></div><div class="section"><div class="titlepage"><div><h3 class="title"><a name="id5347974"></a>RivetChan</h3></div></div><p style="width:90%">
+ </p></div><div class="section"><div class="titlepage"><div><h3 class="title"><a name="id5347989"></a>RivetChan</h3></div></div><p style="width:90%">
The RivetChan system was created in
order to have an actual Tcl channel that we could redirect
standard output to. This lets us use, for instance, the
@@ -25,7 +25,7 @@
Tcl's regular standard output is replaced with an instance of
this channel type, so that, by default, output will go to the
web page.
- </p></div><div class="section"><div class="titlepage"><div><h3 class="title"><a name="id5348003"></a>Page Parsing, Execution and Cacheing</h3></div></div><p style="width:90%">
+ </p></div><div class="section"><div class="titlepage"><div><h3 class="title"><a name="id5348018"></a>Page Parsing, Execution and Cacheing</h3></div></div><p style="width:90%">
When a Rivet page is requested, it is transformed into an
ordinary Tcl script by parsing the file for the <? ?>
processing instruction tags. Everything outside these tags
1.5 +2 -2 tcl-site/rivet/docs/upgrading.html
Index: upgrading.html
===================================================================
RCS file: /home/cvs/tcl-site/rivet/docs/upgrading.html,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- upgrading.html 18 Oct 2002 07:05:53 -0000 1.4
+++ upgrading.html 20 Oct 2002 17:08:42 -0000 1.5
@@ -6,8 +6,8 @@
compatibility was not a primary goal when creating Rivet, but we
do provide this information which may be of use to those wishing
to upgrade from mod_dtcl or NWS installations.
- </p><div class="section"><div class="titlepage"><div><h3 class="title"><a name="id5348082"></a>mod_dtcl</h3></div></div><p style="width:90%">
+ </p><div class="section"><div class="titlepage"><div><h3 class="title"><a name="id5348090"></a>mod_dtcl</h3></div></div><p style="width:90%">
Rivet was originally based on the dtcl code, but it has
changed (improved!) quite a bit. The concepts remain the
same, but many of the commands have changed.
- </p></div><div class="section"><div class="titlepage"><div><h3 class="title"><a name="id5347491"></a>NeoWebScript</h3></div></div><p style="width:90%">TODO</p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="internals.html">Prev</a>�</td><td width="20%" align="center"><a accesskey="u" href="index.html">Up</a></td><td width="40%" align="right">�</td></tr><tr><td width="40%" align="left" valign="top">Rivet Internals�</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">�</td></tr></table></div></body></html>
+ </p></div><div class="section"><div class="titlepage"><div><h3 class="title"><a name="id5347507"></a>NeoWebScript</h3></div></div><p style="width:90%">TODO</p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="internals.html">Prev</a>�</td><td width="20%" align="center"><a accesskey="u" href="index.html">Up</a></td><td width="40%" align="right">�</td></tr><tr><td width="40%" align="left" valign="top">Rivet Internals�</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">�</td></tr></table></div></body></html>
---------------------------------------------------------------------
To unsubscribe, e-mail: tcl-site-cvs-unsubscribe@tcl.apache.org
For additional commands, e-mail: tcl-site-cvs-help@tcl.apache.org