summaryrefslogtreecommitdiff
path: root/locale/README
diff options
context:
space:
mode:
authorBrion Vibber <brion@pobox.com>2010-04-05 13:19:16 -0700
committerBrion Vibber <brion@pobox.com>2010-04-05 13:19:16 -0700
commit3ac3bc32fc48508deab171019e3539ece9bd72ff (patch)
tree9a676ab2ee3cae431386ada59a61283352a65e19 /locale/README
parentdbaa93d1aa92561674a3071e6429b0f708a37cb4 (diff)
Some localization cleanup and doc to aid in customization:
* added locale/en/LC_MESSAGES/statusnet.po to make it easier to start customizing English texts * added notes to locale/README about customizing and how to disable languages you haven't customized * renamed PO templates from *.po to *.pot to match general conventions and reduce confusion for people trying to find which file they're supposed to edit
Diffstat (limited to 'locale/README')
-rw-r--r--locale/README57
1 files changed, 52 insertions, 5 deletions
diff --git a/locale/README b/locale/README
index 25df9ee74..d7d7fa76b 100644
--- a/locale/README
+++ b/locale/README
@@ -1,9 +1,56 @@
Localizations for StatusNet are being maintained through TranslateWiki:
http://translatewiki.net/wiki/Translating:StatusNet
-Note if you are working with a direct git checkout, you will need to build
-the binary .mo files from the .po source files for translations to work
-in the web app.
+Ongoing translation work should be done there to ensure updates are
+integrated into future versions of StatusNet.
-If gettext and GNU make are installed, you can simply run 'make' in this
-directory to build them.
+
+== Building runtime translations ==
+
+If you are working with a direct git checkout or have customized any
+message files, you will need to build binary .mo files from the .po
+source files for translations to work in the web app.
+
+If gettext and GNU make are installed, you can simply run 'make' in the
+main StatusNet directory, and all core and plugin localizations will be
+recompiled.
+
+
+== Customization ==
+
+User interface texts in any language can be customized by editing the
+texts in the .po source files, then rebuilding the binary .mo files
+used at runtime.
+
+The default/US English texts can be overridden by adding "translations"
+to en/LC_MESSAGES/statusnet.po.
+
+Note that texts you change in one language will not affect other
+languages, which are selected based on visitors' browser preferences.
+If you customizations include important information or links,
+you may wish to disable languages that you haven't customized so that
+visitors always get your text.
+
+To disable all non-English languages add this to your config.php (you
+will need to edit both the en and en_GB files):
+
+$config['site']['languages'] = array(
+ 'en-us' => array('q' => 1, 'lang' => 'en', 'name' => 'English (US)', 'direction' => 'ltr'),
+ 'en-gb' => array('q' => 1, 'lang' => 'en_GB', 'name' => 'English (British)', 'direction' => 'ltr'),
+ 'en' => array('q' => 1, 'lang' => 'en', 'name' => 'English (US)', 'direction' => 'ltr'),
+);
+
+
+To disable everything including British English variant:
+
+$config['site']['languages'] = array(
+ 'en' => array('q' => 1, 'lang' => 'en', 'name' => 'English', 'direction' => 'ltr'),
+);
+
+
+== Plugins ==
+
+This locale directory contains translations for the core StatusNet
+software only. Plugins may have their own locale subdirectories and
+their own .po and .mo files as well, so if customizing you may need
+to poke at those as well.