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