diff --git a/TeachingHowTos/EmbedQuizQuestions.ipynb b/TeachingHowTos/EmbedQuizQuestions.ipynb index afd29fc..42305f8 100644 --- a/TeachingHowTos/EmbedQuizQuestions.ipynb +++ b/TeachingHowTos/EmbedQuizQuestions.ipynb @@ -1,219 +1,199 @@ { "cells": [ { "cell_type": "markdown", "metadata": {}, "source": [ "# How to add auto-corrected quiz questions to my notebooks?\n", "\n", "\n", "
\n", "\"Moodle\n", "\"Moodle\n", "
\n", "\n", "Interactive quiz questions are a great way to engage students with the content of the notebook and to help them check their understanding. \n", "In this notebook, we present how to **create quiz questions in moodle** (using the H5P plugin) and **embed the questions into your notebooks**. \n", "\n", "The figure on the righ shows an example of what it can look like, before and after a student submits an answer.\n", "\n", "To see an example of a notebook including quiz questions, have a look at our [\"Suspended Objects\" example](../TeachingExamples/SuspendedObjects-exercise.ipynb). \n", "\n", "
 
\n", "\n", "\n", "## Why use moodle?\n", "\n", "

There are other ways to integrate quiz questions into notebooks but the solution we suggest here has a very important characteristic: the data collected on students' responses is stored on the EPFL moodle server.
\n", "This is extremely important in order to be consistent with the data protection and professional confidentiality provisions of Swiss law.

\n", "\n", "In addition, using moodle to create quiz questions has **a number of advantages**:\n", "* The moodle H5P plugin for creating quiz questions offers a [wide range of question types](https://h5p.org/content-types-and-applications) with multiple options to customize them ;\n", "* You don't need to write code to correct the quiz questions, the moodle H5P plugin has multiple options that allow you to give feedback automatically to students when they answer the quiz ;\n", "* In your moodle page, you will be able to see how people answer your quiz question, which can give you useful feedback ;\n", "* The quiz questions that you create in moodle can be reused for different purposes (e.g. learning activities in moodle) and they can also be exported / imported.\n", "\n", "However, this solution (as any other) has some limitations.\n", "\n", "## Limitations\n", "\n", "You need to **have a moodle course page** for creating the quiz questions and you need to have the \"teacher\" (or \"manager\") role on this page to be able to edit it. \n", "We suggest you use the moodle page of one of your courses. In case this is not possible or not adapted for your project, don't hesitate to [contact us](mailto:noto-support@groupes.epfl.ch) to discuss other options.\n", "\n", "One important limitation of this is that **the way in which you set up registrations on your moodle course** will impact **who can see your quiz questions in your notebooks**. \n", "Please [check below](#Step-0:-check-who-will-have-access-to-your-quiz-questions) who will have access to your quiz questions before anything else. \n", "\n", " \n", "\n", "## Step 0: check who will have access to your quiz questions \n", "\n", "In your moodle course, go to the \"Participants\" page and check the \"Enrolment methods\" which are activated on your course.\n", "\n", "Here is who will have access to your quiz questions depending on the enrolment methods activated (these enrolment methods can be combined):\n", - "* **\"External database\"**: students who are registered on your course on IS-Academia have access to your quiz questions - this is the option recommanded so that your students can use your quiz questions\n", - "* **\"Manual enrolment\"**: you have to add manually each persons you want to have access to your quiz questions (they need to have a GASPAR account)\n", - "* **\"Self enrolment\"**: anyone with a GASPAR account can register to your course and have access to your quiz questions - this is the option recommanded so that any EPFL students and member of EPFL staff can use your quiz questions\n", - "* **\"Guest access\"**: anyone from the general public can see your moodle page and have access to your quiz question - this is the option recommanded so that the general public can use your quiz questions, however one important drawback of this method is that you will no longer be able to see how people answer your quiz (and it also means the whole content of your moodle page is public).\n", + "1. **\"External database\"**: students who are registered on your course on IS-Academia have access to your quiz questions - this is the option recommanded so that your students can use your quiz questions\n", + "1. **\"Manual enrolment\"**: you have to add manually the persons who will have access to your quiz questions (they need to have a GASPAR account)\n", + "1. **\"Self enrolment\"**: anyone with a GASPAR account can register to your course and have access to your quiz questions - this is the option recommanded so that any EPFL students and member of EPFL staff can use your quiz questions\n", + "1. **\"Guest access\"**: anyone from the general public can see your moodle page and have access to your quiz questions - this is the option recommanded so that the general public can use your quiz questions, however one important drawback of this method is that you will no longer be able to see how people answer your quiz (and it also means the whole content of your moodle page is public).\n", + "\n", + "Please note that for methods 1, 2 and 3, people have to be **logged on moodle** when they use your notebooks so that they see your quiz questions. It is recommended to add a short sentence indicating that if they don't see the quiz then they need to log on moodle.\n", "\n", "When someone does not have access as per the enrolment methods above, here is what they see in place of the quiz question in the notebook:\n", "\n", "\"No\n", "\n", "\n", " \n" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "## Step 1: create a quiz question in moodle\n", "\n", "\n", "You need to *turn editing on* your moodle page before proceeding to the next steps.\n", "\n", "

Add a hidden section to your moodle page

\n", "\n", "We suggest that you create an additional section (\"topic\") in your moodle course page, which will serve as a container for your quiz questions. \n", "To add a section, then go at the bottom of the moodle page and click on \"Add topics\".\n", "\n", "We also suggest that you hide this section from your moodle page so that the quiz question are visible only in the notebooks - of course, if you want your students to see the questions in your moodle page then skip this step. \n", "At the top of the section, select \"Edit\" then \"Hide topic\". A blue tage should appear just below the title of the section saying `Hidden from students`.\n", "\n", "\n", "

Create a question

\n", "\n", "To create a new quiz question, use the \"Add an activity\" dropdown menu and then choose \"Interactive content\" as shown on the figure below. \n", "Attention: do not select the \"quiz\" option in the dropdown menu (this type of quiz cannot be embedded in a notebook).\n", "\n", "\"Interactive\n", "\n", "Select the type of question that you want in the list and click on it.\n", "\n", "\"Content\n", "\n", "Fill out the form to create your question, then choose \"Save and return to course\".\n", "\n", "

Make the question available

\n", "\n", "If your question is placed in a hidden section as we have suggested, then you have to indicate to moodle that you want to make the quiz question available outside of moodle (i.e. in your notebooks). On the right side of the activity, select the \"Edit\" menu and then click on \"Make available\", as shown on the image below. \n", "NB: this step is not necessary if the question is in a visible section of the moodle page (by default it is then available).\n", "\n", "\"Make\n", "\n", "Once this is done, a blue tag saying `Available but not shown on course page` should appear right below your quiz question.\n", "\n", " " ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "## Step 2: embed the question into a notebook\n", "\n", "

Get the URL of your question

\n", "\n", "From your moodle page, click on your new question. This will open your question and show you how it will look like for students. \n", "Click on the \"<> Embed\" link at the bottom of the question, as shown on the figure below. Copy the code which appears in the \"Embed\" popup.\n", "\n", "\"Embed\"\n", "\n", "Paste the code into your favorite text editor and find the URL of the question, which should appear between quotes after `\n", - " " - ], - "text/plain": [ - "" - ] - }, - "execution_count": 3, - "metadata": {}, - "output_type": "execute_result" - } - ], + "outputs": [], "source": [ "from IPython.display import IFrame\n", "IFrame('https://moodle.epfl.ch/mod/hvp/embed.php?id=1028285', 800, 600)" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "If you see the message `Vous n'avez pas accès à ce contenu. Essayez de vous connecter.`, check that you are logged on [moodle](https://moodle.epfl.ch/) using your GASPAR account and that you are registered as participant on the [Noto Community moodle page](https://moodle.epfl.ch/enrol/index.php?id=15917)." ] } ], "metadata": { "kernelspec": { "display_name": "Python 3", "language": "python", "name": "python3" }, "language_info": { "codemirror_mode": { "name": "ipython", "version": 3 }, "file_extension": ".py", "mimetype": "text/x-python", "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", "version": "3.6.8" } }, "nbformat": 4, "nbformat_minor": 4 }