Vocab for PalmOS

Lee Wilmot <lee@ripe.net>
5th December, 2000

Contents:

It's Not My Fault Statement

This software was written carefully and tested extensively over several months. All bugs that I am aware of have been removed, apart from those non-damaging which have been listed in the bugs section of this document. Having said that, I make no guarantees of any kind that this program will not destroy any valuable data, will not crash at any time etc etc. You use it entirely at your own risk! By using it you agree to this statement.

Introduction

What is it ?

Vocab is a Palm OS program for storing associations between words and phrases in various languages, and testing the user on these associations.

Features

Does it cost ?

Vocab is shareware, which means that if you like it you must register. You can register by getting a code from Palmgear and entering it via the File->register menu option in the program itself.

What does it work on ?

Vocab should work on all machines running PalmOS 3+.

What does this manual cover ?

It tries to cover everything which is not covered by the in-program help. If you can't find information on a topic here, try one of the 'i' info buttons.

Can I customise it to new languages ?

Yes, please read here and here once you've gotten a basic idea of how the program works.

You unfortunately can't have the article after the key as is needed for affixing languages. But you can always change the article to (m) for masculine etc.

Why didn't you call it 'PocketVocab', that's a much better name ?

Some, erm, person had already taken it.

You will need a copy of Vocab running on your palm for the rest of this manual to make any sense.

The Entry Screen

Entering A Translation

Two words are shown at once, we'll call them the top word and the bottom word. To the right is a space where existing words in the present language are shown called the dictionary list, which can be scrolled through.

At the top left is a popup list for the article of the top word. To the right of this is the key field for the top word. The key is the way the entry is identified. Below that is the details field, where usage notes, pronounciation etc can be stored. Below and to the left is the language for the top word. There are equivalents for all of these controls for the bottom word at the... bottom of the screen.

To enter a translation, you enter data (only the key field is compulsory) for the top and bottom words and then press the enter button at the top-middle. Let's enter gerade (language DE) and straight (language EN). Press enter.

Notice that straight has now had it's details cleared. The program is waiting for you to enter another translation for gerade. Let's enter recht (language NL), and press enter. Again, the bottom word has been cleared. Notice that there's an arrow and a number under gerade. The number is called the entry number and tells us that this is main meaning 1 of gerade. The arrow allows us the move around the various translations of this meaning of gerade.

Now, it so happens that gerade could also mean just in English. To tell the program we want to enter another meaning of gerade tap on the number 1. It should change to a 2. Now enter just in the bottom key field and press enter. If you press the number a few times, you'll notice you can cycle through the base meanings of gerade. A + sign after the number means that there is another base meaning to view after the current one.

Miscellaneous

Clear Button

Notice the two dots to the left-middle of the screen ? Just above the top dot is an invisible button that clears the top word. Hold your pen down just above the top dot to see it's outline. The button clears the data of the top word. Between the dots is a button which clears the data of both words. Below the bottom dot is... well, you guessed it.

You can also write an '0' in graffiti to clear both words.

The Dictionary List

On the far right of the screen is a list of the words that you've entered so far. Each language has it's own dictioanry list, so you see all the words of one language at a time. If you tap on one of the words in the list, the details of it's first base meaning will be shown, together with it's translation.

The arrows in the middle of the screen scroll the word list. You can also use the hardware scroll buttons.

Notice that as you write a word in one of the keyfields, the possible words matching ones which have already been stored in the database are displayed. If the keyfield contains a word which already exists in the database, that word is highlighted in the dictionary list.

The Filter Button

At the very top right is a button labelled F, standing for filter. On the entry screen, when the button is enabled words are only shown in the filter list which have the same article as the one entered for the current word. Exception: if the 'blank' (first) article is selected, then all words are shown.

Article Shortcuts

Writing a number (other than 0) in the graffiti area will select the matching article for the current word.

The Word Delays

The two numbers on the left give the test delays of the shown words (see test section for their significance). Tapping on them will reset them to 1. You don't need to press the enter button for this change to take effect.

Test Reverse Flag

Between the two test delays is a checkbox which controls whether the top word will be tested in reverse. See the test section to understand it's effect. You don't need to tap the enter button for a tap on this checkbox to have an effect.

Phrase Flags

There is a checkbox to the right of each key field called the phrase flag. See here for the use of these flags, you should read the test section first. You need to press the enter button for a change to the phrase flag to be stored. Usually, if you're going to set the phrase flag you'll do it at the same time as you enter a word for the first time.

Sticky Entry

In general, when you change a control or field on the entry screen it will stay at what you set it until one of the clear buttons is pressed. This is generally advantageous, however, watch for pitfalls like entering data in the details field and then tapping on one of the words in the dictionary list. The details stored in the database will not overwrite the details you entered previously.

The Menu Bar

The non-obvious menu bar features are described in the program itself. Select the File->about menu and then press the i button in the top right of the screen.

The Test Screen

Running A Test

To start a test, press the test button to the right of the enter button at the top of the screen.

The enter button disappears and a number appears at the top of the screen indicating how many tests are remaining. There's a bar next to it also giving the same information graphically.

The top word is shown, but the bottom word is blank. The entry number has a * in front of it. That means that it's indicating how many entries there are with this key and article combination. For instance, a *2 with the fence means that there are 2 possible base meanings of the fence (a barrier and a person who sells stolen goods). If you'd also entered to fence, the number would still be 2.

You must decide whether you know the translation(s) of the shown word, then tap anywhere on the screen. The translation appears, and you then tap on one of the 5 buttons on the right to signify to the program how right you were. From left to right, they signify very wrong, wrong, unsure, right and very right.

You can also just directly tap on one of the answer buttons without actually revealing the answer first.

How Testing Works

You don't need to read this section unless you intend to experiment with the test values in the settings screen.

Each base meaning of a word has associated with it a test delay. When you press test on the entry screen, the program does two things:

When you hit one of the answer buttons, the delay of the word is affected negatively or positively depending on the answer you gave. The delay is reduced for wrong answers and increased for right answers. If you have the test timer on in the settings screen, the change is modified by how long you took to answer.

When a word's delay passes the boost threshold it's given a large boost. This indicates that you seem to have a reasonable grasp on the word, and don't need to be tested on it again for a while.

A newly created word has a delay of zero, meaning it has not yet been tested. All other words have a delay been 1 and 254.

Miscellaneous Testing Info

Reverse Test

Each word has a checkbox (on the entry screen) indicating whether it should be tested forward or reverse. If it's set to be tested reverse (the box is checked), then everytime it's tested one of it's translations is shown on the test screen instead of the word itself.

The Test Button

Tapping the test button during a test will abort the current test. You will be asked if you wish to end the test. If you click 'no' then the test details will be saved so the test can be resumed later. The test button will remain labelled '+Test+' to indicate that a test is waiting to be finished.

Hardware Buttons

During a test you can optionally use the hardware buttons to answer. See the settings screen in the program and it's associated help info for details.

Effect of Filter Button

If the filter button is engaged when you press the test button, then only words of the type designated by the article in the top word will be eligible to be tested. You could use this, for instance, to only test verbs.

If the first (blank) article is showing, all word types will be tested. Therefore, if you always press the clear button before a test you can be sure that all word types will be tested even though you have filtering on by default in the entry screen.

Between Test Navigation

Between tapping the screen to reveal the answer to a particular test, and tapping one of the answer buttons, you can navigate at leisure around the given word, it's base meaning and translations etc. Tapping one of the answer buttons will still only affect the originally tested word.

Testing Strategy

It's a good idea to only use the test button maximum once per day, so that new words can be tested over a period of days before being labelled as 'known' (boosted). If you are feeling keen, use the menu item Test->Old which will only test older words. If you've just learnt several new words and want to test yourself on them, without going through the hassle of a full-blown test, use the menu item Test->New.

Testing Phrases

Often a word only makes sense within a set phrase. For phrases like the English 'a different kettle of fish' you should:
  1. enter a keyword like 'fish'
  2. enter in the details field 'a different kettle of fish'
  3. tap the checkbox to the right of the key field
When the word is tested, only the phrase 'a different kettle of fish' will be shown.

More Test Delay Details

For the courageous only...

The test method described has the effect that a word is tested until it is gotten right a few times, at which time it is boosted. After that, it slowly drops towards 1 again. However, it is not allowed to drop below the boost threshold unless it is with response to a test answer. In addition, despite what was said previously, when a test begins delays are not reduced by 1 if there are too many words already sitting at the boost threshold. This mechanism forms a self-inhibiting system so that once many words are entered in the databases the user is swamped with words all sitting at delay 1.

Miscellaneous Topics

Database Mechanics

An unfortunate data structure was chosen early in development. It has two disadvantages... On the other hand, all lookup operations are lightning quick...

Changing Languages

You can set the language popup labels to any two letter string you wish. First type a two letter string in the top key field. Then select the language label you wish to change. Finally, select the menu item Top->Set lang name. The label of the current language will be changed to what you selected.

Important: this does not enable you to get over the six-language limit: only the label of the database is changed, no new database is created.

Changing Articles

If you change to a non-listed language, you probably will also need to change the articles. You do this in the same way. Write a new label in the top key field. Select the language and article you wish to change. Finally, select the menu item Top->Set article.

Known Bugs

Well, an inconvenience really...