From 7534bae0c5eeb34a0146e76a81a9312797f6ba5c Mon Sep 17 00:00:00 2001
From: Chris McDonough <chrism@agendaless.com>
Date: Sun, 25 Apr 2010 00:02:12 +0000
Subject: Merge i18n branch via svn merge --ignore-ancestry -r9030:9150
 $REPOZE_SVN/repoze.bfg/branches/i18n

No foreigners were harmed in the coding of this feature.
---
 docs/zcml/localenegotiator.rst | 41 ++++++++++++++++++++++++++
 docs/zcml/translationdir.rst   | 66 ++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 107 insertions(+)
 create mode 100644 docs/zcml/localenegotiator.rst
 create mode 100644 docs/zcml/translationdir.rst

(limited to 'docs/zcml')

diff --git a/docs/zcml/localenegotiator.rst b/docs/zcml/localenegotiator.rst
new file mode 100644
index 000000000..59dcf32c2
--- /dev/null
+++ b/docs/zcml/localenegotiator.rst
@@ -0,0 +1,41 @@
+.. _localenegotiator_directive:
+
+``localenegotiator``
+--------------------
+
+Set the :term:`locale negotiator` for the current configurator to
+support localization of text.
+
+.. note:  This ZCML directive is new as of :mod:`repoze.bfg` version 1.3.
+
+Attributes
+~~~~~~~~~~
+
+``negotiator``
+
+  The :term:`dotted Python name` to a :term:`locale negotiator`
+  implementation.  This attribute is required.  If it begins with a
+  dot (``.``), the name will be considered relative to the directory
+  in which the ZCML file which contains this directive lives.
+
+Example
+~~~~~~~
+
+.. code-block:: xml
+   :linenos:
+
+   <localenegotiator
+     negotiator="some.package.module.my_locale_negotiator"
+     />
+
+Alternatives
+~~~~~~~~~~~~
+
+Use :meth:`repoze.bfg.configuration.Configurator.set_locale_negotiator`
+method instance during initial application setup.
+
+See Also
+~~~~~~~~
+
+See also :ref:`activating_translation`.
+
diff --git a/docs/zcml/translationdir.rst b/docs/zcml/translationdir.rst
new file mode 100644
index 000000000..5c69cb737
--- /dev/null
+++ b/docs/zcml/translationdir.rst
@@ -0,0 +1,66 @@
+.. _translationdir_directive:
+
+``translationdir``
+------------------
+
+Add a :term:`gettext` :term:`translation directory` to the current
+configuration for use in localization of text.
+
+.. note:  This ZCML directive is new as of :mod:`repoze.bfg` version 1.3.
+
+Attributes
+~~~~~~~~~~
+
+``dir``
+  The path to the translation directory.  This path may either be 1)
+  absolute (e.g. ``/foo/bar/baz``) 2) Python-package-relative
+  (e.g. ``packagename:foo/bar/baz``) or 3) relative to the package
+  directory in which the ZCML file which contains the directive
+  (e.g. ``foo/bar/baz``).
+
+Example 1
+~~~~~~~~~
+
+.. code-block:: xml
+   :linenos:
+
+   <!-- relative to configure.zcml file -->
+
+   <translationdir
+     dir="locale"
+     />
+
+Example 2
+~~~~~~~~~
+
+.. code-block:: xml
+   :linenos:
+
+   <!-- relative to another package -->
+
+   <translationdir
+     dir="another.package:locale"
+     />
+
+Example 3
+~~~~~~~~~
+
+.. code-block:: xml
+   :linenos:
+
+   <!-- an absolute directory name -->
+
+   <translationdir
+     dir="/usr/share/locale"
+     />
+
+Alternatives
+~~~~~~~~~~~~
+
+Use :meth:`repoze.bfg.configuration.Configurator.add_translation_dirs`
+method instance during initial application setup.
+
+See Also
+~~~~~~~~
+
+See also :ref:`activating_translation`.
-- 
cgit v1.2.3