mirror of
https://github.com/pgadmin-org/pgadmin4.git
synced 2025-02-25 18:55:31 -06:00
Translation doc update:
- ...anonymized the language codes (ISO 639-1, $LANG) - ...clarified the "Updating and Merging" description and removed the examples as they were pretty useless in my eyes. Correct me if they had a meaning. - ...anonymized the bash user - ...updated the "New Language" section
This commit is contained in:
Jonas Thelemann
committed by
Dave Page
Dave Page
parent
9f6041b2a7
commit
7deb570b61
@@ -2,37 +2,38 @@
|
|||||||
Translations
|
Translations
|
||||||
************
|
************
|
||||||
|
|
||||||
pgAdmin supports multiple languages using the `Flask-Babel
|
pgAdmin supports multiple languages using the `Flask-Babel
|
||||||
<https://pythonhosted.org/Flask-Babel/>`_ Python module. A list of supported
|
<https://pythonhosted.org/Flask-Babel/>`_ Python module. A list of supported
|
||||||
languages is included in the **web/config.py** configuration file and must be
|
languages is included in the **web/config.py** configuration file and must be
|
||||||
updated whenever langauges are added or removed.
|
updated whenever languages are added or removed with
|
||||||
|
`ISO 639-1 <https://en.wikipedia.org/wiki/ISO_639-1>`_ (two letter) language
|
||||||
|
codes. The codes are named **$LANG** in this document.
|
||||||
|
|
||||||
Translation Marking
|
Translation Marking
|
||||||
===================
|
===================
|
||||||
|
|
||||||
Strings can be marked for translation in either Python code (using **gettext()**)
|
Strings can be marked for translation in either Python code (using **gettext()**)
|
||||||
or Jinja templates (using **_()**). Here are some examples that show how this
|
or Jinja templates (using **_()**). Here are some examples that show how this
|
||||||
is achieved.
|
is achieved.
|
||||||
|
|
||||||
Python::
|
Python::
|
||||||
|
|
||||||
errormsg = gettext('No server group name was specified')
|
errormsg = gettext('No server group name was specified')
|
||||||
|
|
||||||
Jinja:
|
Jinja:
|
||||||
|
|
||||||
.. code-block:: html
|
.. code-block:: html
|
||||||
|
|
||||||
<input type="submit" value="{{ _('Change Password') }}">
|
<input type="submit" value="{{ _('Change Password') }}">
|
||||||
|
|
||||||
.. code-block:: html
|
.. code-block:: html
|
||||||
|
|
||||||
<title>{{ _('%(appname)s Password Change', appname=config.APP_NAME) }}</title>
|
<title>{{ _('%(appname)s Password Change', appname=config.APP_NAME) }}</title>
|
||||||
|
|
||||||
.. code-block:: javascript
|
.. code-block:: javascript
|
||||||
|
|
||||||
define(['sources/gettext', ...], function(gettext, ...){
|
define(['sources/gettext', ...], function(gettext, ...){
|
||||||
...
|
...
|
||||||
|
|
||||||
var alert = alertify.prompt(
|
var alert = alertify.prompt(
|
||||||
gettext('Password Change'),
|
gettext('Password Change'),
|
||||||
gettext('New password for %(userName)s', {userName: 'jsmith' }),
|
gettext('New password for %(userName)s', {userName: 'jsmith' }),
|
||||||
@@ -40,83 +41,34 @@ Jinja:
|
|||||||
)
|
)
|
||||||
})
|
})
|
||||||
|
|
||||||
|
|
||||||
Updating and Merging
|
Updating and Merging
|
||||||
====================
|
====================
|
||||||
|
|
||||||
Whenever new strings are added to the application, the template catalogues
|
Whenever new strings are added to the application, the template catalogue
|
||||||
(**web/pgadmin/messages.pot**) must be updated and the existing catalogues
|
(**web/pgadmin/messages.pot**) and the existing translation
|
||||||
merged with the updated template and compiled. This can be achieved using the
|
catalogues (**web/pgadmin/translations/$LANG/LC_MESSAGES/messages.po**) must be updated
|
||||||
following command from the **web** directory, in the Python virtual environment
|
and compiled. This can be achieved using the following commands from the
|
||||||
used for pgAdmin:
|
**web** directory in the Python virtual environment for pgAdmin:
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
(pgadmin4)piranha:web dpage$ pybabel extract -F babel.cfg -o pgadmin/messages.pot pgadmin
|
(pgadmin4) user$ pybabel extract -F babel.cfg -o pgadmin/messages.pot pgadmin
|
||||||
|
|
||||||
For example:
|
Once the template has been updated it needs to be merged into the existing
|
||||||
|
message catalogues:
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
(pgadmin4)piranha:web dpage$ pybabel extract -F babel.cfg -o pgadmin/messages.pot pgadmin
|
(pgadmin4) user$ pybabel update -i pgadmin/messages.pot -d pgadmin/translations
|
||||||
extracting messages from pgadmin/__init__.py
|
|
||||||
extracting messages from pgadmin/about/__init__.py
|
|
||||||
extracting messages from pgadmin/about/hooks.py
|
|
||||||
extracting messages from pgadmin/about/views.py
|
|
||||||
extracting messages from pgadmin/about/templates/about/index.html (extensions="jinja2.ext.autoescape,jinja2.ext.with_")
|
|
||||||
extracting messages from pgadmin/browser/__init__.py
|
|
||||||
extracting messages from pgadmin/browser/hooks.py
|
|
||||||
extracting messages from pgadmin/browser/views.py
|
|
||||||
extracting messages from pgadmin/browser/nodes/CollectionNode.py
|
|
||||||
extracting messages from pgadmin/browser/nodes/ObjectNode.py
|
|
||||||
extracting messages from pgadmin/browser/nodes/__init__.py
|
|
||||||
extracting messages from pgadmin/browser/nodes/server_groups/__init__.py
|
|
||||||
extracting messages from pgadmin/browser/nodes/server_groups/hooks.py
|
|
||||||
extracting messages from pgadmin/browser/nodes/server_groups/views.py
|
|
||||||
extracting messages from pgadmin/browser/templates/browser/body.html (extensions="jinja2.ext.autoescape,jinja2.ext.with_")
|
|
||||||
extracting messages from pgadmin/browser/templates/browser/index.html (extensions="jinja2.ext.autoescape,jinja2.ext.with_")
|
|
||||||
extracting messages from pgadmin/browser/templates/browser/messages.html (extensions="jinja2.ext.autoescape,jinja2.ext.with_")
|
|
||||||
extracting messages from pgadmin/help/__init__.py
|
|
||||||
extracting messages from pgadmin/help/hooks.py
|
|
||||||
extracting messages from pgadmin/help/views.py
|
|
||||||
extracting messages from pgadmin/redirects/__init__.py
|
|
||||||
extracting messages from pgadmin/redirects/views.py
|
|
||||||
extracting messages from pgadmin/settings/__init__.py
|
|
||||||
extracting messages from pgadmin/settings/hooks.py
|
|
||||||
extracting messages from pgadmin/settings/settings_model.py
|
|
||||||
extracting messages from pgadmin/settings/views.py
|
|
||||||
extracting messages from pgadmin/templates/base.html (extensions="jinja2.ext.autoescape,jinja2.ext.with_")
|
|
||||||
extracting messages from pgadmin/templates/security/change_password.html (extensions="jinja2.ext.autoescape,jinja2.ext.with_")
|
|
||||||
extracting messages from pgadmin/templates/security/fields.html (extensions="jinja2.ext.autoescape,jinja2.ext.with_")
|
|
||||||
extracting messages from pgadmin/templates/security/forgot_password.html (extensions="jinja2.ext.autoescape,jinja2.ext.with_")
|
|
||||||
extracting messages from pgadmin/templates/security/login_user.html (extensions="jinja2.ext.autoescape,jinja2.ext.with_")
|
|
||||||
extracting messages from pgadmin/templates/security/messages.html (extensions="jinja2.ext.autoescape,jinja2.ext.with_")
|
|
||||||
extracting messages from pgadmin/templates/security/panel.html (extensions="jinja2.ext.autoescape,jinja2.ext.with_")
|
|
||||||
extracting messages from pgadmin/templates/security/reset_password.html (extensions="jinja2.ext.autoescape,jinja2.ext.with_")
|
|
||||||
extracting messages from pgadmin/templates/security/watermark.html (extensions="jinja2.ext.autoescape,jinja2.ext.with_")
|
|
||||||
extracting messages from pgadmin/test/__init__.py
|
|
||||||
extracting messages from pgadmin/test/hooks.py
|
|
||||||
extracting messages from pgadmin/test/views.py
|
|
||||||
extracting messages from pgadmin/utils/__init__.py
|
|
||||||
extracting messages from pgadmin/utils/views.py
|
|
||||||
writing PO template file to pgadmin/messages.pot
|
|
||||||
|
|
||||||
Once the template has been updated, it needs to be merged into the existing
|
|
||||||
message catalogues, for example:
|
|
||||||
|
|
||||||
.. code-block:: bash
|
|
||||||
|
|
||||||
(pgadmin4)piranha:web dpage$ pybabel update -i pgadmin/messages.pot -d pgadmin/translations
|
|
||||||
updating catalog 'pgadmin/translations/fr/LC_MESSAGES/messages.po' based on 'pgadmin/messages.pot'
|
|
||||||
|
|
||||||
Finally, the message catalogues can be compiled for use:
|
Finally, the message catalogues can be compiled for use:
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
(pgadmin4)piranha:web dpage$ pybabel compile -d pgadmin/translations
|
(pgadmin4) user$ pybabel compile -d pgadmin/translations
|
||||||
compiling catalog 'pgadmin/translations/fr/LC_MESSAGES/messages.po' to 'pgadmin/translations/fr/LC_MESSAGES/messages.mo'
|
|
||||||
|
|
||||||
Adding a new Language
|
Adding a New Language
|
||||||
=====================
|
=====================
|
||||||
|
|
||||||
Adding a new language is simple. First, add the language name and identifier to
|
Adding a new language is simple. First, add the language name and identifier to
|
||||||
@@ -125,15 +77,14 @@ Adding a new language is simple. First, add the language name and identifier to
|
|||||||
# Languages we support in the UI
|
# Languages we support in the UI
|
||||||
LANGUAGES = {
|
LANGUAGES = {
|
||||||
'en': 'English',
|
'en': 'English',
|
||||||
'fr': 'Français'
|
'zh': 'Chinese (Simplified)',
|
||||||
|
'de': 'German',
|
||||||
|
'pl': 'Polish'
|
||||||
}
|
}
|
||||||
|
|
||||||
Then, create the new message catalogue from the **web** directory in the source
|
Then, create the new message catalogue from the **web** directory in the source
|
||||||
tree, in the Python virtual environment used for pgAdmin:
|
tree in the Python virtual environment for pgAdmin:
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
(pgadmin4)piranha:web dpage$ pybabel init -i pgadmin/messages.pot -d pgadmin/translations -l fr
|
(pgadmin4) user$ pybabel init -i pgadmin/messages.pot -d pgadmin/translations -l $LANG
|
||||||
|
|
||||||
This will initialise a new catalogue for a French translation.
|
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user