summaryrefslogtreecommitdiff
path: root/docs/narr/i18n.rst
diff options
context:
space:
mode:
authorChris McDonough <chrism@plope.com>2011-01-27 23:06:55 -0500
committerChris McDonough <chrism@plope.com>2011-01-27 23:06:55 -0500
commit70acd25f40f32fc6cbb3b5d38a695b8982b52a31 (patch)
treeecaee199a36054a3664c39a7955cb441aaf6503d /docs/narr/i18n.rst
parent45c45f3ba6b688c988957056cb2c49883329dfe5 (diff)
downloadpyramid-70acd25f40f32fc6cbb3b5d38a695b8982b52a31.tar.gz
pyramid-70acd25f40f32fc6cbb3b5d38a695b8982b52a31.tar.bz2
pyramid-70acd25f40f32fc6cbb3b5d38a695b8982b52a31.zip
module name contractions
Diffstat (limited to 'docs/narr/i18n.rst')
-rw-r--r--docs/narr/i18n.rst45
1 files changed, 22 insertions, 23 deletions
diff --git a/docs/narr/i18n.rst b/docs/narr/i18n.rst
index 7bfd29631..9a43e8772 100644
--- a/docs/narr/i18n.rst
+++ b/docs/narr/i18n.rst
@@ -59,7 +59,7 @@ This creates a Unicode-like object that is a TranslationString.
:term:`Django` i18n, using a TranslationString is a lot like using
"lazy" versions of related gettext APIs.
-The first argument to :class:`pyramid.i18n.TranslationString` is
+The first argument to :class:`~pyramid.i18n.TranslationString` is
the ``msgid``; it is required. It represents the key into the
translation mappings provided by a particular localization. The
``msgid`` argument must be a Unicode object or an ASCII string. The
@@ -139,7 +139,7 @@ Using the ``TranslationStringFactory`` Class
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Another way to generate a translation string is to use the
-:attr:`pyramid.i18n.TranslationStringFactory` object. This object
+:attr:`~pyramid.i18n.TranslationStringFactory` object. This object
is a *translation string factory*. Basically a translation string
factory presets the ``domain`` value of any :term:`translation string`
generated by using it. For example:
@@ -156,11 +156,11 @@ generated by using it. For example:
file generation tools.
After assigning ``_`` to the result of a
-:func:`pyramid.i18n.TranslationStringFactory`, the subsequent result
-of calling ``_`` will be a :class:`pyramid.i18n.TranslationString`
+:func:`~pyramid.i18n.TranslationStringFactory`, the subsequent result
+of calling ``_`` will be a :class:`~pyramid.i18n.TranslationString`
instance. Even though a ``domain`` value was not passed to ``_`` (as
would have been necessary if the
-:class:`pyramid.i18n.TranslationString` constructor were used instead
+:class:`~pyramid.i18n.TranslationString` constructor were used instead
of a translation string factory), the ``domain`` attribute of the
resulting translation string will be ``pyramid``. As a result, the
previous code example is completely equivalent (except for spelling)
@@ -175,7 +175,7 @@ to:
You can set up your own translation string factory much like the one
provided above by using the
-:class:`pyramid.i18n.TranslationStringFactory` class. For example,
+:class:`~pyramid.i18n.TranslationStringFactory` class. For example,
if you'd like to create a translation string factory which presets the
``domain`` value of generated translation strings to ``form``, you'd
do something like this:
@@ -491,13 +491,12 @@ translations will be available to :app:`Pyramid`.
Using a Localizer
-----------------
-A :term:`localizer` is an object that allows you to perform
-translation or pluralization "by hand" in an application. You may use
-the :func:`pyramid.i18n.get_localizer` function to obtain a
-:term:`localizer`. :func:`pyramid.i18n.get_localizer`. This
-function will return either the localizer object implied by the active
-:term:`locale negotiator` or a default localizer object if no explicit
-locale negotiator is registered.
+A :term:`localizer` is an object that allows you to perform translation or
+pluralization "by hand" in an application. You may use the
+:func:`pyramid.i18n.get_localizer` function to obtain a :term:`localizer`.
+This function will return either the localizer object implied by the active
+:term:`locale negotiator` or a default localizer object if no explicit locale
+negotiator is registered.
.. code-block:: python
:linenos:
@@ -534,7 +533,7 @@ translation in a view component of an application might look like so:
translated = localizer.translate(ts) # translation string
# ... use translated ...
-The :func:`pyramid.i18n.get_localizer` function will return a
+The :func:`~pyramid.i18n.get_localizer` function will return a
:class:`pyramid.i18n.Localizer` object bound to the locale name
represented by the request. The translation returned from its
:meth:`pyramid.i18n.Localizer.translate` method will depend on the
@@ -612,9 +611,9 @@ locale negotiator returns ``None``. You can change the default locale
name by changing the ``default_locale_name`` setting; see
:ref:`default_locale_name_setting`.
-Once :func:`pyramid.i18n.get_locale_name` is first run, the locale
+Once :func:`~pyramid.i18n.get_locale_name` is first run, the locale
name is stored on the request object. Subsequent calls to
-:func:`pyramid.i18n.get_locale_name` will return the stored locale
+:func:`~pyramid.i18n.get_locale_name` will return the stored locale
name without invoking the :term:`locale negotiator`. To avoid this
caching, you can use the :func:`pyramid.i18n.negotiate_locale_name`
function:
@@ -641,7 +640,7 @@ You can also obtain the locale name related to a request using the
Obtaining the locale name as an attribute of a localizer is equivalent
to obtaining a locale name by calling the
-:func:`pyramid.i18n.get_locale_name` function.
+:func:`~pyramid.i18n.get_locale_name` function.
.. index::
single: date and currency formatting (i18n)
@@ -753,7 +752,7 @@ Localization-Related Deployment Settings
A :app:`Pyramid` application will have a ``default_locale_name``
setting. This value represents the :term:`default locale name` used
when the :term:`locale negotiator` returns ``None``. Pass it to the
-:mod:`pyramid.config.Configurator` constructor at startup
+:mod:`~pyramid.config.Configurator` constructor at startup
time:
.. code-block:: python
@@ -891,7 +890,7 @@ application startup. For example:
'another.application:locale/')
A message catalog in a translation directory added via
-:meth:`pyramid.config.Configurator.add_translation_dirs`
+:meth:`~pyramid.config.Configurator.add_translation_dirs`
will be merged into translations from a message catalog added earlier
if both translation directories contain translations for the same
locale and :term:`translation domain`.
@@ -937,8 +936,8 @@ a particular request. A locale negotiator is a bit of code which
accepts a request and which returns a :term:`locale name`. It is
consulted when :meth:`pyramid.i18n.Localizer.translate` or
:meth:`pyramid.i18n.Localizer.pluralize` is invoked. It is also
-consulted when :func:`pyramid.i18n.get_locale_name` or
-:func:`pyramid.i18n.negotiate_locale_name` is invoked.
+consulted when :func:`~pyramid.i18n.get_locale_name` or
+:func:`~pyramid.i18n.negotiate_locale_name` is invoked.
.. _default_locale_negotiator:
@@ -949,7 +948,7 @@ Most applications can make use of the default locale negotiator, which
requires no additional coding or configuration.
The default locale negotiator implementation named
-:class:`pyramid.i18n.default_locale_negotiator` uses the following
+:class:`~pyramid.i18n.default_locale_negotiator` uses the following
set of steps to dermine the locale name.
- First, the negotiator looks for the ``_LOCALE_`` attribute of the
@@ -1000,7 +999,7 @@ You may add your newly created locale negotiator to your application's
configuration by passing an object which can act as the negotiator (or a
:term:`dotted Python name` referring to the object) as the
``locale_negotiator`` argument of the
-:class:`pyramid.config.Configurator` instance during application
+:class:`~pyramid.config.Configurator` instance during application
startup. For example:
.. code-block:: python