.. _Notes Tool:

About the Notes Tool
#####################

.. tags:: educator, how-to

The notes tool allows learners to highlight and make notes about what
they read in the body of the course.

.. image:: /_images/educator_how_tos/SFD_SN_bodyexample.png
  :width: 500
  :alt: Image of a course page that includes highlighted text and a note.

.. note:: The notes tool is available for text, including text in
 Text components. However, the tool is currently not available for discussions,
 exercises, video transcripts, or PDF documents.

Learners can access their notes either in the body of the course or on a
**Notes** page. On the **Notes** page, a learner can see all the notes that
she has made during the course. The page also contains links to the location
of the notes in the course body.

.. image:: /_images/educator_how_tos/SN_NotesPage.png
  :width: 500
  :alt: The Notes page, listing the notes a learner has made in the
      course.

You must enable the Notes tool before learners can use it. To enable the Notes
tool, follow these steps.

.. admonition:: Install the Notes Application

   In order for the Notes Application to work, it must be installed on your Open edX instance.
   Please contact your site administrator to enable the `Notes Tutor Plugin <https://github.com/overhangio/tutor-notes>`_.
   See :ref:`Enable Notes` for more details.

#. In Studio, from the **Content** menu select **Pages & Resources**.

#. Click the gear icon on the **Notes** card shown on this page.

#. From the **Configure notes** modal, select the toggle to enable or disable the notes application.

   .. image:: /_images/educator_how_tos/enable_notes.png
     :width: 500
     :alt: The Configure Notes modal

#. Select **Save** to save your configuration changes.

.. seealso::

 :ref:`Enable Notes` (how-to)

 :ref:`RecommenderXBlock` (how-to)

 :ref:`Annotation` (how-to)

 :ref:`Calculator` (how-to)

 :ref:`Enable Completion` (how-to)


**Maintenance chart**

+--------------+-------------------------------+----------------+--------------------------------+
| Review Date  | Working Group Reviewer        |   Release      |Test situation                  |
+--------------+-------------------------------+----------------+--------------------------------+
| 2024-04-14   | sarina                        | Sumac          | Pass                           |
+--------------+-------------------------------+----------------+--------------------------------+