Skip to content
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

FC-0068 docs: how-tos reviewed by 17 edunext #766

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 20 additions & 1 deletion source/educators/how-tos/add_course_page.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,27 @@
.. _Add a Course Page:

Add a Course Page
#################

.. tags:: educator, how-to

You can create a custom course page as demonstrated in the following video:

.. youtube:: vIR9auBmiFU
.. 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)


27 changes: 12 additions & 15 deletions source/educators/how-tos/course_development/add_textbooks.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
.. _Adding Textbooks:

###########################
Textbooks
###########################
#############

.. tags:: educator, how-to

Expand All @@ -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.

Expand All @@ -48,7 +47,6 @@ Add a Textbook

.. _Delete a Textbook:

*****************
Delete a Textbook
*****************

Expand All @@ -58,40 +56,39 @@ 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<Lock a
the **Textbooks** page, the recommendation is to :ref:`lock<Lock a
File>` or :ref:`delete<Delete a File>` 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
:width: 500
: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<Lock a
**Textbooks** page, the recommendation is to :ref:`lock<Lock a
File>` or :ref:`delete<Delete a File>` the PDF file for the chapter on the
**Files & Uploads** page to avoid copyright issues.

Expand Down
17 changes: 5 additions & 12 deletions source/educators/how-tos/course_development/create_course_wiki.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
.. _Create Course Wiki:

########################
Using the Course Wiki
########################

Expand All @@ -16,7 +15,6 @@ collaboratively edit information both about, and for, your course.

.. _Showing or Hiding the Wiki:

********************************
Showing or Hiding the Wiki
********************************

Expand All @@ -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
********************************

Expand All @@ -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`.
Expand All @@ -63,7 +60,6 @@ a Wiki Article`.

.. _Setting Permissions for Wiki Articles:

***************************************
Setting Permissions for Wiki Articles
***************************************

Expand All @@ -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.

Expand Down Expand Up @@ -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
********************************

Expand All @@ -129,7 +124,6 @@ Read more about tasks :ref:`Course Wiki Tasks`

.. _Locking a Wiki Article:

********************************
Locking a Wiki Article
********************************

Expand All @@ -152,7 +146,6 @@ follow these steps.

.. _Deleting a Wiki Article:

********************************
Deleting a Wiki Article
********************************

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
.. _Full Screen Image:

######################
Full Screen Image Tool
######################

Expand All @@ -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
Expand Down Expand Up @@ -68,7 +67,7 @@ Create a Full Screen Image
``<img alt="Full screen image" src="/static/Image1.jpg"/>``

* 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
Expand All @@ -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**.
#. 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)
Loading