Add translations section to developer guide

369e1ac8 · Bob Mottram · 6b635054 · 369e1ac8 · 369e1ac8
Commit 369e1ac8 authored 6 years ago by Bob Mottram
--- a/doc/EN/devguide.org
+++ b/doc/EN/devguide.org
@@ -136,6 +136,16 @@ Then run the administrator control panel and you should see the new app within *

 Submit your working app to *https://code.freedombone.net/bashrc/freedombone/issues*, create a pull request or if you don't have an account there you can send patches via email to bob@freedombone.net.

+* Translations
+These can be added or edited within the web UI. Navigate to http://freedombone/admin or its onion address, select *settings* then *language*. Select the language that you want to translate to then the *translate* button. In the right hand column you can then manually edit the translated strings. When you are done select the *update* button.
+
+The format of the translation files is very simple. It's:
+
+#+BEGIN_SRC bash
+English string|Translated string
+#+END_SRC
+
+If you prefer to edit the raw files within your own editor of choice they can be found within the *webadmin/translations* directory of the repo.
 * Customising mesh images
 If you want to make your own specially branded version of the mesh images, such as for a particular event, then to change the default desktop backgrounds edit the images within *img/backgrounds* and to change the available avatars and desktop icons edit the images within *img/avatars*. Re-create disk images using the instructions shown previously.


--- a/website/EN/devguide.html
+++ b/website/EN/devguide.html
@@ -4,7 +4,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
 <head>
 <title>Freedombone</title>
-<!-- 2018-09-13 Thu 23:20 -->
+<!-- 2018-09-26 Wed 20:35 -->
 <meta  http-equiv="Content-Type" content="text/html;charset=utf-8" />
 <meta  name="generator" content="Org-mode" />
 <meta  name="author" content="Bob Mottram" />
@@ -371,9 +371,31 @@ Submit your working app to <b><a href="https://code.freedombone.net/bashrc/freed
 </div>

 <div id="outline-container-sec-6" class="outline-2">
-<h2 id="sec-6">Customising mesh images</h2>
+<h2 id="sec-6">Translations</h2>
 <div class="outline-text-2" id="text-6">
 <p>
+These can be added or edited within the web UI. Navigate to <a href="http://freedombone/admin">http://freedombone/admin</a> or its onion address, select <b>settings</b> then <b>language</b>. Select the language that you want to translate to then the <b>translate</b> button. In the right hand column you can then manually edit the translated strings. When you are done select the <b>update</b> button.
+</p>
+
+<p>
+The format of the translation files is very simple. It's:
+</p>
+
+<div class="org-src-container">
+
+<pre class="src src-bash">English string|Translated string
+</pre>
+</div>
+
+<p>
+If you prefer to edit the raw files within your own editor of choice they can be found within the <b>webadmin/translations</b> directory of the repo.
+</p>
+</div>
+</div>
+<div id="outline-container-sec-7" class="outline-2">
+<h2 id="sec-7">Customising mesh images</h2>
+<div class="outline-text-2" id="text-7">
+<p>
 If you want to make your own specially branded version of the mesh images, such as for a particular event, then to change the default desktop backgrounds edit the images within <b>img/backgrounds</b> and to change the available avatars and desktop icons edit the images within <b>img/avatars</b>. Re-create disk images using the instructions shown previously.
 </p>