Template for modules docs

[Joshua Slive]

Here is a first draft of a template for the modules documents.  I would
greatly appreciate contributions of more detailed requirements and
feedback.

Changes from existing files:

- Always start with a one sentence description of the module, with no
excess cruft.

- Addition of "Status" and "Compatibility" headings near the top.
A corresponding change will need to be made to directive-dict.html

- Removal of any references to "compiled in by default", or the name of
the source file.  These are less meaningful in a dynamically loaded world,
and the name of the source file is obvious in any case.  It might be
useful to include a heading for the name used in the "LoadModule"
directive.  (config_log_module is not obvious for mod_log_config)

- A "Directives" section with links to all the directives is ALWAYS near
the top, immediately below "Summary"

- The directives themselves are always the LAST thing in the file.
(Some modules docs place examples or other stuff below the directives.
I think if the directives are linked near the top, then they should
be placed absolutely last.)

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

Title: Apache module mod_template

Module mod_template A one sentence description of the module. Status: Base Compatibility: Only available in Apache 1.3 or later 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. 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.