Module mod_autoindex

The AddAlt directive sets the alternate text to display for automatic directory indexing.

Parameter One: string

• The string parameter is enclosed in double quotes ("..."). This alternate text is displayed if the client is image-incapable or has image loading disabled.

Parameter Two: file

• The file parameter is either ^^DIRECTORY^^ for child directories, ^^PARENT^^ for parent directories, ^^BLANKICON^^ for blank lines (to format the list correctly), a file extension, a wildcard expression, a partial file, or a complete filename. It could also be a QSYS.LIB member type if this directive is being used to set alternate text for QSYS.LIB members. For example:

  AddAlt "IMG" .jpg .gif
  AddAlt " " ^^BLANKICON^^
  AddAlt "BAK" *~ 

The AddAltByEncoding directive sets the alternate text to display for a file, instead of an icon, for automatic directory indexing.

Parameter One: string

• The string parameter is enclosed in double quotes ("..."). This alternate text is displayed if the client is image-incapable or has image loading disabled.

Parameter Two: MIME-encoding

• The MIME-encoding parameter is a valid content-encoding, such as x-compress.

The AddAltByType directive sets the alternate text to display for a file, instead of an icon, for automatic directory indexing.

Parameter One: string

• The string parameter is enclosed in double quotes ("..."). This alternate text is displayed if the client is image-incapable or has image loading disabled.

Parameter Two: MIME-type

• The MIME-type parameter is a valid content-type, such as text/html.

The AddDescription directive sets the description to display for a file, for automatic directory indexing. File is a file extension, partial filename, QSYS.LIB member type, wildcard expression or full filename for files to describe. String is enclosed in double quotes ("). For example:

AddDescription "The planet Mars" /web/pics/mars.gif

By default, the description field is 23 bytes wide. Seven more bytes may be added if the directory is covered by an IndexOptions SuppressSize, and 19 bytes may be added if IndexOptions SuppressLastModified is in effect. The widest this column can be is therefore 49 bytes, unless configured differently using IndexOptions DescriptionMaxWidth.

The DescriptionWidth IndexOptions keyword allows you to adjust this width to any arbitrary size.

The following order of precedence will be used to search for a directory listing file description. The first mechanism from this list that applies will be used to generate the file description:

1. The file matches one of those specified on an AddDescription directive. The string from the directive is displayed. This option is the least CPU intensive.
2. The file system contains a description for the file. The file system description information is displayed. Note that if the file is a QSYS.LIB member, the member text is displayed.
3. If IndexOptions ScanHTMLTitles is configured, the title is extracted from HTML documents for fancy indexing. This is CPU and disk intensive.

The AddIcon directive sets the icon to display next to a file ending in name for automatic directory indexing.

Parameter One: icon

• The icon parameter is either a (%-escape) 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.

Parameter Two: name

• The name parameter is either ^^DIRECTORY^^ for child directories, ^^PARENT^^ for parent directories, ^^BLANKICON^^ for blank lines (to format the list correctly), a file extension, a wildcard expression, a partial file or a complete filename. For example

  AddIcon (IMG,icons/image) .gif .jpg 
  AddIcon (PAR, icons/parent .gif) ^^PARENT^^ 
  AddIcon /dir.gif ^^DIRECTORY^^ 
  AddIcon backup.gif *~ 

AddIconByType should be used in preference to AddIcon, when possible.

The AddIConByEncoding directive sets the icon to display next to files with MIME-encoding for automatic directory indexing.

Parameter One: icon

• The icon parameter is either a (%-escaped) relative URL to the icon or of the format (alttext,url) where alttext is the text tag five for an icon for non-graphical browsers.

Parameter Two: MIME-encoding

• The MIME-encoding parameter is a wildcard expression matching required content-encoding.

The AddIconByType directive sets the icon to display next to files of type 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 non-graphical browsers.

Parameter One: icon

• The icon parameter 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.

Parameter Two: MIME-type

• The MIME-type parameter is a wildcard expression matching the required MIME types.

The DefaultIcon directive sets the icon to display for files when no specific icon is known, for automatic directory indexing.

Parameter: url

• The url parameter 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. For example:

  DefaultIcon (UNK,unknown.gif)

The HeaderName directive sets the name of the file that will be inserted at the top of the index listing.

Parameter: filename

• The filename parameter is the name of the file to include.

Filename is treated as a URI path relative to the one used to access the directory being indexed, and must resolve to a document with a major content type of "text" (for example, text/html, text/plain). 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

Content negotiation will be performed if the MultiViews option is enabled. See Content negotiation for HTTP Server for more information.

If filename resolves to a static text/html document (not a CGI script) and the Includes Option is enabled, the file will be processed for server-side includes. See mod_include for more information.

See also ReadmeName.

IndexHeadInsert "<link rel=\"sitemap\" href=\"/sitemap.html\">"

The IndexHeadInsert directive specifies a string to insert in the <head> section of the HTML generated for the index page.

Parameter: markup

• The markup parameter is a string to be inserted in the <head> section of the HTML generated for the index page. The markup parameter must be enclosed in double quotes ("...").

The IndexIgnore directive adds to the list of files to hide when listing a directory. Multiple IndexIgnore directives add to the list, rather than the replacing the list of ignored files. By default, the dot directory (.) is ignored.

Parameter: file

• The file parameter is a file extension, QSYS.LIB member type, partial filename, wildcard expression or full filename for files to ignore.

The IndexIgnoreReset directive removes any files ignored by IndexIgnore otherwise inherited from other configuration sections.

Parameter: on | off

• When on is specified, any files ignored by IndexIgnore will be reset.
• When off is specified, it inherites from other configuration sections by default.

For example:

<Directory /var/www>
  IndexIgnore *.bak .??* *~ *# HEADER* README* RCS CVS *,v *,t
</Directory>
<Directory /var/www/backups>
  IndexIgnoreReset ON
  IndexIgnore .??* *# HEADER* README* RCS CVS *,v *,t
</Directory>

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.

IndexOrderDefault takes two required arguments and a third optional argument.

Parameter One: ascending | descending

• The ascending and descending parameter indicates the direction of the sort.

Parameter Two: name | date | size | owner | description

• The name, date, size, owner, and description parameter arguments must be used and identifies the primary key. The secondary key is always ascending filename.

Parameter Three: CaseSense | NoCaseSense

• The CaseSense and NoCaseSense parameters are optional third keywords that allow you to choose if the column sort is case sensitive. This keyword is valid if the second keyword is name, owner or description only. If the second keyword is date or size, then this parameter is ignored. The default for keyword is CaseSense.

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.

The IndexStyleSheet directive sets the name of the file that will be used as the CSS for the index listing.

The ReadmeName directive sets the name of the file that will be appended to the end of the index listing.

Parameter: filename

• The filename parameter is the name of the file to include and is taken to be relative to the location being indexed. Details of how its handled may be found under the description of the HeaderName directive, which uses the same mechanism as ReadmeName.