docs: Add How-To on Creating Sections independently of Course Outline

openedx · Jun 22, 2024 · fad5625 · fad5625
1 parent db4c415
commit fad5625
Show file tree

Hide file tree

Showing 9 changed files with 47 additions and 2 deletions.
diff --git a/source/_images/educator_how_tos/hide_in_outline_access_link.png b/source/_images/educator_how_tos/hide_in_outline_access_link.png
diff --git a/source/_images/educator_how_tos/hide_in_outline_custom_pages.png b/source/_images/educator_how_tos/hide_in_outline_custom_pages.png
diff --git a/source/_images/educator_how_tos/hide_in_outline_embed_link.png b/source/_images/educator_how_tos/hide_in_outline_embed_link.png
diff --git a/source/_images/educator_how_tos/hide_in_outline_embedding_the_page.png b/source/_images/educator_how_tos/hide_in_outline_embedding_the_page.png
diff --git a/source/_images/educator_how_tos/hide_in_outline_link_display.png b/source/_images/educator_how_tos/hide_in_outline_link_display.png
diff --git a/source/_images/educator_how_tos/hide_in_outline_share_link.png b/source/_images/educator_how_tos/hide_in_outline_share_link.png
diff --git a/source/community/release_notes/redwood/potpourri.rst b/source/community/release_notes/redwood/potpourri.rst
@@ -19,9 +19,10 @@ reference links to material that must be reviewed at different times of the
 course, and gives learners an easy way to consistently reference parts of the
 course that may need regular review.
 
-For more details on how to use this feature, see the How-to guide. 
+For more details on how to use this feature, see
+:doc:`/educators/how-tos/use_section_independently_of_course_outline`.
 
-For more details on how to turn this feature on, see the :doc:`dev_op_release_notes`.
+For more details on how to turn this feature on, see :doc:`dev_op_release_notes`.
 
 Embed an iframe into the Text Editor
 ************************************

diff --git a/source/educators/how-tos/index.rst b/source/educators/how-tos/index.rst
@@ -124,6 +124,7 @@ Educators: How-tos
          set_release_dates
          publish_content
          hide_content_from_learners
+         use_section_independently_of_course_outline
          set_up_content_groups
          set_access_restrictions_on_unit
          set_access_restrictions_on_component

diff --git a/source/educators/how-tos/use_section_independently_of_course_outline.rst b/source/educators/how-tos/use_section_independently_of_course_outline.rst
@@ -0,0 +1,43 @@
+Use a Section from a Course independently of the Course Outline
+###############################################################
+
+#. From the course outline in Studio, go to the visibility options of a Section.
+   You will see the option “Hide in Course Outline, accessible via Link”:
+
+     .. image:: /_images/educator_how_tos/hide_in_outline_access_link.png
+
+#. When selected and saved, the interface indicates that this section has been
+   hidden but can be accessed through its URL:
+
+     .. image:: /_images/educator_how_tos/hide_in_outline_link_display.png
+
+#. Clicking on the :guilabel:`Share` button enables you to copy the URL to the specific
+   subsection for sharing. There are two sharing options, as the URL for a
+   complete page, or as the URL to embed.
+
+   #. The first option “Full Page” shows the content on the original page, that
+      is, with the header and footer of the site:
+
+        .. image:: /_images/educator_how_tos/hide_in_outline_share_link.png
+
+   #. The second option “Embed Link” displays the content directly on a page
+      without a header or footer. This is ideal for embedding in other places:
+
+        .. image:: /_images/educator_how_tos/hide_in_outline_embed_link.png
+
+#. To embed one of the hidden subsections on a page outside the course flow,
+   copy the link to embed. In Studio, go to the option “Content” → “Pages &
+   Resources” → “Custom pages”:
+
+     .. image:: /_images/educator_how_tos/hide_in_outline_custom_pages.png
+
+#. There the subsection is embedded using the URL copied previously. Keep in
+   mind to adjust the height and width of the iframe using the style attribute
+   with the height in pixels as required: ``style="height: 900px; width: 100%;"``:
+
+     .. image:: /_images/educator_how_tos/hide_in_outline_embedding_the_page.png
+
+
+Now, when the course is viewed from the LMS as a student, the section is not
+displayed in the course outline. You can test this by using the masquerade
+feature in the LMS; see :doc:`view_course_as_learner` for more.