paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-04 14:03:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs/translating: Follow-on cleanups from removing Django templates.

Browse Source 
This follows up the recent commit
3d1d09b3d docs: Remove discussion of old Django templating engine.
with a small grammar fix and removing another vestige of making the
distinction between Jinja2 and Django templates, and also rearranges
the logic slightly to reflect that backend and frontend templates
have separate sections.

Probably a bigger restructuring is in order to help the reader
navigate through all the good content in this doc, but that's
a bigger job for another day.
This commit is contained in:
Greg Price
2017-06-21 16:29:23 -07:00
parent df83cee86b
commit 3286fbe8e3
1 changed files with 13 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
docs/translating.md
View File

@@ -208,23 +208,18 @@ These files are uploaded to [Transifex][], where they can be translated.
## Backend translations ## Backend translations
All user-facing text in the Zulip UI should be generated by an HTML All user-facing text in the Zulip UI should be generated by an HTML
template so that it can be translated. template so that it can be translated. For text generated in the
backend, including logged-out ("portico") pages and the webapp's base
content, we use the [Jinja2][] template engine.
Zulip's HTML is primarily implemented using two types of HTML To mark a string for translation in a Jinja2 template, you
templates: backend templates (powered by the [Jinja2][] template
engine used for logged-out ("portico") pages and the webapp's base
content) and frontend templates (powered by [Handlebars][]) used for
live-rendering HTML from JavaScript for things like the main message
feed.
To mark a string for translation in the Jinja2 template engines, you
can use the `_()` function in the templates like this: can use the `_()` function in the templates like this:
``` ```
{{ _("English text") }} {{ _("English text") }}
``` ```
If a string contains both a literal string component and variables, If a piece of text contains both a literal string component and variables,
you can use a block translation, which makes use of placeholders to you can use a block translation, which makes use of placeholders to
help translators to translate an entire sentence. To translate a help translators to translate an entire sentence. To translate a
block, Jinja2 uses the [trans][] tag. So rather than writing block, Jinja2 uses the [trans][] tag. So rather than writing
@@ -238,7 +233,6 @@ something ugly and confusing for translators like this:
You can instead use: You can instead use:
``` ```
# Jinja2 style
{% trans %}This string will have {{ value }} inside.{% endtrans %} {% trans %}This string will have {{ value }} inside.{% endtrans %}
``` ```
@@ -257,11 +251,14 @@ Zulip linter (`tools/lint`) checks for correct usage.
## Frontend translations ## Frontend translations
Zulip uses the [i18next][] library for frontend translations. There For text generated in the frontend, live-rendering HTML from
are two types of files in Zulip frontend which can hold translatable JavaScript for things like the main message feed, we use the
strings: JavaScript code files and Handlebar templates. To mark a [Handlebars][] template engine and sometimes work directly from
string translatable in JavaScript files, pass it to the `i18n.t` JavaScript code. In both cases, we use the [i18next][] library
function. for translations.
To mark a string translatable in JavaScript files, pass it to the
`i18n.t` function.
``` ```
i18n.t('English Text', context); i18n.t('English Text', context);