It seems that a lot of people get confused about where they can put

header and footer files, and assume that they *must* be in the same
directory as that being indexed. Just being a little more explicit on
this point, as it seems to come up very frequently.

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

diff --git a/docs/manual/mod/mod_autoindex.html.en b/docs/manual/mod/mod_autoindex.html.en
index 2a059f537e500dcf666d8d41d1c58fc11f67c592..f076a5125acfa48a2ee95bb43ad6a6e5f1565e56 100644 (file)
--- a/docs/manual/mod/mod_autoindex.html.en
+++ b/docs/manual/mod/mod_autoindex.html.en
@@ -353,14 +353,21 @@ of the index listing</td></tr><tr><th><a href="directive-dict.html#Syntax">Synta
     of the file that will be inserted at the top of the index
     listing. <em>Filename</em> is the name of the file to include.</p>
 
-<div class="example"><h3>Example</h3><p><code>
-HeaderName HEADER.html
-</code></p></div>
+    <div class="example"><h3>Example</h3><p><code>
+    HeaderName HEADER.html
+    </code></p></div>
 
 <div class="note">
       <p>Both HeaderName and <code class="directive"><a href="#readmename">ReadmeName</a></code> now treat
       <em>Filename</em> as a URI path relative to the one used to
-      access the directory being indexed. <em>Filename</em> must
+      access the directory being indexed. If <em>Filename</em> begins
+      with a slash, it will be taken to be relative to the <code class="directive"><a href="../mod/core.html#documentroot">DocumentRoot</a></code>.</p>
+
+      <div class="example"><h3>Example</h3><p><code>
+      HeaderName /include/HEADER.html
+      </code></p></div>
+      
+      <p><em>Filename</em> must
       resolve to a document with a major content type of
       "<code>text/*</code>" (<em>e.g.</em>, <code>text/html</code>,
       <code>text/plain</code>, <em>etc.</em>). This means that
@@ -731,12 +738,19 @@ of the index listing</td></tr><tr><th><a href="directive-dict.html#Syntax">Synta
     <p>The <code class="directive">ReadmeName</code> directive sets the name
     of the file that will be appended to the end of the index
     listing. <em>Filename</em> is the name of the file to include, and
-    is taken to be relative to the location being indexed.</p>
+    is taken to be relative to the location being indexed. If
+    <em>Filename</em> begins with a slash, it will be taken to be
+    relative to the <code class="directive"><a href="../mod/core.html#documentroot">DocumentRoot</a></code>.
+    </p>
 
     <div class="example"><h3>Example</h3><p><code>
     ReadmeName FOOTER.html
     </code></p></div>
 
+    <div class="example"><h3>Example 2</h3><p><code>
+    ReadmeName /include/FOOTER.html
+    </code></p></div>
+
     <p>See also <code class="directive"><a href="#headername">HeaderName</a></code>, where this behavior
     is described in greater detail.</p>
 </div></div><div id="footer"><p class="apache">Maintained by the <a href="http://httpd.apache.org/docs-project/">Apache HTTP Server Documentation Project</a></p><p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div></body></html>
\ No newline at end of file

diff --git a/docs/manual/mod/mod_autoindex.xml b/docs/manual/mod/mod_autoindex.xml
index 8f4a19443999e924b5132d97d576109160614e89..b24f76976588ddb7abd867e6061c1268f0239e0f 100644 (file)
--- a/docs/manual/mod/mod_autoindex.xml
+++ b/docs/manual/mod/mod_autoindex.xml
@@ -409,15 +409,23 @@ of the index listing</description>
     of the file that will be inserted at the top of the index
     listing. <em>Filename</em> is the name of the file to include.</p>
 
-<example><title>Example</title>
-HeaderName HEADER.html
-</example>
+    <example><title>Example</title>
+    HeaderName HEADER.html
+    </example>
 
 <note>
       <p>Both HeaderName and <directive
       module="mod_autoindex">ReadmeName</directive> now treat
       <em>Filename</em> as a URI path relative to the one used to
-      access the directory being indexed. <em>Filename</em> must
+      access the directory being indexed. If <em>Filename</em> begins
+      with a slash, it will be taken to be relative to the <directive
+      module="core">DocumentRoot</directive>.</p>
+
+      <example><title>Example</title>
+      HeaderName /include/HEADER.html
+      </example>
+      
+      <p><em>Filename</em> must
       resolve to a document with a major content type of
       "<code>text/*</code>" (<em>e.g.</em>, <code>text/html</code>,
       <code>text/plain</code>, <em>etc.</em>). This means that
@@ -839,12 +847,19 @@ of the index listing</description>
     <p>The <directive>ReadmeName</directive> directive sets the name
     of the file that will be appended to the end of the index
     listing. <em>Filename</em> is the name of the file to include, and
-    is taken to be relative to the location being indexed.</p>
+    is taken to be relative to the location being indexed. If
+    <em>Filename</em> begins with a slash, it will be taken to be
+    relative to the <directive module="core">DocumentRoot</directive>.
+    </p>
 
     <example><title>Example</title>
     ReadmeName FOOTER.html
     </example>
 
+    <example><title>Example 2</title>
+    ReadmeName /include/FOOTER.html
+    </example>
+
     <p>See also <directive
     module="mod_autoindex">HeaderName</directive>, where this behavior
     is described in greater detail.</p>