Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,12 @@ Then run the tests.

./run_tests.sh


.. note::
The CI Build Docs job treats Sphinx warnings as errors, so ensure
``run_tests.sh`` completes with zero warnings **and** zero errors before
pushing. Check ``test_root/<project>/err.log`` for the full warning output.

Additionally, you can run tests for a single project. For example, to build an
HTML version of the *Installing, Configuring, and Running the Open edX
Platform* guide, you run this test.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,46 +1,61 @@
.. _Feature_Description_Xpert_Course_Translations:

##############################################
Feature Description: Xpert Course Translations
Feature Description: Xpert Course Translations
##############################################

Xpert Course Translations (XT) is a set of features enabling certain types of course content to be automatically translated into different languages.

Currently supported content types include:

- **Video transcripts**, where an original English transcript exists.
- Video transcripts, where an original English transcript exists.
- Unit page content, including HTML, Problems, and Polls.

- **Unit page content**, including HTML, Problems, and Polls.
.. only:: Partners

For notes and limitations regarding the supported content types, see :ref:`Feature_Limitations_Xpert_Course_Translations`.
For notes and limitations regarding the supported content types, see :ref:`Feature Limitations: Xpert Course Translations <Feature_Limitations_Xpert_Course_Translations>`.

************************************
Selecting a Language for Translation
************************************
.. _Selecting_a_Language_for_Translation:

If Xpert Course Translations are enabled in your course, a new "Translate" button will appear (pictured below).
*************************************
Selecting a Language for Translation
*************************************

Students within your course can click the button to open a modal with languages available for translation.
Course translations are controlled by your site language. This can be changed with the globe icon in the top bar of the in-course experience (pictured below).

.. image:: ../../images/xpert_unit_translations_widget.png
:alt: Course unit showing Xpert translations widget
.. image:: ../../images/xpert_translations_globe_icon.png
:alt: Course top bar showing the Xpert translations globe icon
:align: center

|

.. image:: ../../images/xpert_unit_translations_language_selector.png
:alt: Course unit showing Xpert translations language selector
Clicking on this icon opens a modal which allows users to set their site language preference directly from within their course.

.. image:: ../../images/xpert_translations_language_modal.png
:alt: Language selection modal showing available translation languages
:align: center

|

Once a student has selected a language for translation, supported content types will be translated into the target language.
If a course supports unit translation and a user has selected a language other than English, a translation button will appear at the top of the unit. :ref:`Supported content types <Feature_Limitations_Xpert_Course_Translations>` will be automatically translated to their site language. For enabling or disabling the feature across a course, see :ref:`Enabling or Disabling Translations <Enabling_or_Disabling_translations>`.

.. image:: ../../images/xpert_translations_unit_translation.png
:alt: Course unit showing the translation button with content translated to the site language
:align: center

|

.. note::
Content is translated on-demand. The first time a particular piece of course material is translated, there may be a slight delay in page loading before translated material is returned.
Content is translated on-demand. The first time a particular piece of course material is translated, there may be a slight delay in page loading before translated material is returned.

.. _Resetting_Translations:

**********************
Resetting Translations
**********************

Students can view original non-translated content by clicking the "Translate" button again and selecting "Original course language".
Students can reset course material to its original language, disabling unit translations, by clicking this translation button and selecting "Original course language".

.. image:: ../../images/xpert_translations_reset_icon.png
:alt: Course page showing the translation reset icon
:align: center
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.