Commit 6a67ad70 authored by Richard Bowen's avatar Richard Bowen
Browse files

Note which indexoptions require fancyindexing. resolves bz56985 


git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/branches/2.4.x@1673893 13f79535-47bb-0310-9956-ffa450edef68
parent af13fb60

docs/manual/mod/mod_autoindex.xml

+47 −13
Changes for docs/manual/mod/mod_autoindex.xml: 47 added lines, 13 removed lines.
Original line number Diff line number Diff line
@@ -635,17 +635,17 @@ indexing</description> 
      specify the width of the description column in

      characters.</dd>



      <dd><code>-DescriptionWidth</code> (or unset) allows

      <module>mod_autoindex</module> to calculate the best width.</dd>

      <dt><code>-DescriptionWidth</code> (or unset) allows

      <module>mod_autoindex</module> to calculate the best width.</dt>



      <dd><code>DescriptionWidth=<var>n</var></code> fixes the column width to

      <var>n</var> bytes wide.</dd>



      <dd><code>DescriptionWidth=*</code> grows the column to the

      width necessary to accommodate the longest description

      string.</dd>

      string.



      <dd><strong>See the section on <directive

      <strong>See the section on <directive

      module="mod_autoindex">AddDescription</directive> for dangers

      inherent in truncating descriptions.</strong></dd>
@@ -666,9 +666,11 @@ indexing</description> 
      <code>FoldersFirst</code> is enabled, subdirectory

      <code>Zed</code> will be listed before subdirectory

      <code>Beta</code>, which will be listed before normal files

      <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>

      <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></dt>
@@ -695,7 +697,13 @@ indexing</description> 
      icon. This allows browser to precalculate the page layout without having

      to wait until all the images have been loaded. If no value is given for

      the option, it defaults to the standard height of the icons supplied

      with the Apache httpd software.</dd>

      with the Apache httpd software.

     

      <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.iconwidth"

               id="indexoptions.iconwidth">IconWidth[=<var
@@ -784,7 +792,12 @@ indexing</description> 
      >AddDescription</directive> for information about setting the file

      description. See also the <code><a

      href="#indexoptions.descriptionwidth">DescriptionWidth</a></code>

      index option to limit the size of the description column.</dd>

      index option to limit the size of the description column.

      

      <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.suppresshtmlpreamble"

               id="indexoptions.suppresshtmlpreamble"
@@ -820,7 +833,12 @@ indexing</description> 
               >SuppressLastModified</a></dt>



      <dd>This will suppress the display of the last modification date,

      in fancy indexing listings.</dd>

      in fancy indexing listings.

      

      <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.suppressrules"

               id="indexoptions.suppressrules">SuppressRules</a>
@@ -831,12 +849,23 @@ indexing</description> 
      <code>SuppressRules</code> yields proper HTML 3.2 output, which

      by the final specification prohibits <code>img</code> and

      <code>hr</code> elements from the <code>pre</code> block (used to

      format FancyIndexed listings.)</dd>

      format FancyIndexed listings.)

      

      <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.suppresssize"

               id="indexoptions.suppresssize">SuppressSize</a></dt>



      <dd>This will suppress the file size in fancy indexing listings.</dd>

      <dd>This will suppress the file size in fancy indexing listings.

      

      <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.trackmodified"

               id="indexoptions.trackmodified">TrackModified</a></dt>
@@ -903,10 +932,15 @@ indexing</description> 
      (<em>Apache HTTP Server 2.0.49 and later</em>)</dt>



      <dd>The <code>XHTML</code> keyword forces <module>mod_autoindex</module>

      to emit XHTML 1.0 code instead of HTML 3.2.</dd>

      to emit XHTML 1.0 code instead of HTML 3.2.

      <strong>This option

      only has an effect if <a href="#indexoptions.fancyindexing"

      ><code>FancyIndexing</code></a> is also enabled.</strong>

      </dd>



    </dl>





   <!--

     XXX: we should consider to allow sections inside <usage>

     this would require some xslt changes...