From c101c845587a02afeb591620c95d10fb7a428796 Mon Sep 17 00:00:00 2001
From: Kevin Chabowski <kevin@kch42.de>
Date: Sat, 3 Mar 2012 20:19:53 +0100
Subject: Initial commit.

---
 help.html | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 help.html

(limited to 'help.html')

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>
-- 
cgit v1.2.3-70-g09d2