Creating .edu files: Difference between revisions
mNo edit summary |
m Bold important parts |
||
Line 1: | Line 1: | ||
There are two different ways to create questions that can be uploaded to [https://www.edubase.hu/ 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. EduBase uses [https://khan.github.io/KaTeX/ KaTeX] to render the LaTeX code | There are '''two different ways to create questions''' that can be uploaded to [https://www.edubase.hu/ 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 [https://khan.github.io/KaTeX/ 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 consult with the KaTeX page''' to try out whether your code can be interpreted or not. A red error message will indicate the problem. | |||
An empty .edu file can be downloaded from '''here'''. | An empty .edu file can be downloaded from '''here'''. | ||
The file is divided into sections, which are denoted amidst % signs, | The file is divided into sections, which are denoted amidst "''%''" signs, for example:<syntaxhighlight lang="latex" line="1"> | ||
%------LANGUAGE------% | %------LANGUAGE------% | ||
%------QUESTION!------% | %------QUESTION!------% | ||
%------ANSWER!------% | %------ANSWER!------% | ||
... | ... | ||
</syntaxhighlight>Categories marked with an exclamation mark (!) are mandatory to fill in, like "''QUESTION!''" and "''ANSWER!''" above. Without filling these out the system will not accept your task, however the order of the sections does not matter, but it's recommended to use the predefined order for the sake of clarity in case of collaborating with others. | </syntaxhighlight>Categories marked with an '''exclamation mark''' ('''!''') are '''mandatory to fill''' in, like "''QUESTION'''!'''''" and "''ANSWER'''!'''''" above. Without filling these out the system will '''not accept''' your task, however the order of the sections does not matter, but '''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 refer to the full documentation. | In order to gain full understanding of what each section stands for please refer to the '''full documentation'''. |
Revision as of 16:37, 9 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 consult with the KaTeX page to try out whether your code can be interpreted or not. A red error message will indicate the 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 in, like "QUESTION!" and "ANSWER!" above. Without filling these out the system will not accept your task, however the order of the sections does not matter, but 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 refer to the full documentation.