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 mx...@apache.org on 2017/06/07 08:47:10 UTC

svn commit: r1797897 - in /tcl/rivet/trunk: ChangeLog doc/Makefile.am doc/rivet.xml doc/xml-2/ doc/xml-2/request.xml doc/xml/ doc/xml/intro.xml

Author: mxmanghi
Date: Wed Jun  7 08:47:10 2017
New Revision: 1797897

URL: http://svn.apache.org/viewvc?rev=1797897&view=rev
Log:
    * doc/xml-2/: XML manual moved to xml-2 to make rewriting easier


Added:
    tcl/rivet/trunk/doc/xml/
    tcl/rivet/trunk/doc/xml-2/
      - copied from r1797896, tcl/rivet/trunk/doc/xml/
    tcl/rivet/trunk/doc/xml/intro.xml
Modified:
    tcl/rivet/trunk/ChangeLog
    tcl/rivet/trunk/doc/Makefile.am
    tcl/rivet/trunk/doc/rivet.xml
    tcl/rivet/trunk/doc/xml-2/request.xml

Modified: tcl/rivet/trunk/ChangeLog
URL: http://svn.apache.org/viewvc/tcl/rivet/trunk/ChangeLog?rev=1797897&r1=1797896&r2=1797897&view=diff
==============================================================================
--- tcl/rivet/trunk/ChangeLog (original)
+++ tcl/rivet/trunk/ChangeLog Wed Jun  7 08:47:10 2017
@@ -1,3 +1,7 @@
+2017-06-07 Massimo Manghi <mx...@apache.org>
+    * doc/xml-2/: XML manual moved to xml-2 to make
+    rewriting easier
+
 2017-05-15 Massimo Manghi <mx...@apache.org>
     * src/mod_rivet_ng/rivet_prefork_mpm.c: server root 
     interpreter needs to re-seed the random number generator

Modified: tcl/rivet/trunk/doc/Makefile.am
URL: http://svn.apache.org/viewvc/tcl/rivet/trunk/doc/Makefile.am?rev=1797897&r1=1797896&r2=1797897&view=diff
==============================================================================
--- tcl/rivet/trunk/doc/Makefile.am (original)
+++ tcl/rivet/trunk/doc/Makefile.am Wed Jun  7 08:47:10 2017
@@ -25,14 +25,14 @@ EXAMPLES_SGML:=$(wildcard examples-sgml/
 EXAMPLES:=$(wildcard examples/*.*)
 
 # English, multiple files.
-$(buildir)/html/index.html: $(srcdir)/rivet.xml $(srcdir)/rivet-chunk.xsl $(srcdir)/rivet.xsl $(srcdir)/xml/*.xml
+$(buildir)/html/index.html: $(srcdir)/rivet.xml $(srcdir)/rivet-chunk.xsl $(srcdir)/rivet.xsl $(srcdir)/xml-2/*.xml
 	xsltproc --stringparam html.stylesheet rivet.css \
 	--stringparam html.ext ".html" \
 	--stringparam chunker.output.encoding UTF-8  \
 	--nonet -o $(builddir)/html/ $(srcdir)/rivet-chunk.xsl $(srcdir)/rivet.xml
 
 # English, one big file.
-$(buildir)/html/rivet.html: $(srcdir)/rivet.xml $(srcdir)/rivet-nochunk.xsl $(srcdir)/rivet.xsl $(srcdir)/xml/*.xml
+$(buildir)/html/rivet.html: $(srcdir)/rivet.xml $(srcdir)/rivet-nochunk.xsl $(srcdir)/rivet.xsl $(srcdir)/xml-2/*.xml
 	xsltproc --stringparam html.stylesheet rivet.css \
 	--stringparam html.ext ".html" \
 	--stringparam chunker.output.encoding UTF-8  \

Modified: tcl/rivet/trunk/doc/rivet.xml
URL: http://svn.apache.org/viewvc/tcl/rivet/trunk/doc/rivet.xml?rev=1797897&r1=1797896&r2=1797897&view=diff
==============================================================================
--- tcl/rivet/trunk/doc/rivet.xml (original)
+++ tcl/rivet/trunk/doc/rivet.xml Wed Jun  7 08:47:10 2017
@@ -12,24 +12,27 @@
     <!ENTITY download.tcl	        SYSTEM	"examples-sgml/download.tcl" >
     <!ENTITY rivet_web_service.tcl SYSTEM "examples-sgml/rivet_web_service.tcl" >
     <!ENTITY intro.xml		        SYSTEM "xml/intro.xml" >
-    <!ENTITY install.xml	        SYSTEM "xml/install.xml" >
-    <!ENTITY directives.xml	     SYSTEM "xml/directives.xml" >
-    <!ENTITY commands.xml          SYSTEM "xml/commands.xml" >
-    <!ENTITY examples.xml          SYSTEM "xml/examples.xml" >
-    <!ENTITY packages.xml          SYSTEM "xml/packages.xml" >
-    <!ENTITY dio.xml               SYSTEM "xml/dio.xml" >
-    <!ENTITY diodisplay.xml        SYSTEM "xml/diodisplay.xml" >
-    <!ENTITY session.xml           SYSTEM "xml/session.xml" >
-    <!ENTITY form.xml              SYSTEM "xml/form.xml" >
-    <!ENTITY calendar.xml          SYSTEM "xml/calendar.xml" >
-    <!ENTITY help.xml              SYSTEM "xml/help.xml" >
-    <!ENTITY internals.xml         SYSTEM "xml/internals.xml" >
-    <!ENTITY upgrade.xml           SYSTEM "xml/upgrade.xml" >
-    <!ENTITY request.xml           SYSTEM "xml/request.xml" >
-    <!ENTITY entities.xml          SYSTEM "xml/entities.xml" >
-    <!ENTITY asciiglyphs.xml		  SYSTEM "xml/asciiglyphs.xml" >
-    <!ENTITY lazybridge.xml		  SYSTEM "xml/lazybridge.xml" >
-    <!ENTITY formbroker.xml        SYSTEM "xml/formbroker.xml" >
+    <!ENTITY install.xml	        SYSTEM "xml-2/install.xml" >
+    <!ENTITY directives.xml	     SYSTEM "xml-2/directives.xml" >
+    <!ENTITY commands.xml          SYSTEM "xml-2/commands.xml" >
+    <!ENTITY examples.xml          SYSTEM "xml-2/examples.xml" >
+    <!ENTITY packages.xml          SYSTEM "xml-2/packages.xml" >
+    <!ENTITY dio.xml               SYSTEM "xml-2/dio.xml" >
+    <!ENTITY diodisplay.xml        SYSTEM "xml-2/diodisplay.xml" >
+    <!ENTITY session.xml           SYSTEM "xml-2/session.xml" >
+    <!ENTITY form.xml              SYSTEM "xml-2/form.xml" >
+    <!ENTITY calendar.xml          SYSTEM "xml-2/calendar.xml" >
+    <!ENTITY help.xml              SYSTEM "xml-2/help.xml" >
+    <!ENTITY internals.xml         SYSTEM "xml-2/internals.xml" >
+    <!ENTITY upgrade.xml           SYSTEM "xml-2/upgrade.xml" >
+    <!ENTITY request.xml           SYSTEM "xml-2/request.xml" >
+    <!ENTITY entities.xml          SYSTEM "xml-2/entities.xml" >
+    <!ENTITY asciiglyphs.xml		  SYSTEM "xml-2/asciiglyphs.xml" >
+    <!ENTITY lazybridge.xml		  SYSTEM "xml-2/lazybridge.xml" >
+    <!ENTITY formbroker.xml        SYSTEM "xml-2/formbroker.xml" >
+    <!ENTITY version	"3.0" >
+    <!ENTITY fullversion "3.0.0" >
+
 ]>
 
 <!--
@@ -54,21 +57,7 @@
   <articleinfo>
     <title>Apache Rivet</title>
     <copyright>
-        <year>2002</year>
-        <year>2003</year>
-        <year>2004</year>
-        <year>2005</year>
-        <year>2006</year>
-        <year>2007</year>
-        <year>2008</year>
-        <year>2009</year>
-        <year>2010</year>
-        <year>2011</year>
-        <year>2012</year>
-        <year>2013</year>
-        <year>2014</year>
-        <year>2015</year>
-        <year>2016</year>
+        <year>2002-2017</year>
         <holder>Apache Software Foundation</holder>
     </copyright>
     <author>

Modified: tcl/rivet/trunk/doc/xml-2/request.xml
URL: http://svn.apache.org/viewvc/tcl/rivet/trunk/doc/xml-2/request.xml?rev=1797897&r1=1797896&r2=1797897&view=diff
==============================================================================
--- tcl/rivet/trunk/doc/xml-2/request.xml (original)
+++ tcl/rivet/trunk/doc/xml-2/request.xml Wed Jun  7 08:47:10 2017
@@ -136,13 +136,13 @@
 	<simplesect>
     	<title>Apache Rivet Error and Exception Scripts Directives</title>
         <para>
-            Rivet is highly configurable and each of the webserver lifecycle stages 
-            can be exploited to control a web application. 
-            Not only the orderly sequence of stages
-            in a child lifecycle can be controlled with Tcl scripts, but also
-            Tcl error or abnormal conditions taking place during
-            the execution can be caught and handled with specific scripts.
-        </para>
+         Rivet is highly configurable and each of the webserver lifecycle stages 
+         can be exploited to control a web application. 
+         Not only the orderly sequence of stages
+         in a child lifecycle can be controlled with Tcl scripts, but also
+         Tcl error or abnormal conditions taking place during
+         the execution can be caught and handled with specific scripts.
+       </para>
 	    <para>
 	    	Tcl errors (conditions generated when a command exits with code TCL_ERROR) 
 	    	usually result in the printing of a backtrace of the code fragment
@@ -218,7 +218,6 @@
 				<tr class="processing"><td>AfterEveryScript</td><td>::</td></tr>
 				<tr class="childexit"><td>Child Termination</td><td>ChildExitScript</td><td>::</td></tr>
 				<tr class="processing"><td>Error Handling</td><td>ErrorScript</td><td>::</td></tr>
-
 			</tbody>
 		</table>
 	</simplesect>

Added: tcl/rivet/trunk/doc/xml/intro.xml
URL: http://svn.apache.org/viewvc/tcl/rivet/trunk/doc/xml/intro.xml?rev=1797897&view=auto
==============================================================================
--- tcl/rivet/trunk/doc/xml/intro.xml (added)
+++ tcl/rivet/trunk/doc/xml/intro.xml Wed Jun  7 08:47:10 2017
@@ -0,0 +1,74 @@
+<section id="introduction">
+    <title>Introduction to Apache Rivet version &version;</title>
+    <para>
+      Apache Rivet is a system for creating dynamic web content by
+      integrating the 
+		<ulink url="http://www.tcl.tk/">Tcl programming language</ulink> within the 
+      <ulink url="http://httpd.apache.org">Apache Web Server</ulink>.
+      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).
+    </para>
+    <para>
+      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.
+    </para>
+    <para>
+        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!
+    </para>
+    
+    <simplesect>
+        <title>Introduction</title>
+        <para>
+	        	Rivet &version; ships with a major rewriting of mod_rivet, the Apache HTTP
+	        	Websever module at the core of Rivet. With this version of the module
+	        	we attained full support of different MPM (Multiprocessing Modules) for
+	        	the Apache framework, whereas previous version of mod_rivet only supported
+	        	the prefork MPM.
+        </para>
+        <para>
+        		Threaded <ulink href="https://httpd.apache.org/docs/2.4/mpm.html">MPM</ulink>
+        		integration was achieved by making mod_rivet multithreaded and
+        		modular itself, introducing the concept of MPM bridges, a set of loadable modules 
+        		responsible to offer the running MPM the best possible integration with 
+        		mod_rivet. As a side effect of this design we now have a the whole module 
+        		is now not only able to integrate
+        		with its environment but also to work as a platform for writing more MPM bridges
+        		designed following different multi-threading schemes and workload management. 
+        		See the <link linkend="internals">internals</link> section of this manual for
+        		further reading.
+        </para>
+    </simplesect>
+    <simplesect>
+    	<title>Request Processing</title>
+    	<para>
+    			Request processing was performed in mod_rivet by chaining together 3 scripts
+    	</para>
+    	<itemizedlist>
+    		 	<listitem>BeforeScript, if defined in the configuration</listitem>
+ 				<listitem>The URI referenced Tcl script or rvt template (using the defaults defined in the
+ 				Apache webserver configuration)</listitem>
+ 				<listitem>AfterScript, if defined in the configuration</listitem> 
+		</itemizedlist>
+		<para>
+			Errors and exceptions (raised by the <link linkend="abort_page">::rivet::abort_page</link> command)
+			are handled by the ErrorScript and AbortScript (ErrorScript has a default implementation
+			if undefined in the configuration)
+		</para>
+		
+		<para>
+			Rivet &version; supports a new <link linkend="request">request processing scheme</link> 
+			entirely based on Tcl. By default this scheme emulates the historic way to handle a request
+			but developers are encouraged to think up their own way to request handling.
+		</para>
+    </simplesect>
+</section>



---------------------------------------------------------------------
To unsubscribe, e-mail: site-cvs-unsubscribe@tcl.apache.org
For additional commands, e-mail: site-cvs-help@tcl.apache.org