Skip to content

X
xblock-mentoring
Commit bca0bdf7 by Xavier Antoviaque
Options

Add deprecation warning to README and link to current version

parent fd472edd
Showing with 3 additions and 158 deletions
README.md
...@@ -3,163 +3,8 @@ Mentoring XBlock ...@@ -3,163 +3,8 @@ Mentoring XBlock
This XBlock allows to automate the workflow of real-life mentoring, within an edX course. This XBlock allows to automate the workflow of real-life mentoring, within an edX course.
It supports: **Warning: This is an outdated and deprecated version of the Mentoring XBlock.** Please upgrade to the latest version, Mentoring v2, aka Problem Builder: https://github.com/open-craft/problem-builder
* **Free-form answers** (textarea) which can be shared accross different XBlock instances (for example, to remind a student of an answer he gave before). Editable or read-only.
* **Self-assessment quizzes** (multiple choice), to display predetermined feedback to a student based on his choices in the self-assessment. Supports rating scales and arbitrary answers.
* **Progression tracking**, allowing to check that the student has completed the previous steps before allowing to complete a given XBlock instance. Provides a link to the next step to the student.
* **Tables**, which allow to present answers from the student to free-form answers in a concise way. Supports custom headers.
Examples
--------
### Free-form answers
First XBlock instance:
```xml
<mentoring url_name="goal_definition" followed_by="getting_feedback">
<html>
<p>What is your goal?</p>
</html>
<answer name="goal" />
</mentoring>
```
Second XBlock instance:
```xml
<mentoring url_name="getting_feedback">
<html>
<p>The goal you entered was:</p>
</html>
<answer name="goal" read_only="true" />
<html>
<p>Ask feedback from friends about this goal - what did they think?</p>
</html>
<answer name="goal_feedback" />
</mentoring>
```
### Self-assessment quizzes
```xml
<mentoring url_name="quizz_1" enforce_dependency="false">
<quizz name="quizz_1_1" type="choices">
<question>Do you like this quizz?</question>
<choice value="yes">Yes</choice>
<choice value="maybenot">Maybe not</choice>
<choice value="understand">I don't understand</choice>
<tip display="yes">Great!</tip>
<tip reject="maybenot">Ah, damn.</tip>
<tip reject="understand"><html><div id="test-custom-html">Really?</div></html></tip>
</quizz>
<quizz name="quizz_1_2" type="rating" low="Not good at all" high="Extremely good">
<question>How much do you rate this quizz?</question>
<choice value="notwant">I don't want to rate it</choice>
<tip display="4,5">I love good grades.</tip>
<tip reject="1,2,3">Will do better next time...</tip>
<tip reject="notwant">Your loss!</tip>
</quizz>
<message type="completed">
All is good now...
<html><p>Congratulations!</p></html>
</message>
</mentoring>
```
### Tables
```xml
<mentoring-table type="goal" url_name="goal_table">
<column>
<header>Your goal</header>
<answer name="goal" />
</column>
<column>
<header>Header Test 2</header>
<answer name="goal_feedback" />
</column>
</mentoring-table>
```
Installing dependencies
-----------------------
From the xblock-mentoring repository, and within the Python virtual environment you used to setup the XBlock
workbench or the LMS, install the requirements:
```bash
$ pip install -r requirements.txt
```
You also need to install the mentoring XBlock in the same virtual environment. From the `xblock-mentoring`
directory, enter:
```bash
$ pip install -e .
```
Custom workbench settings
-------------------------
In the main XBlock repository, create the following configuration file in `workbench/settings_mentoring.py`
in the XBlock repository:
```python
from settings import *
INSTALLED_APPS += ('mentoring',)
DATABASES['default']['NAME'] = 'workbench.sqlite'
```
Starting the workbench
----------------------
Because this XBlock uses a Django model, you need to sync the database before starting the workbench. Run this
from the XBlock repository root:
```bash
$ ./manage.py syncdb --settings=workbench.settings_mentoring
```
Then start the workbench:
```bash
$ ./manage.py runserver 8000 --settings=workbench.settings_mentoring
```
Access it at http://localhost:8000/
Running tests
-------------
From the xblock-mentoring repository root, run the tests with the following command:
```bash
$ DJANGO_SETTINGS_MODULE="workbench.settings_mentoring" PYTHONPATH=".:/path/to/xblock" nosetests --with-django
```
`/path/to/xblock` is the path to the XBlock main repository (the one containing the workbench)
Adding custom scenarios to the workbench If you have existing course content using Mentoring v1, you would need to upgrade that content to v2, see https://github.com/open-craft/problem-builder#upgrading-from-version-1 (note that you should do this at the beginning of a course run, before users start using it).
----------------------------------------
Within the xblock-mentoring repository, create the `templates/xml` and add XML scenarios to it - all files with
the `*.xml` extension will be automatically loaded by the workbench:
```bash
$ mkdir templates/xml
$ cat > templates/xml/my_mentoring_scenario.xml
```
Restart the workbench to take the new scenarios into account.
If for some reason you can't upgrade now, you can use the latest Mentoring v1 version: https://github.com/edx-solutions/xblock-mentoring
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment