- Updated documentation.
- Fixed XHTML 1.0 validation by enclosing JS code into a CDATA section.pull/4/head
parent
75e90109e0
commit
2f429b796b
33
README.rst
33
README.rst
|
@ -1,9 +1,24 @@
|
||||||
=========================
|
========================
|
||||||
Nginx_ Fancy Index module
|
Nginx Fancy Index module
|
||||||
=========================
|
========================
|
||||||
|
|
||||||
.. contents::
|
.. contents::
|
||||||
|
|
||||||
|
The Fancy Index module makes possible the generation of file listings, like
|
||||||
|
the built-in `autoindex <http://wiki.codemongers.com/NginxHttpAutoindexModule>`__
|
||||||
|
module does, but adding a touch of style. This is possible because the module
|
||||||
|
module allows a certain degree of customization of the generated content:
|
||||||
|
|
||||||
|
* Custom headers. Either local or stored remotely (*working*).
|
||||||
|
* Custom footers. Either local or stored remotely (*working*).
|
||||||
|
* Insert readme files either at the top or the bottom of listings
|
||||||
|
(*partially working*).
|
||||||
|
* Add you own CSS style rules (*not yet implemented*).
|
||||||
|
|
||||||
|
This module is designed to work with Nginx_, a high performance open source web
|
||||||
|
server written by `Igor Sysoev <http://sysoev.ru>`__.
|
||||||
|
|
||||||
|
|
||||||
Requirements
|
Requirements
|
||||||
============
|
============
|
||||||
* Sources for Nginx_ 0.6.x, and its requirements.
|
* Sources for Nginx_ 0.6.x, and its requirements.
|
||||||
|
@ -40,6 +55,18 @@ Building
|
||||||
5. Configure Nginx_ by using the modules' configuration directives_.
|
5. Configure Nginx_ by using the modules' configuration directives_.
|
||||||
|
|
||||||
|
|
||||||
|
Example
|
||||||
|
=======
|
||||||
|
|
||||||
|
You can test the default built-in style by adding the following lines into
|
||||||
|
a ``server`` section in your Nginx_ configuration file::
|
||||||
|
|
||||||
|
location / {
|
||||||
|
fancyindex on; # Enable fancy indexes.
|
||||||
|
fancyindex_exact_size off; # Output human-readable file sizes.
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
Directives
|
Directives
|
||||||
==========
|
==========
|
||||||
|
|
||||||
|
|
|
@ -45,6 +45,7 @@ static const u_char t01_head1[] = ""
|
||||||
"</style>"
|
"</style>"
|
||||||
"\n"
|
"\n"
|
||||||
"<script type=\"text/javascript\">"
|
"<script type=\"text/javascript\">"
|
||||||
|
"// <![CDATA["
|
||||||
"function ngx_onload(){"
|
"function ngx_onload(){"
|
||||||
"var f=document.getElementById('readme');"
|
"var f=document.getElementById('readme');"
|
||||||
"if(!(f&&f.contentDocument))return;"
|
"if(!(f&&f.contentDocument))return;"
|
||||||
|
@ -52,6 +53,7 @@ static const u_char t01_head1[] = ""
|
||||||
"f.contentDocument.body.style.padding='0';"
|
"f.contentDocument.body.style.padding='0';"
|
||||||
"f.contentDocument.body.style.margin='0';"
|
"f.contentDocument.body.style.margin='0';"
|
||||||
"}"
|
"}"
|
||||||
|
"// ]]>"
|
||||||
"</script>"
|
"</script>"
|
||||||
"\n"
|
"\n"
|
||||||
"<title>Index of "
|
"<title>Index of "
|
||||||
|
|
|
@ -44,6 +44,7 @@
|
||||||
</style>
|
</style>
|
||||||
|
|
||||||
<script type="text/javascript">
|
<script type="text/javascript">
|
||||||
|
// <![CDATA[
|
||||||
function ngx_onload(){
|
function ngx_onload(){
|
||||||
var f=document.getElementById('readme');
|
var f=document.getElementById('readme');
|
||||||
if(!(f&&f.contentDocument))return;
|
if(!(f&&f.contentDocument))return;
|
||||||
|
@ -51,6 +52,7 @@
|
||||||
f.contentDocument.body.style.padding='0';
|
f.contentDocument.body.style.padding='0';
|
||||||
f.contentDocument.body.style.margin='0';
|
f.contentDocument.body.style.margin='0';
|
||||||
}
|
}
|
||||||
|
// ]]>
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
<title>Index of
|
<title>Index of
|
||||||
|
|
Loading…
Reference in New Issue