Basic HTML documentation generation
[hcoop/domtool2.git] / lib / mod_autoindex.dtl
CommitLineData
9d7fa346
AC
1{{Support for Apache's mod_autoindex, which generates pretty default directory
2 index pages}}
3
4extern val addDescription : string -> [no_spaces] -> [^Vhost];
5{{See <a href="http://httpd.apache.org/docs/2.0/mod/mod_autoindex.html#adddescription">the
6 Apache documentation</a> for <tt>AddDescription</tt>.}}
7
8extern type autoindex_width;
9{{A setting for how wide some column should be}}
10extern val autofit : autoindex_width;
11extern val characters : int -> autoindex_width;
12
13extern type autoindex_option;
14{{See <a href="http://httpd.apache.org/docs/2.0/mod/mod_autoindex.html#indexoptions">the
15 Apache documentation</a> for what the options mean.}}
16
17extern val descriptionWidth : autoindex_width -> autoindex_option;
18extern val fancyIndexing : autoindex_option;
19extern val foldersFirst : autoindex_option;
20extern val htmlTable : autoindex_option;
21extern val iconsAreLinks : autoindex_option;
22extern val iconHeight : int -> autoindex_option;
23extern val iconWidth : int -> autoindex_option;
24extern val ignoreCase : autoindex_option;
25extern val ignoreClient : autoindex_option;
26extern val nameWidth : autoindex_width -> autoindex_option;
27extern val scanHtmlTitles : autoindex_option;
28extern val suppressColumnSorting : autoindex_option;
29extern val suppressDescription : autoindex_option;
30extern val suppressHtmlPreamble : autoindex_option;
31extern val suppressIcon : autoindex_option;
32extern val suppressLastModified : autoindex_option;
33extern val suppressRules : autoindex_option;
34extern val suppressSize : autoindex_option;
35extern val trackModified : autoindex_option;
36extern val versionSort : autoindex_option;
37extern val xhtml : autoindex_option;
38
39extern val indexOptions : [autoindex_option] -> [^Vhost];
40{{Declare exactly the set of options in effect for the current scope.}}
41
42extern val set_indexOptions : [autoindex_option] -> [^Vhost];
43extern val unset_indexOptions : [autoindex_option] -> [^Vhost];
44{{Specify some options to be set or unset, leaving the rest as they are.}}
45
46extern val headerName : no_spaces -> [^Vhost];
47{{See <a href="http://httpd.apache.org/docs/2.0/mod/mod_autoindex.html#headername">the
48 Apache documentation</a>.}}
49
50extern val readmeName : no_spaces -> [^Vhost];
51{{See <a href="http://httpd.apache.org/docs/2.0/mod/mod_autoindex.html#readmename">the
52 Apache documentation</a>.}}