forked from openedx-unsupported/edx-documentation
-
Notifications
You must be signed in to change notification settings - Fork 1
docs:update xpert translation docs #9
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
90c2848
feat: Update Xpert Translation Docs
nsprenkle a0cc4cb
chore: fix SPHINX warning
nsprenkle dff0e0a
docs: Update readme to note that GitHub jobs will fail on *warnings*
nsprenkle 9a950ce
chore: fix un-wrapped reference causing issues
nsprenkle a95ef43
chore: update docs with new copy
nsprenkle File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
47 changes: 31 additions & 16 deletions
47
...ourse_authors/source/course_features/xpert_translations/feature_description.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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: | ||
|
|
||
nsprenkle marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| 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 removed
BIN
-324 KB
en_us/course_authors/source/images/xpert_transcript_caption_select.png
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.
Binary file added
BIN
+61.9 KB
en_us/course_authors/source/images/xpert_translations_language_modal.png
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 added
BIN
+252 KB
en_us/course_authors/source/images/xpert_translations_unit_translation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed
BIN
-202 KB
en_us/course_authors/source/images/xpert_unit_translations_language_selector.png
Binary file not shown.
Binary file removed
BIN
-176 KB
en_us/course_authors/source/images/xpert_unit_translations_widget.png
Binary file not shown.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.