[iar#176] Update documentation for JavaScript translations

ckan/plugins/interfaces.py

@@ -1547,6 +1547,9 @@ def abort(self, status_code, detail, headers, comment):
 
 
 class ITranslation(Interface):
+    u'''
+    Allows extensions to provide their own translation strings.
+    '''
     def i18n_directory(self):
         u'''Change the directory of the .mo translation files'''
 

doc/contributing/string-i18n.rst

@@ -277,19 +277,18 @@ placeholders and constructing plural forms. Note that you should not call
 .. note::
 
     CKAN's JavaScript code automatically downloads the appropriate translations
-    at request time from the CKAN server. The corresponding translation files
-    are generated beforehand using ``paster trans js``. During development you
-    need to run that command manually if you're updating JavaScript
-    translations::
+    at request time from the CKAN server. Since CKAN 2.7 the corresponding
+    translation files are regenerated automatically if necessary when CKAN
+    starts.
+
+    You can also regenerate the translation files manually using ``paster trans
+    js``::
 
         python setup.py extract_messages  # Extract translatable strings
         # Update .po files as desired
         python setup.py compile_catalog   # Compile .mo files for Python/Jinja
         paster trans js                   # Compile JavaScript catalogs
 
-    Also note that extensions currently `cannot provide translations for
-    JS strings <https://github.com/ckan/ideas-and-roadmap/issues/176>`_.
-
 -------------------------------------------------
 General guidelines for internationalizing strings
 -------------------------------------------------

doc/extensions/translating-extensions.rst

@@ -30,6 +30,12 @@ containing:
 This template provides a sample string that we will internationalize in this
 tutorial.
 
+.. note::
+
+    While this tutorial only covers Python/Jinja templates it is also possible
+    (since CKAN 2.7) to :ref:`translate strings in an extension's JavaScript
+    modules <javascript_i18n>`.
+
 ---------------
 Extract strings
 ---------------
@@ -164,12 +170,3 @@ implement the ``ITranslation`` interface yourself.
    ~ckan.plugins.interfaces.ITranslation.i18n_locales
    ~ckan.plugins.interfaces.ITranslation.i18n_domain
 
-----------
-JavaScript
-----------
-Extensions currently `cannot provide their own translations for JavaScript
-strings <https://github.com/ckan/ideas-and-roadmap/issues/176>`_.
-
-However, they can re-use existing JavaScript translations from CKAN. See
-:ref:`javascript_i18n` for details.
-

doc/maintaining/paster.rst

@@ -504,9 +504,15 @@ trans: Translation helper functions
 
 Usage::
 
-    trans js      - generate the javascript translations
+    trans js      - generate the JavaScript translations
     trans mangle  - mangle the zh_TW translations for testing
 
+.. note::
+
+    Since version 2.7 the JavaScript translation files are automatically
+    regenerated if necessary when CKAN is started. Hence you usually do not
+    need to run ``paster trans js`` manually.
+
 
 .. _paster-user: