summaryrefslogtreecommitdiff
path: root/docs/internals
diff options
context:
space:
mode:
Diffstat (limited to 'docs/internals')
-rw-r--r--docs/internals/contributing.txt38
1 files changed, 28 insertions, 10 deletions
diff --git a/docs/internals/contributing.txt b/docs/internals/contributing.txt
index cb2c3ac804..52b52d6f7e 100644
--- a/docs/internals/contributing.txt
+++ b/docs/internals/contributing.txt
@@ -388,21 +388,39 @@ the ticket database:
Submitting and maintaining translations
=======================================
-Various parts of Django, such as the admin site and validator error messages,
+Various parts of Django, such as the admin site and validation error messages,
are internationalized. This means they display different text depending on a
-user's language setting.
+user's language setting. For this, Django uses the same internationalization
+infrastructure that is available to Django applications that is described
+in the :ref:`i18n documentation<topics-i18n>`.
These translations are contributed by Django users worldwide. If you find an
incorrect translation, or if you'd like to add a language that isn't yet
translated, here's what to do:
* Join the `Django i18n mailing list`_ and introduce yourself.
- * Create translations using the methods described in the
- :ref:`i18n documentation <topics-i18n>`.
- * Create a diff of the ``.po`` file against the current Subversion trunk.
- * Make sure that `` django-admin.py compilemessages -l <lang>`` runs without
+
+ * Create translations using the methods described in the :ref:`i18n
+ documentation <topics-i18n>`. For this you will use the ``django-admin.py
+ makemessages`` tool. In this particular case it should be run from the
+ top-level``django`` directory of the Django source tree.
+
+ The script runs over the entire Django source tree and pulls out all
+ strings marked for translation. It creates (or updates) a message file in
+ the directory ``conf/locale`` (for example for ``pt-BR``, the file will be
+ ``conf/locale/pt-br/LC_MESSAGES/django.po``).
+
+ * Make sure that ``django-admin.py compilemessages -l <lang>`` runs without
producing any warnings.
- * Attach the patch to a ticket in Django's ticket system.
+
+ * Repeat the last two steps for the ``djangojs`` domain (by appending the
+ ``-d djangojs`` command line option to the ``django-admin.py``
+ invocations.
+
+ * Create a diff of the ``.po`` file(s) against the current Subversion trunk.
+
+ * Open a ticket in Django's ticket system, set its ``Component`` field to
+ ``Translations``, and attach the patch to it.
.. _Django i18n mailing list: http://groups.google.com/group/django-i18n/
@@ -457,13 +475,13 @@ Template style
brackets and the tag contents.
Do this:
-
+
.. code-block:: html+django
{{ foo }}
Don't do this:
-
+
.. code-block:: html+django
{{foo}}
@@ -743,7 +761,7 @@ You will also need to ensure that your database uses UTF-8 as the default
character set. If your database server doesn't use UTF-8 as a default charset,
you will need to include a value for ``TEST_DATABASE_CHARSET`` in your settings
file.
-
+
If you want to run the full suite of tests, you'll need to install a number of
dependencies: