Skip to content

Commit

Permalink
docs: XBlock JavaScript translations OEP-58
Browse files Browse the repository at this point in the history
  • Loading branch information
OmarIthawi committed Jan 21, 2024
1 parent 470069c commit 94a194b
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions source/developers/how-tos/enable-translations-new-repo.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,10 @@ workflow:
- Django plugins: ``django.po``
- If the repo uses ``gettext`` and has a ``static`` directory with JavaScript, it may include ``djangojs.po``

#. If XBlock JavaScript translations is needed, use the ``XBlockI18NService.get_javascript_i18n_catalog_url`` method
similar to the `Drag and Drop XBlock XBlockI18NService js translations pull request`_. This method is available as
of `Open edX Redwood XBlock translations feature`_ and `XBlock==1.9.1 release`_.

#. Add the repository to `extract-translation-source-files.yml`_ in the `openedx-translations repo`_.

Add a new entry under the ``python-translations`` section. For example, the XBlock located at
Expand Down Expand Up @@ -260,6 +264,9 @@ After adding a repository to the `openedx-translations repo`_ verify the followi
.. _frontend-lib-special-exams testing pull request: https://github.com/Zeit-Labs/openedx-translations/pull/1/files
.. _transifex.yml: https://github.com/openedx/openedx-translations/blob/main/transifex.yml
.. _Drag and Drop XBlock transifex.yml entry: https://github.com/openedx/openedx-translations/blob/19c0fcbbc334c56022df355fa5b529e5853d30f9/transifex.yml#L253-L259
.. _Drag and Drop XBlock XBlockI18NService js translations pull request: https://github.com/openedx/xblock-drag-and-drop-v2/pull/365/files#diff-fe829a32b6885a4d3c06b0710a0f38ed86a773e090e269356fcc5c934b42b50fR343-R349
.. _Open edX Redwood XBlock translations feature: https://github.com/openedx/edx-platform/pull/33698
.. _XBlock==1.9.1 release: https://github.com/openedx/XBlock/pull/702

.. _edx-platform: https://github.com/openedx/edx-platform
.. _credentials: https://github.com/openedx/credentials
Expand Down

0 comments on commit 94a194b

Please sign in to comment.