aboutsummaryrefslogtreecommitdiff
path: root/help.html
diff options
context:
space:
mode:
authorKevin Chabowski <kevin@kch42.de>2012-03-03 20:19:53 +0100
committerKevin Chabowski <kevin@kch42.de>2012-03-03 20:19:53 +0100
commitc101c845587a02afeb591620c95d10fb7a428796 (patch)
tree70d4d1cd9b455cab676eeec8aac3dcc874a0231c /help.html
downloadcustom_translation-c101c845587a02afeb591620c95d10fb7a428796.tar.gz
custom_translation-c101c845587a02afeb591620c95d10fb7a428796.tar.bz2
custom_translation-c101c845587a02afeb591620c95d10fb7a428796.zip
Initial commit.
Diffstat (limited to 'help.html')
-rw-r--r--help.html28
1 files changed, 28 insertions, 0 deletions
diff --git a/help.html b/help.html
new file mode 100644
index 0000000..a482772
--- /dev/null
+++ b/help.html
@@ -0,0 +1,28 @@
+<h2>custom_translation</h2>
+
+<p>Your own translations, so you can easilly internationalize your templates!</p>
+
+<p>custom_translation gives you an STE tag called <code>&lt;ste:custom_translation /&gt;</code> to include translations to your plugin and a plugin page in the backend where you can set your translations.</p>
+
+<h3>Usage of the STE Tag</h3>
+
+<code>&lt;ste:custom_translation /&gt;</code> is a self-closing tag and uses these parameters:
+
+<table class="listtab">
+ <thead>
+ <tr>
+ <th>Parameter</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><code>for</code></td>
+ <td>The translation key to lookup.</td>
+ </tr>
+ <tr>
+ <td><code>raw</code></td>
+ <td>If not empty, it will return the raw translation, otherwise it will be already HTML escaped.</td>
+ </tr>
+ </tbody>
+</table>