From ce599e4f9f94b4eb00c1b5edb85bce5431ab3df2 Mon Sep 17 00:00:00 2001 From: toma Date: Wed, 25 Nov 2009 17:56:58 +0000 Subject: Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features. BUG:215923 git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdeedu@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da --- doc/klatin/index.docbook | 502 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 502 insertions(+) create mode 100644 doc/klatin/index.docbook (limited to 'doc/klatin/index.docbook') diff --git a/doc/klatin/index.docbook b/doc/klatin/index.docbook new file mode 100644 index 00000000..3e0340de --- /dev/null +++ b/doc/klatin/index.docbook @@ -0,0 +1,502 @@ + +KLatin"> + + + KVTML"> + + + + + + + +]> + + + + +The &klatin; Handbook + + + +George +Wright + +
gwright@kde.org
+ + + +Anne-Marie +Mahfouf + +
&Anne-Marie.Mahfouf.mail;
+ +Help in documentation + + + + + +2001-2004 +George Wright + + +&FDLNotice; + +2006-02-24 +0.9 + + + +&klatin; is a &kde; application to help revise/teach Latin. + + + + +KDE +kdeedu +KLatin +Latin +education +language +latin + + + + + +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 notes, 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 +SettingsConfigure +&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. + + + +&klatin; configuration dialog + + + + + +&klatin; configuration dialog + + + + + + + +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 <guimenu>File</guimenu> Menu + + + + + +&Ctrl;Q + +File +Quit + +Quits &klatin; + + + + + +The <guimenu>Section</guimenu> Menu + + + + +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 <guimenu>Settings</guimenu> Menu + + + + +Settings +Configure Shortcuts... + +Configure the keyboard keys you use to access the different actions. + + + + + +Settings +Configure Toolbars... + +Not implemented yet. + + + + + +Settings +Configure &klatin;... + +Display the &klatin; settings dialog + + + + + + + + +The <guimenu>Help</guimenu> 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, German and Polish. + + +How To Translate &klatin; vocabulary files + + + +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. + + + + + +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. + + + + + +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. + + + + +Please send them to George +gwright@users.sourceforge.net. + + + + + + + +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 folder 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 License + + +&klatin; + + +Program copyright 2001-2004 George Wright gwright@users.sourceforge.net + + +Contributors: + + +&Neil.Stevens; &Neil.Stevens.mail; + +&Anne-Marie.Mahfouf; &Anne-Marie.Mahfouf.mail; + +Mark Westcott mark@houseoffish.org + + + + + + +Documentation copyright 2001-2004 George Wright gwright@users.sourceforge.net + + + + +&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; + + + -- cgit v1.2.1