Skip to content

Commit

Permalink
docs: add docs for Xpert course translations (#2266)
Browse files Browse the repository at this point in the history
  • Loading branch information
nsprenkle authored Jun 10, 2024
1 parent 508b59a commit f3fe7ad
Show file tree
Hide file tree
Showing 12 changed files with 146 additions and 0 deletions.
1 change: 1 addition & 0 deletions en_us/course_authors/source/course_features/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,4 @@ see :ref:`Developing Your Course Index`.
timed_exams
lti/index
xpert_summaries/index
xpert_translations/index
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
.. _Enabling_or_Disabling_translations:

##############################################
Enabling or Disabling Translations
##############################################

.. only:: Partners

*****************************
Video Transcript Translations
*****************************

- There is a waffle flag managed by edX internally to enable the translations UI in Studio for all of a Partner's courses

- Once enabled by waffle flag, course teams can manage all transcripts from the Studio videos page UI

.. image:: ../../images/xpert_transcript_edit_menu.png
:alt: Studio page showing video transcript edit menu
:align: center

**********************
Unit Page Translations
**********************

- There is a waffle flag managed internally by edX to enable this feature for all of a partners' courses

- Once enabled, the feature's availability for a course can be controlled from the “Pages & Resources” section of a course

- This toggle will allow course teams to disable unit page translations for a specific course if desired
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
.. _Feature_Description_Xpert_Course_Translations:

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

.. only:: Partners

Two translation features will be available on the edX platform

#. **Video transcript translations:** Machine generated transcripts produced from existing english transcripts, originally provided by content creators.

#. **Unit page translations:** The ability to replace unit page content with translated versions of unit page content in real time.

a. V1 - Generate Spanish or Arabic translated versions of HTML+Problem blocks.

Combined, these features support the concept of **Xpert Course Translation**.

*****************************
Video transcript translations
*****************************

Video transcripts can be generated through a translations UI on the videos page in Studio for a course. An existing english transcript is required for translations of video transcripts. For more information on obtaining an english transcript see `readthedocs <https://edx.readthedocs.io/projects/edx-partner-course-staff/en/latest/video/prepare_video/obtain_transcript.html>`_.

.. image:: ../../images/xpert_transcript_settings_link.png
:alt: Studio page showing link to Transcript settings
:align: center

|
.. image:: ../../images/xpert_transcript_settings_options.png
:alt: Studio pane showing links to generate translations in different languages
:align: center
:scale: 70 %

|
If video transcript translations are enabled for a course, learners can select from a list of available languages to view the transcript

.. image:: ../../images/xpert_transcript_caption_select.png
:alt: Course video player showing list of generated transcripts
:align: center

|
Once a learner selects a language for their translated transcript, that choice is persisted as the default for the rest of the videos in a course. Learners can update their transcript language at any time using the video player UI.

=========================================
Video transcript translation limitations:
=========================================

- Does not currently apply to youtube video transcripts

- An existing English transcript is required for generating transcripts in other languages.

**********************
Unit page translations
**********************

Users will be able to select an icon on the unit page of a course (pictured below):

.. image:: ../../images/xpert_unit_translations_widget.png
:alt: Course unit showing Xpert translations widget
:align: center

|
.. image:: ../../images/xpert_unit_translations_language_selector.png
:alt: Course unit showing Xpert translations language selector
:align: center

|
Once users have selected a language to translate the course into, each new unit page they encounter will have the content translated into the specified language.

==================================
Unit page translation limitations:
==================================

- Currently only on platform HTML and Problem Blocks are available for translation.

- The languages available for translation are currently Spanish and Arabic.
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.. _Xpert_Course_translations:

#####################################
Xpert Course Translations
#####################################

.. toctree::
:maxdepth: 2

feature_description
enabling_disabling_translations
reviewing_and_editing_translations
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
.. _Reviewing_and_Editing_Translations:

##################################
Reviewing and Editing Translations
##################################

.. only:: Partners

Video transcript translations:

- Full review and edit capability is available on the Studio Videos page

Unit Page translations:

- We do not currently offer the ability for course teams to edit the course level translations
- Review can be done by viewing the course as a Verified Learner or Staff

************************************************
What happens when there are updates to a course?
************************************************

When changes are made to a course run the updated version of content will be translated the first time a user requests the translation from the updated unit page.
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.
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.

0 comments on commit f3fe7ad

Please sign in to comment.