diff --git a/README.md b/README.md index a5b27fe..0352247 100644 --- a/README.md +++ b/README.md @@ -162,6 +162,18 @@ python -m pip install text2qti Depending on your system, you may need to use `python3` instead of `python`. This will often be the case for Linux and OS X. +### Demo + +There is a demo `[quiz.txt](demo/quiz.txt)` file with a set of sample questions that can be converted into a QTI quiz on Canvas. + +To test out this python package, you can download the `[quiz.txt](demo/quiz.txt)` file, and after installing `text2qti`, run it as follows: + +``` +text2qti quiz.txt +``` + +The output of this script will be a zip file `[quiz.zip](demo/quiz.zip)` that can be imported into Canvas. +Once the import is done, a quiz will appear - a PDF print of that quiz will look similar to `[quiz.pdf](demo/quiz.pdf)` ### Upgrading diff --git a/demo/quiz.pdf b/demo/quiz.pdf new file mode 100644 index 0000000..56e4d5d Binary files /dev/null and b/demo/quiz.pdf differ diff --git a/demo/quiz.txt b/demo/quiz.txt new file mode 100644 index 0000000..f036726 --- /dev/null +++ b/demo/quiz.txt @@ -0,0 +1,54 @@ +Quiz title: Sample Quiz +Quiz description: Add a Description of the quiz + +Title: Multiple Choice Q +Points: 2 +1. What is 2+3? +... General question feedback. ++ Feedback for correct answer. +- Feedback for incorrect answer. +a) 6 +... Feedback for this particular answer. +b) 1 +... Feedback for this particular answer. +*c) 5 +... Feedback for this particular answer. + +Title: Checkbox Q +Points: 2 +1. Which of the following are dinosaurs? +[ ] Woolly mammoth +[*] Tyrannosaurus rex +[*] Triceratops +[ ] Smilodon fatalis + +Title: Numerical Q1 +Points: 2 +1. What is the square root of 2? += 1.4142 +- 0.0001 + +Title: Numerical Q2 +Points: 2 +1. What is the cube root of 2? += [1.2598, 1.2600] + +Title: Fill in the Blank +Points: 2 +1. Who lives at the North Pole? +* Santa +* Santa Claus +* Father Christmas +* Saint Nicholas +* Saint Nick + +Title: Essay Question +Points: 2 +1. Write an essay. +... General question feedback. +____ + +Title: Upload a File +Points: 2 +1. Upload a file. +... General question feedback. +^^^^ \ No newline at end of file diff --git a/demo/quiz.zip b/demo/quiz.zip new file mode 100644 index 0000000..3ff3e23 Binary files /dev/null and b/demo/quiz.zip differ