Return-Path: 
 <websh-cvs-return-162-apmail-tcl-websh-cvs-archive=tcl.apache.org@tcl.apache.org>
Delivered-To: apmail-tcl-websh-cvs-archive@tcl.apache.org
Received: (qmail 50448 invoked by uid 500); 8 Apr 2002 19:55:07 -0000
Mailing-List: contact websh-cvs-help@tcl.apache.org; run by ezmlm
Precedence: bulk
X-No-Archive: yes
List-Post: <mailto:websh-cvs@tcl.apache.org>
List-Help: <mailto:websh-cvs-help@tcl.apache.org>
List-Unsubscribe: <mailto:websh-cvs-unsubscribe@tcl.apache.org>
List-Subscribe: <mailto:websh-cvs-subscribe@tcl.apache.org>
Delivered-To: mailing list websh-cvs@tcl.apache.org
Received: (qmail 50435 invoked from network); 8 Apr 2002 19:55:07 -0000
Date: 8 Apr 2002 19:55:07 -0000
Message-ID: <20020408195507.6906.qmail@icarus.apache.org>
From: davidw@apache.org
To: tcl-websh-cvs@apache.org
Subject: cvs commit: tcl-websh/doc quickref.xml
X-Spam-Rating: daedalus.apache.org 1.6.2 0/1000/N

davidw      02/04/08 12:55:06

  Modified:    doc      quickref.xml
  Log:
  Commence work on improving the documentation language and style.
  
  Revision  Changes    Path
  1.32      +27 -24    tcl-websh/doc/quickref.xml
  
  Index: quickref.xml
  ===================================================================
  RCS file: /home/cvs/tcl-websh/doc/quickref.xml,v
  retrieving revision 1.31
  retrieving revision 1.32
  diff -u -r1.31 -r1.32
  --- quickref.xml	5 Apr 2002 09:23:21 -0000	1.31
  +++ quickref.xml	8 Apr 2002 19:55:06 -0000	1.32
  @@ -1,7 +1,7 @@
   <?xml version="1.0" encoding="iso-8859-1"?>
   
   <!--
  -$Id: quickref.xml,v 1.31 2002/04/05 09:23:21 ronnie Exp $
  +$Id: quickref.xml,v 1.32 2002/04/08 19:55:06 davidw Exp $
   -->
   
   <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
  @@ -12,7 +12,7 @@
     <title>Webshell Reference</title>
     <articleinfo>
       <releaseinfo>
  -      $Id: quickref.xml,v 1.31 2002/04/05 09:23:21 ronnie Exp $
  +      $Id: quickref.xml,v 1.32 2002/04/08 19:55:06 davidw Exp $
       </releaseinfo>
     </articleinfo>
     <section id="intro">
  @@ -38,14 +38,14 @@
   	takes &quot;-o2&quot; as the first argument.
         </para>
         <para>
  -	Instead of the normal Tcl behaviour, WebSH configuration
  +	Instead of the normal Tcl behaviour, Webshell configuration
   	commands normally return the previous value, when a new value
   	is set.
         </para>
         <para>
   	In addition to the examples given here you might find <ulink
   	  url="http://websh.com/examples.html">http://websh.com/examples.html</ulink>
  -	  a usefull source of information.
  +	  a useful source of information.
         </para>
       </section>
       <section id="about">
  @@ -53,14 +53,14 @@
         <para>
   	The original version of this document can always be found at
   	<ulink
  -	url="http://tcl.apache.org/websh/">http://tcl.apache.org/websh</ulink>.
  +	url="http://tcl.apache.org/websh/">http://tcl.apache.org/websh/</ulink>.
         </para>
         <note>
   	<para>
   	  We try to keep this quick reference up-to-date and hope that
   	  it will be useful. We do not guarantee that it is suitable
   	  for any particular purpose whatsoever. The authors accept no
  -	  liability in respect to this information or its use.
  +	  liability with regards to this information or its use.
   	</para>
         </note>
       </section>
  @@ -96,8 +96,8 @@
   	  <term><option>cmdparam</option> <optional><option>name</option></optional></term>
   	  <listitem>
   	    <para>
  -	      Name of the parameter to store reference to a web::command command
  -	      in the URL. Default: &quot;cmd&quot;.
  +	      Name of the <command>web::command</command> parameter
  +	      name in the URL. Default: &quot;cmd&quot;.
   	    </para>
   	  </listitem>
   	</varlistentry>
  @@ -105,8 +105,8 @@
   	  <term><option>timeparam</option> <optional><option>name</option></optional></term>
   	  <listitem>
   	    <para>
  -	      Name of the parameter to store reference to the timestamp
  -	      in the URL. Default: &quot;t&quot;.
  +	      Name of the timestamp parameter in the URL. Default:
  +	      &quot;t&quot;.
   	    </para>
   	  </listitem>
   	</varlistentry>
  @@ -114,7 +114,8 @@
   	  <term><option>logsubst</option> <optional><option>boolean</option></optional></term>
   	  <listitem>
   	    <para>
  -	      Turns substitution of log messages on or off. Default: on.
  +	      Turns substitution of log messages on or off. Default:
  +	      off.
   	    </para>
   	  </listitem>
   	</varlistentry>
  @@ -122,10 +123,11 @@
   	  <term><option>putxmarkup</option> <optional><option>brace|tag</option></optional></term>
   	  <listitem>
   	    <para>
  -	      Sets the markup characters for sections to be eval'd in web::putx
  -	      and web::putxfile commands to either curly braces ({ ... }) or
  -	      special tags (&lt;% ... %&gt;). Please note that when using the tags &lt;%%&gt;,
  -	      they cannot be nested. Default: brace.
  +	      Sets the markup characters for sections to be eval'd in
  +	      web::putx and web::putxfile commands to either curly
  +	      braces ({ ... }) or special tags (&lt;?
  +	      ... ?&gt;). Please note that when using the tags &lt;?
  +	      ?&gt;, they cannot be nested. Default: brace.
   	    </para>
   	  </listitem>
   	</varlistentry>
  @@ -133,7 +135,7 @@
   	  <term><option>version</option></term>
   	  <listitem>
   	    <para>
  -	      Returns the version info string
  +	      Returns the version info string.
   	    </para>
   	  </listitem>
   	</varlistentry>
  @@ -141,7 +143,7 @@
   	  <term><option>copyright</option></term>
   	  <listitem>
   	    <para>
  -	      Returns a copyright message string
  +	      Returns a copyright message string.
   	    </para>
   	  </listitem>
   	</varlistentry>
  @@ -149,8 +151,8 @@
   	  <term><option>encryptchain</option> <option>list</option></term>
   	  <listitem>
   	    <para>
  -	      defines which commands should be tried, in sequence, to encrypt
  -	      a message. Default: &quot;web::encryptd&quot;
  +	      defines which commands should be tried, in sequence, to
  +	      encrypt a message. Default: &quot;web::encryptd&quot;.
   	    </para>
   	  </listitem>
   	</varlistentry>
  @@ -158,8 +160,8 @@
   	  <term><option>decryptchain</option> <option>list</option></term>
   	  <listitem>
   	    <para>
  -	      defines which commands should be tried, in sequence, to decrypt
  -	      a message. Default: &quot;web::decryptd&quot;
  +	      defines which commands should be tried, in sequence, to
  +	      decrypt a message. Default: &quot;web::decryptd&quot;.
   	    </para>
   	  </listitem>
   	</varlistentry>
  @@ -183,9 +185,10 @@
       <title>Command dispatching and session management</title>
       <para>
         Webshell provides a command dispatching mechanism to produce,
  -      for example, different HTML pages within one application. The
  -      name of the command to be used is encoded in the querystring
  -      (see <command>web::cmdurl</command> for details on
  +      for example, different HTML pages within one "application",
  +      which is most likely one file on the file system. The name of
  +      the command to be used for a particular page is encoded in the
  +      querystring (see <command>web::cmdurl</command> for details on
         how to produce such querystrings).  Command dispatching is
         initiated with the command <command>web::dispatch</command>.
         Commands are defined with <command>web::command</command>.
  
  
  

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