draft changes for release of rivet 3.1
diff --git a/rivet/doap_rivet.rdf b/rivet/doap_rivet.rdf
index 7750d78..9607e53 100644
--- a/rivet/doap_rivet.rdf
+++ b/rivet/doap_rivet.rdf
@@ -37,8 +37,8 @@
<release>
<Version>
<name>rivet-3.1</name>
- <created>2018-11-28</created>
- <revision>3.1.0</revision>
+ <created>2019-01-08</created>
+ <revision>3.1.1</revision>
</Version>
</release>
<repository>
diff --git a/rivet/html/release-notes.html b/rivet/html/release-notes.html
index b3cf73c..fa6fea7 100644
--- a/rivet/html/release-notes.html
+++ b/rivet/html/release-notes.html
@@ -16,17 +16,24 @@
<div id="body">
<div id="content">
<h2>Apache Rivet Release Notes</h2>
- <p>Apache Rivet current stable version is 3.1.0</p>
+ <p>Apache Rivet current stable version is 3.1.1</p>
<dl>
- <dt>Rivet 3.1</dt>
+ <dt>Rivet 3.1 release notes</dt>
<dd>
+ <h4>Rivet 3.1.1</h4>
+ <ul>
+ <li>Rivet 3.1.1 attempts to solve various problems with
+ the CMake scripts needed to build mod_rivet on Windows</li>
+ <li>Several broken links in the manual were fixed</li>
+ </ul>
+ <h4>Rivet 3.1.0</h4>
<ul>
<li>Rivet 3.1.0 is a bug fix release of Rivet 3.0.3. The decision of
- releasing a new point release has been suggested by the nature of the fix that,
- even though unlikely, in principle might break existing code developed on
- wrong assumptions about the behavior of commands
- <b>::rivet::var_ps</b>
+ releasing a new point release has been suggested by the nature of the fix that,
+ even though unlikely, in principle might break existing code developed on
+ wrong assumptions about the behavior of commands
+ <b>::rivet::var_ps</b>
and <b>::rivet::var_post</b>
</li>
@@ -36,10 +43,10 @@
<dd>
<h4>Rivet 3.0.3</h4>
<ul>
- <li>Packages in DIO are not assuming anymore the rivet command set has
- been imported into the global namespace</li>
+ <li>Packages in DIO are anymore assuming the rivet command set has been
+ imported into the global namespace</li>
<li>A minor change to ::rivet::xml provides a new form to
- generate self closing elements</li>
+ generate self closing elements</li>
</ul>
<h4>Rivet 3.0.2</h4>
<ul>
diff --git a/rivet/manual3.1/examples.html b/rivet/manual3.1/examples.html
index d7ed1c7..74faa87 100644
--- a/rivet/manual3.1/examples.html
+++ b/rivet/manual3.1/examples.html
@@ -33,13 +33,23 @@
In another simple example, we dynamically generate a table selecting
a different background color for each cell. The font color is determined
through a simple CSS rule embedded in a HTML <style> element. Create
- the file color-table.tcl and put the following code in it
- </p><pre class="programlisting">puts "<html><head>"
-puts "<style>\n td { font-size: 12px; text-align: center; padding-left: 3px; padding-right: 3px}"
-puts " td.bright { color: #eee; }\n td.dark { color: #222; }\n</style>"
-puts "</head><body>"
-puts "<table>"
-
+ the file colortable.rvt and put the following code in it
+ </p><pre class="programlisting"><html><head>
+ <style>
+ td {
+ font-size: 12px;
+ font-family: monospace;
+ text-align: center;
+ padding-left: 3px;
+ padding-right: 3px
+ }
+ td.bright { color: #eee; }
+ td.dark { color: #222; }
+ </style>
+</head>
+<body>
+ <table>
+<?
# we create a 9x9 table selecting a different background for each cell
for {set i 0} { $i < 9 } {incr i} {
@@ -47,24 +57,29 @@
for {set j 0} {$j < 9} {incr j} {
set r [expr int(255 * ($i + $j) / 16)]
- set g [expr int(255 * (8 - $i + $j) / 16)]
- set b [expr int(255 * ($i + 8 - $j) / 16)]
+ set g [expr int(255 * (8 + $j - $i) / 16)]
+ set b [expr int(255 * (abs (4 - $i) + abs(4 - $j)) / 8)]
# determining the background luminosity (YIQ space of NTSC) and choosing
# the foreground color accordingly in order maintain maximum contrast
- if { [expr ($r*0.29894)+($g*0.58704)+($b*0.11402)] > 128.0} {
+ if { [expr ($r*0.29894)+($g*0.58704)+($b*0.11402)] > 148.0} {
set cssclass "dark"
} else {
set cssclass "bright"
}
- puts [format "<td bgcolor=\"%02x%02x%02x\" class=\"%s\">$r $g $b</td>" $r $g $b $cssclass]
+ set cell [format "%3d %3d %3d" $r $g $b]
+
+ puts [format \
+ "<td bgcolor=\"%02x%02x%02x\" class=\"%s\">%s</td>" \
+ $r $g $b $cssclass $cell]
}
puts "</tr>"
}
-puts "</table>"
-puts "</body></html>"
+?>
+ </table>
+</body></html>
</pre><p style="width:90%">
If you read the code, you can see that this is pure Tcl. We
could take the same code, run it outside of Rivet, and it
diff --git a/rivet/manual3.1/exit.html b/rivet/manual3.1/exit.html
index 44746df..757fdb0 100644
--- a/rivet/manual3.1/exit.html
+++ b/rivet/manual3.1/exit.html
@@ -21,7 +21,7 @@
could be the only way to exit a process and force the Apache HTTP web server to start
a fresh one. Moreover the core <span style="font-family:monospace"><span class="command"><strong>exit</strong></span></span> could be called from third parties
software and you may not be aware of it. We thus decided to trap this command and give it
- the most gentle behavior still preserving the its basic purpose.
+ the most gentle behavior still preserving its basic purpose.
</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/note.png"></td><th align="left">Note</th></tr><tr><td align="left" valign="top">
Nonetheless we discourage the programmer to use such command, and suggest to focus on proper
application design and avoid such a drastic way to bail out.
diff --git a/rivet/manual3.1/fb.html b/rivet/manual3.1/fb.html
index cf195b4..9d5eaa4 100644
--- a/rivet/manual3.1/fb.html
+++ b/rivet/manual3.1/fb.html
@@ -1,19 +1,20 @@
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>FormBroker</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.1"><link rel="up" href="formbroker.html" title="The Form Broker"><link rel="prev" href="formbroker.html" title="The Form Broker"><link rel="next" href="help.html" title="Resources - How to Get Help"></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">FormBroker</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="formbroker.html"><img src="images/prev.png" alt="Prev"></a> </td><th width="60%" align="center">The Form Broker</th><td width="20%" align="right"> <a accesskey="n" href="help.html"><img src="images/next.png" alt="Next"></a></td></tr></table></div><div class="refentry"><a name="fb"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>FormBroker —
Form broker object creator
- </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "><span style="font-weight:bold ; font-family:monospace">::FormBroker</span> <span style="font-family:monospace; font-weight: bold;">create</span> ?<span style="font-family:monospace; font-weight: bold;">-quoting quoting_procedure</span>? ?<span style="font-family:monospace; font-weight: bold;">variable1 descriptor</span>? ?<span style="font-family:monospace; font-weight: bold;">variable2 descriptor</span>? ?<span style="font-family:monospace; font-weight: bold;">...</span>?</div></div></div><div class="refsect1"><a name="idm4221"></a><h2>Description</h2><p style="width:90%">
+ </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "><span style="font-weight:bold ; font-family:monospace">::FormBroker</span> <span style="font-family:monospace; font-weight: bold;">create</span> ?<span style="font-family:monospace; font-weight: bold;">-quoting quoting_procedure</span>? ?<span style="font-family:monospace; font-weight: bold;">variable1 descriptor</span>? ?<span style="font-family:monospace; font-weight: bold;">variable2 descriptor</span>? ?<span style="font-family:monospace; font-weight: bold;">...</span>?</div></div></div><div class="refsect1"><a name="idm4223"></a><h2>Description</h2><p style="width:90%">
The command returns a reference to a form broker object by creating
a representation of the form data using the list of variable
- descriptors passed to <span style="font-family:monospace"><span class="command"><strong>create</strong></span></span>. Each descriptor
- is a list of parameter or parameter-value pairs whose order has as only requirement
- to begin with the <span style="font-family:monospace"><span class="command"><strong>{variable_name variable_type}</strong></span></span> pair.
- A formbroker object handles natively integer, unsigned, string, boolean and email data types.
- The programmer can defined new data type and provide in the descriptor a
- reference to a validating procedure for that type.
+ descriptors passed to method <span style="font-family:monospace"><span class="command"><strong>create</strong></span></span>. Each descriptor
+ is a list of parameter or parameter-value pairs that must
+ begin with the <span style="font-family:monospace"><span class="command"><strong>{variable_name variable_type}</strong></span></span> pair as only
+ requirement. A formbroker object provide native support for
+ integer, unsigned integer, string, boolean and email data types.
+ The programmer can defined new data types and provide in the descriptor a
+ reference to a validation procedure for that type.
</p><p style="width:90%">
- The optional ?<span style="font-family:monospace; font-weight: bold;">-quoting quoting_procedure</span>? switch assigns a procedure to
- be called to quote the form response values. The quoting procedure is any
- procedure accepting a single string argument and returning its quoted value. A most
- basic example is the FormBroker default quoting procedure
+ The optional ?<span style="font-family:monospace; font-weight: bold;">-quoting quoting_procedure</span>? switch defines an
+ external procedure to quote or reformat the response values.
+ The quoting procedure is any procedure accepting a single string argument
+ and returning its quoted value. A most basic example is the FormBroker default quoting procedure
</p><pre class="programlisting">proc force_quote {str} {
return "'$str'"
}</pre><p style="width:90%">
@@ -35,7 +36,7 @@
</li></ul></div><p style="width:90%">
An example of a form accepting four variable, one for each native type of a form broker object
</p><pre class="programlisting"> % set fbroker [::FormBroker create {var1 integer} {var2 unsigned} {var3 string} {var4 integer bounds {-10 100}}]
-::FormBroker::form0</pre></div><div class="refsect1"><a name="idm4248"></a><h2>Form broker object methods</h2><p style="width:90%">
+::FormBroker::form0</pre></div><div class="refsect1"><a name="idm4250"></a><h2>Form broker object methods</h2><p style="width:90%">
The central method of a form broker object is <span style="font-family:monospace"><span class="command"><strong>validate</strong></span></span>
</p><div class="variablelist"><dl class="variablelist"><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;"><em class="replaceable"><code>formBroker_object</code></em></span> <span style="font-family:monospace; font-weight: bold;">validate</span> ?<span style="font-family:monospace; font-weight: bold;">-forcequote</span>? <span style="font-family:monospace; font-weight: bold;">response</span> ?<span style="font-family:monospace; font-weight: bold;"><em class="replaceable"><code>response copy</code></em></span>?</div></div><div style="margin-bottom:1.5ex ; padding .5ex">
The method <span style="font-family:monospace"><span class="command"><strong>validate</strong></span></span> takes as argument the name of an array of variables
@@ -194,7 +195,7 @@
a(var2) = 1
a(var4) = 0</pre></div></dd><dt></dt><dd><div style="padding:4 ; margin-top:3 ; margin-bottom:3 ; width:75%"><div class="cmdsynopsis" style="width:80%"><div style="border: 1px solid #282; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "> <span style="font-family:monospace; font-weight: bold;"><em class="replaceable"><code>formBroker_object</code></em></span> <span style="font-family:monospace; font-weight: bold;">reset</span> </div></div><div style="margin-bottom:1.5ex ; padding .5ex">
The method resets the object to its initial defaults
- </div></div></dd></dl></div></div><div class="refsect1"><a name="idm4313"></a><h2>Writing a custom variable validator</h2><p style="width:90%">
+ </div></div></dd></dl></div></div><div class="refsect1"><a name="idm4315"></a><h2>Writing a custom variable validator</h2><p style="width:90%">
The form broker is by no means restricted to work only with its native
data types: you may define your own form variable types and have
them validated with their own variable validator.
diff --git a/rivet/manual3.1/formbroker.html b/rivet/manual3.1/formbroker.html
index 8d0ef90..e411268 100644
--- a/rivet/manual3.1/formbroker.html
+++ b/rivet/manual3.1/formbroker.html
@@ -1,16 +1,18 @@
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>The Form Broker</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.1"><link rel="up" href="index.html" title="Apache Rivet 3.1"><link rel="prev" href="toglyphs.html" title="toGlyphs"><link rel="next" href="fb.html" title="FormBroker"></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">The Form Broker</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="toglyphs.html"><img src="images/prev.png" alt="Prev"></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="fb.html"><img src="images/next.png" alt="Next"></a></td></tr></table></div><div class="section"><div class="titlepage"><div><div><hr><h2 class="title" style="clear: both"><a name="formbroker"></a>The Form Broker</h2></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4198"></a>Introduction</h3></div></div></div><p style="width:90%">
The <span style="font-family:monospace"><span class="command"><strong>FormBroker</strong></span></span> package creates instances of
- objects representing a form data description. These objects offer a
- simple interface of methods meant to validate and control data
- as typically posted through an HTML form,
- thus data represented through the association of form variables
- with their values as returned, for example,
- by the <span style="font-family:monospace"><span class="command"><strong>::rivet::load_response</strong></span></span> command
+ form data description objects. These objects instances have
+ a simple set of methods to validate and control data
+ as typically posted by HTML forms,
+ thus data represented as the map of form variables
+ to their values. In Rivet this association can be obtained either
+ calling <a class="xref" href="load_response.html" title="load_response">load_response</a> or
+ <a class="xref" href="var.html" title="var">var, </a> (form variables can be selectively
+ read also calling <span style="font-family:monospace"><span class="command"><strong>::rivet::var_post</strong></span></span> or
+ <span style="font-family:monospace"><span class="command"><strong>::rivet::var_qs</strong></span></span>)
</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/note.png"></td><th align="left">Note</th></tr><tr><td align="left" valign="top">
The <span style="font-family:monospace"><span class="command"><strong>FormBroker</strong></span></span> package is still experimental.
Basic functionalities and interface are not likely to change but
internal details and implementation could be redesigned
in future releases. More specifically the external validator mechanism
- could be improved with the purpose of shielding the <span style="font-family:monospace"><span class="command"><strong>FormBroker</strong></span></span>
- internals from a data validation procedure.
+ will likely need design improvements.
</td></tr></table></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="toglyphs.html"><img src="images/prev.png" alt="Prev"></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="fb.html"><img src="images/next.png" alt="Next"></a></td></tr><tr><td width="40%" align="left" valign="top">toGlyphs </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a></td><td width="40%" align="right" valign="top"> FormBroker</td></tr></table></div></body></html>
diff --git a/rivet/manual3.1/help.html b/rivet/manual3.1/help.html
index 2d98d9b..ce1384c 100644
--- a/rivet/manual3.1/help.html
+++ b/rivet/manual3.1/help.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Resources - How to Get Help</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.1"><link rel="up" href="index.html" title="Apache Rivet 3.1"><link rel="prev" href="fb.html" title="FormBroker"><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="fb.html"><img src="images/prev.png" alt="Prev"></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="internals.html"><img src="images/next.png" alt="Next"></a></td></tr></table></div><div class="section"><div class="titlepage"><div><div><hr><h2 class="title" style="clear: both"><a name="help"></a>Resources - How to Get Help</h2></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4326"></a>Mailing Lists</h3></div></div></div><p style="width:90%">
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Resources - How to Get Help</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.1"><link rel="up" href="index.html" title="Apache Rivet 3.1"><link rel="prev" href="fb.html" title="FormBroker"><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="fb.html"><img src="images/prev.png" alt="Prev"></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="internals.html"><img src="images/next.png" alt="Next"></a></td></tr></table></div><div class="section"><div class="titlepage"><div><div><hr><h2 class="title" style="clear: both"><a name="help"></a>Resources - How to Get Help</h2></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4328"></a>Mailing Lists</h3></div></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
or you have a question, idea, or comment about the Rivet code itself send email to
@@ -6,7 +6,7 @@
<code class="email"><<a class="email" href="mailto:rivet-dev-subscribe@tcl.apache.org">rivet-dev-subscribe@tcl.apache.org</a>></code>.
</p><p style="width:90%">
The mailing list archives are available at <a class="ulink" href="http://mail-archives.apache.org/mod_mbox/tcl-rivet-dev/" target="_top">http://mail-archives.apache.org/mod_mbox/tcl-rivet-dev/</a>
- </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4333"></a>Newsgroup</h3></div></div></div><p style="width:90%">
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4335"></a>Newsgroup</h3></div></div></div><p style="width:90%">
The <a class="ulink" href="news:comp.lang.tcl" target="_top">news:comp.lang.tcl</a> newsgroup is a good
place to ask about Tcl questions in general. Rivet developers
also follow the newsgroup, but it's best to ask Rivet-specific
@@ -28,14 +28,14 @@
</div></li><li class="listitem"><div style="margin-bottom:1.5ex ; padding .5ex">
<a class="ulink" 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><div><h3 class="title"><a name="idm4353"></a>Bug Tracking System</h3></div></div></div><p style="width:90%">
+ </div></li></ul></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4355"></a>Bug Tracking System</h3></div></div></div><p style="width:90%">
Apache Rivet uses the Apache Bug Tracking system at <a class="ulink" href="http://issues.apache.org/bugzilla/" target="_top">http://issues.apache.org/bugzilla/</a>. Here,
you can report problems, or check and see if existing issues
are already known and being dealt with.
- </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4357"></a>IRC</h3></div></div></div><p style="width:90%">
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4359"></a>IRC</h3></div></div></div><p style="width:90%">
Occasionally, someone from the Rivet team is on IRC at
irc.freenode.net, channel #tcl.
- </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4360"></a>Editing Rivet Template Files</h3></div></div></div><p style="width:90%">
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4362"></a>Editing Rivet Template Files</h3></div></div></div><p style="width:90%">
Rivet makes available code for two popular editors,
<span class="application">emacs</span> and
<span class="application">vim</span> to facilitate the editing of
diff --git a/rivet/manual3.1/images/color-table.png b/rivet/manual3.1/images/color-table.png
index c05a112..f9eaf3d 100644
--- a/rivet/manual3.1/images/color-table.png
+++ b/rivet/manual3.1/images/color-table.png
Binary files differ
diff --git a/rivet/manual3.1/index.html b/rivet/manual3.1/index.html
index 7136030..3933da6 100644
--- a/rivet/manual3.1/index.html
+++ b/rivet/manual3.1/index.html
@@ -1,6 +1,6 @@
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Apache Rivet 3.1</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.1"><link rel="next" href="installation.html" title="Apache Rivet 3.1 Installation"></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">Apache Rivet 3.1</th></tr><tr><td width="20%" align="left"> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="installation.html"><img src="images/next.png" alt="Next"></a></td></tr></table></div><div class="article"><div class="titlepage"><div><div><h2 class="title"><a name="idm1"></a>Apache Rivet 3.1</h2></div><div><div class="author"><h3 class="author"><span class="firstname">The Rivet Team</span></h3><div class="affiliation"><span class="orgname">The Apache Software Foundation<br></span><div class="address"><p><br>
<code class="email"><<a class="email" href="mailto:rivet-dev@tcl.apache.org">rivet-dev@tcl.apache.org</a>></code><br>
- </p></div></div></div></div><div><p class="copyright">Copyright © 2002-2018 Apache Software Foundation</p></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="section"><a href="index.html#introduction">Introduction to Apache Rivet version 3.1</a></span></dt><dt><span class="section"><a href="installation.html">Apache Rivet 3.1 Installation</a></span></dt><dt><span class="section"><a href="cmake.html">Building Rivet 3.1 with CMake</a></span></dt><dd><dl><dt><span class="section"><a href="cmake.html#idm185">CMake build procedure and examples</a></span></dt></dl></dd><dt><span class="section"><a href="directives.html">Apache Rivet 3.1 Configuration</a></span></dt><dd><dl><dt><span class="section"><a href="directives.html#idm200">Apache Rivet Configuration lines</a></span></dt><dt><span class="section"><a href="directives.html#idm212">Configuration Directives</a></span></dt></dl></dd><dt><span class="section"><a href="processing.html">Apache Rivet HTTP Request Processing</a></span></dt><dd><dl><dt><span class="section"><a href="processing.html#idm574">Tcl Scripts Processing</a></span></dt><dt><span class="section"><a href="processing.html#idm583">Example: basic OO Rivet Application</a></span></dt></dl></dd><dt><span class="section"><a href="request.html">Apache Child Processes Lifecycle and Request Processing</a></span></dt><dt><span class="section"><a href="commands.html">Rivet Tcl Commands and Variables</a></span></dt><dd><dl><dt><span class="section"><a href="commands.html#idm726"></a></span></dt><dt><span class="refentrytitle"><a href="shorthand.html"><?= ... ?></a></span><span class="refpurpose"> —
+ </p></div></div></div></div><div><p class="copyright">Copyright © 2002-2019 Apache Software Foundation</p></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="section"><a href="index.html#introduction">Introduction to Apache Rivet version 3.1</a></span></dt><dt><span class="section"><a href="installation.html">Apache Rivet 3.1 Installation</a></span></dt><dt><span class="section"><a href="cmake.html">Building Rivet 3.1 with CMake</a></span></dt><dd><dl><dt><span class="section"><a href="cmake.html#idm185">CMake build procedure and examples</a></span></dt></dl></dd><dt><span class="section"><a href="directives.html">Apache Rivet 3.1 Configuration</a></span></dt><dd><dl><dt><span class="section"><a href="directives.html#idm200">Apache Rivet Configuration lines</a></span></dt><dt><span class="section"><a href="directives.html#idm212">Configuration Directives</a></span></dt></dl></dd><dt><span class="section"><a href="processing.html">Apache Rivet HTTP Request Processing</a></span></dt><dd><dl><dt><span class="section"><a href="processing.html#idm574">Tcl Scripts Processing</a></span></dt><dt><span class="section"><a href="processing.html#idm583">Example: basic OO Rivet Application</a></span></dt></dl></dd><dt><span class="section"><a href="request.html">Apache Child Processes Lifecycle and Request Processing</a></span></dt><dt><span class="section"><a href="commands.html">Rivet Tcl Commands and Variables</a></span></dt><dd><dl><dt><span class="section"><a href="commands.html#idm726"></a></span></dt><dt><span class="refentrytitle"><a href="shorthand.html"><?= ... ?></a></span><span class="refpurpose"> —
Shorthand construct for single strings output
</span></dt><dt><span class="refentrytitle"><a href="abort_code.html">abort_code</a></span><span class="refpurpose"> —
Returns the code passed to <span style="font-family:monospace"><span class="command"><strong>abort_page</strong></span></span>
@@ -38,8 +38,8 @@
print large ASCII glyphs
</span></dt><dt><span class="section"><a href="asciiglyphs.html#idm4193">Example</a></span></dt></dl></dd><dt><span class="section"><a href="formbroker.html">The Form Broker</a></span></dt><dd><dl><dt><span class="section"><a href="formbroker.html#idm4198">Introduction</a></span></dt><dt><span class="refentrytitle"><a href="fb.html">FormBroker</a></span><span class="refpurpose"> —
Form broker object creator
- </span></dt></dl></dd><dt><span class="section"><a href="help.html">Resources - How to Get Help</a></span></dt><dd><dl><dt><span class="section"><a href="help.html#idm4326">Mailing Lists</a></span></dt><dt><span class="section"><a href="help.html#idm4333">Newsgroup</a></span></dt><dt><span class="section"><a href="help.html#websites">Web Sites</a></span></dt><dt><span class="section"><a href="help.html#idm4353">Bug Tracking System</a></span></dt><dt><span class="section"><a href="help.html#idm4357">IRC</a></span></dt><dt><span class="section"><a href="help.html#idm4360">Editing Rivet Template Files</a></span></dt></dl></dd><dt><span class="section"><a href="internals.html">Rivet Internals</a></span></dt><dd><dl><dt><span class="section"><a href="internals.html#idm4372">Rivet approach to Apache Multiprocessing Models</a></span></dt><dt><span class="section"><a href="internals.html#idm4385">mod_rivet MPM Bridge callbacks</a></span></dt><dt><span class="section"><a href="internals.html#idm4419">Server Initialization and MPM Bridge</a></span></dt><dt><span class="section"><a href="internals.html#idm4422">RivetChan</a></span></dt><dt><span class="section"><a href="internals.html#idm4427">The <span style="font-family:monospace"><span class="command"><strong>global</strong></span></span> Command</a></span></dt><dt><span class="section"><a href="internals.html#idm4435">Page Parsing, Execution and Caching</a></span></dt><dt><span class="section"><a href="internals.html#idm4443">Extending Rivet by developing C code procedures</a></span></dt><dt><span class="section"><a href="internals.html#idm4467">Debugging Rivet and Apache</a></span></dt></dl></dd><dt><span class="section"><a href="lazybridge.html">Example: the <span class="quote">“<span class="quote">Lazy</span>”</span> bridge</a></span></dt><dd><dl><dt><span class="section"><a href="lazybridge.html#idm4497">The rationale of threaded bridges</a></span></dt><dt><span class="section"><a href="lazybridge.html#idm4501">Lazy bridge data structures</a></span></dt><dt><span class="section"><a href="lazybridge.html#idm4517">Handling Tcl's exit core command</a></span></dt><dt><span class="section"><a href="lazybridge.html#idm4536">HTTP request processing with the lazy bridge</a></span></dt></dl></dd></dl></div><div class="list-of-examples"><p><b>List of Examples</b></p><dl><dt>1. <a href="examples.html#hello_world">Hello World</a></dt><dt>2. <a href="examples.html#idm1941">Generate a Colorful Table</a></dt><dt>3. <a href="examples.html#variable_access">Variable Access</a></dt><dt>4. <a href="examples.html#file_upload">File Upload</a></dt><dt>5. <a href="examples.html#file_download">File Download</a></dt><dt>6. <a href="examples.html#ajax_xml_messaging">XML Messages and Ajax</a></dt><dt>7. <a href="examples.html#calendar_example">A Calendar Utility</a></dt></dl></div><p style="width:90%">
- This manual is released as part of Apache/Rivet 3.1.0 (Saturday 2018-11-24 11:24:35+01:00).
+ </span></dt></dl></dd><dt><span class="section"><a href="help.html">Resources - How to Get Help</a></span></dt><dd><dl><dt><span class="section"><a href="help.html#idm4328">Mailing Lists</a></span></dt><dt><span class="section"><a href="help.html#idm4335">Newsgroup</a></span></dt><dt><span class="section"><a href="help.html#websites">Web Sites</a></span></dt><dt><span class="section"><a href="help.html#idm4355">Bug Tracking System</a></span></dt><dt><span class="section"><a href="help.html#idm4359">IRC</a></span></dt><dt><span class="section"><a href="help.html#idm4362">Editing Rivet Template Files</a></span></dt></dl></dd><dt><span class="section"><a href="internals.html">Rivet Internals</a></span></dt><dd><dl><dt><span class="section"><a href="internals.html#idm4374">Rivet approach to Apache Multiprocessing Models</a></span></dt><dt><span class="section"><a href="internals.html#idm4387">mod_rivet MPM Bridge callbacks</a></span></dt><dt><span class="section"><a href="internals.html#idm4421">Server Initialization and MPM Bridge</a></span></dt><dt><span class="section"><a href="internals.html#idm4424">RivetChan</a></span></dt><dt><span class="section"><a href="internals.html#idm4429">The <span style="font-family:monospace"><span class="command"><strong>global</strong></span></span> Command</a></span></dt><dt><span class="section"><a href="internals.html#idm4437">Page Parsing, Execution and Caching</a></span></dt><dt><span class="section"><a href="internals.html#idm4445">Extending Rivet by developing C code procedures</a></span></dt><dt><span class="section"><a href="internals.html#idm4469">Debugging Rivet and Apache</a></span></dt></dl></dd><dt><span class="section"><a href="lazybridge.html">Example: the <span class="quote">“<span class="quote">Lazy</span>”</span> bridge</a></span></dt><dd><dl><dt><span class="section"><a href="lazybridge.html#idm4499">The rationale of threaded bridges</a></span></dt><dt><span class="section"><a href="lazybridge.html#idm4503">Lazy bridge data structures</a></span></dt><dt><span class="section"><a href="lazybridge.html#idm4519">Handling Tcl's exit core command</a></span></dt><dt><span class="section"><a href="lazybridge.html#idm4538">HTTP request processing with the lazy bridge</a></span></dt></dl></dd></dl></div><div class="list-of-examples"><p><b>List of Examples</b></p><dl><dt>1. <a href="examples.html#hello_world">Hello World</a></dt><dt>2. <a href="examples.html#idm1941">Generate a Colorful Table</a></dt><dt>3. <a href="examples.html#variable_access">Variable Access</a></dt><dt>4. <a href="examples.html#file_upload">File Upload</a></dt><dt>5. <a href="examples.html#file_download">File Download</a></dt><dt>6. <a href="examples.html#ajax_xml_messaging">XML Messages and Ajax</a></dt><dt>7. <a href="examples.html#calendar_example">A Calendar Utility</a></dt></dl></div><p style="width:90%">
+ This manual is released as part of Apache/Rivet 3.1.1 (Saturday 2019-01-05 19:13:52+01:00).
</p><div class="section"><div class="titlepage"><div><div><hr><h2 class="title" style="clear: both"><a name="introduction"></a>Introduction to Apache Rivet version 3.1</h2></div></div></div><p style="width:90%">
Apache Rivet is a system for creating dynamic web content by
integrating the
@@ -56,26 +56,27 @@
giving you ideas on how to best take advantage of Rivet's
architecture to create different styles of web site.
</p><p style="width:90%">
- This documentation is focused on the current version of Rivet, but
- still 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!
+ This documentation is focused on the current version of Rivet, but
+ still 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!
</p><div class="simplesect"><div class="titlepage"><div><div><h3 class="title"><a name="idm21"></a>Apache MPM and Rivet Bridge Modules</h3></div></div></div><p style="width:90%">
- Rivet 3.1 is a major rewriting of mod_rivet, the Apache HTTP
- Websever module at the core of Rivet. Unlike in previous versions of
- mod_rivet which only supported the <a class="ulink" href="" target="_top">prefork MPM</a>
- (<a class="ulink" href="" target="_top">Multiprocessing Module</a>),
- starting with 3.0 we attained full support of different MPM for
- the Apache framework.
+ Rivet 3.1 is a successor to Rivet 3.0, a major rewriting of mod_rivet,
+ the Apache HTTP Websever module at the core of Rivet. Unlike in 2.x of
+ mod_rivet, which only supported the
+ <a class="ulink" href="https://httpd.apache.org/docs/2.4/mod/prefork.html" target="_top">prefork MPM</a>
+ (<a class="ulink" href="https://httpd.apache.org/docs/2.4/mpm.html" target="_top">Multiprocessing Module</a>),
+ starting with 3.0 we attained full support of different MPM for
+ the Apache framework.
</p><p style="width:90%">
- Threaded <a class="ulink" href="" target="_top">MPM</a>
+ Threaded <a class="ulink" href="https://httpd.apache.org/docs/2.4/mpm.html" target="_top">MPM</a>
integration was achieved by making mod_rivet multithreaded and
modular itself, introducing the MPM-module bridge concept.
- We developed a set of loadable modules
- which are supposed not only to overcome the issues related to threading but also
- to offer the best possible MPM mod_rivet integration.
+ We developed a set of loadable modules which are supposed not only to overcome
+ the issues related to threading but also to offer the best possible MPM mod_rivet
+ integration.
As a side effect of this modular design mod_rivet is not only able to integrate
with its environment but also to work as a framework for writing more MPM bridges
designed along different multi-threading schemes and workload management models.
@@ -99,7 +100,7 @@
entirely based on Tcl. By default rivet 3.1 provides compatiblity with the
version 2.x scheme to handle a request but this can be entirely overridden by
the developer replacing the central request handling procedure. See the
- <a class="link" href="request.html" title="Apache Child Processes Lifecycle and Request Processing">request processing</a> page for further reading
+ <a class="link" href="request.html" title="Apache Child Processes Lifecycle and Request Processing">request processing</a> page.
</p></div><div class="simplesect"><div class="titlepage"><div><div><h3 class="title"><a name="idm44"></a>Acknowledgements</h3></div></div></div><p style="width:90%">This version of Rivet received substantial contributions from George Petasis who solved
several problems with the threaded code, improved the code in several ways and made the CMake
based build scripts</p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="installation.html"><img src="images/next.png" alt="Next"></a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"> </td><td width="40%" align="right" valign="top"> Apache Rivet 3.1 Installation</td></tr></table></div></body></html>
diff --git a/rivet/manual3.1/installation.html b/rivet/manual3.1/installation.html
index 7abc0d5..5541f49 100644
--- a/rivet/manual3.1/installation.html
+++ b/rivet/manual3.1/installation.html
@@ -7,7 +7,7 @@
are already available for download.
</p><p style="width:90%">
Rivet 2.x was restricted to work with the
- <a class="ulink" href="http://httpd.apache.org/docs/2.4/mod/prefork.html" target="_top">prefork</a> MPM
+ <a class="ulink" href="https://httpd.apache.org/docs/2.4/mod/prefork.html" target="_top">prefork</a> MPM
of the Apache HTTP webserver. MPM modules are fundamental components of the
webserver architecture. They provide multiple implementations of multiprocessing
in order to better suit specific OS features and scalability requirements.
@@ -17,13 +17,13 @@
system call. This model has several limitations but also some advantages. The
solution we adopted tries to attain the best from any MPM as much as possible
and Rivet 3.1 is now able to run with the
- <a class="ulink" href="http://httpd.apache.org/docs/2.4/mod/worker.html" target="_top">worker</a>
+ <a class="ulink" href="https://httpd.apache.org/docs/2.4/mod/worker.html" target="_top">worker</a>
and the
- <a class="ulink" href="http://httpd.apache.org/docs/2.4/mod/event.html" target="_top">event</a>
+ <a class="ulink" href="https://httpd.apache.org/docs/2.4/mod/event.html" target="_top">event</a>
MPMs. Rivet 3.1 has not been ported to OS of the Windows family
but we feel that the current design would fit just fine with the Windows specific
MPMs such as
- <a class="ulink" href="http://httpd.apache.org/docs/2.4/mod/mpm_winnt.html" target="_top">winnt</a>.
+ <a class="ulink" href="https://httpd.apache.org/docs/2.4/mod/mpm_winnt.html" target="_top">winnt</a>.
</p><p style="width:90%">
If you need to build Apache Rivet yourself this is the procedure to follow
</p><ol class="procedure" type="1"><li class="step"><p class="title"><b>Building Tcl: requirements</b></p><p style="width:90%">
@@ -45,7 +45,7 @@
to build mod_rivet
</p><p style="width:90%">
The
- <a class="ulink" href="http://httpd.apache.org/" target="_top">Apache HTTP Webserver</a> development
+ <a class="ulink" href="http://httpd.apache.org" target="_top">Apache HTTP Webserver</a> development
files and libraries are required along with the
<a class="ulink" href="http://apr.apache.org/" target="_top">Apache Portable Runtime</a>
and the
@@ -67,8 +67,8 @@
We will assume that you have Apache installed at this point.
You must uncompress the Rivet sources in the directory where you
wish to compile them.
- </p><pre class="programlisting">gunzip rivet-3.1.0.tar.gz
-tar -xvf rivet-3.1.0.tar.gz</pre><p style="width:90%">
+ </p><pre class="programlisting">gunzip rivet-3.1.1.tar.gz
+tar -xvf rivet-3.1.1.tar.gz</pre><p style="width:90%">
</p></li><li class="step"><p class="title"><b>Building Rivet</b></p><ol type="a" class="substeps"><li class="step"><p style="width:90%">
Rivet uses the standard <span style="font-family:monospace"><span class="command"><strong>./configure ; make ; make install</strong></span></span>
sequence which installs to their target directories the Apache module, the binary libraries and the
diff --git a/rivet/manual3.1/internals.html b/rivet/manual3.1/internals.html
index 8f8fb3d..3e09e99 100644
--- a/rivet/manual3.1/internals.html
+++ b/rivet/manual3.1/internals.html
@@ -5,7 +5,7 @@
themselves, the Subversion revision control system
(<span style="font-family:monospace"><span class="command"><strong>svn</strong></span></span>) can provide you with information about
what has been happening with the code.
- </p><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4372"></a>Rivet approach to Apache Multiprocessing Models</h3></div></div></div><p style="width:90%">
+ </p><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4374"></a>Rivet approach to Apache Multiprocessing Models</h3></div></div></div><p style="width:90%">
The Apache HTTP web server has an extremely modular architecture
that made it very popular among web developers. Most of the server
features can be implemented in external modules, including some of
@@ -30,15 +30,15 @@
loadable modules that are responsible to adapt the module procedural design to
a given class of Apache MPMs. This design is open to the development of more
MPM bridges coping with different multi-processing models but also to the development of
- different approaches to resource consumption and workload balance. By now we have 3 bridges:
+ different approaches to resource consumption and workload balance. Currently we have 3 bridges:
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">rivet_prefork_mpm.c: a bridge for the prefork MPM</li><li class="listitem">rivet_worker_mpm.c: a threaded bridge creating a pool of threads
each running Tcl interpreters and communicating with the worker MPM threads
through a thread safe queue. This bridge is needed by the worker MPM.</li><li class="listitem">rivet_lazy_mpm.c: a threaded bridge where Tcl threads are
started <span class="quote">“<span class="quote">on demand</span>”</span>. The bridge creates no threads and Tcl interpreters
at start up and only when requests come in Tcl execution threads are created.
This bridge is explained in detail in the <a class="xref" href="lazybridge.html" title="Example: the “Lazy” bridge">the section called “Example: the <span class="quote">“<span class="quote">Lazy</span>”</span> bridge”</a>.
- Since the resource demand at startup is minimal this bridge should suite
- development machines that go through frequent web server restarts.</li></ul></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4385"></a>mod_rivet MPM Bridge callbacks</h3></div></div></div><p style="width:90%">
+ Since the resource demand at startup is minimal this bridge should suit
+ development machines that go through frequent web server restarts.</li></ul></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4387"></a>mod_rivet MPM Bridge callbacks</h3></div></div></div><p style="width:90%">
A bridge is a loadable library implementing different ways to handle
specific features needed to mod_rivet. It was originally meant as a way
to handle the prefork/worker/event MPM specificities that prevented mod_rivet
@@ -66,9 +66,9 @@
child process initialization. If the pointer is assigned with
a non-NULL value the function is called by Rivet_ChildInit.
</li><li class="listitem"><span class="emphasis"><em>mpm_request</em></span>: This pointer must
- be assigned with a valid function pointer to the content generator
+ be a valid function pointer to the content generator
implemented by the bridge. If the pointer is not defined the Apache
- web server will stop during start up. This condition is motivated by
+ web server will stop at start up. This condition is motivated by
the need of avoiding useless testing of the pointer. The fundamental
purpose of a content generator module (like mod_rivet) is to respond
to requests creating content, thus whatever it is
@@ -79,7 +79,7 @@
passed by the web server and then it calls some method to communicate
these data to the Tcl execution thread waiting for result to be
returned. The <span class="quote">“<span class="quote">prefork</span>”</span> bridge is an exception since there
- are no multiple threads and the bridge calls directly Rivet_SendContent
+ are no threads and the bridge calls directly Rivet_SendContent
</li><li class="listitem"><span class="emphasis"><em>mpm_finalize</em></span>: pointer to a finalization
function called during a child process exit. This function is registered
as child process memory pool cleanup function. If the pointer is NULL
@@ -118,8 +118,8 @@
status. So this macro (and associated function) should hide from the module core function
the specific approach followed in a particular bridge
</li></ul></div><p style="width:90%">
- </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4419"></a>Server Initialization and MPM Bridge</h3></div></div></div><p style="width:90%">
- </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4422"></a>RivetChan</h3></div></div></div><p style="width:90%">
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4421"></a>Server Initialization and MPM Bridge</h3></div></div></div><p style="width:90%">
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4424"></a>RivetChan</h3></div></div></div><p style="width:90%">
The <span class="structname">RivetChan</span> system was created in
order to have an actual Tcl channel that we could redirect
standard output to. This enables us use, for instance, the
@@ -129,7 +129,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><div><h3 class="title"><a name="idm4427"></a>The <span style="font-family:monospace"><span class="command"><strong>global</strong></span></span> Command</h3></div></div></div><p style="width:90%">
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4429"></a>The <span style="font-family:monospace"><span class="command"><strong>global</strong></span></span> Command</h3></div></div></div><p style="width:90%">
Rivet aims to run standard Tcl code with as few surprises as
possible. At times this involves some compromises - in this
case regarding the <span style="font-family:monospace"><span class="command"><strong>global</strong></span></span> command. The
@@ -144,7 +144,7 @@
you really need a true global variable, use either
<span style="font-family:monospace"><span class="command"><strong>::global</strong></span></span> or add the :: namespace qualifier
to variables you wish to make global.
- </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4435"></a>Page Parsing, Execution and Caching</h3></div></div></div><p style="width:90%">
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4437"></a>Page Parsing, Execution and Caching</h3></div></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
@@ -170,7 +170,7 @@
without having to reload it (and re-parse it) from the disk.
The number of scripts stored in memory is configurable. This
feature can significantly improve performance.
- </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4443"></a>Extending Rivet by developing C code procedures</h3></div></div></div><p style="width:90%">
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4445"></a>Extending Rivet by developing C code procedures</h3></div></div></div><p style="width:90%">
Rivet endows the Tcl interpreter with new commands
serving as interface between the application layer and the
Apache web server. Many of these commands
@@ -245,7 +245,7 @@
mycmd->1</pre>
The value associated to the test must be 0 in case the
command doesn't need to test the <span style="font-family:monospace"><span class="command"><strong>private->r</strong></span></span> pointer.
- </li></ul></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4467"></a>Debugging Rivet and Apache</h3></div></div></div><p style="width:90%">
+ </li></ul></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4469"></a>Debugging Rivet and Apache</h3></div></div></div><p style="width:90%">
If you are interested in hacking on Rivet, you're welcome to
contribute! Invariably, when working with code, things go
wrong, and it's necessary to do some debugging. In a server
diff --git a/rivet/manual3.1/lazybridge.html b/rivet/manual3.1/lazybridge.html
index 7a1c179..85ca1e8 100644
--- a/rivet/manual3.1/lazybridge.html
+++ b/rivet/manual3.1/lazybridge.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Example: the “Lazy” bridge</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.1"><link rel="up" href="index.html" title="Apache Rivet 3.1"><link rel="prev" 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">Example: the <span class="quote">“<span class="quote">Lazy</span>”</span> bridge</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="internals.html"><img src="images/prev.png" alt="Prev"></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> </td></tr></table></div><div class="section"><div class="titlepage"><div><div><hr><h2 class="title" style="clear: both"><a name="lazybridge"></a>Example: the <span class="quote">“<span class="quote">Lazy</span>”</span> bridge</h2></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4497"></a>The rationale of threaded bridges</h3></div></div></div><p style="width:90%">
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Example: the “Lazy” bridge</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Apache Rivet 3.1"><link rel="up" href="index.html" title="Apache Rivet 3.1"><link rel="prev" 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">Example: the <span class="quote">“<span class="quote">Lazy</span>”</span> bridge</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="internals.html"><img src="images/prev.png" alt="Prev"></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> </td></tr></table></div><div class="section"><div class="titlepage"><div><div><hr><h2 class="title" style="clear: both"><a name="lazybridge"></a>Example: the <span class="quote">“<span class="quote">Lazy</span>”</span> bridge</h2></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4499"></a>The rationale of threaded bridges</h3></div></div></div><p style="width:90%">
The 'bridge' concept was introduced to cope with the ability of
the Apache HTTP web server to adopt different multiprocessing
models by loading one of the available MPMs (Multi Processing Modules).
@@ -19,7 +19,7 @@
This demands a Tcl interpreters be run
on separated threads communicating with the HTTP web server
through suitable methods.
- </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4501"></a>Lazy bridge data structures</h3></div></div></div><p style="width:90%">
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4503"></a>Lazy bridge data structures</h3></div></div></div><p style="width:90%">
The lazy bridge was initially developed to outline the basic tasks
carried out by each function making a rivet MPM bridge.
The lazy bridge attempts to be minimalist
@@ -132,7 +132,7 @@
module_globals->mpm->vhosts[vh].threads_count = 0;
}
module_globals->mpm->server_shutdown = 0;
-}</pre></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4517"></a>Handling Tcl's exit core command</h3></div></div></div><p style="width:90%">
+}</pre></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4519"></a>Handling Tcl's exit core command</h3></div></div></div><p style="width:90%">
Most of the fields in the <span style="font-family:monospace"><span class="command"><strong>mpm_bridge_status</strong></span></span> are meant to deal
with the child exit process. Rivet supersedes the Tcl core's exit function
with a <span style="font-family:monospace"><span class="command"><strong>::rivet::exit</strong></span></span> function and it does so in order to curb the effects
@@ -164,7 +164,7 @@
when the web server shuts down.
See these functions' code for further details, they are very easy to
read and understand
- </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4536"></a>HTTP request processing with the lazy bridge</h3></div></div></div><p style="width:90%">
+ </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm4538"></a>HTTP request processing with the lazy bridge</h3></div></div></div><p style="width:90%">
Requests processing with the lazy bridge is done by determining for which
virtual host a request was created. The <span style="font-family:monospace"><span class="command"><strong>rivet_server_conf</strong></span></span>
structure keeps a numerical index for each virtual host. This index is used
diff --git a/rivet/manual3.1/processing.html b/rivet/manual3.1/processing.html
index 1a2f235..aa55b61 100644
--- a/rivet/manual3.1/processing.html
+++ b/rivet/manual3.1/processing.html
@@ -93,8 +93,7 @@
and any code interruption brought about by calling
<span style="font-family:monospace"><span class="command"><strong>::rivet::abort_page</strong></span></span>.
The current procedure might work as a template to be
- reworked and used as a template to develop your own
- request handler.
+ reworked into your own request handler.
</td></tr></table></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="idm583"></a>Example: basic OO Rivet Application</h3></div></div></div><p style="width:90%">
An applications may have no interest in running
a script pointed by the URL as in the traditional approach
diff --git a/rivet/picts/color-table.png b/rivet/picts/color-table.png
index a9cea8f..f9eaf3d 100644
--- a/rivet/picts/color-table.png
+++ b/rivet/picts/color-table.png
Binary files differ
