swerc

commit c4f2b509b1ddfc09a507dd63f2207dbc3f52ce24
parent ec3eff0e3515c6ab7e823d6ded8924ee43434339
Author: uriel@soma <unknown>
Date:   Thu,  5 Feb 2009 03:02:10 +0000

Expand documentation in werc website.
Diffstat:
M
sites/werc.cat-v.org/docs/config_options.md
 | 
43
+++++++++++++++++++++++++++++++++++++++++++
M
sites/werc.cat-v.org/docs/rc_template_lang.md
 | 
33
+++++++++++++++++++++++++++++++--

2 files changed, 74 insertions(+), 2 deletions(-)
diff --git a/sites/werc.cat-v.org/docs/config_options.md b/sites/werc.cat-v.org/docs/config_options.md
@@ -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/.
+
+
+
diff --git a/sites/werc.cat-v.org/docs/rc_template_lang.md b/sites/werc.cat-v.org/docs/rc_template_lang.md
@@ -1,5 +1,5 @@
-Rc template language
-====================
+The Rc Template Language
+========================
 
 Implemented by Kris, thanks!
 
@@ -10,3 +10,32 @@ Basic syntax:
 * To 'inline' the value of an environment variable use `%($my_var%)`
 
 That is basically it!
+
+
+Examples
+--------
+
+Loops
+
+    <ul>
+    % for(i in a b c) {
+    %   echo '<li>'$i'</li>'
+    % }
+    </uL>
+ 
+Is equivalent to: 
+
+    <ul>
+    % for(i in a b c) {
+    <li>%($i%)</li>
+    % }
+    </uL>
+
+and results in this output:
+
+    <ul>
+    <li>a</li>
+    <li>b</li>
+    <li>c</li>
+    </ul>
+