tde-i18n/tde-i18n-en_GB/docs/tdeedu/klatin/index.docbook

<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
  <!ENTITY kapp "&klatin;"><!-- replace klatin here -->
  <!ENTITY kappname "&klatin;">
  <!ENTITY package "tdeedu">
  <!ENTITY kwordquiz "<application>KWordQuiz</application>">
  <!ENTITY kvtml "<acronym>KVTML</acronym>">
  <!--<!ENTITY klatin-index SYSTEM "klatin-index.docbook">-->
  <!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 % British-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@users.sourceforge.net</email></address>
</affiliation>
</author>
<othercredit role="developer"><firstname>Anne-Marie</firstname> <surname>Mahfouf</surname> <affiliation> <address><email>annma@kde.org</email></address>
</affiliation>
<contrib>Help in documentation</contrib>
</othercredit>
</authorgroup>

<othercredit role="translator"><firstname>Andrew </firstname><surname>Coles</surname><affiliation><address><email>andrew_coles@yahoo.co.uk</email></address></affiliation><contrib>Conversion to British English</contrib></othercredit> 

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

<legalnotice>&FDLNotice;</legalnotice>

<date>2004-08-23</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</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 <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>

</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 File</guimenuitem> </menuchoice></term>
<listitem><para><action>Loads</action> a new vocabulary file. This menu is only enabled if you are in the Vocabulary section</para></listitem>
</varlistentry>

<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 &klatin;...</guimenuitem> </menuchoice></term>
<listitem><para><action>Display</action> the &klatin; settings dialogue </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. </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>Commit your files to CVS HEAD or tar them and send them to George <email>gwright@users.sourceforge.net</email> or to Anne-Marie <email>annma@kde.org</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 directory 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 Licence</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@qualityassistant.org</email></para>
</listitem>
<listitem><para>Anne-Marie Mahfouf <email>annma@kde.org</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>

<para>Andrew Coles<email>andrew_coles@yahoo.co.uk</email></para> 
&underFDL; &underGPL; </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>