From a326ae995260c45cb1f86137a99dbe97239bed44 Mon Sep 17 00:00:00 2001 From: michael Date: Mon, 10 May 2004 15:55:19 +0000 Subject: [PATCH] Type: Documentation. Description: First draft i18n doc. --- docs/i18n.txt | 56 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 56 insertions(+), 0 deletions(-) create mode 100644 docs/i18n.txt diff --git a/docs/i18n.txt b/docs/i18n.txt new file mode 100644 index 0000000..0a1bc0a --- /dev/null +++ b/docs/i18n.txt @@ -0,0 +1,56 @@ +KnowledgeTree Internationalisation (i18n) +----------------------------------------- + +Overview +-------- +Support for i18n has been added to the KnowledgeTree- however, we are not in a position to +begin translating the KnowledgeTree until all the text and graphics in the application are marked for translation. +This is a mammoth task that will require the support and aid of the KnowledgeTree community :) + +Requirements +------------ + +i18n requires gettext (http://www.gnu.org/software/gettext) and the gettext php module to work +(see http://php.net/gettext for installation instructions). + +Completed Tasks and Implementation Details +------------------------------------------ + +- i18n//LC_MESSAGES + /graphics + +- gettext support loaded if php module available + +- dashboard and document browse view i18n'd + +***TODO**** +- checks the browser's Accept-Language header and uses that language (if there is a translation for it) + + +The TODO List +------------- + +The rest of the KnowledgeTree needs to be i18n'd. +Here are some guidelines for adding gettext support to the KnowledgeTree. + +- find translatable strings and wrap literals with _() + eg. change: + + to: + _("Checked Out Documents") +- if strings are concatenated with dynamic content use sprintf + eg. +- add ordering to sprintf parameters- use single quotes so slashes aren't escaped in the .po files + eg. + sprintf(_('Hi %1$s, welcome back to the %2$s DMS, part of the Knowledge Tree') + +Testing +------- +- install gettext command line utilities +- run xgettext to generate .po files +- write a test translation +- use msgfmt to compile your translated file +- change the default language and verify + - you may have to specify the complete locale ie _ + +$Id$ \ No newline at end of file -- libgit2 0.21.4