You are viewing a plain text version of this content. The canonical link for it is here.
Posted to rivet-dev@tcl.apache.org by da...@apache.org on 2003/08/26 16:27:42 UTC
cvs commit: tcl-rivet/doc/html help.html.en index.html.en internals.html.en tcl_packages.html.en upgrading.html.en
davidw 2003/08/26 07:27:42
Modified: . ChangeLog STATUS
doc rivet.xml
doc/html help.html.en index.html.en internals.html.en
tcl_packages.html.en upgrading.html.en
Log:
* doc/rivet.xml: Added section to documentation about emacs and vim
modesl for Rivet files.
Revision Changes Path
1.137 +3 -0 tcl-rivet/ChangeLog
Index: ChangeLog
===================================================================
RCS file: /home/cvs/tcl-rivet/ChangeLog,v
retrieving revision 1.136
retrieving revision 1.137
diff -u -r1.136 -r1.137
--- ChangeLog 26 Aug 2003 10:34:32 -0000 1.136
+++ ChangeLog 26 Aug 2003 14:27:41 -0000 1.137
@@ -1,5 +1,8 @@
2003-08-26 David N. Welton <da...@dedasys.com>
+ * doc/rivet.xml: Added section to documentation about emacs and
+ vim modesl for Rivet files.
+
* src/configure.in.tcl: -with-apxs option no longer takes a
default. It should work that out on its own using the
findapxs.tcl script.
1.14 +3 -1 tcl-rivet/STATUS
Index: STATUS
===================================================================
RCS file: /home/cvs/tcl-rivet/STATUS,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -r1.13 -r1.14
--- STATUS 26 Aug 2003 13:19:46 -0000 1.13
+++ STATUS 26 Aug 2003 14:27:41 -0000 1.14
@@ -22,6 +22,8 @@
*) Documentation
+ Italian and Russian translations need updating.
+
*) Installation
Platform Tcl Version Ok?
1.30 +20 -4 tcl-rivet/doc/rivet.xml
Index: rivet.xml
===================================================================
RCS file: /home/cvs/tcl-rivet/doc/rivet.xml,v
retrieving revision 1.29
retrieving revision 1.30
diff -u -r1.29 -r1.30
--- rivet.xml 22 Aug 2003 09:42:27 -0000 1.29
+++ rivet.xml 26 Aug 2003 14:27:41 -0000 1.30
@@ -1107,8 +1107,8 @@
<section id="tcl_packages">
<title>Rivet Tcl Packages</title>
<para>
-In addition to the core Apache module, Rivet provides a number of Tcl
-packages that include potentially useful code.
+ In addition to the core Apache module, Rivet provides a number
+ of Tcl packages that include potentially useful code.
</para>
<itemizedlist>
@@ -1228,6 +1228,22 @@
irc.freenode.net, channel #tcl.
</para>
</section>
+
+ <section>
+ <title>Editing Rivet Template Files</title>
+ <para>
+ Rivet makes available code for two popular editors,
+ <command>emacs</command> and <command>vim</command> to
+ facilitate the editing of Rivet template files. The key
+ concept is that the editor is aware of the <? and ?>
+ tags and switches back and forth between Tcl and HTML modes as
+ the cursor moves. These files,
+ <filename>two-mode-mode.el</filename> and
+ <filename>rvt.vim</filename> are available in the
+ <filename>contrib/</filename> directory.
+ </para>
+ </section>
+
</section>
1.8 +10 -0 tcl-rivet/doc/html/help.html.en
Index: help.html.en
===================================================================
RCS file: /home/cvs/tcl-rivet/doc/html/help.html.en,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- help.html.en 22 Aug 2003 09:42:27 -0000 1.7
+++ help.html.en 26 Aug 2003 14:27:42 -0000 1.8
@@ -38,4 +38,14 @@
</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id5397017"></a>IRC</h3></div></div><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" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id5396013"></a>Editing Rivet Template Files</h3></div></div><div></div></div><p style="width:90%">
+ Rivet makes available code for two popular editors,
+ <span style="font-family:monospace"><b class="command">emacs</b></span> and <span style="font-family:monospace"><b class="command">vim</b></span> to
+ facilitate the editing of Rivet template files. The key
+ concept is that the editor is aware of the <? and ?>
+ tags and switches back and forth between Tcl and HTML modes as
+ the cursor moves. These files,
+ <tt class="filename">two-mode-mode.el</tt> and
+ <tt class="filename">rvt.vim</tt> are available in the
+ <tt class="filename">contrib/</tt> directory.
</p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="tcl_packages.html.en"><img src="images/prev.png" alt="Prev"></a>�</td><td width="20%" align="center"><a accesskey="u" href="index.html.en"><img src="images/up.png" alt="Up"></a></td><td width="40%" align="right">�<a accesskey="n" href="internals.html.en"><img src="images/next.png" alt="Next"></a></td></tr><tr><td width="40%" align="left" valign="top">Rivet Tcl Packages�</td><td width="20%" align="center"><a accesskey="h" href="index.html.en"><img src="images/home.png" alt="Home"></a></td><td width="40%" align="right" valign="top">�Rivet Internals</td></tr></table></div></body></html>
1.10 +2 -2 tcl-rivet/doc/html/index.html.en
Index: index.html.en
===================================================================
RCS file: /home/cvs/tcl-rivet/doc/html/index.html.en,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- index.html.en 22 Aug 2003 09:42:27 -0000 1.9
+++ index.html.en 26 Aug 2003 14:27:42 -0000 1.10
@@ -2,7 +2,7 @@
��<tt class="email"><<a href="mailto:davidw@apache.org">davidw@apache.org</a>></tt><br>
</p></div></div></div></div><div><div class="author"><h3 class="author"><span class="firstname">Damon</span> <span class="surname">Courtney</span></h3><div class="affiliation"><div class="address"><p><br>
��<tt class="email"><<a href="mailto:damonc@apache.org">damonc@apache.org</a>></tt><br>
- </p></div></div></div></div><div><p class="copyright">Copyright � 2002, 2003 Apache Software Foundation</p></div></div><div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><a href="index.html.en#id5393752">Introduction to Apache Rivet</a></dt><dt><a href="installation.html.en">Apache Rivet Installation</a></dt><dt><a href="directives.html.en">Rivet Apache Directives</a></dt><dt><a href="commands.html.en">Rivet Tcl Commands and Variables</a></dt><dt><a href="examples.html.en">Examples and Usage</a></dt><dt><a href="tcl_packages.html.en">Rivet Tcl Packages</a></dt><dt><a href="help.html.en">Resources - How to Get Help</a></dt><dd><dl><dt><a href="help.html.en#id5396846">Mailing Lists</a></dt><dt><a href="help.html.en#id5396893">Newsgroup</a></dt><dt><a href="help.html.en#websites">Web Sites</a></dt><dt><a href="help.html.en#id5396996">Bug Tracking System</a></dt><dt><a href="help.html.en#id5397017">IRC</a></dt></dl></dd><dt><a href="internals.html.en">Rivet Internals</a></dt><dd><dl><dt><a href="internals.html.en#id5396036">Initialization</a></dt><dt><a href="internals.html.en#id5396073">RivetChan</a></dt><dt><a href="internals.html.en#id5396102">Page Parsing, Execution and Caching</a></dt></dl></dd><dt><a href="upgrading.html.en">Upgrading from mod_dtcl or NeoWebScript</a></dt><dd><dl><dt><a href="upgrading.html.en#id5396185">mod_dtcl</a></dt><dt><a href="upgrading.html.en#id5396201">NeoWebScript</a></dt></dl></dd></dl></div><p style="width:90%">
+ </p></div></div></div></div><div><p class="copyright">Copyright � 2002, 2003 Apache Software Foundation</p></div></div><div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><a href="index.html.en#id5393752">Introduction to Apache Rivet</a></dt><dt><a href="installation.html.en">Apache Rivet Installation</a></dt><dt><a href="directives.html.en">Rivet Apache Directives</a></dt><dt><a href="commands.html.en">Rivet Tcl Commands and Variables</a></dt><dt><a href="examples.html.en">Examples and Usage</a></dt><dt><a href="tcl_packages.html.en">Rivet Tcl Packages</a></dt><dt><a href="help.html.en">Resources - How to Get Help</a></dt><dd><dl><dt><a href="help.html.en#id5396846">Mailing Lists</a></dt><dt><a href="help.html.en#id5396893">Newsgroup</a></dt><dt><a href="help.html.en#websites">Web Sites</a></dt><dt><a href="help.html.en#id5396996">Bug Tracking System</a></dt><dt><a href="help.html.en#id5397017">IRC</a></dt><dt><a href="help.html.en#id5396013">Editing Rivet Template Files</a></dt></dl></dd><dt><a href="internals.html.en">Rivet Internals</a></dt><dd><dl><dt><a href="internals.html.en#id5396075">Initialization</a></dt><dt><a href="internals.html.en#id5396112">RivetChan</a></dt><dt><a href="internals.html.en#id5396140">Page Parsing, Execution and Caching</a></dt></dl></dd><dt><a href="upgrading.html.en">Upgrading from mod_dtcl or NeoWebScript</a></dt><dd><dl><dt><a href="upgrading.html.en#id5396217">mod_dtcl</a></dt><dt><a href="upgrading.html.en#id5396233">NeoWebScript</a></dt></dl></dd></dl></div><p style="width:90%">
This document is also available in the following languages: <a href="index.html.it" target="_top">Italian</a>, <a href="index.html.ru" target="_top">Russian</a>
</p><p style="width:90%">
Document reversion: $Revision$, last modified $Date$ by $Author$.
1.8 +3 -3 tcl-rivet/doc/html/internals.html.en
Index: internals.html.en
===================================================================
RCS file: /home/cvs/tcl-rivet/doc/html/internals.html.en,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- internals.html.en 22 Aug 2003 09:42:27 -0000 1.7
+++ internals.html.en 26 Aug 2003 14:27:42 -0000 1.8
@@ -4,7 +4,7 @@
is the source code itself. If you are interested in the changes
themselves, <span style="font-family:monospace"><b class="command">cvs</b></span> can provide you with
information about what has been happening with the code.
- </p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id5396036"></a>Initialization</h3></div></div><div></div></div><p style="width:90%">
+ </p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id5396075"></a>Initialization</h3></div></div><div></div></div><p style="width:90%">
When Apache is started, (or when child Apache processes are
started if a threaded Tcl is used),
<tt class="function">Rivet_InitTclStuff</tt> is called, which
@@ -15,7 +15,7 @@
executes Rivet's <tt class="filename">init.tcl</tt>. The caching
system is also set up, and if there is a
<span style="font-family:monospace"><b class="command">GlobalInitScript</b></span>, it is run.
- </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id5396073"></a>RivetChan</h3></div></div><div></div></div><p style="width:90%">
+ </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id5396112"></a>RivetChan</h3></div></div><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 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" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id5396102"></a>Page Parsing, Execution and Caching</h3></div></div><div></div></div><p style="width:90%">
+ </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id5396140"></a>Page Parsing, Execution and Caching</h3></div></div><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
1.4 +2 -2 tcl-rivet/doc/html/tcl_packages.html.en
Index: tcl_packages.html.en
===================================================================
RCS file: /home/cvs/tcl-rivet/doc/html/tcl_packages.html.en,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- tcl_packages.html.en 22 Aug 2003 09:42:27 -0000 1.3
+++ tcl_packages.html.en 26 Aug 2003 14:27:42 -0000 1.4
@@ -1,6 +1,6 @@
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Rivet Tcl Packages</title><link rel="stylesheet" href="rivet.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.60.1"><link rel="home" href="index.html.en" title="Apache Rivet"><link rel="up" href="index.html.en" title="Apache Rivet"><link rel="previous" href="examples.html.en" title="Examples and Usage"><link rel="next" href="help.html.en" 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">Rivet Tcl Packages</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="examples.html.en"><img src="images/prev.png" alt="Prev"></a>�</td><th width="60%" align="center">�</th><td width="20%" align="right">�<a accesskey="n" href="help.html.en"><img src="images/next.png" alt="Next"></a></td></tr></table></div><div class="section" lang="en"><div class="titlepage"><div><div><hr><h2 class="title" style="clear: both"><a name="tcl_packages"></a>Rivet Tcl Packages</h2></div></div><div></div></div><p style="width:90%">
-In addition to the core Apache module, Rivet provides a number of Tcl
-packages that include potentially useful code.
+ In addition to the core Apache module, Rivet provides a number
+ of Tcl packages that include potentially useful code.
</p><div class="itemizedlist"><ul type="disc"><li><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">commserver is a package providing a server that can be
used for IPC. Still experimental. Requires the comm package
from tcllib.</div></li><li><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">dio is a database abstraction layer.</div></li><li><div style=" margin:1ex ; margin-bottom:1.5ex ; padding .5ex">dtcl is a compatibility package for mod_dtcl
1.8 +2 -2 tcl-rivet/doc/html/upgrading.html.en
Index: upgrading.html.en
===================================================================
RCS file: /home/cvs/tcl-rivet/doc/html/upgrading.html.en,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- upgrading.html.en 22 Aug 2003 09:42:27 -0000 1.7
+++ upgrading.html.en 26 Aug 2003 14:27:42 -0000 1.8
@@ -5,8 +5,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" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id5396185"></a>mod_dtcl</h3></div></div><div></div></div><p style="width:90%">
+ </p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id5396217"></a>mod_dtcl</h3></div></div><div></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" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id5396201"></a>NeoWebScript</h3></div></div><div></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.en"><img src="images/prev.png" alt="Prev"></a>�</td><td width="20%" align="center"><a accesskey="u" href="index.html.en"><img src="images/up.png" alt="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.en"><img src="images/home.png" alt="Home"></a></td><td width="40%" align="right" valign="top">�</td></tr></table></div></body></html>
+ </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id5396233"></a>NeoWebScript</h3></div></div><div></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.en"><img src="images/prev.png" alt="Prev"></a>�</td><td width="20%" align="center"><a accesskey="u" href="index.html.en"><img src="images/up.png" alt="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.en"><img src="images/home.png" alt="Home"></a></td><td width="40%" align="right" valign="top">�</td></tr></table></div></body></html>
---------------------------------------------------------------------
To unsubscribe, e-mail: rivet-cvs-unsubscribe@tcl.apache.org
For additional commands, e-mail: rivet-cvs-help@tcl.apache.org