cvs commit: apache/htdocs/manual/mod mod_autoindex.html

[Rodent of Unusual Size]

coar        97/07/15 08:57:29

  Modified:    htdocs/manual/mod  mod_autoindex.html
  Log:
        Add documentation for IndexOptions SuppressHTMLPreamble (and
        alphabetise the options list, too).
  
  Revision  Changes    Path
  1.11      +37 -24    apache/htdocs/manual/mod/mod_autoindex.html
  
  Index: mod_autoindex.html
  ===================================================================
  RCS file: /export/home/cvs/apache/htdocs/manual/mod/mod_autoindex.html,v
  retrieving revision 1.10
  retrieving revision 1.11
  diff -C3 -r1.10 -r1.11
  *** mod_autoindex.html        1997/07/08 19:58:33     1.10
  --- mod_autoindex.html        1997/07/15 15:57:28     1.11
  ***************
  *** 267,296 ****
    <dt>FancyIndexing
    <dd><!--%plaintext &lt;?INDEX {\tt FancyIndexing} index option&gt; -->
    This turns on fancy indexing of directories.
  - <dt>IconsAreLinks
  - <dd>
  - <!--%plaintext &lt;?INDEX {\tt IconsAreLinks} index option&gt; -->
  - This makes the icons part of the anchor for the filename, for
  - fancy indexing.
  - <dt>ScanHTMLTitles
  - <dd><!--%plaintext &lt;?INDEX {\tt ScanHTMLTitles} index option&gt; -->
  - This enables the extraction of the title from HTML documents for fancy
  - indexing. If the file does not have a description given by
  - <A HREF="#adddescription">AddDescription</A> then httpd will read the
  - document for the value of the TITLE tag.  This is CPU and disk intensive.
  - <dt>SuppressLastModified
  - <dd>
  - <!--%plaintext &lt;?INDEX {\tt SuppressLastModified} index option&gt; -->
  - This will suppress the display of the last modification date, in fancy
  - indexing listings.
  - <dt>SuppressSize
  - <dd>
  - <!--%plaintext &lt;?INDEX {\tt SuppressSize} index option&gt; -->
  - This will suppress the file size in fancy indexing listings.
  - <dt>SuppressDescription
  - <dd>
  - <!--%plaintext &lt;?INDEX {\tt SuppressDescription} index option&gt; -->
  - This will suppress the file description in fancy indexing listings.
    <dt>IconHeight[=pixels] (<EM>Apache 1.3 and later</EM>)
    <dd>
    <!--%plaintext &lt;?INDEX {\tt IconHeight} index option&gt; -->
  --- 267,272 ----
  ***************
  *** 301,306 ****
  --- 277,287 ----
    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
    software.
  + <dt>IconsAreLinks
  + <dd>
  + <!--%plaintext &lt;?INDEX {\tt IconsAreLinks} index option&gt; -->
  + This makes the icons part of the anchor for the filename, for
  + fancy indexing.
    <dt>IconWidth[=pixels] (<EM>Apache 1.3 and later</EM>)
    <dd>
    <!--%plaintext &lt;?INDEX {\tt IconWidth} index option&gt; -->
  ***************
  *** 311,316 ****
  --- 292,329 ----
    images have been loaded.  If no value is given for the option, it
    defaults to the standard width of the icons supplied with the Apache
    software.
  + <dt>ScanHTMLTitles
  + <dd><!--%plaintext &lt;?INDEX {\tt ScanHTMLTitles} index option&gt; -->
  + This enables the extraction of the title from HTML documents for fancy
  + indexing. If the file does not have a description given by
  + <A HREF="#adddescription">AddDescription</A> then httpd will read the
  + document for the value of the TITLE tag.  This is CPU and disk intensive.
  + <dt>SuppressDescription
  + <dd>
  + <!--%plaintext &lt;?INDEX {\tt SuppressDescription} index option&gt; -->
  + This will suppress the file description in fancy indexing listings.
  + <dt>SuppressHTMLPreamble
  + <dd>
  + <!--%plaintext &lt;?INDEX {\tt SuppressHTMLPreamble} index option&gt; -->
  + If the directory actually contains a file specified by the
  + <A
  +  HREF="#headername"
  + >HeaderName</A>
  + directive, the module usually includes the contents of the file
  + after a standard HTML preamble (&lt;HTML&gt;, &lt;HEAD&gt;, <EM>et
  + cetera</EM>).  The SuppressHTMLPreamble option disables this behaviour,
  + causing the module to start the display with the header file contents.
  + The header file must contain appropriate HTML instructions in this case.
  + If there is no header file, the preamble is generated as usual.
  + <dt>SuppressLastModified
  + <dd>
  + <!--%plaintext &lt;?INDEX {\tt SuppressLastModified} index option&gt; -->
  + This will suppress the display of the last modification date, in fancy
  + indexing listings.
  + <dt>SuppressSize
  + <dd>
  + <!--%plaintext &lt;?INDEX {\tt SuppressSize} index option&gt; -->
  + This will suppress the file size in fancy indexing listings.
    </dl>
    This default is that no options are enabled. If multiple IndexOptions
    could apply to a directory, then the most specific one is taken complete;