Re: Template for modules docs

[Joshua Slive]

Second draft, with an included module-dict.html

The main changes, other than the inclusion of the module-dict,
is two new header fields near the top: source file name (obvious)
and module identifier (for use with LoadModule -- I couldn't come
up with a better name for it).  I also added an <HR> between
the header and the summary.

This obvious only works if people think it is worth following, so some
feedback would be good.

-- 
Joshua Slive
[EMAIL PROTECTED]
http://finance.commerce.ubc.ca/~slive/
Phone: (604) 822-1871

Title: Definitions of terms used to describe Apache modules

Terms Used to Describe Apache Modules Each Apache module directive is described using a common format that looks like this: Status: status Source File: source-file Module Identifier: module-identifier Compatibility: compatibility notes Each of the directive's attributes, complete with possible values where possible, are described in this document. Directive Terms Status Source File Module Identifier Compatibility Status This indicates how tightly bound into the Apache Web server the module is; in other words, you may need to recompile the server in order to gain access to the module and its functionality. Possible values for this attribute are: Base A module labeled as having "Base" status is compiled into the server by default, and is therefore normally available unless you've taken steps to remove the module from your configuration. Extension A module with "Extension" status is not normally compiled into the server. To enable the module and its functionality, you may need to change the server build configuration files and re-compile Apache. Experimental "Experimental" status indicates that the module is available as part of the Apache kit, but you're on your own if you try to use it. The module is being documented for completeness, and is not necessarily supported. Source File This quite simply lists the name of the source file which contains the code for the module. Module Identifier This is a string which identifies the module for use in the LoadModule directive when dynamically loading modules. In paritular, it is the name of the external variable of type module in the source file. Compatibility If the module was not part of the original Apache version 1 distribution, the version in which it was introduced should be listed here.

Title: Apache module mod_template

Module mod_template A one sentence description of the module. Status: Template Source File: mod_template.c Module Identifier: template_module Compatibility: Only available in Apache 1.3.13 and above. Summary A one to three paragraph summary of what the module does and how to use it. Directives Directive1 Directive2 See also Directive3 and Directive4. More Details More details here. More Details Even more details here. Directive1 directive Syntax: Directive1 file-pipe format-or-nickname Context: server config, virtual host Status: Base Compatibility: Available in Apache 1.3 or later Module: mod_template Details on the syntax and usage of the directive, as well as examples of its use. See also Directive3. Directive2 directive Syntax: Directive2 file-pipe format-or-nickname env=[!]environment-variable Context: server config, virtual host Status: Base Compatibility: Only available in Apache 1.3.5 or later Module: mod_template Details on the syntax and usage of the directive, as well as examples of its use. See also Directive4.