From c4b942db91224945df78c2d3b50576fcf8510a4a Mon Sep 17 00:00:00 2001
From: Graeme Geldenhuys <graemeg@gmail.com>
Date: Wed, 18 Aug 2010 20:41:47 +0200
Subject: fpg_constants docs update

---
 docs/xml/corelib/fpg_constants.xml | 40 ++++++++++++++++++++++++++++++++++----
 1 file changed, 36 insertions(+), 4 deletions(-)

(limited to 'docs')

diff --git a/docs/xml/corelib/fpg_constants.xml b/docs/xml/corelib/fpg_constants.xml
index e02dd9c7..3f66acbe 100644
--- a/docs/xml/corelib/fpg_constants.xml
+++ b/docs/xml/corelib/fpg_constants.xml
@@ -6,11 +6,21 @@
 <short>All constants used in fpGUI are defined here</short>
 <descr><p><printshort id="fpg_constants"/>. All the text constants defined here,
 are also the ones that get translated to multiple languages. Currently fpGUI
-and translations for: Afrikaans, German, English (default), Spanish, French,
-Italian, Portuguese (Brazil) and Russian.</p>
+has translations for:</p>
+<ul>
+<li>Afrikaans</li>
+<li>German</li>
+<li>English (default language - but is user selectable)</li>
+<li>Spanish</li>
+<li>French</li>
+<li>Italian</li>
+<li>Portuguese (Brazilian)</li>
+<li>Russian</li>
+</ul>
 <p>To change the default (compiled in) language used by fpGUI, simply enabled
-one of the language DEFINES in the interface section of the fpg_constants unit.
-</p>
+one of the language DEFINES in the interface section of the fpg_constants unit.</p>
+<p>For more details on changing the default language of fpGUI Toolkit, see the topic
+"<link id="fpg_constants.ChangingDefaultLanguage">Changing the default language</link>".</p>
 </descr>
       <element name="fpgAddColon">
         <short>A utility function to add a colon at the correct location in a string</short>
@@ -26,6 +36,28 @@ one of the language DEFINES in the interface section of the fpg_constants unit.
       <element name="DOUBLECLICK_DISTANCE">
         <short>Maximum distance a mouse pointer can move between two left-clicks and still trigger a double click event</short>
       </element>
+      
+<topic name="ChangingDefaultLanguage">
+<short>Changing the default language</short>
+<descr><p>Inside the <var>fpg_constants.pas</var> unit there are a few commented language
+defines. If no language specific Define is set, then fpGUI defaults to the English
+language. So say you want to change the default language to German, simply uncomment
+the <b>de</b> define, and recompile fpGUI.
+</p>
+<p>Here is a list of current supported languages and their commented defines as they
+appear in the <var>fpg_constants</var> unit.</p>
+<code>
+{.$DEFINE de}     // German
+{.$DEFINE ru}     // Russian
+{.$DEFINE fr}     // French
+{.$DEFINE pt}     // Portuguese (Brazil)
+{.$DEFINE af}     // Afrikaans
+{.$DEFINE it}     // Italian
+{.$DEFINE es}     // Spanish
+</code>
+</descr>
+</topic>    
+      
     </module>
   </package>
 </fpdoc-descriptions>
-- 
cgit v1.2.3-54-g00ecf