diff --git a/source/educators/how-tos/add_course_page.rst b/source/educators/how-tos/add_course_page.rst index 095a18be..98bd6164 100644 --- a/source/educators/how-tos/add_course_page.rst +++ b/source/educators/how-tos/add_course_page.rst @@ -1,3 +1,5 @@ +.. _Add a Course Page: + Add a Course Page ################# @@ -5,4 +7,21 @@ Add a Course Page You can create a custom course page as demonstrated in the following video: -.. youtube:: vIR9auBmiFU \ No newline at end of file +.. youtube:: vIR9auBmiFU + +.. seealso:: + :class:dropdown + + :ref:`Add Files to a Course` (how-to) + + :ref:`Adding Pages to a Course` (how-to) + + :ref:`Adding Textbooks` (how-to) + + :ref:`Configure Resources` (how-to) + + :ref:`Google Drive Files Tool` (reference) + + :ref:`The Files Page` (reference) + + \ No newline at end of file diff --git a/source/educators/how-tos/course_development/add_textbooks.rst b/source/educators/how-tos/course_development/add_textbooks.rst index 736fbdea..95590084 100644 --- a/source/educators/how-tos/course_development/add_textbooks.rst +++ b/source/educators/how-tos/course_development/add_textbooks.rst @@ -1,8 +1,7 @@ .. _Adding Textbooks: -########################### Textbooks -########################### +############# .. tags:: educator, how-to @@ -13,21 +12,21 @@ You can add textbooks in PDF format to your course. course, because they are not accessible to learners who use screen readers. For more information, review :ref:`Creating Accessible PDFs`. -Each textbook that you add is displayed to learners as a page, or tab, in the -course navigation bar. EdX recommends that you upload a separate PDF for each +Each textbook you add is displayed to learners as a page, or tab, in the +course navigation bar. The recommendation is to upload a separate PDF for each chapter of your textbook. When learners open the textbook page in the course, they can navigate the textbook by chapter. +.. _Add a Textbook: -***************** Add a Textbook ***************** .. note:: When you add a textbook to your course, Studio automatically adds each PDF - file that you upload to the **Files & Uploads** page. + file you upload to the **Files & Uploads** page. #. Prepare PDFs of your textbook on your computer. @@ -48,7 +47,6 @@ Add a Textbook .. _Delete a Textbook: -***************** Delete a Textbook ***************** @@ -58,30 +56,29 @@ Delete a Textbook #. On the **Content** menu, select **Textbooks**. -#. On the **Textbooks** page, hover the cursor over the textbook that you want +#. On the **Textbooks** page, hover the cursor over the textbook you want to delete, and then select the trash can icon. #. In the confirmation dialog box, select **Delete**. .. note:: - When you add a textbook to your course, Studio adds each PDF file that you + When you add a textbook to your course, Studio adds each PDF file you upload to the **Files & Uploads** page. After you delete your textbook on - the **Textbooks** page, edX strongly recommends that you :ref:`lock` or :ref:`delete` the PDF files for the textbook on the **Files & Uploads** page to avoid copyright issues. .. _Delete a Chapter: -***************** Delete a Chapter ***************** #. On the **Content** menu, select **Textbooks**. #. On the **Textbooks** page, hover the cursor over the textbook that contains - the chapter that you want to delete, and then select **Edit**. + the chapter you want to delete, and then select **Edit**. -#. On the textbook editing page, locate the chapter that you want to delete, +#. On the textbook editing page, locate the chapter you want to delete, and then select the X icon next to that chapter. .. image:: /_images/educator_how_tos/DeleteChapter.png @@ -89,9 +86,9 @@ Delete a Chapter :alt: Textbook editing page with a callout for the X icon .. note:: - When you add a textbook to your course, Studio adds each PDF file that you + When you add a textbook to your course, Studio adds each PDF file you upload to the **Files & Uploads** page. After you delete a chapter on the - **Textbooks** page, edX strongly recommends that you :ref:`lock` or :ref:`delete` the PDF file for the chapter on the **Files & Uploads** page to avoid copyright issues. diff --git a/source/educators/how-tos/course_development/create_course_wiki.rst b/source/educators/how-tos/course_development/create_course_wiki.rst index 82ae8ec6..31da826a 100644 --- a/source/educators/how-tos/course_development/create_course_wiki.rst +++ b/source/educators/how-tos/course_development/create_course_wiki.rst @@ -1,6 +1,5 @@ .. _Create Course Wiki: -######################## Using the Course Wiki ######################## @@ -16,7 +15,6 @@ collaboratively edit information both about, and for, your course. .. _Showing or Hiding the Wiki: -******************************** Showing or Hiding the Wiki ******************************** @@ -27,14 +25,13 @@ To disable or enable the Wiki application, follow these steps. #. From the **Configure wiki** modal, select the toggle to enable or disable the **wiki**. #. Select **Apply** to save your configuration changes. -When you hide the wiki in your course, any existing articles remain in the edX- wide wiki, +When you hide the wiki in your course, any existing articles remain in the wide wiki, but the Wiki page is removed from your course pages. .. In XML authoring, remove the `{"type": "wiki"}` entry in your `/policies/TERM/policy.json` file. .. _Controlling Wiki Access: -******************************** Controlling Access to the Wiki ******************************** @@ -51,9 +48,9 @@ To change access to the course wiki, follow these steps. The **Enable public wiki access** wiki setting is disabled by default, meaning that only course team members -and enrolled learners can see the course wiki. If you enable this setting, then any registered edX user +and enrolled learners can see the course wiki. If you enable this setting, then any registered user can access the course wiki, even if they are not enrolled in your course. However, public users would have -to explicitly navigate to your wiki via the edX-wide wiki structure, or a link that has been provided to them. +to explicitly navigate to your wiki via the wide wiki structure, or a link that has been provided to them. To modify viewing or editing permissions for specific groups of users by article, see :ref:`Setting Permissions for Wiki Articles`. @@ -63,7 +60,6 @@ a Wiki Article`. .. _Setting Permissions for Wiki Articles: -*************************************** Setting Permissions for Wiki Articles *************************************** @@ -72,7 +68,7 @@ need to modify the read/write permissions for articles. For example, as a member of the course team, you likely want to prevent learners from creating wiki articles at the top level, so you should remove write access to course- level wiki articles for most users. (Top-level wiki articles are children of -the edX-wide wiki, and cannot be found within the course wiki). +the wide wiki, and cannot be found within the course wiki). To modify the permissions for wiki articles, follow these steps. @@ -107,11 +103,10 @@ You add users to these groups in the LMS by selecting **Instructor** and then The permissions for the **Others** group apply to users who are not in the three course groups, including learners. -.. If permissions are unchanged from the default wiki, students can create articles at the course level (children of the edX-wide wiki). This is easy to do accidentally due to the prominence of the Add article button for the top level. +.. If permissions are unchanged from the default wiki, students can create articles at the course level. This is easy to do accidentally due to the prominence of the Add article button for the top level. .. _Seeding the Wiki: -******************************** Seeding the Wiki ******************************** @@ -129,7 +124,6 @@ Read more about tasks :ref:`Course Wiki Tasks` .. _Locking a Wiki Article: -******************************** Locking a Wiki Article ******************************** @@ -152,7 +146,6 @@ follow these steps. .. _Deleting a Wiki Article: -******************************** Deleting a Wiki Article ******************************** diff --git a/source/educators/how-tos/course_development/exercise_tools/create_full_screen_image.rst b/source/educators/how-tos/course_development/exercise_tools/create_full_screen_image.rst index 6675df94..657496db 100644 --- a/source/educators/how-tos/course_development/exercise_tools/create_full_screen_image.rst +++ b/source/educators/how-tos/course_development/exercise_tools/create_full_screen_image.rst @@ -1,6 +1,5 @@ .. _Full Screen Image: -###################### Full Screen Image Tool ###################### @@ -14,27 +13,27 @@ all the detail in context. :local: :depth: 1 -**************************************** + The Learner View of a Full Screen Image **************************************** -The learner sees the full screen image in a unit page. When the learner moves +#. The learner sees the full screen image in a unit page. When the learner moves the cursor over the image, the **Fullscreen** option appears. -.. image:: /_images/educator_how_tos/image-modal.png - :alt: Image of the full screen image tool with the Full Screen button. + .. image:: /_images/educator_how_tos/image-modal.png + :alt: Image of the full screen image tool with the Full Screen button. -When the learner selects **Fullscreen**, the image opens and expands in the +#. When the learner selects **Fullscreen**, the image opens and expands in the full browser window. **Close**, **Zoom In**, and **Zoom Out** options appear. -.. image:: /_images/educator_how_tos/image-modal-window.png - :alt: Image of the Image Modal tool with the Full Screen button. + .. image:: /_images/educator_how_tos/image-modal-window.png + :alt: Image of the Image Modal tool with the Full Screen button. -The learner can then zoom in on the image, and drag the image to view a +#. The learner can then zoom in on the image, and drag the image to view a specific part of it. -.. image:: /_images/educator_how_tos/image-modeal-zoomed.png - :alt: Image of the Image Modal tool with the Full Screen button. + .. image:: /_images/educator_how_tos/image-modeal-zoomed.png + :alt: Image of the Image Modal tool with the Full Screen button. ****************************** Create a Full Screen Image @@ -68,7 +67,7 @@ Create a Full Screen Image ``Full screen image`` * Ensure that the value of the ``href`` and ``src`` attributes are the same, - and that you do not change the class attribute. Your sample code should + and you do not change the class attribute. Your sample code should look like the following example. .. code-block:: xml @@ -82,4 +81,23 @@ Create a Full Screen Image You can use this same HTML code in any Text component, not just those components you created as full screen images. -#. Select **Save**. \ No newline at end of file +#. Select **Save**. + +.. seealso:: + :class:dropdown + + :ref:`Working with Text Components` (reference) + + :ref:`Work with HTML code` (how-to) + + :ref:`Create a Text Component` (how-to) + + :ref:`Add Link to Website Course Unit or File` (how-to) + + :ref:`Add an Image to a Text Component` (how-to) + + :ref:`Paste without Formatting in a Text Component` (how-to) + + :ref:`Work with Latex Code` (how-to) + + :ref:`Add Written Content` (how-to) diff --git a/source/educators/how-tos/course_development/text_components/add_image.rst b/source/educators/how-tos/course_development/text_components/add_image.rst index 4cae20af..5982265e 100644 --- a/source/educators/how-tos/course_development/text_components/add_image.rst +++ b/source/educators/how-tos/course_development/text_components/add_image.rst @@ -1,8 +1,7 @@ .. _Add an Image to a Text Component: -********************************* Add an Image to a Text Component -********************************* +################################# .. tags:: educator, how-to @@ -11,8 +10,8 @@ a Text component. You can see a preview of the image before you add it to the component. .. note:: - * Before you add an image, make sure that you obtain copyright permissions for - images you use in your course, and that you cite sources appropriately. + * Before you add an image, make sure you obtain copyright permissions for + images you use in your course, and cite sources appropriately. * To add effective alternative text for images, review :ref:`Best Practices for Describing Images`. * You can only add one image at one time. @@ -23,21 +22,24 @@ procedures. * :ref:`Locate an image ` by using the **Browse Your Computer** option in the **Add Image** dialog box. -* :ref:`Select an image ` you have previously uploaded. +.. contents:: + :local: + :depth: 1 + .. _Locate an Image on Your Computer: -================================ Locate an Image on Your Computer -================================ +********************************** #. In the Text component, position the cursor where you want to add an image, and then select the image icon on the toolbar. #. In the **Add an Image** dialog box, **Upload a New Image (10 MB max)**. -#. In the dialog box that opens, locate the file that you want to add, and +#. In the dialog box that opens, locate the file you want to add, and then select **Open**, or locate the image in the Image Gallery, and then select **Next**. @@ -64,9 +66,8 @@ Locate an Image on Your Computer .. _Select a Previously Uploaded Image: -================================== Select a Previously Uploaded Image -================================== +*********************************** #. When you upload an image, the image automatically becomes available in a gallery list that opens when you add an image to a Text component. @@ -97,60 +98,13 @@ Select a Previously Uploaded Image #. Save the Text component and test the image. -.. _Format an Image in a Text Component: - -=================================== -Format an Image in a Text Component -=================================== - -You have several options for formatting an image in a Text component. - -.. contents:: - :local: - :depth: 1 - -.. _Align an Image: - -Align an Image -************** - -To align your image to the right, the left, or the center, follow these steps. - -#. In the Text component, select the image. - -#. On the toolbar, select the left align, right align, or center icon. - -.. _Change the Image Size: - -Change the Image Size -********************* - -To change the size of your image, follow these steps. - -#. In the Text component, select the image that you want to edit, and then - select the Contextual image icon that appears above the image. - -#. In the **Image Settings** dialog box, locate **Image Dimensions**, and - then enter the values that you want for the **Width** and **Height** - options. - - .. note:: - To make sure that the image keeps the same proportions when you change the - image size, make sure that **Lock proportions** is selected, and enter a - number in only the **Width** field or the **Height** field. After you tab - or click outside that field, the number in the other field changes to a - value that maintains the image proportions. - -#. Select **Save**. - -If you want to change the image back to the original size, clear the values in -the **Width** and **Height** fields. - .. seealso:: :class: dropdown :ref:`Working with Text Components` (reference) + :ref:`Format an Image in a Text Component` (how-to) + :ref:`Create a Text Component` (how-to) :ref:`Paste without Formatting in a Text Component` (how-to) diff --git a/source/educators/how-tos/course_development/text_components/create_text_component.rst b/source/educators/how-tos/course_development/text_components/create_text_component.rst index 1e0a3bd1..521a841c 100644 --- a/source/educators/how-tos/course_development/text_components/create_text_component.rst +++ b/source/educators/how-tos/course_development/text_components/create_text_component.rst @@ -1,8 +1,7 @@ .. _Create a Text Component: -*********************** Create a Text Component -*********************** +######################### .. tags:: educator, how-to @@ -37,9 +36,8 @@ When you use the visual editor, you can also perform the following tasks. .. _Text Component Templates: -======================== Text Component Templates -======================== +************************** When you create a Text component, you select from a list of templates and editor types, including the following: diff --git a/source/educators/how-tos/course_development/text_components/format_image.rst b/source/educators/how-tos/course_development/text_components/format_image.rst new file mode 100644 index 00000000..3a614ec4 --- /dev/null +++ b/source/educators/how-tos/course_development/text_components/format_image.rst @@ -0,0 +1,66 @@ +.. _Format an Image in a Text Component: + +Format an Image in a Text Component +##################################### + +.. tags:: educator, how-to + +You have several options for formatting an image in a Text component. + +.. contents:: + :local: + :depth: 1 + +.. _Align an Image: + +Align an Image +************** + +To align your image to the right, the left, or the center, follow these steps. + +#. In the Text component, select the image. + +#. On the toolbar, select the left align, right align, or center icon. + +.. _Change the Image Size: + +Change the Image Size +********************* + +To change the size of your image, follow these steps. + +#. In the Text component, select the image you want to edit, and then + select the Contextual image icon that appears above the image. + +#. In the **Image Settings** dialog box, locate **Image Dimensions**, and + then enter the values you want for the **Width** and **Height** + options. + + .. note:: + To make sure that the image keeps the same proportions when you change the + image size, make sure that **Lock proportions** is selected, and enter a + number in only the **Width** field or the **Height** field. After you tab + or click outside that field, the number in the other field changes to a + value that maintains the image proportions. + +#. Select **Save**. + +If you want to change the image back to the original size, clear the values in +the **Width** and **Height** fields. + +.. seealso:: + :class: dropdown + + :ref:`Add an Image to a Text Component` (how-to) + + :ref:`Working with Text Components` (reference) + + :ref:`Create a Text Component` (how-to) + + :ref:`Paste without Formatting in a Text Component` (how-to) + + :ref:`Add Link to Website Course Unit or File` (how-to) + + :ref:`Work with HTML code` (how-to) + + :ref:`Work with Latex Code` (how-to) diff --git a/source/educators/how-tos/course_development/text_components/paste_without_formatting.rst b/source/educators/how-tos/course_development/text_components/paste_without_formatting.rst index 590e6293..30ac6151 100644 --- a/source/educators/how-tos/course_development/text_components/paste_without_formatting.rst +++ b/source/educators/how-tos/course_development/text_components/paste_without_formatting.rst @@ -1,6 +1,5 @@ .. _Paste without Formatting in a Text Component: -############################################# Paste without Formatting in a Text Component ############################################# @@ -18,7 +17,7 @@ text will not be aligned in Studio or the LMS. .. image:: /_images/educator_how_tos/HTML_PowerPastePop.png - :alt: an image of the popup that you will receive after copying and + :alt: an image of the popup you will receive after copying and pasting content into the Text Editor. This popup allows you to select either keep or remove formatting. :width: 300 diff --git a/source/educators/how-tos/course_development/text_components/work_with_html.rst b/source/educators/how-tos/course_development/text_components/work_with_html.rst index 1b78a700..240b2918 100644 --- a/source/educators/how-tos/course_development/text_components/work_with_html.rst +++ b/source/educators/how-tos/course_development/text_components/work_with_html.rst @@ -1,6 +1,5 @@ .. _Work with HTML code: -############################################# Work with HTML Code in the Text Component ############################################# @@ -16,23 +15,23 @@ HTML, see `Wikipedia `_. Review HTML Markup in the Visual Editor *************************************** -To review the HTML markup added to content in the visual editor, select +#. To review the HTML markup added to content in the visual editor, select **HTML** from the visual editor's toolbar. The HTML source code editor opens. -.. image:: /_images/educator_how_tos/HTML_source_code.png - :alt: The HTML source code editor for the visual editor in Studio, showing - HTML with markup. - :width: 600 + .. image:: /_images/educator_how_tos/HTML_source_code.png + :alt: The HTML source code editor for the visual editor in Studio, showing + HTML with markup. + :width: 600 -You can edit text and the HTML markup in this editor. However, you cannot add +#. You can edit text and the HTML markup in this editor. However, you cannot add custom styles or scripts in this editor. To do this, you must use the :ref:`raw HTML editor` instead. -Select **Save** to return to the visual editor. The visual editor attempts to -correct any problems with the markup that you entered. For example, if you do +#. Select **Save** to return to the visual editor. The visual editor attempts to +correct any problems with the markup you entered. For example, if you do not provide a close paragraph tag, the editor adds the tag for you. -You can then continue working in the visual editor. +#. You can then continue working in the visual editor. .. warning:: Selecting **OK** in the source code editor does not save your changes to the @@ -42,9 +41,8 @@ You can then continue working in the visual editor. .. _The Raw HTML Editor: -=================== The Raw HTML Editor -=================== +******************** The raw HTML editor is a text editor. It does not offer a toolbar with formatting options. @@ -58,7 +56,7 @@ not validate your HTML code. If you use this editor, you should thoroughly test the HTML content in your course. .. important:: - When you add a heading to a Text component, make sure that you use only + When you add a heading to a Text component, make sure you use only heading level 2 ``

`` through heading level 6 ``

``. Text components are part of a complete page, and elements outside the Text component use heading level 1 by default. Because tools such as screen readers use heading diff --git a/source/educators/how-tos/course_development/text_components/work_with_latex.rst b/source/educators/how-tos/course_development/text_components/work_with_latex.rst index a5c75f2c..c25abee0 100644 --- a/source/educators/how-tos/course_development/text_components/work_with_latex.rst +++ b/source/educators/how-tos/course_development/text_components/work_with_latex.rst @@ -1,19 +1,11 @@ .. _Work with Latex Code: -############################################# Work with LaTeX Code ############################################# .. tags:: educator, how-to - -JRistau (26 Sept 2022) - LaTeX editor support was removed with the rollout of -the new Course Authoring based Text Editor. Coursegraph shows ~100 active -courses that have enabled the LaTeX advanced module, and we have had no -issues reported since rollout of the new text editor. The LaTeX component -is listed as “Unsupported” in studio (TNL-9993). For these reasons, edX PM -has decided to remove this section of our support documentation. - +.. note:: LaTeX editor support was removed with the rollout of the new Course Authoring-based Text Editor in the Redwood release. .. ========================== @@ -79,12 +71,12 @@ has decided to remove this section of our support documentation. .. following image. .. .. image:: /_images/educator_how_tos/HTML_LaTeX_LMS.png - :alt: Math formulas created with LaTeX in a Text component. +.. :alt: Math formulas created with LaTeX in a Text component. .. .. warning:: - The LaTeX processor that Studio uses to convert LaTeX code to XML is a third - party tool. We recommend that you use this feature with caution. If you use - the tool, make sure that you work with your partner manager. +.. The LaTeX processor that Studio uses to convert LaTeX code to XML is a third +.. party tool. We recommend you use this feature with caution. If you use +.. the tool, make sure you work with your partner manager. .. seealso:: :class: dropdown diff --git a/source/educators/how-tos/manage_files.rst b/source/educators/how-tos/manage_files.rst index 892050b8..48d93f6d 100644 --- a/source/educators/how-tos/manage_files.rst +++ b/source/educators/how-tos/manage_files.rst @@ -1,3 +1,5 @@ +.. _Manage Course Files: + Manage Course Files ################### @@ -5,4 +7,22 @@ Manage Course Files Did you know you can add files to your course and make them available to learners? This is how to add textbooks PDFs: -.. youtube:: CaSbi09YpJU \ No newline at end of file +.. youtube:: CaSbi09YpJU + +.. seealso:: + :class:dropdown + + :ref:`Add Files to a Course` (how-to) + + :ref:`Add a Course Page` (how-to) + + :ref:`Adding Pages to a Course` (how-to) + + :ref:`Adding Textbooks` (how-to) + + :ref:`Configure Resources` (how-to) + + :ref:`Google Drive Files Tool` (reference) + + :ref:`The Files Page` (reference) + diff --git a/source/educators/navigation/content_creation_management.rst b/source/educators/navigation/content_creation_management.rst index 6639ce9f..7a58d6f1 100644 --- a/source/educators/navigation/content_creation_management.rst +++ b/source/educators/navigation/content_creation_management.rst @@ -50,6 +50,7 @@ Add Text Components ../how-tos/course_development/text_components/create_text_component.rst ../how-tos/course_development/text_components/add_link_website_unit_file.rst ../how-tos/course_development/text_components/add_image.rst + ../how-tos/course_development/text_components/format_image.rst ../how-tos/course_development/exercise_tools/create_full_screen_image.rst ../how-tos/course_development/text_components/paste_without_formatting.rst ../how-tos/add_written_content.rst