Usage
Taking an Exam
Common Flow
A common flow of exams is as the following:
-
Click "File > Open" and choose a data file.
-
Click "Exam > Start" to start an exam.
-
A question is displayed.
-
If you need a hint, press "Hint".
-
Make an answer.
-
Press "Proceed" to display the answer.
-
If you want to try the card later again, press "Retry".
-
Press "Proceed" to move to the next card.
-
Repeat from the step 3 until no more cards are left.
-
Press "Proceed" to finish the exam.
Note: Sample data files can be found in the directory "Samples".
Retry Interval
The card specified to be tried again later is pushed back by a certain
number of cards. If the number is set to 4, the card reappears after the
following four cards. To change the number, click "Exam > Rules > Details".
The retry interval also restricts the number of cards at hand. For example,
if the value is set to 4, pressing "Retry" at every card rotates regular
five cards. It means that a new card never appears until any of the rotating
cards is passed.
Creating a Data File
Data File
A data file is a text file. You can create your own data files with a text
editor. The data must be saved in an ANSI character set, not in Unicode.
A data file consists of sections. Any kind of sections is not necessary.
So, there can be a data file with no sections.
A section consists of key-value pairs. Any kind of key-value pairs is
not necessary. So, there can be a section with no key-value pairs.
A section is written in the following format:
[SECTION]
KEY=VALUE
KEY=VALUE
KEY=VALUE
KEY=VALUE
The identifiers of sections and keys are case-insensitive.
"About" Section
The "About" section contains information about a deck (a collection of
cards). It takes the following key-value pairs.
Key |
Value |
Title |
Title of the deck. |
Description |
Description of the deck. |
"Card" Section
The "Card" section contains data of things to be memorized. It takes the
following key-value pairs.
Key |
Value |
Question.Text |
Text of the question. |
Question.File |
Path of the supplementary file for the question. |
Answer.Text |
Text of the answer. |
Answer.File |
Path of the supplementary file for the answer. |
Hint |
Text of the hint. The text is displayed only when the user clicks "Hint". |
Note |
Text of the note. The text is always displayed following the answer. |
The working directory is assumed to be the parent directory of the data
file. If you want to make a data file portable, the paths of files should
be in a relative form.
Examples
Below is an example of a data file.
[About]
Title=Numbers in Italian
Description=Say numbers in Italian.
[Card]
Question.Text=1
Answer.Text=uno
[Card]
Question.Text=2
Answer.Text=due
[Card]
Question.Text=3
Answer.Text=tre
[Card]
Question.Text=4
Answer.Text=quattro
Compiling a Review Deck
To compile a review deck:
-
Start a text editor you would like.
-
Start an exam.
-
At a concerned card, click "Edit > Copy Data > Current Card" to copy its
data to the clipboard.
-
Paste the data to the text editor.
-
Repeat from the step 3 until the exam is finished.
-
Save the collected data to a file.
Back