[sword-svn] r2382 - trunk/doc

[scribe at crosswire.org]

Author: scribe
Date: 2009-05-05 13:53:14 -0700 (Tue, 05 May 2009)
New Revision: 2382

Modified:
   trunk/doc/translation-template.conf
Log:
Updated locale template


Modified: trunk/doc/translation-template.conf
===================================================================
--- trunk/doc/translation-template.conf	2009-05-05 00:48:31 UTC (rev 2381)
+++ trunk/doc/translation-template.conf	2009-05-05 20:53:14 UTC (rev 2382)
@@ -1,7 +1,20 @@
+# Enter a comment here like:
+# Farsi also known as Persian
+# Provided by Peter Von Kaehne
+# 5 December 2006
+
 [Meta]
-Name=<insert here abrevation of language, e.g. de, no, it, fr etc.. Delete this commant>
-Description=<insert here name of language. Delete this comment.>
 
+# Enter here the appropriate locale code, e.g. de, no, it, fr etc..
+Name=
+
+# Enter a string here to present to a user for choosing this locale, e.g. Farsi
+Description=
+
+# The encoding of your locale (usually, UTF-8)
+Encoding=UTF-8
+
+
 [Text]
 
 # Insert after the = characters the translated booknames.
@@ -74,6 +87,7 @@
 Revelation of John=
 
 #Apocr
+
 I Esdras=
 II Esdras=
 Tobit=
@@ -102,7 +116,7 @@
 #
 # They must be in what ICU will return as UPPERCASE
 # for your language.  They must also include AT LEAST one
-# entry for each entry above which is EXACTLY your translation
+# entry for each entry from above which is EXACTLY your translation
 # converted to uppercase. e.g., if, above, you translated:
 #
 # Revelation of John=Rev of J
@@ -122,16 +136,19 @@
 # matched (specific details follow later), so you will already have,
 # most likely, some abbreviation capability.
 #
-# try it out by copying your locale.conf file to your SWORD locales.d/
+# Try it out by copying your locale.conf file to your SWORD locales.d/
 # folder where things are installed on your computer (NOT the locales.d/
 # folder in the sword source tree), then running:
 #
 # sword/tests/parsekey "<verseRef in your language>" <your_locale_name>
 #
+# This command (above) will also do a basic sanity check of your locale
+# so look for errors on first run.
+#
 # Add more abbreviations as you see fit, and keep testing with the
 # above simple test command.
 #
-# After adding all know abbrevs, you'll want to tune
+# After adding all known abbrevs, you'll want to tune
 # the parsing logic for ambiguities.
 #
 # Tuning works as follows: