I started this several months ago, and then abandoned it in a fit of frustration.
I'm back. This is very similar to what I posted in December, with the exception that the transformation system is now xslt (Xerces+Xalan) rather than Velocity+Anakia. The most important attached doc is mod_setenvif.xml, which is an example of how the xml source files will look. Please review this to see if you agree with what I have done. Are there tags missing that we should be using? Are the tags named correctly? Is the nesting correct? The other attached files are the site.xsl file, which drives the transformation, and mod_setenvif.html, which is the result. These are rather arbitrary; other transformation engines could be used, and someone should surely spend some time changing them to use CSS. As far as the mechanics go, the site.xsl would be committed somewhere under httpd-2.0/docs/manual/. Transformations would happen "in place", in the sense that the target .html file would be written in the same directory as the source .xml file. To make the release manager's job easier, the .html files would be committed to cvs (even though they are generated from the xml). The actual engine to do the transform (jar files, build.xml, etc) would probably not be committed. We could either make it available on the website, or in a separate cvs repository. Some unresolved issues: - This is only for the module docs at the moment. Others will require some more work. - This will completely kill the parallel between 1.3 and 2.0. Future 1.3 changes will need to be hand-ported to the 2.0 docs (unless somebody feels very strongly that the .xml system should be used in 1.3 as well). - Translations? I'm sure they could be worked in somehow. I plan to proceed with this quite soon, before I lose my momentum. So please speak now or forever hold your peace. Joshua.
<?xml version="1.0" encoding="ISO-8859-1"?> <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"; version="1.0"> <!-- Output method --> <xsl:output method="html" encoding="iso-8859-1" indent="yes"/> <!-- Defined parameters (overrideable) --> <xsl:param name="relative-path" select="'.'"/> <!-- Process an entire document into an HTML page --> <xsl:template match="modulesynopsis"> <html> <head> <xsl:apply-templates select="meta"/> <title><xsl:value-of select="name"/> - Apache HTTP Server</title> </head> <body> <div align="center"> <img src="../images/sub.gif" alt="[APACHE DOCUMENTATION]" /> <h3>Apache HTTP Server Version 2.0</h3> </div> <h1 align="center">Apache Module <xsl:value-of select="name"/></h1> <!-- Description and module-headers --> <p><xsl:apply-templates select="description"/></p> <table bgcolor="#cccccc" cellpadding="0" cellspacing="1"> <tr><td> <table bgcolor="#ffffff"> <tr><td><a class="help" href="module-dict.html#Status">Status:</a> </td> <td><xsl:value-of select="status"/></td></tr> <tr><td><a class="help" href="module-dict.html#ModuleIdentifier">Module Identifier:</a> </td> <td><xsl:value-of select="identifier"/></td></tr> </table> </td></tr> </table> <h2>Summary</h2> <xsl:apply-templates select="summary"/> <xsl:if test="seealso"> <p><strong>See also:</strong></p> <ul> <xsl:for-each select="seealso"> <xsl:variable name="href"> <xsl:value-of select="./@href"/> </xsl:variable> <li><a href="{$href}"><xsl:apply-templates/></a></li> </xsl:for-each> </ul> </xsl:if> <h2>Directives</h2> <ul> <xsl:for-each select="directivesynopsis/name"> <xsl:variable name="name"> <xsl:value-of select="."/> </xsl:variable> <li><a href="#{$name}"><xsl:value-of select="."/></a></li> </xsl:for-each> </ul> <xsl:apply-templates select="section"/> <hr /> <xsl:apply-templates select="directivesynopsis"/> <h3 align="center">Apache HTTP Server Version 2.0</h3> <a href="./"><img src="../images/index.gif" alt="Index" /></a> <a href="../"><img src="../images/home.gif" alt="Home" /></a> </body> </html> </xsl:template> <!-- Process a documentation section --> <xsl:template match="section"> <xsl:variable name="title"> <xsl:value-of select="./title/@id"/> </xsl:variable> <!-- Section heading --> <xsl:if test="./title/@id"> <h2><a name="{$title}"><xsl:value-of select="./title"/></a></h2> </xsl:if> <xsl:if test="not(./title/@id)"> <h2><xsl:value-of select="./title"/></h2> </xsl:if> <!-- Section body --> <xsl:apply-templates/> </xsl:template> <xsl:template match="summary"> <xsl:apply-templates/> </xsl:template> <xsl:template match="directivesynopsis"> <xsl:variable name="name"> <xsl:value-of select="./name"/> </xsl:variable> <h2><a name="{$name}"><xsl:value-of select="./name"/> Directive</a></h2> <table bgcolor="#cccccc" border="0" cellspacing="0" cellpadding="1"> <tr><td> <table bgcolor="#ffffff" width="100%"> <tr><td><strong>Description:</strong> </td> <td><xsl:value-of select="description"/></td></tr> <tr><td><a class="help" href="directive-dict.html#Syntax">Syntax:</a> </td> <td><xsl:apply-templates select="syntax"/></td></tr> <tr><td><a class="help" href="directive-dict.html#Default">Default:</a> </td> <td><code><xsl:value-of select="default"/></code></td></tr> <tr><td><a class="help" href="directive-dict.html#Context">Context:</a> </td> <td><xsl:value-of select="context"/></td></tr> <tr><td><a class="help" href="directive-dict.html#Override">Override:</a> </td> <td><xsl:value-of select="override"/></td></tr> <tr><td><a class="help" href="directive-dict.html#Status">Status:</a> </td> <td><xsl:value-of select="status"/></td></tr> <tr><td><a class="help" href="directive-dict.html#Module">Module:</a> </td> <td><xsl:value-of select="/modulesynopsis/name"/></td></tr> <tr><td><a class="help" href="directive-dict.html#Compatibility">Compatibility:</a> </td> <td><xsl:value-of select="compatibility"/></td></tr> </table> </td></tr></table> <xsl:apply-templates select="usage"/> <xsl:if test="seealso"> <p><strong>See also:</strong></p> <ul> <xsl:for-each select="seealso"> <xsl:variable name="href"> <xsl:value-of select="./@href"/> </xsl:variable> <li><a href="{$href}"><xsl:apply-templates/></a></li> </xsl:for-each> </ul> </xsl:if> <hr /> </xsl:template> <xsl:template match="example"> <blockquote> <table><tr><td bgcolor="#eeeeee"> <xsl:if test="./title"> <p align="center"><strong><xsl:apply-templates select="./title"/> </strong></p> </xsl:if> <code><xsl:apply-templates/></code> </td></tr></table> </blockquote> </xsl:template> <xsl:template match="directive"> <code> <xsl:if test="@href"> <xsl:variable name="href"> <xsl:value-of select="./@href"/> </xsl:variable> <a href="{$href}"><xsl:value-of select="."/></a> </xsl:if> <xsl:if test="not(@href)"> <xsl:value-of select="."/> </xsl:if> </code> </xsl:template> <xsl:template match="module"> <code> <xsl:if test="@href"> <xsl:variable name="href"> <xsl:value-of select="./@href"/> </xsl:variable> <a href="{$href}"><xsl:value-of select="."/></a> </xsl:if> <xsl:if test="not(@href)"> <xsl:value-of select="."/> </xsl:if> </code> </xsl:template> <!-- Process everything else by just passing it through --> <xsl:template match="*|@*"> <xsl:copy> <xsl:apply-templates select="@*|*|text()"/> </xsl:copy> </xsl:template> </xsl:stylesheet>Title: mod_setenvif - Apache HTTP Server
Apache HTTP Server Version 2.0
Apache Module mod_setenvif
|
Summary
The mod_setenvif module allows you to set
environment variables according to whether different aspects of
the request match regular expressions you specify. These
environment variables can be used by other parts of the server
to make decisions about actions to be taken.
The directives are considered in the order they appear in
the configuration files. So more complex sequences can be used,
such as this example, which sets netscape if the
browser is mozilla but not MSIE.
BrowserMatch ^Mozilla netscape
BrowserMatch MSIE !netscape
See also:
Directives
BrowserMatch Directive
|
The BrowserMatch directive defines
environment variables based on the User-Agent HTTP
request header field. The first argument should be a POSIX.2
extended regular _expression_ (similar to an
egrep-style regex). The rest of the arguments give
the names of variables to set, and optionally values to which they
should be set. These take the form of
-
varname, or -
!varname, or -
varname=value
In the first form, the value will be set to "1". The second
will remove the given variable if already defined, and the
third will set the variable to the value given by
value. If a User-Agent
string matches more than one entry, they will be merged.
Entries are processed in the order in which they appear, and
later entries can override earlier ones.
For example:
BrowserMatch ^Mozilla forms jpeg=yes browser=netscape
BrowserMatch "^Mozilla/[2-3]" tables agif frames _javascript_
BrowserMatch MSIE !_javascript_
Note that the regular _expression_ string is
case-sensitive. For case-INsensitive matching,
see the BrowserMatchNoCase
directive.
The BrowserMatch and
BrowserMatchNoCase directives are special cases of
the SetEnvIf and SetEnvIfNoCase
directives. The following two lines have the same effect:
BrowserMatchNoCase Robot is_a_robot
SetEnvIfNoCase User-Agent Robot is_a_robot
BrowserMatchNoCase Directive
|
The BrowserMatchNoCase directive is
semantically identical to the BrowserMatch directive.
However, it provides for case-insensitive matching. For
example:
BrowserMatchNoCase mac platform=macintosh
BrowserMatchNoCase win platform=windows
The BrowserMatch and
BrowserMatchNoCase directives are special cases of
the SetEnvIf and SetEnvIfNoCase
directives. The following two lines have the same effect:
BrowserMatchNoCase Robot is_a_robot
SetEnvIfNoCase User-Agent Robot is_a_robot
SetEnvIf Directive
|
The SetEnvIf directive defines environment
variables based on attributes of the request. These attributes
can be the values of various HTTP request header fields (see RFC2616
for more information about these), or of other aspects of the
request, including the following:
-
Remote_Host- the hostname (if available) of the client making the request -
Remote_Addr- the IP address of the client making the request -
Remote_User- the authenticated username (if available) -
Request_Method- the name of the method being used (GET,POST, et cetera) -
Request_Protocol- the name and version of the protocol with which the request was made (e.g., "HTTP/0.9", "HTTP/1.1", etc.) -
Request_URI- the portion of the URL following the scheme and host portion
Some of the more commonly used request header field names
include Host, User-Agent, and
Referer.
If the attribute name doesn't match any of the
special keywords, nor any of the request's header field names,
it is tested as the name of an environment variable in the list
of those associated with the request. This allows
SetEnvIf directives to test against the result of
prior matches.
SetEnvIf[NoCase] directives are available for
testing in this manner. 'Earlier' means that they were
defined at a broader scope (such as server-wide) or
previously in the current directive's scope.
attribute may be a regular _expression_ when used to match a request header. If attribute is a regular _expression_ and it doesn't match any of the request's header names, then attribute is not tested against the request's environment variable list.
Example: Example: SetEnvIf Request_URI "\.gif$" object_is_image=gif
SetEnvIf Request_URI "\.jpg$" object_is_image=jpg
SetEnvIf Request_URI "\.xbm$" object_is_image=xbm
:
SetEnvIf Referer www\.mydomain\.com intra_site_referral
:
SetEnvIf object_is_image xbm XBIT_PROCESSING=1
:
SetEnvIf ^TS* ^[a-z].* HAVE_TS
The first three will set the environment variable
object_is_image if the request was for an image
file, and the fourth sets intra_site_referral if
the referring page was somewhere on the
www.mydomain.com Web site.
The last example will set environment variable
HAVE_TS if the request contains any headers that
begin with "TS" whose values begins with any character in the
set [a-z].
SetEnvIfNoCase Directive
|
The SetEnvIfNoCase is semantically identical to
the SetEnvIf directive,
and differs only in that the regular _expression_ matching is
performed in a case-insensitive manner. For example:
SetEnvIfNoCase Host Apache\.Org site=apache
This will cause the site environment variable
to be set to "apache" if the HTTP request header
field Host: was included and contained
Apache.Org, apache.org, or any other
combination.
Apache HTTP Server Version 2.0
<?xml version="1.0"?>
<modulesynopsis>
<name>mod_setenvif</name>
<status>Base</status>
<identifier>setenvif_module</identifier>
<sourcefile>mod_setenvif.c</sourcefile>
<compatibility>Available in Apache 1.3 and later</compatibility>
<description>Allows the setting of environment variables based
on characteristics of the request</description>
<summary>
<p>The <module>mod_setenvif</module> module allows you to set
environment variables according to whether different aspects of
the request match regular expressions you specify. These
environment variables can be used by other parts of the server
to make decisions about actions to be taken.</p>
<p>The directives are considered in the order they appear in
the configuration files. So more complex sequences can be used,
such as this example, which sets <code>netscape</code> if the
browser is mozilla but not MSIE.</p>
<example>
BrowserMatch ^Mozilla netscape<br />
BrowserMatch MSIE !netscape<br />
</example>
</summary>
<seealso href="env.html">Environment Variables in Apache</seealso>
<directivesynopsis>
<name>BrowserMatch</name>
<description>Sets environment variables conditional on HTTP User-Agent
</description>
<syntax>BrowserMatch <em>regex env-variable</em>[=<em>value</em>]
[<em>env-variable</em>[=<em>value</em>]] ...</syntax>
<default><i>none</i></default>
<context>server config, virtual host, directory, .htaccess</context>
<override>FileInfo</override>
<compatibility>Apache 1.2 and
above (in Apache 1.2 this directive was found in the
now-obsolete mod_browser module)</compatibility>
<usage>
<p>The <directive>BrowserMatch</directive> directive defines
environment variables based on the <code>User-Agent</code> HTTP
request header field. The first argument should be a POSIX.2
extended regular expression (similar to an
<code>egrep</code>-style regex). The rest of the arguments give
the names of variables to set, and optionally values to which they
should be set. These take the form of</p>
<ol>
<li><code><em>varname</em></code>, or</li>
<li><code>!<em>varname</em></code>, or</li>
<li><code><em>varname</em>=<em>value</em></code></li>
</ol>
<p>In the first form, the value will be set to "1". The second
will remove the given variable if already defined, and the
third will set the variable to the value given by
<code><em>value</em></code>. If a <code>User-Agent</code>
string matches more than one entry, they will be merged.
Entries are processed in the order in which they appear, and
later entries can override earlier ones.</p>
<p>For example:</p>
<example>
BrowserMatch ^Mozilla forms jpeg=yes browser=netscape<br />
BrowserMatch "^Mozilla/[2-3]" tables agif frames javascript<br />
BrowserMatch MSIE !javascript<br />
</example>
<p>Note that the regular expression string is
<strong>case-sensitive</strong>. For case-INsensitive matching,
see the <directive
href="#BrowserMatchNoCase">BrowserMatchNoCase</directive>
directive.</p>
<p>The <directive>BrowserMatch</directive> and
<directive>BrowserMatchNoCase</directive> directives are special cases of
the <directive href="#SetEnvIf">SetEnvIf</directive> and <directive
href="#SetEnvIfNoCase">SetEnvIfNoCase</directive>
directives. The following two lines have the same effect:</p>
<example>
BrowserMatchNoCase Robot is_a_robot<br />
SetEnvIfNoCase User-Agent Robot is_a_robot<br />
</example>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>BrowserMatchNoCase</name>
<description>Sets environment variables conditional on User-Agent without
respect to case</description>
<syntax>BrowserMatchNoCase <em>regex env-variable</em>[=<em>value</em>]
[<em>env-variable</em>[=<em>value</em>]] ...</syntax>
<default><em>none</em></default>
<context>server config, virtual host, directory, .htaccess</context>
<override>FileInfo</override>
<compatibility>Apache 1.2 and
above (in Apache 1.2 this directive was found in the
now-obsolete mod_browser module)</compatibility>
<usage>
<p>The <directive>BrowserMatchNoCase</directive> directive is
semantically identical to the <directive
href="#BrowserMatch">BrowserMatch</directive> directive.
However, it provides for case-insensitive matching. For
example:</p>
<example>
BrowserMatchNoCase mac platform=macintosh<br />
BrowserMatchNoCase win platform=windows<br />
</example>
<p>The <directive>BrowserMatch</directive> and
<directive>BrowserMatchNoCase</directive> directives are special cases of
the <directive href="#SetEnvIf">SetEnvIf</directive> and <directive
href="#SetEnvIfNoCase">SetEnvIfNoCase</directive>
directives. The following two lines have the same effect:</p>
<example>
BrowserMatchNoCase Robot is_a_robot<br />
SetEnvIfNoCase User-Agent Robot is_a_robot<br />
</example>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>SetEnvIf</name>
<description>Sets environment variables based on attributes of the request
</description>
<syntax>SetEnvIf <em>attribute
regex env-variable</em>[=<em>value</em>]
[<em>env-variable</em>[=<em>value</em>]] ...</syntax>
<default><em>none</em></default>
<context> server config, virtual host, directory, .htaccess</context>
<override>FileInfo</override>
<compatibility>Apache 1.3 and
above; the Request_Protocol keyword and environment-variable
matching are only available with 1.3.7 and later</compatibility>
<usage>
<p>The <directive>SetEnvIf</directive> directive defines environment
variables based on attributes of the request. These attributes
can be the values of various HTTP request header fields (see <a
href="http://www.rfc-editor.org/rfc/rfc2616.txt";>RFC2616</a>
for more information about these), or of other aspects of the
request, including the following:</p>
<ul>
<li><code>Remote_Host</code> - the hostname (if available) of
the client making the request</li>
<li><code>Remote_Addr</code> - the IP address of the client
making the request</li>
<li><code>Remote_User</code> - the authenticated username (if
available)</li>
<li><code>Request_Method</code> - the name of the method
being used (<code>GET</code>, <code>POST</code>, <em>et
cetera</em>)</li>
<li><code>Request_Protocol</code> - the name and version of
the protocol with which the request was made (<em>e.g.</em>,
"HTTP/0.9", "HTTP/1.1", <em>etc.</em>)</li>
<li><code>Request_URI</code> - the portion of the URL
following the scheme and host portion</li>
</ul>
<p>Some of the more commonly used request header field names
include <code>Host</code>, <code>User-Agent</code>, and
<code>Referer</code>.</p>
<p>If the <em>attribute</em> name doesn't match any of the
special keywords, nor any of the request's header field names,
it is tested as the name of an environment variable in the list
of those associated with the request. This allows
<directive>SetEnvIf</directive> directives to test against the result of
prior matches.</p>
<note>
<strong>Only those environment variables defined by earlier
<code>SetEnvIf[NoCase]</code> directives are available for
testing in this manner. 'Earlier' means that they were
defined at a broader scope (such as server-wide) or
previously in the current directive's scope.</strong>
</note>
<p><em>attribute</em> may be a regular expression when used to
match a request header. If <em>attribute</em> is a regular
expression and it doesn't match any of the request's header
names, then <em>attribute</em> is not tested against the
request's environment variable list.</p>
<example>
<title>Example:</title>
SetEnvIf Request_URI "\.gif$" object_is_image=gif<br />
SetEnvIf Request_URI "\.jpg$" object_is_image=jpg<br />
SetEnvIf Request_URI "\.xbm$" object_is_image=xbm<br />
:<br />
SetEnvIf Referer www\.mydomain\.com intra_site_referral<br />
:<br />
SetEnvIf object_is_image xbm XBIT_PROCESSING=1<br />
:<br />
SetEnvIf ^TS* ^[a-z].* HAVE_TS<br />
</example>
<p>The first three will set the environment variable
<code>object_is_image</code> if the request was for an image
file, and the fourth sets <code>intra_site_referral</code> if
the referring page was somewhere on the
<code>www.mydomain.com</code> Web site.</p>
<p>The last example will set environment variable
<code>HAVE_TS</code> if the request contains any headers that
begin with "TS" whose values begins with any character in the
set [a-z].</p>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>SetEnvIfNoCase</name>
<description>Sets environment variables based on attributes of the request
without respect to case</description>
<syntax>SetEnvIfNoCase <em>attribute regex env-variable</em>[=<em>value</em>]
[<em>env-variable</em>[=<em>value</em>]] ...</syntax>
<default><em>none</em></default>
<context>server config, virtual host, directory, .htaccess</context>
<override>FileInfo</override>
<compatibility>Apache 1.3 and above</compatibility>
<usage>
<p>The <directive>SetEnvIfNoCase</directive> is semantically identical to
the <directive href="#SetEnvIf">SetEnvIf</directive> directive,
and differs only in that the regular expression matching is
performed in a case-insensitive manner. For example:</p>
<example>
SetEnvIfNoCase Host Apache\.Org site=apache
</example>
<p>This will cause the <code>site</code> environment variable
to be set to "<code>apache</code>" if the HTTP request header
field <code>Host:</code> was included and contained
<code>Apache.Org</code>, <code>apache.org</code>, or any other
combination.</p>
</usage>
</directivesynopsis>
</modulesynopsis>
--------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
