diff options
Diffstat (limited to 'docs/zcml/localenegotiator.rst')
| -rw-r--r-- | docs/zcml/localenegotiator.rst | 41 |
1 files changed, 41 insertions, 0 deletions
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`. + |