doc/klatin/index.docbook

   1 <?xml version="1.0" ?>
   2 <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
   3   <!ENTITY kapp "&klatin;"><!-- replace klatin here -->
   4   <!ENTITY kappname "&klatin;">
   5   <!ENTITY package "kdeedu">
   6   <!ENTITY kwordquiz "<application>KWordQuiz</application>">
   7   <!ENTITY kvtml "<acronym>KVTML</acronym>">
   8   <!--<!ENTITY klatin-index SYSTEM "klatin-index.docbook">-->
   9   <!ENTITY numbers SYSTEM "numbers.docbook">
  10   <!ENTITY verbs SYSTEM "verbs.docbook">
  11   <!ENTITY adjectives SYSTEM "adjectives.docbook">
  12   <!ENTITY nouns SYSTEM "nouns.docbook">
  13   <!ENTITY pronouns SYSTEM "pronouns.docbook">
  14   <!ENTITY % addindex "IGNORE">
  15   <!ENTITY % English "INCLUDE"><!-- change language only here -->
  16 ]>
  17
  18 <book lang="&language;">
  19
  20 <bookinfo>
  21 <title>The &klatin; Handbook</title>
  22
  23 <authorgroup>
  24 <author>
  25 <firstname>George</firstname>
  26 <surname>Wright</surname>
  27 <affiliation>
  28 <address><email>gwright@kde.org</email></address>
  29 </affiliation>
  30 </author>
  31 <othercredit role="developer">
  32 <firstname>Anne-Marie</firstname>
  33 <surname>Mahfouf</surname>
  34 <affiliation>
  35 <address><email>annma@kde.org</email></address>
  36 </affiliation>
  37 <contrib>Help in documentation</contrib>
  38 </othercredit>
  39 </authorgroup>
  40
  41 <!-- TRANS:ROLES_OF_TRANSLATORS -->
  42
  43 <copyright>
  44 <year>2001-2004</year>
  45 <holder>George Wright</holder>
  46 </copyright>
  47
  48 <legalnotice>&FDLNotice;</legalnotice>
  49
  50 <date>2004-08-23</date>
  51 <releaseinfo>0.9</releaseinfo>
  52
  53 <abstract>
  54 <para>
  55 &klatin; is a &kde; application to help revise/teach Latin.
  56 </para>
  57 </abstract>
  58
  59 <keywordset>
  60 <keyword>KDE</keyword>
  61 <keyword>kdeedu</keyword>
  62 <keyword>KLatin</keyword>
  63 <keyword>Latin</keyword>
  64 <keyword>education</keyword>
  65 <keyword>language</keyword>
  66 <keyword>latin</keyword>
  67 </keywordset>
  68
  69 </bookinfo>
  70
  71 <chapter id="introduction">
  72 <title>Introduction</title>
  73
  74 <para>
  75 &klatin; is a program to help revise Latin. There are three
  76 <quote>sections</quote> in which different aspects of the language can be
  77 revised. These are the vocabulary, grammar, and verb testing sections. In
  78 addition there is a set of revision notes that can be used for self-guided
  79 revision.
  80 </para>
  81 <para>
  82 In the vocabulary section an &XML; file is loaded containing various words and
  83 their local language translations. &klatin; asks you what each of these words
  84 translate into. The questions take place in a multiple-choice environment.
  85 </para>
  86 <para>
  87 In the grammar and verb sections &klatin; asks for a particular part of a noun
  88 or a verb, such as the <quote>ablative singular</quote>, or the <quote>1st
  89 person indicative passive plural</quote>, and is not multiple choice.
  90 </para>
  91 </chapter>
  92
  93 <chapter id="using-klatin">
  94 <title>Using &klatin;</title>
  95
  96 <para>
  97 When you start &klatin;, you are greeted by four options that you can choose
  98 from.
  99 </para>
 100
 101 <screenshot>
 102 <screeninfo>&klatin; main screen, directly after the first start</screeninfo>
 103 <mediaobject>
 104 <imageobject>
 105 <imagedata fileref="klatin1.png" format="PNG"/>
 106 </imageobject>
 107 <textobject>
 108 <phrase>&klatin; main screen</phrase>
 109 </textobject>
 110 </mediaobject>
 111 </screenshot>
 112
 113 <para>The first one, <guilabel>Vocabulary</guilabel>, is a
 114 multiple-choice vocabulary tester.
 115 </para>
 116
 117 <screenshot>
 118 <screeninfo>&klatin; vocabulary section</screeninfo>
 119 <mediaobject>
 120 <imageobject>
 121 <imagedata fileref="klatin2.png" format="PNG"/>
 122 </imageobject>
 123 <textobject>
 124 <phrase>&klatin; vocabulary</phrase>
 125 </textobject>
 126 </mediaobject>
 127 </screenshot>
 128
 129 <para>
 130 After you finish your test, a results screen is displayed.
 131 </para>
 132
 133 <screenshot>
 134 <screeninfo>&klatin; vocabulary results</screeninfo>
 135 <mediaobject>
 136 <imageobject>
 137 <imagedata fileref="results.png" format="PNG"/>
 138 </imageobject>
 139 <textobject>
 140 <phrase>&klatin; results</phrase>
 141 </textobject>
 142 </mediaobject>
 143 </screenshot>
 144
 145 <para>
 146 The second, <guilabel>Grammar</guilabel> tests you on grammatical parts of
 147 nouns.
 148 </para>
 149
 150 <screenshot>
 151 <screeninfo>&klatin; grammar section</screeninfo>
 152 <mediaobject>
 153 <imageobject>
 154 <imagedata fileref="klatin3.png" format="PNG"/>
 155 </imageobject>
 156 <textobject>
 157 <phrase>&klatin; grammar</phrase>
 158 </textobject>
 159 </mediaobject>
 160 </screenshot>
 161
 162 <para>
 163 <guilabel>Verbs</guilabel> is almost the same as the <guilabel>Grammar</guilabel>
 164 section, except that it tests you on verb forms.
 165 </para>
 166
 167 <screenshot>
 168 <screeninfo>&klatin; verbs section</screeninfo>
 169 <mediaobject>
 170 <imageobject>
 171 <imagedata fileref="klatin4.png" format="PNG"/>
 172 </imageobject>
 173 <textobject>
 174 <phrase>&klatin; verbs</phrase>
 175 </textobject>
 176 </mediaobject>
 177 </screenshot>
 178
 179 <para>
 180 The fourth section,
 181 <guilabel>Revision</guilabel>, loads &konqueror; into the &klatin; revision notes
 182 section.
 183 </para>
 184
 185 <para>
 186 In addition to the options, you can also launch these sections via the menubar,
 187 in the <guimenu>Section</guimenu>.
 188 </para>
 189
 190 <para>
 191 The configuration dialog for &klatin; can be accessed by choosing
 192 <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure
 193 &klatin;...</guimenuitem></menuchoice> from the menu.
 194 <!-- In the <quote>General</quote> settings page, you can configure your name.-->
 195 In the <guilabel>Vocabulary</guilabel> page, you can set whether you want the test to
 196 take place from your language into Latin, or vice versa. You can also choose
 197 the default file which you want to use to test your vocabulary on, and you can
 198 also set how many questions you want to be tested on.
 199 </para>
 200
 201 </chapter>
 202
 203 <chapter id="klatin-mainwindow">
 204 <title>The &klatin; main window</title>
 205 <para>The &klatin; main window consists of four option buttons to choose which
 206 section to enter, and a menubar.</para>
 207 <para>Choose from the <guilabel>Revision Sections</guilabel> list a section and
 208 click <guibutton>Start!</guibutton> to start the chosen section.</para>
 209
 210 <para>When you are finished with that section, click <guibutton>Back</guibutton>
 211 to return to &klatin;'s main menu.</para>
 212
 213 </chapter>
 214
 215 <chapter id="commands">
 216 <title>Command Reference</title>
 217 <sect1 id="menu-file">
 218 <title>The <guimenu>File</guimenu> Menu</title>
 219
 220 <variablelist>
 221 <varlistentry>
 222 <term><menuchoice>
 223 <shortcut>
 224 <keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
 225 </shortcut>
 226 <guimenu>File</guimenu>
 227 <guimenuitem>Quit</guimenuitem>
 228 </menuchoice></term>
 229 <listitem><para><action>Quits</action> &klatin;</para></listitem>
 230 </varlistentry>
 231 </variablelist>
 232 </sect1>
 233
 234 <sect1 id="menu-section">
 235 <title>The <guimenu>Section</guimenu> Menu</title>
 236 <variablelist>
 237 <varlistentry>
 238 <term><menuchoice>
 239 <guimenu>Section</guimenu>
 240 <guimenuitem>Load Vocabulary File</guimenuitem>
 241 </menuchoice></term>
 242 <listitem><para><action>Loads</action> a new vocabulary file. This menu is only enabled if you are in the Vocabulary section</para></listitem>
 243 </varlistentry>
 244
 245 <varlistentry>
 246 <term><menuchoice>
 247 <guimenu>Section</guimenu>
 248 <guimenuitem>Load Vocabulary</guimenuitem>
 249 </menuchoice></term>
 250 <listitem><para><action>Loads</action> the vocabulary section</para></listitem>
 251 </varlistentry>
 252
 253 <varlistentry>
 254 <term><menuchoice>
 255 <guimenu>Section</guimenu>
 256 <guimenuitem>Load Grammar</guimenuitem>
 257 </menuchoice></term>
 258 <listitem><para><action>Loads</action> the grammar section</para></listitem>
 259 </varlistentry>
 260
 261 <varlistentry>
 262 <term><menuchoice>
 263 <guimenu>Section</guimenu>
 264 <guimenuitem>Load Verbs</guimenuitem>
 265 </menuchoice></term>
 266 <listitem><para><action>Loads</action> the verbs section</para></listitem>
 267 </varlistentry>
 268
 269 <varlistentry>
 270 <term><menuchoice>
 271 <guimenu>Section</guimenu>
 272 <guimenuitem>Load Revision</guimenuitem>
 273 </menuchoice></term>
 274 <listitem><para><action>Loads</action> the revision section</para></listitem>
 275 </varlistentry>
 276
 277
 278 </variablelist>
 279
 280 </sect1>
 281 <sect1 id="menu-settings">
 282 <title>The <guimenu>Settings</guimenu> Menu</title>
 283
 284 <variablelist>
 285 <varlistentry>
 286 <term><menuchoice>
 287 <guimenu>Settings</guimenu>
 288 <guimenuitem>Configure Shortcuts...</guimenuitem>
 289 </menuchoice></term>
 290 <listitem><para><action>Configure</action> the keyboard keys you use to access the different actions.</para>
 291 </listitem>
 292 </varlistentry>
 293
 294 <varlistentry>
 295 <term><menuchoice>
 296 <guimenu>Settings</guimenu>
 297 <guimenuitem>Configure &klatin;...</guimenuitem>
 298 </menuchoice></term>
 299 <listitem><para><action>Display</action> the &klatin; settings dialog
 300 </para></listitem>
 301 </varlistentry>
 302
 303 </variablelist>
 304
 305 </sect1>
 306
 307 <sect1 id="menu-help">
 308 <title>The <guimenu>Help</guimenu> Menu</title>
 309 &help.menu.documentation;
 310 </sect1>
 311 </chapter>
 312
 313 <chapter id="translation">
 314 <title>Translation Guide to &klatin;</title>
 315
 316 <para>Only the vocabulary files have to be translated in your language. The
 317 vocabulary files use the &kvtml; format, which is the same as other programs
 318 such as &kwordquiz; use. &kwordquiz; is very useful as you can create the
 319 vocabulary files in that and load them directly into &klatin;.
 320 </para>
 321 <para>
 322 Below is explained how you can translate &klatin; vocabulary files. At the
 323 moment, the files are only in English.
 324 </para>
 325 <sect1 id="translate_vocab">
 326 <title>How To Translate &klatin; vocabulary files</title>
 327 <procedure>
 328 <step>
 329 <para>
 330 Get the latest &klatin; code from CVS or a latest release. The words are stored in
 331 <filename class="directory">source_dir_of_kdeedu/klatin/klatin/data/vocab/en/</filename>
 332 in files like <filename>A.kvtml</filename> for Latin words beginning with A,
 333 <filename>BC.kvtml</filename> for Latin words beginning with B and C and so on.
 334 </para>
 335 </step>
 336
 337 <step>
 338 <para>
 339 Create a new subdirectory in <filename class="directory">data/vocab/</filename> named
 340 as your language code (for example, <filename
 341 class="directory">fr</filename> for French, <filename
 342 class="directory">ja</filename> for Japanese). Copy all the English vocabulary files there as well as
 343 the <filename>Makefile.am</filename>. Edit the <filename>Makefile.am</filename>
 344 and replace <quote>en</quote> with your language code.
 345 </para>
 346 </step>
 347
 348 <step>
 349 <para>
 350 In <filename class="directory">data/vocab/<replaceable>your_language_code</replaceable></filename>, edit
 351 all the files and translate the English words, &ie; those that are between the
 352 <sgmltag class="starttag">t</sgmltag> and <sgmltag class="endtag">t</sgmltag>
 353 tags.
 354 </para>
 355 </step>
 356 <step>
 357 <para>
 358 Please send them to George
 359 <email>gwright@users.sourceforge.net</email>.
 360 </para>
 361 </step>
 362 </procedure>
 363 </sect1>
 364 </chapter>
 365
 366 <chapter id="developers">
 367 <title>Developer's Guide to &klatin;</title>
 368 <sect1 id="add_files">
 369 <title>Create new vocabulary files</title>
 370 <para>
 371 The &klatin; vocabulary database system is very easy to extend. Just look at
 372 the files and you'll understand! It uses the &kvtml; format, which is the same
 373 as other programs such as &kwordquiz; use. So you can open &kwordquiz; and use
 374 it to create the vocabulary files.
 375 </para>
 376 <para>
 377 You can save your new files in the corresponding folder depending on what
 378 language they refer to in <filename class="directory">.kde/share/apps/klatin/data/vocab/<replaceable>language_code</replaceable>/</filename>.
 379 For example, English &kvtml; files are kept in a directory called
 380 <filename class="directory">en</filename>, German files in <filename class="directory">de</filename>, and so on. You can also
 381 send me your files so I can add them in the next &klatin; release.
 382 </para>
 383 </sect1>
 384 <!-- FIXME: They will still need specifically outlining -->
 385 </chapter>
 386
 387 <chapter id="credits">
 388
 389 <title>Credits and License</title>
 390
 391 <para>
 392 &klatin;
 393 </para>
 394 <para>
 395 Program copyright 2001-2004 George Wright <email>gwright@users.sourceforge.net</email>
 396 </para>
 397 <para>
 398 Contributors:
 399 <itemizedlist>
 400
 401 <listitem><para>Neil Stevens <email>neil@qualityassistant.org</email></para>
 402 </listitem>
 403 <listitem><para>Anne-Marie Mahfouf <email>annma@kde.org</email></para>
 404 </listitem>
 405 <listitem><para>Mark Westcott <email>mark@houseoffish.org</email></para>
 406 </listitem>
 407
 408 </itemizedlist>
 409 </para>
 410
 411 <para>
 412 Documentation copyright 2001-2004 George Wright <email>gwright@users.sourceforge.net</email>
 413 </para>
 414
 415 <!-- TRANS:CREDIT_FOR_TRANSLATORS -->
 416
 417 &underFDL;
 418
 419 &underGPL;                 <!-- GPL License -->
 420
 421 </chapter>
 422
 423 <chapter id="klatin-index">
 424 <title>&klatin; notes</title>
 425
 426 <para>
 427 Welcome to the &klatin; notes section. This is aimed to help
 428 you in your revision and covers the English <acronym>GCSE</acronym> syllabus (England).
 429 </para>
 430
 431 <para>
 432 Here are the different sections you can get help for:
 433 </para>
 434
 435 <itemizedlist>
 436 <listitem><para><link
 437 linkend="numbers">Latin numbers</link>
 438 </para></listitem>
 439 <listitem><para><link
 440 linkend="verbs">Latin verbs</link>
 441 </para></listitem>
 442 <listitem><para><link
 443 linkend="nouns">Latin nouns</link>
 444 </para></listitem>
 445 <listitem><para><link
 446 linkend="adjectives">Latin adjectives</link>
 447 </para></listitem>
 448 <listitem><para><link
 449 linkend="pronouns">Latin pronouns</link>
 450 </para></listitem>
 451 </itemizedlist>
 452
 453 &numbers;
 454 &verbs;
 455 &nouns;
 456 &adjectives;
 457 &pronouns;
 458
 459 </chapter>
 460
 461 <appendix id="installation">
 462 <title>Installation</title>
 463
 464 <sect1 id="getting-klatin">
 465 <title>How to obtain &klatin;</title>
 466
 467 &install.intro.documentation;
 468
 469 </sect1>
 470
 471 <sect1 id="compilation">
 472 <title>Compilation and Installation</title>
 473
 474 &install.compile.documentation;
 475
 476 </sect1>
 477
 478 </appendix>
 479
 480 &documentation.index;
 481 </book>
 482 <!--
 483 Local Variables:
 484 mode: sgml
 485 sgml-minimize-attributes:nil
 486 sgml-general-insert-case:lower
 487 sgml-indent-step:0
 488 sgml-indent-data:nil
 489 End:
 490 -->
 491