Commit 9e5be8bb authored by Richard Bowen's avatar Richard Bowen
Browse files

Base template for Apache module documentation 


git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@90483 13f79535-47bb-0310-9956-ffa450edef68
parent ed903e45

docs/manual/mod/mod_TEMPLATE.html

0 → 100644
+131 −0
Original line number Diff line number Diff line 
<html>

<head>

<title>Apache module mod_foo</title>

</head>



<!-- Background white, links blue (unvisited), navy (visited), red (active) -->

<body bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink=

"#000080" alink="#FF0000">



<!--#include virtual="header.html" -->



<h1 align="center">Module mod_foo</h1>



The module mod_foo should be summarized in a sentence or two here.

A more complete summary is below, so keep it short. You might say

something about what is necessary to enable the functionality, and

link to the relevant doc. See <a href=

"mod_autoindex.html"><code>mod_autoindex</code></a> as a good

example. 



<p><a href="module-dict.html#Status" rel=

"Help"><strong>Status:</strong></a> Base<br>



 <a href="module-dict.html#SourceFile" rel="Help"><strong>Source

File:</strong></a> mod_autoindex.c<br>



 <a href="module-dict.html#ModuleIdentifier" rel=

"Help"><strong>Module Identifier:</strong></a> foo_module</p>



<h2>Summary</h2>



A more detailed summary goes here, but it should still be kept to a

few short paragraphs. More detailed discussion of the finer points

of the module should be left for below. 



<h2>Directives</h2>



<ul>

<li><a href="#directive1">Directive1</a></li>



<li><a href="#directive2">Directive2</a></li>



<li><a href="#directive3">Directive3</a></li>

</ul>



<p>See also: <a href="core.html#options">Options</a> and <a href=

"mod_dir.html#directoryindex">DirectoryIndex</a>.</p>



<h2>More detailed discussion one</h2>



<p>Here you can discuss in detail a particular point of interest,

or soemthing which requires a detailed explanation. This is a good

place for examples and tutorial-style discussion.</p>



<h2>Detailed discussion two</h2>



<p>You can have more than one such discussion, if appropriate.</p>



<hr>

<h2><a name="directive1">Directive1</a> directive</h2>



<a href="directive-dict.html#Syntax" rel=

"Help"><strong>Syntax:</strong></a> Directive 1 <em>argument</em>

[<em>optional_argument</em>] ...<br>



 <a href="directive-dict.html#Context" rel=

"Help"><strong>Context:</strong></a> server config, virtual host,

directory, .htaccess<br>



 <a href="directive-dict.html#Override" rel=

"Help"><strong>Override:</strong></a> Indexes<br>



 <a href="directive-dict.html#Status" rel=

"Help"><strong>Status:</strong></a> Base<br>



 <a href="directive-dict.html#Module" rel=

"Help"><strong>Module:</strong></a> mod_foo 



<p><em>Directive1</em> will be described in detail here. Each

argument should be explained, with example values.</p>



<hr>

<h2><a name="directive2">Directive2</a> directive</h2>



<a href="directive-dict.html#Syntax" rel=

"Help"><strong>Syntax:</strong></a> Directive2 <em>argument</em>

[<em>optional_argument</em>] ...<br>



 <a href="directive-dict.html#Context" rel=

"Help"><strong>Context:</strong></a> server config, virtual host,

directory, .htaccess<br>



 <a href="directive-dict.html#Override" rel=

"Help"><strong>Override:</strong></a> Indexes<br>



 <a href="directive-dict.html#Status" rel=

"Help"><strong>Status:</strong></a> Base<br>



 <a href="directive-dict.html#Module" rel=

"Help"><strong>Module:</strong></a> mod_foo 



<p><em>Directive2</em> should then be described in the same manner.</p>



<hr>

<h2><a name="directive3">Directive3</a> directive</h2>



<a href="directive-dict.html#Syntax" rel=

"Help"><strong>Syntax:</strong></a> Directive3 <em>argument</em>

[<em>optional_argument</em>] ...<br>



 <a href="directive-dict.html#Context" rel=

"Help"><strong>Context:</strong></a> server config, virtual host,

directory, .htaccess<br>



 <a href="directive-dict.html#Override" rel=

"Help"><strong>Override:</strong></a> Indexes<br>



 <a href="directive-dict.html#Status" rel=

"Help"><strong>Status:</strong></a> Base<br>



 <a href="directive-dict.html#Module" rel=

"Help"><strong>Module:</strong></a> mod_foo 



<p><em>Directive3</em> is described here, and so on. 



<!--#include virtual="footer.html" -->



</p>

</body>

</html>