svn commit: r936778 - in /httpd/httpd/trunk/docs/manual/mod: index.html.en mod_lua.html.en mod_lua.xml

[rb...@apache.org]

Author: rbowen
Date: Thu Apr 22 11:05:30 2010
New Revision: 936778

URL: http://svn.apache.org/viewvc?rev=936778&view=rev
Log:
Add basic almost-useful usage information.

Modified:
    httpd/httpd/trunk/docs/manual/mod/index.html.en
    httpd/httpd/trunk/docs/manual/mod/mod_lua.html.en
    httpd/httpd/trunk/docs/manual/mod/mod_lua.xml

Modified: httpd/httpd/trunk/docs/manual/mod/index.html.en
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/mod/index.html.en?rev=936778&r1=936777&r2=936778&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/mod/index.html.en (original)
+++ httpd/httpd/trunk/docs/manual/mod/index.html.en Thu Apr 22 11:05:30 2010
@@ -145,7 +145,8 @@ by other LDAP modules</dd>
 <dt><a href="mod_log_config.html">mod_log_config</a></dt><dd>Logging of the requests made to the server</dd>
 <dt><a href="mod_log_forensic.html">mod_log_forensic</a></dt><dd>Forensic Logging of the requests made to the server</dd>
 <dt><a href="mod_logio.html">mod_logio</a></dt><dd>Logging of input and output bytes per request</dd>
-<dt><a href="mod_lua.html">mod_lua</a></dt><dd>Provides Lua hooks to do cool stuff</dd>
+<dt><a href="mod_lua.html">mod_lua</a></dt><dd>Provides Lua hooks into various portions of the httpd
+request processing</dd>
 <dt><a href="mod_mime.html" id="M" name="M">mod_mime</a></dt><dd>Associates the requested filename's extensions
     with the file's behavior (handlers and filters)
     and content (mime-type, language, character set and

Modified: httpd/httpd/trunk/docs/manual/mod/mod_lua.html.en
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/mod/mod_lua.html.en?rev=936778&r1=936777&r2=936778&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/mod/mod_lua.html.en (original)
+++ httpd/httpd/trunk/docs/manual/mod/mod_lua.html.en Thu Apr 22 11:05:30 2010
@@ -23,7 +23,8 @@
 <div class="toplang">
 <p><span>Available Languages: </span><a href="../en/mod/mod_lua.html" title="English">&nbsp;en&nbsp;</a></p>
 </div>
-<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Provides Lua hooks to do cool stuff</td></tr>
+<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Provides Lua hooks into various portions of the httpd
+request processing</td></tr>
 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>lua_module</td></tr>
 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_lua.c</td></tr>
@@ -32,10 +33,6 @@
 
 <p>Someone needs to write this.</p>
 
-<div class="example"><h3>Example</h3><p><code>
-# Examples are always helpful.<br />
-</code></p></div>
-
 </div>
 <div id="quickview"><h3 class="directives">Directives</h3>
 <ul id="toc">
@@ -57,27 +54,31 @@
 </ul>
 <h3>Topics</h3>
 <ul id="topics">
-<li><img alt="" src="../images/down.gif" /> <a href="#moredocs">Additional Documentation</a></li>
-</ul><h3>See also</h3>
-<ul class="seealso">
-<li><a href="...">Useful document</a></li>
-<li><code class="directive"><a href="../mod/mod_useful.html#useful">Useful</a></code></li>
-<li><code class="module"><a href="../mod/mod_useful.html">mod_useful</a></code></li>
+<li><img alt="" src="../images/down.gif" /> <a href="#basicconf">Basic Configuration</a></li>
 </ul></div>
 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 <div class="section">
-<h2><a name="moredocs" id="moredocs">Additional Documentation</a></h2>
+<h2><a name="basicconf" id="basicconf">Basic Configuration</a></h2>
 
-<p>More detailed information about the module in general (as opposed to
-the individual directives) can follow in sections containing titles.</p>
+The basic module loading directive is
 
-<p>The <code>id</code> attribute will be translated into a hypertext
-anchor target.</p>
+<div class="example"><p><code>
+    LoadModule apreq_module modules/mod_apreq2.so<br />
+    LoadModule wombat_module modules/mod_wombat.so
+</code></p></div>
 
-<p>References to directives should use the directive tag: <code class="directive"><a href="#templatedirective">TemplateDirective</a></code>.  References to
-modules should use the module tag
-<code class="module"><a href="../mod/mod_lua.xml.html">mod_lua.xml</a></code>.</p>
+<p>
+<code>mod_lua</code> provides a handler named <code>lua-script</code>,
+which can be used with an <code>AddHandler</code> directive:</p>
+
+<div class="example"><p><code>
+AddHandler lua-script .lua
+</code></p></div>
 
+<p>
+This will cause any <code>.lua</code> file to be evaluated by
+<code>mod_lua</code>.
+</p>
 </div>
 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 <div class="directive-section"><h2><a name="" id="" /> <a name="" id="">Directive</a></h2>

Modified: httpd/httpd/trunk/docs/manual/mod/mod_lua.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/mod/mod_lua.xml?rev=936778&r1=936777&r2=936778&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/mod/mod_lua.xml (original)
+++ httpd/httpd/trunk/docs/manual/mod/mod_lua.xml Thu Apr 22 11:05:30 2010
@@ -24,7 +24,8 @@
 
 <name>mod_lua</name>
 
-<description>Provides Lua hooks to do cool stuff</description>
+<description>Provides Lua hooks into various portions of the httpd
+request processing</description>
 <status>experimental</status>
 <sourcefile>mod_lua.c</sourcefile>
 <identifier>lua_module</identifier>
@@ -33,31 +34,29 @@
 <summary>
 <p>Someone needs to write this.</p>
 
-<example><title>Example</title>
-# Examples are always helpful.<br />
+</summary>
+
+<section id="basicconf"><title>Basic Configuration</title>
+
+The basic module loading directive is
+
+<example>
+    LoadModule apreq_module modules/mod_apreq2.so<br />
+    LoadModule wombat_module modules/mod_wombat.so
 </example>
 
-</summary>
+<p>
+<code>mod_lua</code> provides a handler named <code>lua-script</code>,
+which can be used with an <code>AddHandler</code> directive:</p>
 
-<!-- References to other documents or directives -->
-<seealso><a href="...">Useful document</a></seealso>
-<seealso><directive module="mod_useful">Useful</directive></seealso>
-<seealso><module>mod_useful</module></seealso>
-
-<!-- Any number of sections may be included below -->
-<section id="moredocs"><title>Additional Documentation</title>
-
-<p>More detailed information about the module in general (as opposed to
-the individual directives) can follow in sections containing titles.</p>
-
-<p>The <code>id</code> attribute will be translated into a hypertext
-anchor target.</p>
-
-<p>References to directives should use the directive tag: <directive
-module="mod_lua">TemplateDirective</directive>.  References to
-modules should use the module tag
-<module>mod_lua.xml</module>.</p>
+<example>
+AddHandler lua-script .lua
+</example>
 
+<p>
+This will cause any <code>.lua</code> file to be evaluated by
+<code>mod_lua</code>.
+</p>
 </section>
 
 <directivesynopsis>