vocab tester documentation

The vocab tester allows you to review vocabulary stored in text files in a the format described below. The vocab files can be located anywhere on the Web. You can also print out a list of vocabulary for review when you don't have access to the computer.

When you have reviewed all the items in the file you will see the symbol ▲. If you click on the Next button again you will start once more from the beginning of the list.

Creating a test file

Add vocabulary to a simple text file, one line per term. Each line should contain the term in language A, an optional Latin transcription of the term in language A, and the term in language B, in that order. Each of these must be separated by the character ¶, and there must always be two such characters per line. The file must be saved in the UTF-8 (Unicode) character encoding.

You can add comments to your text file. Comments must start on a new line and begin with with the character #.

You can also add meta-data to your test file. This will be displayed at the bottom of the vocab tester page. Meta-data must start on a new line and begin with the character @. You could use this to describe the content of the file, and attach copyright information.

You must escape double-quotes in the test lines, ie. use ".

Here is an example of a very short file:

丸一日¶maru.ichi.nichi¶all day long 
五才¶go.sai¶5 years old
野菜¶¶vegetable 
# look up transcription for above!
才能¶sai.nou¶talent 
@ This is a small Japanese-English test file.
@ Copyright © Richard Ishida

[Note: you must take care to ensure that the file doesn't start with a BOM, if using comment or meta-data on the first line of a file. Otherwise the comment or meta-data will not be recognised. Windows Notepad, for example, automatically inserts a BOM when you save in UTF-8. If you are not sure, just avoid using comments or meta-data on the first line of your file.]

Features

Next

Click on this to advance through the file. (You can also click on the top term in the term display area.)

Re-test

Adds a copy of the current term to the end of the list. This is useful if you want to retest yourself on the odd item that you couldn't remember when you first met it.

Back

Moves backwards through the file.

Shuffle

Randomly orders the vocabulary items for review.

Restart

Returns you to the beginning of the list.

Load data

Type a URI in the text field and hit Enter to load a new vocabulary file.

Language direction

Allows you to choose which language appears at the top in the term display area. This is particularly useful when the advance mode is set to 'phased' or 'quick test'.

Set advance mode

Phased: the language at the top is revealed with the first click on the Next button, and another click is needed to reveal the transcription and second language.
Review: shows all information in the display area as you move through the terms.
Quick test: shows only the top line in the display area as you move through the terms.

Show transcription

Hides or shows the middle line in the term display area.

Create printable list

Click on the button to create a list of all terms for printing. The Standard button prints in the order in the file. The Random button randomly orders the items before creating the list. This is helpful for reducing the effect of memory related to ordering when using the list for testing.

Still to be done

• Allow assignment of fonts to text in term display area.
• Go through and remove all inline styling (put there for speed of development).