From 6bba1d4ce8f87c69dfb1116a191ff6bcbcfbdb51 Mon Sep 17 00:00:00 2001
From: Andre Malo
Date: Wed, 6 Nov 2002 00:27:17 +0000
Subject: [PATCH] formal changes: - -> - markup improvements - allow
class attribute for
content changes:
- remove the references to apache 1.3 in IndexOptions descriptions
- clarify (prior non-existing) incremental index options example...
git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@97412 13f79535-47bb-0310-9956-ffa450edef68
---
docs/manual/mod/mod_autoindex.xml | 770 +++++++++++++++---------------
docs/manual/style/common.dtd | 1 +
2 files changed, 392 insertions(+), 379 deletions(-)
diff --git a/docs/manual/mod/mod_autoindex.xml b/docs/manual/mod/mod_autoindex.xml
index 9c1c258fe3..6c17d1450e 100644
--- a/docs/manual/mod/mod_autoindex.xml
+++ b/docs/manual/mod/mod_autoindex.xml
@@ -5,8 +5,8 @@
mod_autoindex
Generates directory indexes,
- automatically, similar to the Unix ls command or the
- Win32 dir shell command
+ automatically, similar to the Unix ls
command or the
+ Win32 dir
shell command
Base
mod_autoindex.c
autoindex_module
@@ -59,7 +59,8 @@
they both are shown as "1K".
-Autoindex Request Query Arguments
+
+ Autoindex Request Query Arguments
Apache 2.0.23 reorganized the Query Arguments for Column
Sorting, and introduced an entire group of new query options.
@@ -81,16 +82,14 @@
C=S
sorts the directory by size, then file
name
- C=D
sorts the directory by description, then
- file name
-
+ C=D
sorts the directory by description, then
+ file name
O=A
sorts the listing in Ascending
Order
- O=D
sorts the listing in Descending
- Order
-
+ O=D
sorts the listing in Descending
+ Order
F=0
formats the listing as a simple list
(not FancyIndexed)
@@ -98,26 +97,25 @@
F=1
formats the listing as a FancyIndexed
list
- F=2
formats the listing as an HTMLTable
- FancyIndexed list
-
+ F=2
formats the listing as an
+ HTMLTable FancyIndexed list
V=0
disables version sorting
- V=1
enables version sorting
-
+ V=1
enables version sorting
- P=pattern
lists only files matching
- the given pattern
+ P=pattern
lists only files matching
+ the given pattern
Note that the 'P'attern query argument is tested
- after the usual IndexIgnore directives are processed,
+ after the usual IndexIgnore directives are processed,
and all file names are still subjected to the same criteria as
any other autoindex listing. The Query Arguments parser in
- mod_autoindex will stop abruptly when an unrecognized option is
- encountered. The Query Arguments must be well formed, according
- to the table above.
+ mod_autoindex will stop abruptly when an unrecognized
+ option is encountered. The Query Arguments must be well formed,
+ according to the table above.
The simple example below, which can be clipped and saved in
a header.html file, illustrates these query options. Note that
@@ -125,31 +123,41 @@
to assure the arguments are all parsed before mod_autoindex
encounters the X=Go input.
-
-<form action="" method="get">
- Show me a <select name="F">
- <option value="0"> Plain list</option>
- <option value="1" selected="selected"> Fancy list</option>
- <option value="2"> Table list</option>
- </select>
- Sorted by <select name="C">
- <option value="N" selected="selected"> Name</option>
- <option value="M"> Date Modified</option>
- <option value="S"> Size</option>
- <option value="D"> Description</option>
- </select>
- <select name="O">
- <option value="A" selected="selected"> Ascending</option>
- <option value="D"> Descending</option>
- </select>
- <select name="V">
- <option value="0" selected="selected"> in Normal order</option>
- <option value="1"> in Version order</option>
- </select>
- Matching <input type="text" name="P" value="*" />
- <input type="submit" name="X" value="Go" />
-</form>
-
+
+ <form action="" method="get">
+
+ Show me a <select name="F">
+
+ <option value="0"> Plain list</option>
+ <option value="1" selected="selected"> Fancy list</option>
+ <option value="2"> Table list</option>
+
+ </select>
+ Sorted by <select name="C">
+
+ <option value="N" selected="selected"> Name</option>
+ <option value="M"> Date Modified</option>
+ <option value="S"> Size</option>
+ <option value="D"> Description</option>
+
+ </select>
+ <select name="O">
+
+ <option value="A" selected="selected"> Ascending</option>
+ <option value="D"> Descending</option>
+
+ </select>
+ <select name="V">
+
+ <option value="0" selected="selected"> in Normal order</option>
+ <option value="1"> in Version order</option>
+
+ </select>
+ Matching <input type="text" name="P" value="*" />
+ <input type="submit" name="X" value="Go" />
+
+ </form>
+
@@ -157,7 +165,7 @@
AddAlt
Alternate text to display for a file, instead of an
icon selected by filename
-AddAlt string file [file] ...
+AddAlt string file [file] ...
server configvirtual host
directory.htaccess
@@ -167,18 +175,17 @@ icon selected by filename
AddAlt provides the alternate text to
display for a file, instead of an icon, for FancyIndexing
.
- File is a file extension, partial filename, wild-card
+ File is a file extension, partial filename, wild-card
expression or full filename for files to describe.
- If String contains any whitespace, you have to enclose it
+ If String contains any whitespace, you have to enclose it
in quotes ("
or '
). This alternate text
is displayed if the client is image-incapable, has image loading
disabled, or fails to retrieve the icon.
- Examples:
-
- AddAlt "PDF file" *.pdf
- AddAlt Compressed *.gz *.zip *.Z
-
+ Examples
+ AddAlt "PDF file" *.pdf
+ AddAlt Compressed *.gz *.zip *.Z
+
@@ -186,8 +193,8 @@ icon selected by filename
AddAltByEncoding
Alternate text to display for a file instead of an icon
selected by MIME-encoding
-AddAltByEncoding string MIME-encoding
-[MIME-encoding] ...
+AddAltByEncoding string MIME-encoding
+[MIME-encoding] ...
server configvirtual host
directory.htaccess
@@ -197,16 +204,15 @@ selected by MIME-encoding
AddAltByEncoding provides the alternate
text to display for a file, instead of an icon, for FancyIndexing
.
- MIME-encoding is a valid content-encoding, such as
- x-compress
. If String contains any whitespace,
+ MIME-encoding is a valid content-encoding, such as
+ x-compress
. If String contains any whitespace,
you have to enclose it in quotes ("
or '
).
This alternate text is displayed if the client is image-incapable,
has image loading disabled, or fails to retrieve the icon.
- Example:
-
- AddAltByEncoding gzip x-gzip
-
+ Example
+ AddAltByEncoding gzip x-gzip
+
@@ -214,8 +220,8 @@ selected by MIME-encoding
AddAltByType
Alternate text to display for a file, instead of an
icon selected by MIME content-type
-AddAltByType string
- MIME-type [MIME-type] ...
+AddAltByType string MIME-type
+[MIME-type] ...
server configvirtual host
directory.htaccess
@@ -225,24 +231,22 @@ icon selected by MIME content-type
AddAltByType sets the alternate text to
display for a file, instead of an icon, for FancyIndexing
.
- MIME-type is a valid content-type, such as
- text/html
. If String contains any whitespace,
+ MIME-type is a valid content-type, such as
+ text/html
. If String contains any whitespace,
you have to enclose it in quotes ("
or '
).
This alternate text is displayed if the client is image-incapable,
has image loading disabled, or fails to retrieve the icon.
- Example:
-
- AddAltByType 'plain text' text/plain
-
+ Example
+ AddAltByType 'plain text' text/plain
+
AddDescription
Description to display for a file
-AddDescription
- string file [file] ...
+AddDescription string file [file] ...
server configvirtual host
directory.htaccess
@@ -250,46 +254,46 @@ icon selected by MIME content-type
This sets the description to display for a file, for
- FancyIndexing
.
- File is a file extension, partial filename, wild-card
+ FancyIndexing
.
+ File is a file extension, partial filename, wild-card
expression or full filename for files to describe.
- String is enclosed in double quotes ("
).
- Example:
+ String is enclosed in double quotes ("
).
-AddDescription "The planet Mars"
- /web/pics/mars.gif
+ Example
+ AddDescription "The planet Mars" /web/pics/mars.gif
+
The typical, default description field is 23 bytes wide. 6
- more bytes are added by the
- IndexOptions SuppressIcon
option, 7 bytes are
- added by the IndexOptions SuppressSize
- option, and 19 bytes are added by the
- IndexOptions SuppressLastModified
option.
+ more bytes are added by the IndexOptions SuppressIcon
option, 7 bytes are
+ added by the IndexOptions SuppressSize
option, and 19 bytes are
+ added by the IndexOptions SuppressLastModified
option.
Therefore, the widest default the description column is ever
assigned is 55 bytes.
- See the DescriptionWidth
- IndexOptions keyword
- for details on overriding the size of this column, or allowing
- descriptions of unlimited length.
-
-Caution Descriptive text defined with
- AddDescription 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.
-
+ See the DescriptionWidth IndexOptions keyword for details on overriding the size
+ of this column, or allowing descriptions of unlimited length.
+
+ Caution
+ Descriptive text defined with AddDescription
+ 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.
+
AddIcon
Icon to display for a file selected by name
-AddIcon icon
- name [name] ...
+AddIcon icon name [name]
+...
server configvirtual host
directory.htaccess
@@ -297,23 +301,22 @@ icon selected by MIME content-type
This sets the icon to display next to a file ending in
- name for FancyIndexing
.
- Icon is either a (%-escaped) relative URL to the icon,
- or of the format (alttext,url) where
- alttext is the text tag given for an icon for
- non-graphical browsers.
-
- Name is either ^^DIRECTORY^^ for directories,
- ^^BLANKICON^^ for blank lines (to format the list correctly), a
- file extension, a wildcard expression, a partial filename or a
- complete filename. Examples:
-
-
+ name for FancyIndexing
. Icon is either a (%-escaped)
+ relative URL to the icon, or of the format
+ (alttext,url)
where alttext
+ is the text tag given for an icon for non-graphical browsers.
+
+ Name is either ^^DIRECTORY^^
for directories,
+ ^^BLANKICON^^
for blank lines (to format the list
+ correctly), a file extension, a wildcard expression, a partial
+ filename or a complete filename.
+
+ Examples
AddIcon (IMG,/icons/image.xbm) .gif .jpg .xbm
- AddIcon /icons/dir.xbm ^^DIRECTORY^^
- AddIcon /icons/backup.xbm *~
-
+ AddIcon /icons/dir.xbm ^^DIRECTORY^^
+ AddIcon /icons/backup.xbm *~
+
AddIconByType
should be used in preference to AddIcon,
@@ -325,8 +328,8 @@ icon selected by MIME content-type
AddIconByEncoding
Icon to display next to files selected by MIME
content-encoding
-AddIconByEncoding
- icon MIME-encoding [MIME-encoding] ...
+AddIconByEncoding icon MIME-encoding
+[MIME-encoding] ...
server configvirtual host
directory.htaccess
@@ -335,15 +338,17 @@ content-encoding
This sets the icon to display next to files with FancyIndexing
.
- Icon is either a (%-escaped) relative URL to the icon,
- or of the format (alttext,url) where
- alttext is the text tag given for an icon for
+ Icon is either a (%-escaped) relative URL to the icon,
+ or of the format (alttext,url)
+ where alttext is the text tag given for an icon for
non-graphical browsers.
- Mime-encoding is a wildcard expression matching
- required the content-encoding. Examples:
+ MIME-encoding is a wildcard expression matching
+ required the content-encoding.
-AddIconByEncoding /icons/compress.xbm x-compress
+ Example
+ AddIconByEncoding /icons/compress.xbm x-compress
+
@@ -351,8 +356,8 @@ content-encoding
AddIconByType
Icon to display next to files selected by MIME
content-type
-AddIconByType
- icon MIME-type [MIME-type] ...
+AddIconByType icon MIME-type
+[MIME-type] ...
server configvirtual host
directory.htaccess
@@ -360,17 +365,19 @@ content-type
This sets the icon to display next to files of type
- MIME-type for MIME-type for FancyIndexing
.
- Icon is either a (%-escaped) relative URL to the icon,
- or of the format (alttext,url) where
- alttext is the text tag given for an icon for
+ Icon is either a (%-escaped) relative URL to the icon,
+ or of the format (alttext,url)
+ where alttext is the text tag given for an icon for
non-graphical browsers.
- Mime-type is a wildcard expression matching
- required the mime types. Examples:
+ MIME-type is a wildcard expression matching
+ required the mime types.
-AddIconByType (IMG,/icons/image.xbm) image/*
+ Example
+ AddIconByType (IMG,/icons/image.xbm) image/*
+
@@ -378,7 +385,7 @@ content-type
DefaultIcon
Icon to display for files when no specific icon is
configured
-DefaultIcon url-path
+DefaultIcon url-path
server configvirtual host
directory.htaccess
@@ -388,9 +395,11 @@ configured
The DefaultIcon directive sets the icon
to display for files when no specific icon is known, for FancyIndexing
.
- Url-path is a (%-escaped) relative URL to the icon.
- Examples:
-DefaultIcon /icon/unknown.xbm
+ Url-path is a (%-escaped) relative URL to the icon.
+
+ Example
+ DefaultIcon /icon/unknown.xbm
+
@@ -398,7 +407,7 @@ configured
HeaderName
Name of the file that will be inserted at the top
of the index listing
-HeaderName filename
+HeaderName filename
server configvirtual host
directory.htaccess
@@ -407,47 +416,48 @@ of the index listing
The HeaderName directive sets the name
of the file that will be inserted at the top of the index
- listing. Filename is the name of the file to include.
+ listing. Filename is the name of the file to include.
Example
- HeaderName HEADER.html
+ HeaderName HEADER.html
-
+
Both HeaderName and ReadmeName now treat
- Filename as a URI path relative to the one used to
- access the directory being indexed. If Filename begins
+ Filename as a URI path relative to the one used to
+ access the directory being indexed. If Filename begins
with a slash, it will be taken to be relative to the DocumentRoot.
Example
- HeaderName /include/HEADER.html
+ HeaderName /include/HEADER.html
- Filename must
- resolve to a document with a major content type of
- "text/*
" (e.g., text/html
,
- text/plain
, etc.). This means that
- filename may refer to a CGI script if the script's
+
Filename must resolve to a document with a major
+ content type of text/*
(e.g.,
+ text/html
, text/plain
, etc.). This means
+ that filename may refer to a CGI script if the script's
actual file type (as opposed to its output) is marked as
text/html
such as with a directive like:
-
- AddType text/html .cgi
-
+
+
+ AddType text/html .cgi
+
+
Content negotiation
will be performed if Options
- MultiViews
is in effect. If filename resolves
+ MultiViews
is in effect. If filename resolves
to a static text/html
document (not a CGI script) and
either one of the options
Includes
or IncludesNOEXEC
is enabled,
the file will be processed for server-side includes (see the
mod_include documentation).
-
+
If the file specified by HeaderName contains
- the beginnings of an HTML document (<HTML>, <HEAD>,
- etc) then you will probably want to set IndexOptions
+SuppressHTMLPreamble
, so that these tags are not
repeated.
@@ -458,7 +468,7 @@ of the index listing
IndexIgnore
Adds to the list of files to hide when listing
a directory
-IndexIgnore file [file] ...
+IndexIgnore file [file] ...
server configvirtual host
directory.htaccess
@@ -466,14 +476,16 @@ a directory
The IndexIgnore directive adds to the
- list of files to hide when listing a directory. File is a
+ list of files to hide when listing a directory. File is a
file extension, partial filename, wildcard expression or full
filename for files to ignore. Multiple IndexIgnore directives add
to the list, rather than the replacing the list of ignored
- files. By default, the list contains
- `.
'. Example:
+ files. By default, the list contains .
(the current
+ directory).
-IndexIgnore README .htaccess *~
+
+ IndexIgnore README .htaccess *~
+
@@ -481,7 +493,8 @@ a directory
IndexOptions
Various configuration settings for directory
indexing
-IndexOptions [+|-]option [[+|-]option] ...
+IndexOptions [+|-]option [[+|-]option]
+...
server configvirtual host
directory.htaccess
@@ -489,23 +502,24 @@ indexing
The IndexOptions directive specifies the
- behavior of the directory indexing. Option can be one
+ behavior of the directory indexing. Option can be one
of
- - DescriptionWidth=[n
- | *] (Apache 1.3.10 or 2.0.23 and later)
+ - DescriptionWidth=[n | *] (Apache 2.0.23 and
+ later)
- The
DescriptionWidth
keyword allows you to
specify the width of the description column in
characters.
-DescriptionWidth
(or unset) allows
- mod_autoindex to calculate the best width.
+ mod_autoindex to calculate the best width.
- DescriptionWidth=n
fixes the column width to
- n bytes wide.
+ DescriptionWidth=n
fixes the column width to
+ n bytes wide.
DescriptionWidth=*
grows the column to the
width necessary to accommodate the longest description
@@ -515,15 +529,14 @@ indexing
module="mod_autoindex">AddDescription for dangers
inherent in truncating descriptions.
- - FancyIndexing
+ - FancyIndexing
- -
- This turns on fancy indexing of directories.
+ - This turns on fancy indexing of directories.
- - FoldersFirst (Apache
- 1.3.10 or 2.0.23 and later)
+ - FoldersFirst (Apache
+ 2.0.23 and later)
- If this option is enabled, subdirectory listings will
always appear first, followed by normal files in the
@@ -535,97 +548,89 @@ indexing
Zed
will be listed before subdirectory
Beta
, which will be listed before normal files
Gamma
and Alpha
. This option
- only has an effect if FancyIndexing
- is also enabled.
+ only has an effect if FancyIndexing
is also enabled.
- - HTMLTable (Experimental,
- Apache 2.0.23 and later)
+ - HTMLTable (Experimental,
+ Apache 2.0.23 and later)
- -
- This experimental option with FancyIndexing constructs a
+
- This experimental option with FancyIndexing constructs a
simple table for the fancy directory listing. Note this will
confuse older browsers. It is particularly necessary if file
names or description text will alternate between
left-to-right and right-to-left reading order, as can happen
on WinNT or other utf-8 enabled platforms.
- - IconsAreLinks
+ - IconsAreLinks
- -
- This makes the icons part of the anchor for the filename, for
+
- This makes the icons part of the anchor for the filename, for
fancy indexing.
- - IconHeight[=pixels]
- (Apache 1.3 and later)
+ - IconHeight[=pixels]
- -
- Presence of this option, when used with IconWidth, will cause
- the server to include
HEIGHT
and
- WIDTH
attributes in the IMG
tag for
- the file 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
+ - Presence of this option, when used with IconWidth, will cause
+ the server to include
height
and width
+ attributes in the img
tag for the file 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
software.
- - IconWidth[=pixels] (Apache
- 1.3 and later)
+ - IconWidth[=pixels]
- -
- Presence of this option, when used with IconHeight, will
- cause the server to include
HEIGHT
and
- WIDTH
attributes in the IMG
tag for
+ - Presence of this option, when used with
IconHeight
,
+ will cause the server to include height
and
+ width
attributes in the img
tag for
the file 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 width of the icons supplied with the Apache
software.
- - IgnoreClient
+ - IgnoreClient
- -
- This option causes mod_autoindex to ignore all query
- variables from the client, including sort order (implies
-
SuppressColumnSorting
.)
+ - This option causes mod_autoindex to ignore all
+ query variables from the client, including sort order (implies
+
SuppressColumnSorting
.)
- - NameWidth=[n | *]
- (Apache 1.3.2 and later)
+ - NameWidth=[n
+ | *]
- - The NameWidth keyword allows you to specify the width of
- the filename column in bytes.
+ - The
NameWidth
keyword allows you to specify the width
+ of the filename column in bytes.
- -NameWidth
(or unset) allows mod_autoindex
- to calculate the best width.
+ -NameWidth
(or unset) allows mod_autoindex to calculate the best width.
- NameWidth=n
fixes the column width to n
- bytes wide.
+ NameWidth=n
fixes the column width to
+ n bytes wide.
- NameWidth=*
grows the column to the
- necessary width.
+ NameWidth=*
grows the column to the necessary
+ width.
- - ScanHTMLTitles
+ - ScanHTMLTitles
- -
- This enables the extraction of the title from HTML documents
+
- This enables the extraction of the title from HTML documents
for fancy indexing. If the file does not have a description
- given by AddDescription then
- httpd will read the document for the value of the TITLE tag.
- This is CPU and disk intensive.
+ given by AddDescription
+ then httpd will read the document for the value of the
+ title
element. This is CPU and disk intensive.
- - SuppressColumnSorting
- (Apache 1.3 and later)
+ - SuppressColumnSorting
- -
- If specified, Apache will not make the column headings in a
+
- If specified, Apache will not make the column headings in a
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
@@ -635,84 +640,79 @@ indexing
href="#indexoptions:ignoreclient">IndexOptions
IgnoreClient in Apache 2.0.23.
- - SuppressDescription
+ - SuppressDescription
- -
- This will suppress the file description in fancy indexing
+
- 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
AddDescription
for
- information about setting the file description. See also the
- DescriptionWidth
- index option to limit the size of the description
- column.
-
- - SuppressHTMLPreamble
- (Apache 1.3 and later)
-
- -
- If the directory actually contains a file specified by the
+ space to use for something else. See AddDescription for information about setting the file
+ description. See also the
DescriptionWidth
+ index option to limit the size of the description column.
+
+ - SuppressHTMLPreamble
+
+ - If the directory actually contains a file specified by the
HeaderName
directive, the module usually includes the contents of the file
- after a standard HTML preamble (<HTML>, <HEAD>,
- et cetera). 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.
-
- - SuppressIcon (Apache
+ after a standard HTML preamble (
<html>
,
+ <head>
, et cetera). 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.
+
+ - SuppressIcon (Apache
2.0.23 and later)
- -
- This will suppress the icon in fancy indexing listings.
- Combining both SuppressIcon and
- SuppressRules yields proper HTML 3.2 output, which
- by the final specification prohibits IMG and HR tags from the
- PRE block (used to format FancyIndexed listings.)
+ - This will suppress the icon in fancy indexing listings.
+ Combining both
SuppressIcon
and
+ SuppressRules
yields proper HTML 3.2 output, which
+ by the final specification prohibits img
and
+ hr
elements from the pre
block (used to
+ format FancyIndexed listings.)
- - SuppressLastModified
+ - SuppressLastModified
- -
- This will suppress the display of the last modification date,
+
- This will suppress the display of the last modification date,
in fancy indexing listings.
- - SuppressRules
+
- SuppressRules
(Apache 2.0.23 and later)
- -
- This will suppress the horizontal rule lines (HR tags) in
- directory listings. Combining both SuppressIcon and
- SuppressRules yeilds proper HTML 3.2 output, which
- by the final specification prohibits IMG and HR tags from the
- PRE block (used to format FancyIndexed listings.)
+ - This will suppress the horizontal rule lines (
hr
+ elements) in directory listings. Combining both SuppressIcon
and
+ SuppressRules
yields proper HTML 3.2 output, which
+ by the final specification prohibits img
and
+ hr
elements from the pre
block (used to
+ format FancyIndexed listings.)
- - SuppressSize
+ - SuppressSize
- -
- This will suppress the file size in fancy indexing
- listings.
+ - This will suppress the file size in fancy indexing listings.
- - TrackModified (Apache
- 1.3.15 or 2.0.23 and later)
+ - TrackModified (Apache
+ 2.0.23 and later)
- -
- This returns the Last-Modified and ETag values for the listed
+
- This returns the Last-Modified and ETag values for the listed
directory in the HTTP header. It is only valid if the
operating system and file system return appropriate stat()
results. Some Unix systems do so, as do OS2's JFS and Win32's
NTFS volumes. OS2 and Win32 FAT volumes, for example, do not.
Once this feature is enabled, the client or proxy can track
- changes to the list of files when they perform a HEAD
+ changes to the list of files when they perform a
HEAD
request. Note some operating systems correctly track new and
removed files, but do not track changes for sizes or dates of
the files within the directory. Changes to the size
@@ -720,88 +720,100 @@ indexing
Last-Modified header on all Unix platforms. If this
is a concern, leave this option disabled.
- - VersionSort (Apache 2.0a3
- and later)
-
- -
- The VersionSort keyword causes files containing version
- numbers to sort in a natural way. Strings are sorted as
- usual, except that substrings of digits in the name and
- description are compared according to their numeric value.
- For example:
-
-
-foo-1.7
-foo-1.7.2
-foo-1.7.12
-foo-1.8.2
-foo-1.8.2a
-foo-1.12
-
- If the number starts with a zero, then it is considered to
- be a fraction:
-
-
-foo-1.001
-foo-1.002
-foo-1.030
-foo-1.04
-
-
+ - VersionSort
+ (Apache 2.0a3 and later)
+
+ - The
VersionSort
keyword causes files containing
+ version numbers to sort in a natural way. Strings are sorted as
+ usual, except that substrings of digits in the name and
+ description are compared according to their numeric value.
+
+ Example:
+ foo-1.7
+ foo-1.7.2
+ foo-1.7.12
+ foo-1.8.2
+ foo-1.8.2a
+ foo-1.12
+
- -
- Incremental IndexOptions
-
+ If the number starts with a zero, then it is considered to
+ be a fraction:
- -
- Apache 1.3.3 introduced some significant changes in the
- handling of IndexOptions directives. In
- particular,
-
-
-
-
- - Multiple IndexOptions directives for a
- single directory are now merged together. The result of
- the example above will now be the equivalent of
-
IndexOptions FancyIndexing ScanHTMLTitles
.
-
- - The addition of the incremental syntax
- (i.e., prefixing keywords with '+' or '-').
-
-
- Whenever a '+' or '-' prefixed keyword is encountered, it
- is applied to the current IndexOptions
- settings (which may have been inherited from an upper-level
- directory). However, whenever an unprefixed keyword is
- processed, it clears all inherited options and any
- incremental settings encountered so far. Consider the
- following example:
-
-IndexOptions +ScanHTMLTitles -IconsAreLinks
- FancyIndexing
- IndexOptions +SuppressSize
-
- The net effect is equivalent to
- IndexOptions FancyIndexing +SuppressSize
,
- because the unprefixed FancyIndexing
discarded
- the incremental keywords before it, but allowed them to
- start accumulating again afterward.
-
- To unconditionally set the IndexOptions for a
- particular directory, clearing the inherited settings,
- specify keywords without any '+' or '-' prefixes.
+
+ foo-1.001
+ foo-1.002
+ foo-1.030
+ foo-1.04
+
+
+
+ - Incremental IndexOptions
+ -
+
Apache 1.3.3 introduced some significant changes in the
+ handling of IndexOptions directives. In
+ particular:
+
+
+
+ Whenever a '+' or '-' prefixed keyword is encountered, it
+ is applied to the current IndexOptions
+ settings (which may have been inherited from an upper-level
+ directory). However, whenever an unprefixed keyword is processed, it
+ clears all inherited options and any incremental settings encountered
+ so far. Consider the following example:
+
+
+ IndexOptions +ScanHTMLTitles -IconsAreLinks FancyIndexing
+ IndexOptions +SuppressSize
+
+
+ The net effect is equivalent to IndexOptions FancyIndexing
+ +SuppressSize
, because the unprefixed FancyIndexing
+ discarded the incremental keywords before it, but allowed them to
+ start accumulating again afterward.
+
+ To unconditionally set the IndexOptions for
+ a particular directory, clearing the inherited settings, specify
+ keywords without any +
or -
prefixes.
+
+
IndexOrderDefault
Sets the default ordering of the directory index
-IndexOrderDefault
-Ascending|Descending Name|Date|Size|Description
+IndexOrderDefault Ascending|Descending
+Name|Date|Size|Description
IndexOrderDefault Ascending Name
server configvirtual host
directory.htaccess
@@ -810,12 +822,11 @@ Ascending|Descending Name|Date|Size|Description
The IndexOrderDefault directive is used
- in combination with the FancyIndexing
- index option. By default, fancyindexed directory listings are
- displayed in ascending order by filename; the
- IndexOrderDefault allows you to change this initial
- display order.
+ in combination with the FancyIndexing
index option. By default, fancyindexed
+ directory listings are displayed in ascending order by filename; the
+ IndexOrderDefault allows you to change this
+ initial display order.
IndexOrderDefault takes two
arguments. The first must be either Ascending
or
@@ -826,10 +837,11 @@ Ascending|Descending Name|Date|Size|Description
always the ascending filename.
You can force a directory listing to only be displayed in a
- particular order by combining this directive with the SuppressColumnSorting
- index option; this will prevent the client from requesting the
- directory listing in a different order.
+ particular order by combining this directive with the SuppressColumnSorting
index option; this will prevent
+ the client from requesting the directory listing in a different
+ order.
@@ -837,7 +849,7 @@ Ascending|Descending Name|Date|Size|Description
ReadmeName
Name of the file that will be inserted at the end
of the index listing
-ReadmeName filename
+ReadmeName filename
server configvirtual host
directory.htaccess
@@ -846,23 +858,23 @@ of the index listing
The ReadmeName directive sets the name
of the file that will be appended to the end of the index
- listing. Filename is the name of the file to include, and
+ listing. Filename is the name of the file to include, and
is taken to be relative to the location being indexed. If
- Filename begins with a slash, it will be taken to be
+ Filename begins with a slash, it will be taken to be
relative to the DocumentRoot.
Example
- ReadmeName FOOTER.html
+ ReadmeName FOOTER.html
Example 2
- ReadmeName /include/FOOTER.html
+ ReadmeName /include/FOOTER.html
- See also HeaderName, where this behavior
- is described in greater detail.
+ See also HeaderName, where this behavior is described in greater
+ detail.
diff --git a/docs/manual/style/common.dtd b/docs/manual/style/common.dtd
index ef957064d4..e5a5ead1fd 100644
--- a/docs/manual/style/common.dtd
+++ b/docs/manual/style/common.dtd
@@ -106,6 +106,7 @@
+
--
2.40.0