.. _Manage the Course Wiki:

Manage the Course Wiki
########################

.. tags:: educator, how-to

Wikis provide a way for the course team and learners to access, share, and
collaboratively edit information both about, and for, your course. In order
to access the course wiki, :ref:`view the live version of your course<View Published Content>`.

.. contents::
   :depth: 1
   :local:


.. _Showing or Hiding the Wiki:

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

To disable or enable the Wiki application, follow these steps.

#. In Studio, from the **Content** menu select **Pages & Resources**.
#. Click the gear icon on the **Wiki** card shown on this page.
#. From the **Configure wiki** modal, select the toggle to enable or disable the **wiki**.
#. Select **Save** to save your configuration changes.

   .. image:: /_images/educator_how_tos/configure_wiki.png
    :width: 600
    :alt: The modal shown where you can toggle the wiki and press the "Save" button.


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.

When authoring in :ref:`OLX TOC`, remove the ``{"type": "wiki"}`` entry in your ``/policies/TERM/policy.json`` file.

.. _Controlling Wiki Access:

Controlling Access to the Wiki
********************************

You can control access to the wiki in various ways: by changing access to the
wiki as a whole, by changing the read/write permissions settings of articles
within the wiki, or by locking articles.

To change access to the course wiki, follow these steps.

#. In Studio, from the **Content** menu select **Pages & Resources**.
#. Click the gear icon on the **Wiki** card shown on this page.
#. From the **Configure wiki** modal, check or uncheck the toggle of the **Enable public wiki access** setting.
#. Select **Apply** to save your configuration changes.


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 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 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`.

To lock an article and prevent further editing, see :ref:`Locking
a Wiki Article`.

.. _Setting Permissions for Wiki Articles:

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

To prevent certain groups of users from being able to add or edit articles, you
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 wide wiki, and cannot be found within the course wiki).

To modify the permissions for wiki articles, follow these steps.

#. :ref:`View the live version of your course<View Published Content>`.
#. Select **Wiki**.
#. Navigate to the article whose permissions you are modifying, and then select
   **Settings**.
#. In the **Permissions** section of the **Settings** page, select or clear the
   checkboxes for read or write access for **Group** or **Other**.
#. At the bottom of the page, select the **Save changes** button for the
   **Permissions** section.

Note that there are two different **Save changes** buttons, one near the top of
the page for the **Notifications** section, and one at the bottom of the page
for the **Permissions** section. If you are modifying permissions, make sure
you select the **Save changes** button at the bottom of the page for your
changes to be saved.

===============================
Groups Used in Wiki Permissions
===============================

Each course has the following groups.

    * Beta Testers (by default there are no beta testers until you add them)
    * Admins (by default, the course author is always in this group)
    * Staff (these are course team members)

You add users to these groups in the LMS by selecting **Instructor** and then
**Membership**.

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. 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
********************************

To ensure that learners get the most out of your course wiki, design the wiki
space before the course starts by seeding the course wiki with articles that
give it the desired structure.

For example, you could create wiki articles to mirror the course outline. At
the top level, you could provide a course outline, FAQs, and links to the main
articles for each section. In the child articles for each section, you could
provide information specific to the units and components in that section, and a
page for learners to share their feedback and experiences.

Read more about creating wiki articles at :ref:`Contribute to the Course Wiki`

.. _Locking a Wiki Article:

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

Locking a wiki article prevents further changes from being made to it. To lock
a wiki article either after you create it, or after you make specific edits,
follow these steps.

.. note::

   If you only lock an article without modifying the read/write permissions,
   other users can still create wiki articles at the top level. They also appear
   still to have an Edit button at the top level, but they get Permission Denied
   when they click Edit.

#. :ref:`View the live version of your course<View Published Content>`.
#. Select **Wiki**.
#. Navigate to the article you want to lock, and then select **Settings**.
#. In the **Permissions** section of the **Settings** page, select the **Lock
   article** checkbox.
#. At the bottom of the page, select the **Save changes** button for the
   **Permissions** section.

.. _Deleting a Wiki Article:

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

Only course team members can delete articles. In addition, you can only delete
an article if you have permissions to edit that article. If you have the
required permissions, you see a **Delete article** button at the bottom of the
**Edit** page.

To delete an article, follow these steps.

#. :ref:`View the live version of your course<View Published Content>`.
#. Select **Wiki**.
#. Navigate to the article you want to delete, and then select **Edit**.
#. Select **Delete article** at the very bottom of the page.
#. On the deletion confirmation page, select **Yes, I am sure**.
#. Optionally, also select the **Purge** checkbox. For details, see
   :ref:`Purging a Wiki Article`.
#. Select **Delete article** to confirm the deletion.


.. _Purging a Wiki Article:

========================
Purging a Wiki Article
========================

When you delete and purge an article, it is completely removed from the wiki,
with no option to undo the deletion. Select this option only if you are sure
you will not want to restore the content.

To purge an article as you delete it, select the **Purge** checkbox on the
deletion confirmation page.


.. _Restoring a Deleted Wiki Article:

=================================
Restoring a Deleted Wiki Article
=================================

Articles that have been deleted but not purged can be restored. A link to the
article remains visible at the level at which it was created.

To restore a deleted article, select the link to the article and select
**Restore**.

.. seealso::
 

 :ref:`About Course Wiki` (reference)

 :ref:`Contribute to the Course Wiki` (how to)


**Maintenance chart**


+--------------+-------------------------------+----------------+--------------------------------------------------------------+
| Review Date  | Working Group Reviewer        |   Release      |Test situation                                                |
+--------------+-------------------------------+----------------+--------------------------------------------------------------+
| 2025-04-13   | sarina                        | Sumac          | Pass                                                         |
+--------------+-------------------------------+----------------+--------------------------------------------------------------+
| 03/20/2025   | Leira (Curricu.me)            |   Sumac        | Fail (https://github.com/openedx/docs.openedx.org/issues/963)|
+--------------+-------------------------------+----------------+--------------------------------------------------------------+