From f777c7a05b1e2313c22cd3ce144cecd368cc5f8d Mon Sep 17 00:00:00 2001 From: jesgreco <74380129+jesgreco@users.noreply.github.com> Date: Thu, 26 Dec 2024 20:16:48 -0300 Subject: [PATCH] rst doc creation (#707) * adding txt file: add text * adding txt files adding publish_units & view_as_learner.rs files * adding txt files add_video add_multiple_choice * adding reference .rst to navigation file * fixing see also table for add_,multiple_choice.rst * fixing see also table error for add_video.rst * creating see also tables for publish_unirts.rst * fixing seealso table error * fixing error for see also table in view_as_learner.rst file * fixing see also table for add_video.rst file * fixing error --------- Co-authored-by: Jesica Greco --- .../educators/how-tos/add_multiple_choice.rst | 46 ++++++++++++++++++- source/educators/how-tos/add_video.rst | 37 +++++++++++++++ .../exercise_tools/adding_text.rst | 29 ++++++++++++ source/educators/how-tos/publish_units.rst | 20 ++++++++ source/educators/how-tos/view_as_learner.rst | 19 ++++++++ source/educators/navigation/accessibility.rst | 3 +- .../educators/navigation/creating_course.rst | 4 ++ 7 files changed, 156 insertions(+), 2 deletions(-) create mode 100644 source/educators/how-tos/add_video.rst create mode 100644 source/educators/how-tos/course_development/exercise_tools/adding_text.rst create mode 100644 source/educators/how-tos/publish_units.rst create mode 100644 source/educators/how-tos/view_as_learner.rst diff --git a/source/educators/how-tos/add_multiple_choice.rst b/source/educators/how-tos/add_multiple_choice.rst index e892baaa8..f22e7c964 100644 --- a/source/educators/how-tos/add_multiple_choice.rst +++ b/source/educators/how-tos/add_multiple_choice.rst @@ -5,4 +5,48 @@ Add a Multiple Choice Problem This video explains how to add a multiple choice (also known as "single-select") problem: -.. youtube:: ij5VHvY6jBk \ No newline at end of file +.. youtube:: ij5VHvY6jBk + + +. In the unit where you want to place the text, select :guilabel:`Problem` at the bottom of the page. + +#. From the list of problem types, select :guilabel:`Multiple Choice`. + + The problem component is added at the end of the unit. + +#. In the component, select :guilabel:`Edit`. + + The template multiple choice component opens in the Simple editor, + +#. Edit the question as needed, keeping the following format. + + .. code-block:: + + >>Add the question text, or prompt, here. This text is required. + ||You can add an optional tip or note related to the prompt like this. << + + ( ) an incorrect answer + (x) the correct answer + ( ) an incorrect answer + +#. To enter a display name for the problem, select :guilabel:`Settings`, and then enter text in the :guilabel:`Display Name` field. + +#. Click :guilabel:`Save` to save the problem in the unit. + + +.. seealso:: + :class: dropdown + + :ref: `The Advanced Editor` (reference) + + :ref: `A New Problem Editor Experience (Palm)` (reference) + + + + + + + + + + diff --git a/source/educators/how-tos/add_video.rst b/source/educators/how-tos/add_video.rst new file mode 100644 index 000000000..ac02c38ed --- /dev/null +++ b/source/educators/how-tos/add_video.rst @@ -0,0 +1,37 @@ + +######### +Add Video +######### + +These instructions assume you have uploaded the video to YouTube. + + +#. Copy the video URL from YouTube. + +#. In the unit where you want to place the video, under **Add New Component** select :guilabel:`Video`. + + A video with default settings is added to the unit. + +#. In the video block, click Edit. + +#. In the **Component Display Name** field, enter the name that you want learners to see for this video. + +This name appears as a heading above the video in the LMS, and it identifies the video for you in reports and analytics. If you do not enter a display name, the platform specifies “video” for you. + +#. Paste the video URL in the default Video URL field, and then enter the location of your video. This is the URL that was created when you uploaded the video to the hosting site. + +#. Click :guilabel:`Save` to save the video in the unit. + +.. seealso:: + :class: dropdown + + :ref: `Course About Video Guidelines` (reference) + + :ref: `Troubleshooting Video Problems` (reference) + + + + + + + diff --git a/source/educators/how-tos/course_development/exercise_tools/adding_text.rst b/source/educators/how-tos/course_development/exercise_tools/adding_text.rst new file mode 100644 index 000000000..5a664f5e6 --- /dev/null +++ b/source/educators/how-tos/course_development/exercise_tools/adding_text.rst @@ -0,0 +1,29 @@ +.. _Add Text: + +######## +Add Text +######## + + + +#. In the unit where you want to place the text, select :guilabel:`Text` at the bottom of the page. + +#. Select the **Text** template to add a blank component. + + The component is added at the end of the unit. + +#. In the component, select :guilabel:`Edit`. + + The empty component opens in the visual editor. + +#. Enter and format your content. + +#. To enter a display name for the component, select :guilabel:`Settings`, and then enter text in the :guilabel:`Display Name` field. + +#. Click :guilabel:`Save` to save the text in the unit. + + +.. seealso:: + :class: dropdown + + :ref: `Embed an iframe in the Text Editor` (how-to) diff --git a/source/educators/how-tos/publish_units.rst b/source/educators/how-tos/publish_units.rst new file mode 100644 index 000000000..b09674f88 --- /dev/null +++ b/source/educators/how-tos/publish_units.rst @@ -0,0 +1,20 @@ +.. _Publish Unit: + +############ +Publish Unit +############ + +After you have added content, you must publish it to make it available to learners. + +#. Go back to the course outline. + + You see the unit you created, within the subsection and section, in an unpublished state. + +#. For the section, click the Publish icon (|Publish Icon|). + + +.. seealso:: + :class: dropdown + + :ref: `Controlling Content Visibility and Access` (reference) + diff --git a/source/educators/how-tos/view_as_learner.rst b/source/educators/how-tos/view_as_learner.rst new file mode 100644 index 000000000..d94985ddb --- /dev/null +++ b/source/educators/how-tos/view_as_learner.rst @@ -0,0 +1,19 @@ +.. _View As Learner: + +############### +View As Learner +############### + +After you have published content, you should view it in the LMS, as a learner will. + +#. In the course outline, click :guilabel:`View Live`. + + The course opens in the LMS, in a new tab. + +#. Go through the content you created and check for accuracy. You can edit the content in Studio, then publish your changes, to fix any issues. + +.. seealso:: + :class: dropdown + + :ref: `Controlling Content Visibility and Access` (reference) + diff --git a/source/educators/navigation/accessibility.rst b/source/educators/navigation/accessibility.rst index edf46418f..0836412ae 100644 --- a/source/educators/navigation/accessibility.rst +++ b/source/educators/navigation/accessibility.rst @@ -40,4 +40,5 @@ Accessibility for Video :glob: ../how-tos/course_development/additional_transcript_options.rst - ../how-tos/add_transcript_other_language.rst \ No newline at end of file + ../how-tos/add_transcript_other_language.rst + ../how-tos/add_video.rst \ No newline at end of file diff --git a/source/educators/navigation/creating_course.rst b/source/educators/navigation/creating_course.rst index 408d5143b..0b506abf5 100644 --- a/source/educators/navigation/creating_course.rst +++ b/source/educators/navigation/creating_course.rst @@ -75,9 +75,13 @@ Create a New Course ../how-tos/course_development/create_edit_publish_subsections.rst ../how-tos/course_development/hide_subsections.rst ../how-tos/course_development/create_hide_delete_sections.rst + ../how-tos/course_development/exercise_tools/adding_text.rst + ../how-tos/publish_units.rst ../how-tos/create_subsection.rst + ../how-tos/view_as_learner.rst ../how-tos/set_up_course/add_metadata.rst ../how-tos/use_section_independently_of_course_outline.rst + ../how-tos/add_multiple_choice.rst ../references/resources_for_course_teams.rst ../references/resources_for_open_edx.rst