2. Usage guide
There are two types of users, for teachers (with edit permissions), and students.
There are two areas: Units (you can manage the units and their content) and courses (you can model the content in courses to share it with students).
Here you can see the hierarchy of units. You can search and focus one or more units.
You can choose the level of parents and children of the focused units that you want to show.
If you right click on a unit, you can see a menu with different options. You can edit its name, delete it and add new relationships.
To add a new relation, you must select the type of relationship you want and then click on the unit you want to relate it to.
Also you can edit relationships.
You can create new units. These units will appear in green until saved. But there cannot be repeated names in the same context, if there are name conflicts that does not allow saving, the conflicting units will appear in red.
If you double click on a unit, you will enter in it, and you can manage its content.
Here you can create content in the form of cards. To edit it is in AsciiDoc format, and also you can see the preview.
Inside a card, in addition to text, you can insert an image.
By default, the content of the cards is expanded, you can hide it to see only the title.
Cards are sorted, you can change the order.
There are three types of exercises: Definition, test and list.
- The definition exercise is an open question that the student has to answer.
- The test exercise is a question with some options to answer. The student has to choose just one from the options.
- The list exercise is a question with options to answer. Unlike the test, the student can choose more than one option.
The exercise belongs to an unit. When you choose exercises on the unit menu, you can see a list of the exercises inside the unit.
In this screen you can create new exercises. First, in this example a new definition exercise is created. To create the exercise you need to insert the question itself.
In this example a test exercise is created. To create this exercise you need to insert the question and the answer options. These options can be marked as correct and deleted. Just one of the answers can be correct.
Finally, in this example a list exercise is created. To create this exercise you need to insert the question and the answer options. These options can be marked as correct and deleted. Unlike the test question, more than one answer can be marked as correct.
In this screen you can delete questions and edit them too. When you choose an exercise you will be redirected to a new screen with different information according to the question type.
If you choose a definition exercise the screen shows a chart with information about the student answers (correct, wrong and uncorrected answers). Here you can correct the uncorrected answers too and watch a history of the corrected ones.
If you choose a list exercise, the screen shows a chart with correct/wrong answers and another chart with the most chosen wrong answers. Also, if the question is getting to many wrong answers, a warning message will be shown.
Finally, if you choose a test exercise, the screen shows a chart with correct/wrong answers and another chart with the most chosen wrong answers. Also, if the question is getting to many wrong answers, a warning message will be shown.
A lesson contains a group of slides and its written with AsciiDoc format.
The lesson belongs to an unit. In the unit menu, you can choose lessons and see which ones are inside the unit. In the lesson menu you can delete a lesson or add a new one.
When you choose a lesson you start editting it. On the left pannel the raw AsciiDoc text is shown, on the left pannel you can see the preview. This preview is the way a student sees the lesson.
There are some elements that has been added to AsciiDoc in order to make the lesson way more editable. The first thing you see in the lesson is "==" followed by the name of the lesson. Next step is editting each slide, that slide starts with "===" followed by the name of the slide. The slide is closed with "//"
Appart from text, you can add cards from other unit, slides from other lesson, exercises and images. To add a card you add "insert.card/{Name of the unit the card is in}/{Name of the card} or you can choose it with the tool in the tool menu.
To add a slide you add "insert.slide/{Name of the unit the lesson with the slide is in}/{Name of the lesson the slide is in}/{Name of the slide} or you can choose it with the tool in the tool menu.
To add an exercise you can use the tool in the tool menu.
To add an image you can use the tool in the tool menu.
Everytime you choose an element from the tool, the insert will be copied to clipboard and added to the lesson. Also, in order to avoid mistakes, whenever a name of unit, slide, or lesson is edited, the lesson with the insert will be updated with the new name too.
An itinerary contains a group of lessons or other itineraries recursively. It has a tree shape.
The itinerary belongs to an unit. In the unit menu, you can choose itineraries and see which ones are inside the unit. In the itinerary menu you can delete an itinerary or add a new one.
When you open an itinerary you can see the itinerary shape and open his nodes.
You can delete the nodes inside the tree, no matter its an itinerary or a lesson.
You can add new nodes, this node can be an itinerary or a lesson. In order to avoid recursive mistakes, its not allowed to add a parent itinerary inside a child one. If the user tries to add that, a message will shown.
A course contains an itinerary and a group of students. The course also contains a progress study of the itinerary and the student alone.
The course tab contains a list of the courses that were made by the teacher logged.
A new course can be created in this screen too. To create a new course you must give a name, a description and the itinerary that will be teached in the course. Then, when the course has been created, an URL is copied to the clipboard so the teacher gives that URL to the students. When the student uses that URL, he can start to study the course.
When you access the course you can see the tree of the itinerary and a list of students, in this screen you can add new students too. When you add a new student the URL will be copied so the teacher can give it to the new student.
In the course menu, if you choose the itinerary progress you will se a tree-table with info of each node of the itinerary with questions. In the table you can analyze the realization of the students and the average grade of each of the nodes. Also, there is a chart with the average grade of the main itinerary child nodes.
The other option in the course menu is the class progress. In this screen the teacher can see the realization and average grade of each student and a chart of the grades groupped. You can search in the student table.
The student home shows the courses the student is in.
When the student access a course, he can see a index itinerary on the right, where he can choose the lesson he wants to study; and the itinerary that will allow him to access the desired lesson.
When the student starts a lesson, he will see a group of slides to study.
The lesson also contains exercises. When the student opens the question menu, he can see the exercises that are into the lesson and he can solve them.
First, here is an example of a definition question. The student solves it and awaits for the teacher to correct it.
Second, a list question. The student chooses the answers that are correct and drags them. These exercises will be auto-corrected.
Finally, the test question. In the test question the student will choose just one answer and, like list questions, will be autocorrected.
