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.

Sign up for GitHub

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: reference and how-tos reviewed by edunext 21 #772

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

FC-0068 docs: reference and how-tos reviewed by edunext 21 #772

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a9bd7a9
FC-0068 docs: reference and how-tos reviewed by edunext 21
Apgomeznext Jan 13, 2025
d763116
Update learner_engagement_communication.rst
Apgomeznext Jan 13, 2025
16a3e10
Update dashboard_profile.rst
Apgomeznext Jan 13, 2025
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
7 changes: 6 additions & 1 deletion source/educators/how-tos/course_development/exercise_tools/add_word_cloud.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,4 +78,9 @@ To create a word cloud, follow these steps.
frequency that each of their own contributed words has been entered is
shown as a percentage of all words entered.

#. Select **Save**.
#. Select **Save**.

.. seealso::
:class:dropdown

:ref:`Create Exercises` (concepts)
106 changes: 106 additions & 0 deletions source/educators/how-tos/course_development/exercise_tools/create_poll_olx.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
.. _Create a Poll:

Create a Poll for OLX
########################

.. tags:: educator, how-to

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would add in the Note from the Reference to this page as well, because it's important.

.. note:: Creating a poll requires you to export your course, edit some of
 your course's XML files in a text editor, and then re-import your course. We
 recommend that you create a backup copy of your course before you create the
 poll. We also recommend that you only edit the files that will contain polls
 in the text editor if you are very familiar with editing XML.

#. In the unit where you want to create the poll, create components that
contain all the content that you want *except* for the poll. Make a note of
the 32-digit unit ID that appears in the **Unit Identifier** field under
**Unit Location**.

#. Export your course. For information about how to do this, see
:ref:`Export a Course`. Save the .tar.gz file that contains
your course in a memorable location so that you can find it easily.

#. Locate the .tar.gz file that contains your course, and then unpack the
.tar.gz file so that you can see its contents in a list of folders and
files.

- To do this on a Windows computer, you need to download a third-party
program. For more information, see `How to Unpack a tar File in Windows
<https://www.haskell.org/haskellwiki/How_to_unpack_a_tar_file_in_Windows>`_,
`How to Extract a Gz File <https://www.wikihow.com/Extract-a-Gz-File>`_,
`The gzip Home Page <http://www.gzip.org/>`_, or the `Windows
<http://www.ofzenandcomputing.com/how-to-open-tar-gz-files/#windows>`_
section of the `How to Open .tar.gz Files
<http://www.ofzenandcomputing.com/how-to-open-tar-gz-files/>`_ page.

- For information about how to do this on a Mac, see the `Mac OS X <http://www.ofzenandcomputing.com/how-to-open-tar-gz-files/#mac-os-x>`_ section of the `How to Open .tar.gz Files <http://www.ofzenandcomputing.com/how-to-open-tar-gz-files/>`_ page.

#. In the list of folders and files, open the **Vertical** folder.

.. note:: If your unit is not published, open the **Drafts** folder, and then open the **Vertical** folder in the **Drafts** folder.

#. In the **Vertical** folder, locate the .xml file that has the same name as
the unit ID that you noted in step 1, and then open the file in a text
editor such as Sublime 2. For example, if the unit ID is
e461de7fe2b84ebeabe1a97683360d31, you open the
e461de7fe2b84ebeabe1a97683360d31.xml file.

The file contains a list of all the components in the unit, together with
the URL names of the components. For example, the following file contains an
Text component followed by a discussion component.

.. code-block:: xml

<vertical display_name="Test Unit">
<html url_name="b59c54e2f6fc4cf69ba3a43c49097d0b"/>
<discussion url_name="8320c3d511484f3b96bdedfd4a44ac8b"/>
</vertical>

#. Add the following poll code in the location where you want the poll. Change
the text of the prompt to the text that you want.

.. code-block:: xml

<poll_question display_name="Poll Question">
<p>Text of the prompt</p>
<answer id="yes">Yes</answer>
<answer id="no">No</answer>
</poll_question>

In the example above, if you wanted your poll to appear between the HTML
component and the discussion component in the unit, your code would resemble
the following.

.. code-block:: xml

<vertical display_name="Test Unit">
<html url_name="b59c54e2f6fc4cf69ba3a43c49097d0b"/>
<poll_question display_name="Poll Question">
<p>Text of the prompt</p>
<answer id="yes">Yes</answer>
<answer id="no">No</answer>
</poll_question>
<discussion url_name="8320c3d511484f3b96bdedfd4a44ac8b"/>
</vertical>

#. After you add the poll code, save and close the .xml file.

#. Re-package your course as a .tar.gz file.

#. In Studio, re-import your course. You can now review the poll question and
answers that you added in Studio.

.. note::

* Although polls render correctly in Studio, you cannot edit them in Studio.
You will need to follow the export/import process outlined above to make
any edits to your polls.

* A .csv file that contains student responses to the problem is not currently
available for polls. However, you can obtain the aggregate data directly in
the problem.

.. seealso::
:class: dropdown

:ref:`Poll Tool for OLX` (reference)

:ref:`Poll Tool` (reference)

:ref:`Add Poll` (how to)

:ref:`Enable Poll in OLX` (reference)
47 changes: 47 additions & 0 deletions ...ow-tos/course_development/exercise_tools/download_data_instructor_dashboard.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
.. _Download Data from the Instructor Dashboard:

Download Data from the Instructor Dashboard
##############################################

.. tags:: educator, how-to

#. In the LMS, select **Instructor**.
#. Select **Data Download**.
#. Under **Data Download**, select **Get Student Anonymized IDs CSV**. If you
receive a prompt, specify the location where you want to save the file.

The .csv file is saved to your computer. The file has the following name.

``<course name>_<course number>_<year>_<term>_anon-ids.csv``

For more information about anonymized student IDs, see
:ref:`Access_anonymized`.

#. Under **Reports**, select **Download profile information as a CSV**.
#. When the profile information report appears in the list under **Reports
Available for Download**, select the report to download the .csv file to
your computer. The file has the following name.

``<course name>_<course number>_<year>_<term>_student_profile_info_<date and time>.csv``

For more information about accessing learner data, see :ref:`Learner Data`.

Download Data from Qualtrics
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't see why this is here. This either

(a) refers to the Qualtrics survey tool, in which case I don't see why you'd put these instructions next to the instructor dashboard instructions;

(b) refers to something edx.org-specific

I don't know which. @jswope00 - any ideas? This section seems incongruous with the above section on downloading data from the instructor dashboard.

*******************************

.. note:: Because Qualtrics is a third-party tool, the following steps might
change without notice. See the `Qualtrics website
<http://www.qualtrics.com>`_ for the most up-to-date Qualtrics documentation.

#. In Qualtrics, select the **View Results** tab.
#. On the page that opens, select **Download Data** in the upper left corner
of the page.
#. On the page that opens, clear the **Compress the desired format into a .zip
file before downloading** check box. Accept all the other default values.
#. Under **Format**, select the **This is a Comma
Separated Values format...** link to download the .csv file.

.. seealso::
:class: dropdown

:ref:`Qualtrics Survey` (how to)
11 changes: 11 additions & 0 deletions source/educators/how-tos/sidebar_collapse_expand.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _Collapse and expand the navigation sidebar:

Collapse and expand the navigation sidebar
##########################################

Expand All @@ -16,3 +18,12 @@ of the page:

As the learner advances through the course content, the expanded or collapsed
state of the sidebar remains consistent.

.. seealso::
:class:dropdown

:ref:`What is LMS` (concept)

:ref:`What is Studio` (concept)

:ref:`Course Outline` (concept)
13 changes: 11 additions & 2 deletions source/educators/how-tos/sidebar_view_course_section.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
View course sections from the navigation sidebar
View Course Sections from the Navigation Sidebar
################################################

.. tags:: educator, how-to
Expand All @@ -18,4 +18,13 @@ Clicking on any section:
brings you to a view of the contents of that section, regardless of where you
are in the course at the moment:

.. image:: /_images/educator_how_tos/LSN_view_sections_step2b.png
.. image:: /_images/educator_how_tos/LSN_view_sections_step2b.png

.. seealso::
:class:dropdown

:ref:`What is LMS` (concept)

:ref:`What is Studio` (concept)

:ref:`Course Outline` (concept)
4 changes: 3 additions & 1 deletion source/educators/navigation/learner_engagement_communication.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,7 @@ Poll Tool

../references/course_development/exercise_tools/poll_olx.rst
../references/course_development/exercise_tools/enable_poll_OLX.rst
../how-tos/course_development/exercise_tools/create_poll_olx.rst


Survey Tool
Expand All @@ -154,6 +155,7 @@ Qualtrics Survey Tool

../how-tos/course_development/exercise_tools/add_qualtrics_survey.rst
../references/course_development/exercise_tools/view_qualtrics_responses.rst
../how-tos/course_development/exercise_tools/download_data_instructor_dashboard.rst
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Downloading data from the instructor dashboard should be under Course Data, no? https://docs.openedx.org/en/latest/educators/navigation/data_analytics.html @jswope00




Expand All @@ -164,4 +166,4 @@ Word Cloud Tool
:maxdepth: 2
:glob:

../how-tos/course_development/exercise_tools/add_word_cloud.rst
../how-tos/course_development/exercise_tools/add_word_cloud.rst
7 changes: 3 additions & 4 deletions source/educators/references/course_development/exercise_tools/enable_poll_OLX.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
Alternatively, you can use OLX to enable the poll tool.

.. _Enable Poll in OLX:

======================================
Enable the Poll Tool in OLX
======================================
############################

.. tags:: educator, reference

.. note:: Alternatively, you can use OLX to enable the poll tool.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't understand why this note was added, without a link to the alternative option. What should I do with this note?


To enable polls in your course, you edit the XML file that defines
the course structure.

Expand Down
8 changes: 3 additions & 5 deletions ...ce/educators/references/course_development/exercise_tools/enable_survey_olx.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
.. _Enable Survey OLX:

======================================
Enable the Survey Tool in OLX
======================================
################################

.. tags:: educator, reference

Expand All @@ -22,7 +21,6 @@ For example, the following XML code enables the survey tool.
...
</course>

***************************
Add a Survey in OLX
***************************

Expand Down Expand Up @@ -69,9 +67,9 @@ The following example shows the OLX definition for a survey with two questions.
]"
/>

==========================

survey Element Attributes
==========================
**************************

The following table describes the attribute of the ``survey`` element.

Expand Down
2 changes: 1 addition & 1 deletion source/educators/references/course_development/exercise_tools/google_calendar.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Tool`.
.. note:: Google services are not available in some regions and countries.
If Google services are not available in a learner's area, the learner might
see an "image unavailable" message in the place of the Google Drive file or
Google Calendar. EdX strongly suggests that you provide alternative resources
Google Calendar. The recommendation is to provide alternative resources
for learners in these areas.

*********
Expand Down
Loading