diff options
Diffstat (limited to 'docs/manual/developer/modguide.html.en')
| -rw-r--r-- | docs/manual/developer/modguide.html.en | 35 |
1 files changed, 22 insertions, 13 deletions
diff --git a/docs/manual/developer/modguide.html.en b/docs/manual/developer/modguide.html.en index e22a7cf9ae..a6fafcc86a 100644 --- a/docs/manual/developer/modguide.html.en +++ b/docs/manual/developer/modguide.html.en @@ -125,7 +125,10 @@ of the module is used primarily for two things:<br /> For now, we're only concerned with the first purpose of the module name, which comes into play when we need to load the module: </p> -<div class="example"><pre><a href="../mod/mod_so.html#LoadModule">LoadModule</a> example_module modules/mod_example.so</pre></div> +<pre class="prettyprint lang-config"> +LoadModule example_module modules/mod_example.so +</pre> + <p> In essence, this tells the server to open up <code>mod_example.so</code> and look for a module called <code>example_module</code>. @@ -168,9 +171,10 @@ our example case, we want every request ending with .sum to be served by <code>mod_example</code>, so we'll add a configuration directive that tells the server to do just that: </p> -<div class="example"><pre> +<pre class="prettyprint lang-config"> AddHandler example-handler .sum -</pre></div> +</pre> + <p> What this tells the server is the following: <em>Whenever we receive a request for a URI ending in .sum, we are to let all modules know that we are @@ -742,11 +746,12 @@ what a configuration directive is. Simply put, a directive is a way of telling an individual module (or a set of modules) how to behave, such as these directives control how <code>mod_rewrite</code> works: </p> -<div class="example"><pre> +<pre class="prettyprint lang-config"> RewriteEngine On RewriteCond %{REQUEST_URI} ^/foo/bar RewriteRule ^/foo/bar/(.*)$ /foobar?page=$1 -</pre></div> +</pre> + <p> Each of these configuration directives are handled by a separate function, that parses the parameters given and sets up a configuration accordingly. @@ -822,11 +827,12 @@ module AP_MODULE_DECLARE_DATA example_module = So far so good. To access our new handler, we could add the following to our configuration: </p> -<div class="example"><pre> +<pre class="prettyprint lang-config"> <Location /example> SetHandler example-handler </Location> -</pre></div> +</pre> + <p> When we visit, we'll see our current configuration being spit out by our module. @@ -1077,11 +1083,12 @@ module AP_MODULE_DECLARE_DATA example_module = In our httpd.conf file, we can now change the hard-coded configuration by adding a few lines: </p> -<div class="example"><pre> +<pre class="prettyprint lang-config"> ExampleEnabled On ExamplePath "/usr/bin/foo" ExampleAction file allow -</pre></div> +</pre> + <p> And thus we apply the configuration, visit <code>/example</code> on our web site, and we see the configuration has adapted to what we wrote in our @@ -1269,7 +1276,7 @@ Our next step in creating a context aware configuration is merging configurations. This part of the process particularly apply to scenarios where you have a parent configuration and a child, such as the following: </p> -<div class="example"><pre> +<pre class="prettyprint lang-config"> <Directory "/var/www"> ExampleEnable On ExamplePath /foo/bar @@ -1278,7 +1285,8 @@ where you have a parent configuration and a child, such as the following: <Directory "/var/www/subdir"> ExampleAction file deny </Directory> -</pre></div> +</pre> + <p> In this example, it is natural to assume that the directory <code> /var/www/subdir</code> should inherit the value set for the <code>/var/www @@ -1325,7 +1333,7 @@ Now, let's try putting it all together to create a new module that is context aware. First off, we'll create a configuration that lets us test how the module works: </p> -<div class="example"><pre> +<pre class="prettyprint lang-config"> <Location "/a"> SetHandler example-handler ExampleEnabled on @@ -1343,7 +1351,8 @@ how the module works: ExamplePath "/foo/bar/baz" ExampleEnabled on </Location> -</pre></div> +</pre> + <p> Then we'll assemble our module code. Note, that since we are now using our name tag as reference when fetching configurations in our handler, I have |