Some comments and documentation.

This commit is contained in:
Lars Jung 2011-07-04 16:26:35 +02:00
parent 3e6197d2fc
commit d599425452
3 changed files with 20 additions and 6 deletions

View file

@ -24,9 +24,9 @@ Everything you need is located in folder `target`.
* Copy folder `h5ai` to the web-root directory of your server or alternativly set an alias `/h5ai/` to
this folder.
* Add the content of file `dot.htaccess` to the `.htaccess` file inside the directory
you want to be styled (you might have to create this file). This directory and any subdirectories will be
styled by h5ai.
* Add the content of file `dot.htaccess` to the `.htaccess` file inside the directory you want to be
styled (you might have to create this file). This directory and any subdirectories will be styled by h5ai.
* Adjust `options.js` inside the `h5ai` folder to your needs. Defaults will be fine for a start.
Optionally add `h5ai.header.html` and/or `h5ai.footer.html` files to any of the styled folders to [display
custom top or bottom sections](http://larsjung.de/h5ai/sample/customize). The content of those files
@ -52,6 +52,8 @@ please respect their rights.
* refactored js
* added basic options support
* commented options.js
* optional tree sidebar
### v0.5.2

View file

@ -21,7 +21,13 @@ h5aiOptions = {
/*
* Associative array of folders and their HTTP status codes to
* avoid HEAD requests to that folders.
* avoid HEAD requests to that folders. The key (folder) must start
* and end with a slash (/).
* For example:
* "/some/folder/": 200
* will always return HTTP status 200 (OK), which will be interpreted
* as a non auto indexed folder, that means a folder containing an
* appropriate default index file.
*/
folderStatus: {
/*

View file

@ -17,11 +17,17 @@ h5aiOptions = {
* to the folders, and therefore will invoke index.php scripts. Use
* folderStatus below to avoid such requests.
*/
showTree: false,
showTree: true,
/*
* Associative array of folders and their HTTP status codes to
* avoid HEAD requests to that folders.
* avoid HEAD requests to that folders. The key (folder) must start
* and end with a slash (/).
* For example:
* "/some/folder/": 200
* will always return HTTP status 200 (OK), which will be interpreted
* as a non auto indexed folder, that means a folder containing an
* appropriate default index file.
*/
folderStatus: {
/*