This is an automated email from the ASF dual-hosted git repository.
mxmanghi pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/tcl-rivet.git
commit 8df5cd3732f549df96c80d6964f3bcb9e07d749b
Author: Massimo Manghi <mxman...@apache.org>
AuthorDate: Thu Nov 29 19:00:54 2018 +0100
manual corrections
---
doc/rivet.xml | 2 +-
doc/xml/formbroker.xml | 39 +++++++++++++++++++++------------------
doc/xml/intro.xml | 20 ++++++++++----------
3 files changed, 32 insertions(+), 29 deletions(-)
diff --git a/doc/rivet.xml b/doc/rivet.xml
index b1c39eb..4d8cf4d 100644
--- a/doc/rivet.xml
+++ b/doc/rivet.xml
@@ -75,7 +75,7 @@
<articleinfo>
<title>Apache Rivet &version;</title>
<copyright>
- <year>2002-2018</year>
+ <year>2002-<?dbtimestamp format="Y" ?></year>
<holder>Apache Software Foundation</holder>
</copyright>
<author>
diff --git a/doc/xml/formbroker.xml b/doc/xml/formbroker.xml
index e00a772..3160f2b 100644
--- a/doc/xml/formbroker.xml
+++ b/doc/xml/formbroker.xml
@@ -4,20 +4,22 @@
<title>Introduction</title>
<para>
The <command>FormBroker</command> 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 <command>::rivet::load_response</command> 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 <xref linkend="load_response">::rivet::load_response</xref> or
+ <xref linkend="var">::rivet::var</xref> (form variables can be
selectively
+ read also calling <command>::rivet::var_post</command> or
+ <command>::rivet::var_qs</command>)
</para>
<note>
The <command>FormBroker</command> 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
<command>FormBroker</command>
- internals from a data validation procedure.
+ will likely need design improvements.
</note>
<!-- programlisting>
@@ -45,18 +47,19 @@
<para>
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 <command>create</command>. Each descriptor
- is a list of parameter or parameter-value pairs whose order has
as only requirement
- to begin with the <command>{variable_name
variable_type}</command> 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 <command>create</command>. Each
descriptor
+ is a list of parameter or parameter-value pairs that must
+ begin with the <command>{variable_name variable_type}</command>
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.
</para>
<para>
- The optional <arg>-quoting quoting_procedure</arg> 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 <arg>-quoting quoting_procedure</arg> 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
</para>
<programlisting>proc force_quote {str} {
return "'$str'"
diff --git a/doc/xml/intro.xml b/doc/xml/intro.xml
index ea4409b..447c144 100644
--- a/doc/xml/intro.xml
+++ b/doc/xml/intro.xml
@@ -30,20 +30,20 @@
<!-- title>Introduction</title -->
<title>Apache MPM and Rivet Bridge Modules</title>
<para>
- Rivet &version; 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 <ulink
href="&apachedoc-prefork;">prefork MPM</ulink>
- (<ulink href="&apachedoc-mpm;">Multiprocessing
Module</ulink>),
- starting with &version30; we attained full support of
different MPM for
- the Apache framework.
+ Rivet &version; is a successor to Rivet
&version30;, a major rewriting of mod_rivet,
+ the Apache HTTP Websever module at the core of
Rivet. Unlike in &version2-generic; of
+ mod_rivet, which only supported the <ulink
href="&apachedoc-prefork;">prefork MPM</ulink>
+ (<ulink href="&apachedoc-mpm;">Multiprocessing
Module</ulink>),
+ starting with &version30; we attained full
support of different MPM for
+ the Apache framework.
</para>
<para>
Threaded <ulink href="&apachedoc-mpm;">MPM</ulink>
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.
@@ -79,7 +79,7 @@
entirely based on Tcl. By default rivet &version;
provides compatiblity with the
version &version2-generic; scheme to handle a request
but this can be entirely overridden by
the developer replacing the central request handling
procedure. See the
- <link linkend="request">request processing</link> page
for further reading
+ <link linkend="request">request processing</link> page.
</para>
</simplesect>
<simplesect>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@tcl.apache.org
For additional commands, e-mail: commits-h...@tcl.apache.org
