summaryrefslogtreecommitdiffstats
path: root/doc/klatin/index.docbook
blob: 8d59599d018275041bdc1b2f2481f2157c69724e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
 <!ENTITY klatin "<application>KLatin</application>">
 <!ENTITY kappname "&klatin;">
 <!ENTITY package "tdeedu">
 <!ENTITY kvtml "<acronym>KVTML</acronym>">
 <!ENTITY numbers SYSTEM "numbers.docbook">
 <!ENTITY verbs SYSTEM "verbs.docbook">
 <!ENTITY adjectives SYSTEM "adjectives.docbook">
 <!ENTITY nouns SYSTEM "nouns.docbook">
 <!ENTITY pronouns SYSTEM "pronouns.docbook">
 <!ENTITY % addindex "IGNORE">
 <!ENTITY % English "INCLUDE"><!-- change language only here -->
]>

<book lang="&language;">

<bookinfo>
<title>The &klatin; Handbook</title>

<authorgroup>
<author>
<firstname>George</firstname>
<surname>Wright</surname>
<affiliation>
<address><email>gwright@kde.org</email></address>
</affiliation>
</author>
<othercredit role="developer">
<firstname>Anne-Marie</firstname>
<surname>Mahfouf</surname>
<affiliation>
<address><email>&Anne-Marie.Mahfouf.mail;</email></address>
</affiliation>
<contrib>Help in documentation</contrib>
</othercredit>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>

<copyright>
<year>2001-2004</year>
<holder>George Wright</holder>
</copyright>

<legalnotice>&FDLNotice;</legalnotice>

<date>2006-02-24</date>
<releaseinfo>0.9</releaseinfo>

<abstract>
<para>
&klatin; is a &kde; application to help revise/teach Latin.
</para>
</abstract>

<keywordset>
<keyword>KDE</keyword>
<keyword>tdeedu</keyword>
<keyword>KLatin</keyword>
<keyword>Latin</keyword>
<keyword>education</keyword>
<keyword>language</keyword>
<keyword>latin</keyword>
</keywordset>

</bookinfo>

<chapter id="introduction">
<title>Introduction</title>

<para>
&klatin; is a program to help revise Latin. There are three
<quote>sections</quote> 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.
</para>
<para>
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.
</para>
<para>
In the grammar and verb sections &klatin; asks for a particular part of a noun
or a verb, such as the <quote>ablative singular</quote>, or the <quote>1st
person indicative passive plural</quote>, and is not multiple choice.
</para>
</chapter>

<chapter id="using-klatin">
<title>Using &klatin;</title>

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

<screenshot>
<screeninfo>&klatin; main screen, directly after the first start</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="klatin1.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>&klatin; main screen</phrase>
</textobject>
</mediaobject>
</screenshot>

<para>The first one, <guilabel>Vocabulary</guilabel>, is a
multiple-choice vocabulary tester.
</para>

<screenshot>
<screeninfo>&klatin; vocabulary section</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="klatin2.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>&klatin; vocabulary</phrase>
</textobject>
</mediaobject>
</screenshot>

<para>
After you finish your test, a results screen is displayed.
</para>

<screenshot>
<screeninfo>&klatin; vocabulary results</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="results.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>&klatin; results</phrase>
</textobject>
</mediaobject>
</screenshot>

<para>
The second, <guilabel>Grammar</guilabel> tests you on grammatical parts of
nouns.
</para>
 
<screenshot>
<screeninfo>&klatin; grammar section</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="klatin3.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>&klatin; grammar</phrase>
</textobject>
</mediaobject>
</screenshot>

<para>
<guilabel>Verbs</guilabel> is almost the same as the <guilabel>Grammar</guilabel>
section, except that it tests you on verb forms.
</para>

<screenshot>
<screeninfo>&klatin; verbs section</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="klatin4.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>&klatin; verbs</phrase>
</textobject>
</mediaobject>
</screenshot> 
 
<para>
The fourth section,
<guilabel>Revision notes</guilabel>, loads &konqueror; into the &klatin; revision notes
section.
</para>

<para>
In addition to the options, you can also launch these sections via the menubar,
in the <guimenu>Section</guimenu>.
</para>

<para>
The configuration dialog for &klatin; can be accessed by choosing
<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure
&klatin;...</guimenuitem></menuchoice> from the menu.
<!-- In the <quote>General</quote> settings page, you can configure your name.-->
In the <guilabel>Vocabulary</guilabel> 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.
</para>

<screenshot>
<screeninfo>&klatin; configuration dialog</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="klatin-configuration.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>&klatin; configuration dialog</phrase>
</textobject>
</mediaobject>
</screenshot>

</chapter>

<chapter id="klatin-mainwindow">
<title>The &klatin; Main Window</title>
<para>The &klatin; main window consists of four option buttons to choose which
section to enter, and a menubar.</para>
<para>Choose from the <guilabel>Revision Sections</guilabel> list a section and
click <guibutton>Start</guibutton> to start the chosen section.</para>
 
<para>When you are finished with that section, click <guibutton>Back</guibutton>
to return to &klatin;'s main menu.</para>

</chapter>

<chapter id="commands">
<title>Command Reference</title>
<sect1 id="menu-file">
<title>The <guimenu>File</guimenu> Menu</title>

<variablelist>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Quit</guimenuitem>
</menuchoice></term>
<listitem><para><action>Quits</action> &klatin;</para></listitem>
</varlistentry>
</variablelist>
</sect1>

<sect1 id="menu-section">
<title>The <guimenu>Section</guimenu> Menu</title>
<variablelist>

<varlistentry>
<term><menuchoice>
<guimenu>Section</guimenu>
<guimenuitem>Load Vocabulary</guimenuitem>
</menuchoice></term>
<listitem><para><action>Loads</action> the vocabulary section</para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu>Section</guimenu>
<guimenuitem>Load Grammar</guimenuitem>
</menuchoice></term>
<listitem><para><action>Loads</action> the grammar section</para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu>Section</guimenu>
<guimenuitem>Load Verbs</guimenuitem>
</menuchoice></term>
<listitem><para><action>Loads</action> the verbs section</para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu>Section</guimenu>
<guimenuitem>Load Revision</guimenuitem>
</menuchoice></term>
<listitem><para><action>Loads</action> the revision section</para></listitem>
</varlistentry>


</variablelist>

</sect1>
<sect1 id="menu-settings">
<title>The <guimenu>Settings</guimenu> Menu</title>

<variablelist>
<varlistentry>
<term><menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Configure Shortcuts...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Configure</action> the keyboard keys you use to access the different actions.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Configure Toolbars...</guimenuitem>
</menuchoice></term>
<listitem><para>Not implemented yet.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Configure &klatin;...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Display</action> the &klatin; settings dialog
</para></listitem>
</varlistentry>

</variablelist>

</sect1>

<sect1 id="menu-help">
<title>The <guimenu>Help</guimenu> Menu</title>
&help.menu.documentation;
</sect1>
</chapter>

<chapter id="translation">
<title>Translation Guide to &klatin;</title>

<para>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;.
</para>
<para>
Below is explained how you can translate &klatin; vocabulary files. At the
moment, the files are only in English, German and Polish. 
</para>
<sect1 id="translate_vocab">
<title>How To Translate &klatin; vocabulary files</title>
<procedure>
<step>
<para>
Get the latest &klatin; code from CVS or a latest release. The words are stored in
<filename class="directory">source_dir_of_tdeedu/klatin/klatin/data/vocab/en/</filename>
in files like <filename>A.kvtml</filename> for Latin words beginning with A,
<filename>BC.kvtml</filename> for Latin words beginning with B and C and so on.
</para>
</step>

<step>
<para>
Create a new subdirectory in <filename class="directory">data/vocab/</filename> named
as your language code (for example, <filename
class="directory">fr</filename> for French, <filename
class="directory">ja</filename> for Japanese). Copy all the English vocabulary files there as well as
the <filename>Makefile.am</filename>. Edit the <filename>Makefile.am</filename>
and replace <quote>en</quote> with your language code.
</para>
</step>

<step>
<para>
In <filename class="directory">data/vocab/<replaceable>your_language_code</replaceable></filename>, edit
all the files and translate the English words, &ie; those that are between the
<sgmltag class="starttag">t</sgmltag> and <sgmltag class="endtag">t</sgmltag>
tags.
</para>
</step>
<step>
<para>
Please send them to George
<email>gwright@users.sourceforge.net</email>.
</para>
</step>
</procedure>
</sect1>
</chapter>

<chapter id="developers">
<title>Developer's Guide to &klatin;</title>
<sect1 id="add_files">
<title>Create new vocabulary files</title>
<para>
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.
</para>
<para>
You can save your new files in the corresponding folder depending on what
language they refer to in <filename class="directory">.kde/share/apps/klatin/data/vocab/<replaceable>language_code</replaceable>/</filename>.
For example, English &kvtml; files are kept in a folder called
<filename class="directory">en</filename>, German files in <filename class="directory">de</filename>, and so on. You can also
send me your files so I can add them in the next &klatin; release.
</para>
</sect1>
<!-- FIXME: They will still need specifically outlining -->
</chapter>

<chapter id="credits">

<title>Credits and License</title>

<para>
&klatin;
</para>
<para>
Program copyright 2001-2004 George Wright <email>gwright@users.sourceforge.net</email>
</para>
<para>
Contributors:
<itemizedlist>

<listitem><para>&Neil.Stevens; <email>&Neil.Stevens.mail;</email></para>
</listitem>
<listitem><para>&Anne-Marie.Mahfouf; <email>&Anne-Marie.Mahfouf.mail;</email></para>
</listitem>
<listitem><para>Mark Westcott <email>mark@houseoffish.org</email></para>
</listitem>

</itemizedlist>
</para>

<para>
Documentation copyright 2001-2004 George Wright <email>gwright@users.sourceforge.net</email>
</para>

<!-- TRANS:CREDIT_FOR_TRANSLATORS -->

&underFDL;

&underGPL;                 <!-- GPL License -->

</chapter>

<chapter id="klatin-index">
<title>&klatin; notes</title>

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

<para>
Here are the different sections you can get help for:
</para>

<itemizedlist>
<listitem><para><link
linkend="numbers">Latin numbers</link>
</para></listitem>
<listitem><para><link
linkend="verbs">Latin verbs</link>
</para></listitem>
<listitem><para><link
linkend="nouns">Latin nouns</link>
</para></listitem>
<listitem><para><link
linkend="adjectives">Latin adjectives</link>
</para></listitem>
<listitem><para><link
linkend="pronouns">Latin pronouns</link>
</para></listitem>
</itemizedlist>

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

</chapter>

<appendix id="installation">
<title>Installation</title>

<sect1 id="getting-klatin">
<title>How to obtain &klatin;</title>

&install.intro.documentation;

</sect1>

<sect1 id="compilation">
<title>Compilation and Installation</title>

&install.compile.documentation;

</sect1>

</appendix>

&documentation.index;
</book>