httpd-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From rbo...@apache.org
Subject svn commit: r1243769 - in /httpd/httpd/trunk/docs/manual/mod: mod_autoindex.html.en mod_autoindex.xml
Date Tue, 14 Feb 2012 02:56:34 GMT
Author: rbowen
Date: Tue Feb 14 02:56:33 2012
New Revision: 1243769

URL: http://svn.apache.org/viewvc?rev=1243769&view=rev
Log:
Removes references to how things used to be in 2.0.x, and makes
necessary rephrasings to compensate for those references.

Modified:
    httpd/httpd/trunk/docs/manual/mod/mod_autoindex.html.en
    httpd/httpd/trunk/docs/manual/mod/mod_autoindex.xml

Modified: httpd/httpd/trunk/docs/manual/mod/mod_autoindex.html.en
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/mod/mod_autoindex.html.en?rev=1243769&r1=1243768&r2=1243769&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/mod/mod_autoindex.html.en (original)
+++ httpd/httpd/trunk/docs/manual/mod/mod_autoindex.html.en Tue Feb 14 02:56:33 2012
@@ -39,9 +39,9 @@
       sources:</p>
 
     <ul>
-      <li>A file written by the user, typically called
+      <li>A file located in that directory, typically called
       <code>index.html</code>. The <code class="directive"><a href="../mod/mod_dir.html#directoryindex">DirectoryIndex</a></code>
directive sets the
-      name of this file. This is controlled by
+      name of the file or files to be used. This is controlled by
       <code class="module"><a href="../mod/mod_dir.html">mod_dir</a></code>.</li>
 
       <li>Otherwise, a listing generated by the server. The other
@@ -104,11 +104,11 @@
 <h2><a name="query" id="query">Autoindex Request Query Arguments</a></h2>
     
 
-    <p>Apache HTTP Server 2.0.23 reorganized the Query Arguments for Column
-    Sorting, and introduced an entire group of new query options.
-    To effectively eliminate all client control over the output,
-    the <code><a href="#indexoptions.ignoreclient">IndexOptions
-    IgnoreClient</a></code> option was introduced.</p>
+    <p>Various query string arguments are available to give the client
+    some control over the ordering of the directory listing, as well as
+    what files are listed. If you do not wish to give the client this
+    control, the <code><a href="#indexoptions.ignoreclient">IndexOptions
+    IgnoreClient</a></code> option disables that functionality.</p>
 
     <p>The column sorting headers themselves are self-referencing
     hyperlinks that add the sort query options shown below. Any
@@ -503,6 +503,10 @@ of the index listing</td></tr>
     +SuppressHTMLPreamble</code></a>, so that these tags are not
     repeated.</p>
 
+<h3>See also</h3>
+<ul>
+<li><code class="directive"><a href="../mod/autoindex.html#readmename">ReadmeName</a></code></li>
+</ul>
 </div>
 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif"
/></a></div>
 <div class="directive-section"><h2><a name="IndexHeadInsert" id="IndexHeadInsert">IndexHeadInsert</a>
<a name="indexheadinsert" id="indexheadinsert">Directive</a></h2>
@@ -631,8 +635,7 @@ indexing</td></tr>
       </code></p></div>
       </dd>
 
-      <dt><a name="indexoptions.descriptionwidth" id="indexoptions.descriptionwidth">DescriptionWidth=[<var>n</var>
| *]</a> (<em>Apache HTTP Server 2.0.23 and
-      later</em>)</dt>
+      <dt><a name="indexoptions.descriptionwidth" id="indexoptions.descriptionwidth">DescriptionWidth=[<var>n</var>
| *]</a></dt>
 
       <dd>The <code>DescriptionWidth</code> keyword allows you to
       specify the width of the description column in
@@ -655,8 +658,7 @@ indexing</td></tr>
 
       <dd>This turns on fancy indexing of directories.</dd>
 
-      <dt><a name="indexoptions.foldersfirst" id="indexoptions.foldersfirst">FoldersFirst</a>
(<em>Apache HTTP Server
-      2.0.23 and later</em>)</dt>
+      <dt><a name="indexoptions.foldersfirst" id="indexoptions.foldersfirst">FoldersFirst</a></dt>
 
       <dd>If this option is enabled, subdirectory listings will
       <em>always</em> appear first, followed by normal files in the
@@ -670,8 +672,7 @@ indexing</td></tr>
       <code>Gamma</code> and <code>Alpha</code>. <strong>This
option
       only has an effect if <a href="#indexoptions.fancyindexing"><code>FancyIndexing</code></a>
is also enabled.</strong></dd>
 
-      <dt><a name="indexoptions.htmltable" id="indexoptions.htmltable">HTMLTable</a>
(<em>Apache
-      HTTP Server 2.0.23 and later</em>)</dt>
+      <dt><a name="indexoptions.htmltable" id="indexoptions.htmltable">HTMLTable</a></dt>
 
       <dd>This option with <code>FancyIndexing</code> constructs
       a simple table for the fancy directory listing.
@@ -754,10 +755,9 @@ indexing</td></tr>
       FancyIndexed directory listing into links for sorting. The
       default behavior is for them to be links; selecting the
       column heading will sort the directory listing by the values
-      in that column. <strong>Prior to Apache HTTP Server 2.0.23, this also
-      disabled parsing the Query Arguments for the sort
-      string.</strong> That behavior is now controlled by <a href="#indexoptions.ignoreclient"><code>IndexOptions
-      IgnoreClient</code></a> in Apache HTTP Server 2.0.23.</dd>
+      in that column. However, query string arguments which are appended
+      to the URL will still be honored. That behavior is controlled by <a href="#indexoptions.ignoreclient"><code>IndexOptions
+      IgnoreClient</code></a>.</dd>
 
       <dt><a name="indexoptions.suppressdescription" id="indexoptions.suppressdescription">SuppressDescription</a></dt>
 
@@ -784,8 +784,7 @@ indexing</td></tr>
       ommitted from the output, under the assumption that you'll likely
       put those closing tags in that file.</dd>
 
-      <dt><a name="indexoptions.suppressicon" id="indexoptions.suppressicon">SuppressIcon</a>
(<em>Apache HTTP Server
-      2.0.23 and later</em>)</dt>
+      <dt><a name="indexoptions.suppressicon" id="indexoptions.suppressicon">SuppressIcon</a></dt>
 
       <dd>This will suppress the icon in fancy indexing listings.
       Combining both <code>SuppressIcon</code> and
@@ -800,7 +799,7 @@ indexing</td></tr>
       in fancy indexing listings.</dd>
 
       <dt><a name="indexoptions.suppressrules" id="indexoptions.suppressrules">SuppressRules</a>
-      (<em>Apache HTTP Server 2.0.23 and later</em>)</dt>
+      </dt>
 
       <dd>This will suppress the horizontal rule lines (<code>hr</code>
       elements) in directory listings. Combining both <code>SuppressIcon</code>
and
@@ -813,8 +812,7 @@ indexing</td></tr>
 
       <dd>This will suppress the file size in fancy indexing listings.</dd>
 
-      <dt><a name="indexoptions.trackmodified" id="indexoptions.trackmodified">TrackModified</a>
(<em>Apache HTTP Server
-      2.0.23 and later</em>)</dt>
+      <dt><a name="indexoptions.trackmodified" id="indexoptions.trackmodified">TrackModified</a></dt>
 
       <dd>This returns the <code>Last-Modified</code> and <code>ETag</code>
       values for the listed directory in the HTTP header. It is only valid
@@ -1018,11 +1016,11 @@ of the index listing</td></tr>
     of the file that will be appended to the end of the index
     listing. <var>Filename</var> is the name of the file to include, and
     is taken to be relative to the location being indexed. If
-    <var>Filename</var> begins with a slash, it will be taken to be
+    <var>Filename</var> begins with a slash, as in example 2, 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>
+    <div class="example"><h3>Example 1</h3><p><code>
       ReadmeName FOOTER.html
     </code></p></div>
 

Modified: httpd/httpd/trunk/docs/manual/mod/mod_autoindex.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/mod/mod_autoindex.xml?rev=1243769&r1=1243768&r2=1243769&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/mod/mod_autoindex.xml (original)
+++ httpd/httpd/trunk/docs/manual/mod/mod_autoindex.xml Tue Feb 14 02:56:33 2012
@@ -35,10 +35,10 @@
       sources:</p>
 
     <ul>
-      <li>A file written by the user, typically called
+      <li>A file located in that directory, typically called
       <code>index.html</code>. The <directive
       module="mod_dir">DirectoryIndex</directive> directive sets the
-      name of this file. This is controlled by
+      name of the file or files to be used. This is controlled by
       <module>mod_dir</module>.</li>
 
       <li>Otherwise, a listing generated by the server. The other
@@ -81,11 +81,11 @@
 <section id="query">
     <title>Autoindex Request Query Arguments</title>
 
-    <p>Apache HTTP Server 2.0.23 reorganized the Query Arguments for Column
-    Sorting, and introduced an entire group of new query options.
-    To effectively eliminate all client control over the output,
-    the <code><a href="#indexoptions.ignoreclient">IndexOptions
-    IgnoreClient</a></code> option was introduced.</p>
+    <p>Various query string arguments are available to give the client
+    some control over the ordering of the directory listing, as well as
+    what files are listed. If you do not wish to give the client this
+    control, the <code><a href="#indexoptions.ignoreclient">IndexOptions
+    IgnoreClient</a></code> option disables that functionality.</p>
 
     <p>The column sorting headers themselves are self-referencing
     hyperlinks that add the sort query options shown below. Any
@@ -506,6 +506,8 @@ of the index listing</description>
     +SuppressHTMLPreamble</code></a>, so that these tags are not
     repeated.</p>
 </usage>
+
+<seealso><directive module="autoindex">ReadmeName</directive></seealso>
 </directivesynopsis>
 
 <directivesynopsis>
@@ -539,6 +541,7 @@ a directory</description>
       </p>
     </note>
 </usage>
+
 </directivesynopsis>
 
 <directivesynopsis>
@@ -624,8 +627,7 @@ indexing</description>
 
       <dt><a name="indexoptions.descriptionwidth"
                id="indexoptions.descriptionwidth"
-      >DescriptionWidth=[<var>n</var> | *]</a> (<em>Apache HTTP
Server 2.0.23 and
-      later</em>)</dt>
+      >DescriptionWidth=[<var>n</var> | *]</a></dt>
 
       <dd>The <code>DescriptionWidth</code> keyword allows you to
       specify the width of the description column in
@@ -651,8 +653,7 @@ indexing</description>
       <dd>This turns on fancy indexing of directories.</dd>
 
       <dt><a name="indexoptions.foldersfirst"
-               id="indexoptions.foldersfirst">FoldersFirst</a> (<em>Apache
HTTP Server
-      2.0.23 and later</em>)</dt>
+               id="indexoptions.foldersfirst">FoldersFirst</a></dt>
 
       <dd>If this option is enabled, subdirectory listings will
       <em>always</em> appear first, followed by normal files in the
@@ -668,8 +669,7 @@ indexing</description>
       ><code>FancyIndexing</code></a> is also enabled.</strong></dd>
 
       <dt><a name="indexoptions.htmltable"
-               id="indexoptions.htmltable">HTMLTable</a> (<em>Apache
-      HTTP Server 2.0.23 and later</em>)</dt>
+               id="indexoptions.htmltable">HTMLTable</a></dt>
 
       <dd>This option with <code>FancyIndexing</code> constructs
       a simple table for the fancy directory listing.
@@ -766,11 +766,10 @@ indexing</description>
       FancyIndexed directory listing into links for sorting. The
       default behavior is for them to be links; selecting the
       column heading will sort the directory listing by the values
-      in that column. <strong>Prior to Apache HTTP Server 2.0.23, this also
-      disabled parsing the Query Arguments for the sort
-      string.</strong> That behavior is now controlled by <a
+      in that column. However, query string arguments which are appended
+      to the URL will still be honored. That behavior is controlled by <a
       href="#indexoptions.ignoreclient"><code>IndexOptions
-      IgnoreClient</code></a> in Apache HTTP Server 2.0.23.</dd>
+      IgnoreClient</code></a>.</dd>
 
       <dt><a name="indexoptions.suppressdescription"
                id="indexoptions.suppressdescription"
@@ -805,8 +804,7 @@ indexing</description>
       put those closing tags in that file.</dd>
 
       <dt><a name="indexoptions.suppressicon"
-               id="indexoptions.suppressicon">SuppressIcon</a> (<em>Apache
HTTP Server
-      2.0.23 and later</em>)</dt>
+               id="indexoptions.suppressicon">SuppressIcon</a></dt>
 
       <dd>This will suppress the icon in fancy indexing listings.
       Combining both <code>SuppressIcon</code> and
@@ -824,7 +822,7 @@ indexing</description>
 
       <dt><a name="indexoptions.suppressrules"
                id="indexoptions.suppressrules">SuppressRules</a>
-      (<em>Apache HTTP Server 2.0.23 and later</em>)</dt>
+      </dt>
 
       <dd>This will suppress the horizontal rule lines (<code>hr</code>
       elements) in directory listings. Combining both <code>SuppressIcon</code>
and
@@ -839,8 +837,7 @@ indexing</description>
       <dd>This will suppress the file size in fancy indexing listings.</dd>
 
       <dt><a name="indexoptions.trackmodified"
-               id="indexoptions.trackmodified">TrackModified</a> (<em>Apache
HTTP Server
-      2.0.23 and later</em>)</dt>
+               id="indexoptions.trackmodified">TrackModified</a></dt>
 
       <dd>This returns the <code>Last-Modified</code> and <code>ETag</code>
       values for the listed directory in the HTTP header. It is only valid
@@ -1078,11 +1075,11 @@ of the index listing</description>
     of the file that will be appended to the end of the index
     listing. <var>Filename</var> is the name of the file to include, and
     is taken to be relative to the location being indexed. If
-    <var>Filename</var> begins with a slash, it will be taken to be
+    <var>Filename</var> begins with a slash, as in example 2, it will be taken
to be
     relative to the <directive module="core">DocumentRoot</directive>.
     </p>
 
-    <example><title>Example</title>
+    <example><title>Example 1</title>
       ReadmeName FOOTER.html
     </example>
 



Mime
View raw message