Creating .edu files: Difference between revisions
mNo edit summary |
m Add bare minimum exercise as example |
||
| Line 14: | Line 14: | ||
In order to gain full understanding of what each section stands for please see the '''full documentation'''. | In order to gain full understanding of what each section stands for please see the '''full documentation'''. | ||
== Creating a given task == | |||
Now we show you the steps of creating an actual .edu file from a given task. We assume you have '''downloaded the empty .edu file''', familiarized yourself with its structure '''and''' '''read the documentation'''. | |||
Let's say we have the following exercise, where '''we want students to type their solution''', not to select it from a given set of options:<syntaxhighlight lang="latex"> | |||
Determine the maximum of the following function: $f(x)=2+3\sin(\pi x)$! | |||
</syntaxhighlight>This can be done in 8 lines, '''if we only fill the mandatory sections''':<syntaxhighlight lang="latex" line="1"> | |||
%------QUESTION!------% | |||
Determine the maximum of the following function: $f(x)=2+3\sin(\pi x)$! | |||
%------ANSWER!------% | |||
5 | |||
%------TYPE!------% | |||
% [X] NUMERICAL | |||
%------CATEGORY!------% | |||
Functions | |||
</syntaxhighlight>The ''TYPE'' of the question is ''NUMERICAL'', since we are waiting for a number. We set the question type by writing ''[X]'' next to ''NUMERICAL''. | |||
Revision as of 10:18, 10 February 2017
There are two different ways to create questions that can be uploaded to EduBase:
- with a predefined Excel sheet or
- with .edu files.
In this article we will discuss .edu files, which are text based files that can be edited by any text editor, however it's recommended to use a program that supports LaTeX syntax highlighting, as math tasks tend to use LaTeX quite heavily. As EduBase Quiz operates in a browser, the system uses KaTeX to render the LaTeX code, so it's important to note that only commands that can be interpreted by KaTeX will be displayed. When creating an .edu file with math formulas, please visit the KaTeX page to try out whether your code can be interpreted or not. A red error message will indicate if there is a problem.
An empty .edu file can be downloaded from here.
The file is divided into sections, which are denoted amidst "%" signs, for example:
%------LANGUAGE------%
%------QUESTION!------%
%------ANSWER!------%
...
Categories marked with an exclamation mark (!) are mandatory to fill, like "QUESTION!" and "ANSWER!" above. Without filling these out the system will not accept your task. The order of the sections does not matter, however it's recommended to use the predefined order for the sake of clarity in case of collaborating with others.
In order to gain full understanding of what each section stands for please see the full documentation.
Creating a given task
Now we show you the steps of creating an actual .edu file from a given task. We assume you have downloaded the empty .edu file, familiarized yourself with its structure and read the documentation.
Let's say we have the following exercise, where we want students to type their solution, not to select it from a given set of options:
Determine the maximum of the following function: $f(x)=2+3\sin(\pi x)$!
This can be done in 8 lines, if we only fill the mandatory sections:
%------QUESTION!------%
Determine the maximum of the following function: $f(x)=2+3\sin(\pi x)$!
%------ANSWER!------%
5
%------TYPE!------%
% [X] NUMERICAL
%------CATEGORY!------%
Functions
The TYPE of the question is NUMERICAL, since we are waiting for a number. We set the question type by writing [X] next to NUMERICAL.