<li>Otherwise, a listing generated by the server. The other
directives control the format of this listing. The <code class="directive"><a href="#addicon">AddIcon</a></code>, <code class="directive"><a href="#addiconbyencoding">AddIconByEncoding</a></code> and
<code class="directive"><a href="#addiconbytype">AddIconByType</a></code> are
used to set a list of icons to display for various file types;
for each file listed, the first icon listed that matches the
<p>The two functions are separated so that you can completely
remove (or replace) automatic index generation should you want
to.</p>
<p>Automatic index generation is enabled with using
<code>Options +Indexes</code>. See the
<code class="directive"><a href="../mod/core.html#options">Options</a></code> directive for
more details.</p>
<p>If the <code><a href="#indexoptions.fancyindexing">FancyIndexing</a></code> option is given with the <code class="directive"><a href="#indexoptions">IndexOptions</a></code> directive,
the column headers are links that control the order of the
display. If you select a header link, the listing will be
regenerated, sorted by the values in that column. Selecting the
same header repeatedly toggles between ascending and descending
order. These column header links are suppressed with
<var>File</var> is a file extension, partial filename, wild-card
expression or full filename for files to describe.
<var>String</var> is enclosed in double quotes (<code>"</code>).</p>
<div class="example"><h3>Example</h3><p><code>
AddDescription "The planet Mars" /web/pics/mars.gif
</code></p></div>
<p>The typical, default description field is 23 bytes wide. 6
more bytes are added by the <code><a href="#indexoptions.suppressicon">IndexOptions SuppressIcon</a></code> option, 7 bytes are
added by the <code><a href="#indexoptions.suppresssize">IndexOptions SuppressSize</a></code> option, and 19 bytes are
added by the <code><a href="#indexoptions.suppresslastmodified">IndexOptions SuppressLastModified</a></code> option.
Therefore, the widest default the description column is ever
assigned is 55 bytes.</p>
<p>See the <a href="#indexoptions.descriptionwidth">DescriptionWidth</a> <code class="directive"><a href="#indexoptions">IndexOptions</a></code> keyword for details on overriding the size
of this column, or allowing descriptions of unlimited length.</p>
<div class="note"><h3>Caution</h3>
<p>Descriptive text defined with <code class="directive">AddDescription</code>
may contain HTML markup, such as tags and character entities. If the
width of the description column should happen to truncate a tagged
element (such as cutting off the end of a bolded phrase), the
results may affect the rest of the directory listing.</p>
<dd>The <code>NameWidth</code> keyword allows you to specify the width
of the filename column in bytes.</dd>
<dd><code>-NameWidth</code> (or unset) allows <code class="module"><a href="../mod/mod_autoindex.html">mod_autoindex</a></code> to calculate the best width.</dd>
<dd><code>NameWidth=<var>n</var></code> fixes the column width to
<var>n</var> bytes wide.</dd>
<dd><code>NameWidth=*</code> grows the column to the necessary
<dd>This will suppress the file description in fancy indexing
listings. By default, no file descriptions are defined, and
so the use of this option will regain 23 characters of screen
space to use for something else. See <code class="directive"><a href="#adddescription">AddDescription</a></code> 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>
<p>The <code class="directive">IndexOrderDefault</code> directive is used
in combination with the <code><a href="#indexoptions.fancyindexing">FancyIndexing</a></code> index option. By default, fancyindexed
directory listings are displayed in ascending order by filename; the
<code class="directive">IndexOrderDefault</code> allows you to change this
initial display order.</p>
<p><code class="directive">IndexOrderDefault</code> takes two
arguments. The first must be either <code>Ascending</code> or
<code>Descending</code>, indicating the direction of the sort.
The second argument must be one of the keywords <code>Name</code>,
<code>Date</code>, <code>Size</code>, or <code>Description</code>,
and identifies the primary key. The secondary key is
<em>always</em> the ascending filename.</p>
<p>You can force a directory listing to only be displayed in a
particular order by combining this directive with the <code><a href="#indexoptions.suppresscolumnsorting">SuppressColumnSorting</a></code> index option; this will prevent
the client from requesting the directory listing in a different
<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. <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
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 class="bottomlang">
<p><span>Available Languages: </span><a href="../en/mod/mod_autoindex.html" title="English"> en </a> |
<a href="../ja/mod/mod_autoindex.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> |
<a href="../ko/mod/mod_autoindex.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p>
</div><div id="footer">
<p class="apache">Copyright 2007 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
