cindex-init (Sun Java System Web Server 7.0 Update 2 Administrator's Configuration File Reference)

Sun Java System Web Server 7.0 Update 2 Administrator's Configuration File Reference

cindex-init

The cindex-init function sets the default settings for common indexing. Common indexing (also known as fancy indexing) is performed by the Service function index-common. Indexing occurs:

When the requested URL translates to a directory that does not contain an index file or home page.
If no index file or home page has been specified.

This function is applicable in Init-class directives. In common (fancy) indexing, the directory list shows the name, last modified date, size, and description of each indexed file or directory.

Parameters

The following table describes the cindex-init parameters.

Table 5–1 cindex-init Parameters


Parameter	Description
`opts`	(Optional) String of letters specifying the options to activate. Currently there is only one possible option: `s` instructs the server to scan each HTML file in the directory that is being indexed for the contents of the HTML `TITLE` tag. The `TITLE` tag must be within the first 255 characters of the file. This option is `off` by default. The search for `TITLE` is not case-sensitive.
`widths`	(Optional) Specifies the width of each column in the indexing display. The string is a comma-separated list of numbers that specify the column widths in characters for name, last-modified date, size, and description respectively. The default value for the widths parameter is `22`, `18`, `8`, and `33`. The final three values (corresponding to last-modified date, size, and description) can each be set to `0` to turn off the display for that column. The name column cannot be turned off. The minimum size of a column (if the value is non-zero) is specified by the length of its title. For example, the minimum size of the date column is `5` (the length of the date plus one space). If you set a non-zero value for a column that is less than the length of its title, the width defaults to the minimum required to display the title.
`timezone`	(Optional) Determines whether the last-modified time is shown in local time or in Greenwich Mean Time. The values are `GMT` or `local`. The default is `local`.
`format`	(Optional) Determines the format of the last modified date. It uses the format specification for the UNIX function `strftime()`. The default is `%d-%b-%Y %H:%M`.
`ignore`	(Optional) Specifies a wildcard pattern for file names that the server should ignore while indexing. By default, file names starting with a period (.) are always ignored. For more information, see Appendix B, Using Wildcard Patterns.
`icon-uri`	(Optional) Specifies the URI prefix the `index-common` function uses when generating URLs for file icons (`.gif` files). By default, it is `/mc-icons/`. If `icon-uri` is different from the default, the `pfx2dir` function in the `NameTrans` directive must be changed so that the server can find these icons.

Example

Init fn="cindex-init" widths="50,1,1,0"
Init fn="cindex-init" ignore="*private*"
Init fn="cindex-init" widths="22,0,0,50"