From f17312771ec3f08f00e6b8023d4df5f14f5b32c1 Mon Sep 17 00:00:00 2001 From: Austin King Date: Fri, 14 Jan 2011 14:38:29 -0800 Subject: [PATCH] Adding L10n docs --- docs/index.rst | 1 + docs/l10n_setup.rst | 34 ++++++++++++++++++++++++++++++++++ docs/libs.rst | 2 ++ 3 files changed, 37 insertions(+) create mode 100644 docs/l10n_setup.rst diff --git a/docs/index.rst b/docs/index.rst index b6ad6160..336cc35a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -29,6 +29,7 @@ Contents gettingstarted libs + l10n_setup Indices and tables diff --git a/docs/l10n_setup.rst b/docs/l10n_setup.rst new file mode 100644 index 00000000..6946654b --- /dev/null +++ b/docs/l10n_setup.rst @@ -0,0 +1,34 @@ +L10n Setup +========== + +So you'd like to localize your webapp. **Congratulations!** + +Playdoh comes with all of the libraries and tools you need +in the dev and production requirements. + +Steps +----- + +The following steps will get you started: + +#. Create a SVN reposity based on MDN_ locale directory. + This will give you a README.txt, compile-mo.sh, and + show you the proper directory layout. +#. Compile the po files and mirror the SVN repository in a + git repository via a cron job that runs every 15 minutes. + Example: (TBD) + /home/fwenzel/bin/autol10n/autol10n.sh +#. Add your git repo as an external to this project + It should create a locale directory at the top level +#. Read locale/README.txt for a better understanding of + what Django management commands are used to extract and + merge strings into your po files. It has instructions + for adding more locales. + +Q&A +--- +Why SVN? Our localizers like to use either SVN or Verbatim. + +Why a git repo to mirror an SVN repo? This allows us to have an external reference and update easily. + +.. _MDN: http://svn.mozilla.org/projects/mdn/trunk/locale/ diff --git a/docs/libs.rst b/docs/libs.rst index 42b1c0d1..41d69e13 100644 --- a/docs/libs.rst +++ b/docs/libs.rst @@ -39,6 +39,8 @@ Internationalization (i18n) and Localization (L10n) * `tower `_\*: A library that builds on Babel and Jinja2 to make extracting strings easy and uniform. +* `The Translate toolkit `_: + Tools for working between translation formats. Middleware ----------