# HG changeset patch
# User jbe
# Date 1503282497 -7200
# Node ID bb1f3e7c65d11fe93300cbe76985251ef5e94629
# Parent  696d7e5f2bcb29f8f3fd01e0081a7ff31cb9d626
Added section on Internationalization/Localization to WebMCP's documentation

diff -r 696d7e5f2bcb -r bb1f3e7c65d1 doc/autodoc-header.htmlpart
--- a/doc/autodoc-header.htmlpart	Mon Aug 21 03:58:33 2017 +0200
+++ b/doc/autodoc-header.htmlpart	Mon Aug 21 04:28:17 2017 +0200
@@ -292,6 +292,18 @@
       <li><tt>&lt;!-- WEBMCP SLOT </tt><i>slot_name</i><tt> --&gt;</tt> gets, if the slot is not empty, replaced with a <tt>&lt;div&gt;</tt> element (with the <tt>id</tt> attribute set to "<tt>slot_</tt><i>slotname</i>") that contains the slot's content.</li>
       <li><tt>&lt;!-- WEBMCP SLOTNODIV </tt><i>slot_name</i><tt> --&gt;</tt> gets replaced with the slot's content (without wrapping it in an additional <tt>&lt;div&gt;</tt> element).</li>
     </ul>
+    <h2>Internationalization/Localization</h2>
+    <p>
+      To translate certain strings in your application, simply use the <a href="#_">underscore function</a>. A language can be selected with <tt><a href="#locale.set">locale.set</a>{lang = "code"}</tt> where <tt>code</tt> is a language code. The translations for strings are expected to be contained in files "<tt>locale/translations.</tt><i>language_code</i><tt>.lua</tt>". These files should return a table that maps strings to their corresponding translation:
+    </p>
+    <pre>
+return{
+["Are you sure?"] = "Bist Du sicher?";
+["User '#{name}' created"] = "Benutzer '#{name}' created";
+}</pre>
+    <p>
+      Such translation files can be automatically created with the <tt>langtool.lua</tt> program, found in the framework's <tt>bin/</tt> directory.
+    </p>
     <h2>Directory structure of a WebMCP application</h2>
     Summarizing information from the previous section, we get the following directory structure for a WebMCP application:
     <ul>