From: Felix Dörre <felix@dogcraft.de>
Date: Sat, 12 Jul 2014 14:05:55 +0000 (+0200)
Subject: Document the current syntax for Templates.
X-Git-Url: https://code.wpia.club/?p=gigi.git;a=commitdiff_plain;h=9420682debe732ed08b15c6b4de27a3b078c85ba

Document the current syntax for Templates.
---

diff --git a/doc/TemplateSyntax.txt b/doc/TemplateSyntax.txt
new file mode 100644
index 00000000..3b4a07ca
--- /dev/null
+++ b/doc/TemplateSyntax.txt
@@ -0,0 +1,14 @@
+A template is constructed from a charstream. Everything that is not in "<?" to "?>" will be outputted directly. Text in these markers will be interpreted is template scripting syntax. The following strings are valid:
+
+- <?=$variblename?> will output "variablename".
+   if "variablename" is an Outputable output this thing recursively.
+   else turn it into a String (Object.toString()) and output it.
+   
+- <?=_This is free Text.?> will translate "This is free Text." into the users language, (escaped) and output it.
+   
+- <?=s,$var1,$var2,$var3,...,$varn,This %s is, %s free.?>
+  Translate the last string. Output $var1,...,$varn sprintf-ed into the translated string.
+  
+- <? if($variable) { ?>
+  Output/execute the text until "<? } ?>" only if $variable is boolean and true.
+