# The &klatin; Handbook

## Introduction

&klatin; is a program to help revise Latin. There are three sections in which different aspects of the language can be revised. These are the vocabulary, grammar and verb testing sections. In addition there is a set of revision notes that can be used for self-guided revision.

In the vocabulary section an &XML; file is loaded containing various words and their local language translations. &klatin; asks you what each of these words translate into. The questions take place in a multiple-choice environment.

In the grammar and verb sections &klatin; asks for a particular part of a noun or a verb, such as the ablative singular, or the 1st person indicative passive plural, and is not multiple choice.

## Using &klatin;

When you start &klatin;, you are greeted by four options that you can choose from.

&klatin; main screen, directly after the first start &klatin; main screen

The first one, Vocabulary, is a multiple-choice vocabulary tester.

&klatin; vocabulary section &klatin; vocabulary

After you finish your test, a results screen is displayed.

&klatin; vocabulary results &klatin; results

The second, Grammar tests you on grammatical parts of nouns.

&klatin; grammar section &klatin; grammar

Verbs is almost the same as the Grammar section, except that it tests you on verb forms.

&klatin; verbs section &klatin; verbs

The fourth section, Revision, loads &konqueror; into the &klatin; revision notes section.

In addition to the options, you can also launch these sections via the menubar, in the Section.

The configuration dialog for &klatin; can be accessed by choosing Settings Configure &klatin;... from the menu. In the Vocabulary page, you can set whether you want the test to take place from your language into Latin, or vice versa. You can also choose the default file which you want to use to test your vocabulary on, and you can also set how many questions you want to be tested on.

## The &klatin; main window

The &klatin; main window consists of four option buttons to choose which section to enter, and a menubar.

Choose from the Revision Sections list a section and click Start! to start the chosen section.

When you are finished with that section, click Back to return to &klatin;'s main menu.

## Command Reference

### The File Menu

&Ctrl;Q File Quit

- Quits &klatin;

### The Section Menu

Section Load Vocabulary File

- Loads a new vocabulary file. This menu is only enabled if you are in the Vocabulary section

Section Load Vocabulary

- Loads the vocabulary section

Section Load Grammar

- Loads the grammar section

Section Load Verbs

- Loads the verbs section

Section Load Revision

- Loads the revision section

### The Settings Menu

Settings Configure Shortcuts...

- Configure the keyboard keys you use to access the different actions.

Settings Configure &klatin;...

- Display the &klatin; settings dialogue

### The Help Menu

&help.menu.documentation;

## Translation Guide to &klatin;

Only the vocabulary files have to be translated in your language. The vocabulary files use the &kvtml; format, which is the same as other programs such as &kwordquiz; use. &kwordquiz; is very useful as you can create the vocabulary files in that and load them directly into &klatin;.

Below is explained how you can translate &klatin; vocabulary files. At the moment, the files are only in English.

### How To Translate &klatin; vocabulary files

1. Get the latest &klatin; code from CVS or a latest release. The words are stored in `source_dir_of_kdeedu/klatin/klatin/data/vocab/en/` in files like `A.kvtml` for Latin words beginning with A, `BC.kvtml` for Latin words beginning with B and C and so on.

2. Create a new subdirectory in `data/vocab/` named as your language code (for example, `fr` for French, `ja` for Japanese). Copy all the English vocabulary files there as well as the `Makefile.am`. Edit the `Makefile.am` and replace en with your language code.

3. In `data/vocab/`your_language_code``, edit all the files and translate the English words, &ie; those that are between the `t` and `t` tags.

4. Commit your files to CVS HEAD or tar them and send them to George gwright@users.sourceforge.net or to Anne-Marie annma@kde.org.

## Developer's Guide to &klatin;

### Create new vocabulary files

The &klatin; vocabulary database system is very easy to extend. Just look at the files and you'll understand! It uses the &kvtml; format, which is the same as other programs such as &kwordquiz; use. So you can open &kwordquiz; and use it to create the vocabulary files.

You can save your new files in the corresponding folder depending on what language they refer to in `.kde/share/apps/klatin/data/vocab/`language_code`/`. For example, English &kvtml; files are kept in a directory called `en`, German files in `de`, and so on. You can also send me your files so I can add them in the next &klatin; release.

## Credits and Licence

&klatin;

Program copyright 2001-2004 George Wright gwright@users.sourceforge.net

Contributors:

- Neil Stevens neil@qualityassistant.org

- Anne-Marie Mahfouf annma@kde.org

- Mark Westcott mark@houseoffish.org

Documentation copyright 2001-2004 George Wright gwright@users.sourceforge.net

Andrew Colesandrew_coles@yahoo.co.uk

&underFDL; &underGPL;

## &klatin; notes

Welcome to the &klatin; notes section. This is aimed to help you in your revision and covers the English GCSE syllabus (England).

Here are the different sections you can get help for:

- Latin numbers

- Latin verbs

- Latin nouns

- Latin adjectives

- Latin pronouns

&numbers; &verbs; &nouns; &adjectives; &pronouns;

## Installation

### How to obtain &klatin;

&install.intro.documentation;

### Compilation and Installation

&install.compile.documentation;
&documentation.index;