Expand documentation in werc website.

This commit is contained in:
Uriel 2009-02-05 03:02:10 +00:00
parent 272c9901d0
commit 3f8988a1f8
2 changed files with 74 additions and 2 deletions

View file

@ -0,0 +1,43 @@
Werc Configuration Options
==========================
Titles and metadata
-------------------
Variables:
* Page title:
* siteTitle
* siteSubTitle
* Html header meta tags:
* meta_description
* meta_keywords
* extraHeaders - Raw extra headers.
Sidebar and navigation
----------------------
Variables:
* sideBarNavTitle
Functions:
* `conf_hide_paths [paths_patterns ...]` - Hide the given patterns from navigation menu, sitemap and dir listing (do *not* depend on this for securty!).
Http control
------------
Variables:
* extraHttpHeaders - Raw HTTP headers to be added to response.
Functions:
* `conf_perm_redirect [pattern] destination` - If pattern is provided, match it against the requested url, and replace the match with `destination`; ie., *s/pattern/destination/.