<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.1.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
  <!ENTITY package "kdeedu">
  <!ENTITY kappname "&flashkard;">
  <!ENTITY % addindex "IGNORE">
  <!ENTITY % English "INCLUDE">
]>

<book lang="&language;">
<bookinfo>
<title>The &flashkard; Handbook</title>

<authorgroup>
<author>
<firstname>Scott</firstname>
<othername></othername>
<surname>Wheeler</surname>
<affiliation>
<address><email>wheeler@kde.org</email></address>
</affiliation>
</author>

<othercredit role="reviewer">
<firstname>Marc</firstname>
<surname>Wolf</surname>
<affiliation><address><email>marc@vries.demon.co.uk</email>
</address></affiliation>
<contrib>Reviewer</contrib>
</othercredit>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>

<copyright>
<year>2002</year>
<holder>Scott Wheeler</holder>
</copyright>

<legalnotice>&FDLNotice;</legalnotice>

<date>2002-10-08</date>
<releaseinfo>0.2</releaseinfo>

<!-- Abstract about this handbook -->

<abstract>
<para>
This handbook describes the &flashkard; application. Flash Cards are an easy
learning method for children and adults.
</para>
</abstract>


<keywordset>
<keyword>KDE</keyword>
<keyword>FlashKard</keyword>
<keyword>vocabulary</keyword>
<keyword>training</keyword>
<keyword>learning</keyword>
</keywordset>

</bookinfo>

<chapter id="introduction">
<title>Introduction</title>
<sect1 id="what-is-flashkard">
<title>What is FlashKard</title>
<para>
&flashkard; is based on a rather old learning method used to teach children
facts. The teacher will present a number of cards with questions on it, on which the
pupil will write down the answers on the back of the cards, which will be
checked later on by the teacher. The cards with the correct answers will be
removed from the pile and the incorrectly answered question will be repeated
over and over again, until the answer is <quote>drilled</quote> into the
memory.
</para>

<para>
If you need help, please check
<ulink url="http://www.kde.org">The &kde; Website</ulink> for updates, or by
submitting your question to <ulink url="mailto:kde-user@kde.org">The
&kde; User Mailing list</ulink>.
</para>

<para>
&flashkard; is an easy to use application for children, who can read and write
words using a keyboard. Depending on the level of questions, &flashkard; is suitable for
adults as well to learn for example languages. You really can <quote>drill</quote> words
into your brain over and over again. The computer is the most patient teacher you ever can
have.
</para>
</sect1>

</chapter>

<chapter id="usage">
<title>Usage</title>
<sect1 id="data-entry-view">
<title>Data Entry View</title>

<para>
&flashkard; has two main views, the default data entry view and the
quiz view. In the Data Entry function the cards can be loaded by
opening a <literal role="extension">*.kvtml</literal> file or by
manually entering the cards using the <guibutton>Add Card</guibutton>,
<guibutton>Delete Card</guibutton> and <guibutton>Update
Card</guibutton> buttons. These created cards can be saved into a
<filename>filename.kvtml</filename>.
</para>

<screenshot>
<screeninfo>Data entry view</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="flashkard1.png" format="PNG" /></imageobject>
<textobject><phrase>Data entry view</phrase></textobject>
</mediaobject>
</screenshot>
</sect1>

<sect1 id="the-quiz-view">
<title>The Quiz View</title>
<para>
The learning process contains a number of phases, which are reflected in &flashkard;. First
of all the cards can be learned by flicking through them by
<menuchoice>
<guimenu>Setting</guimenu>
<guimenuitem>Quiz Mode</guimenuitem>
<guimenuitem>Flash Cards</guimenuitem>
</menuchoice>.
If these cards are memorized the actual quiz
can start in either sequential or in ramdom order.
</para>

<sect2 id="quiz-mode-front">
<title>Quiz Mode: Flash Cards Front</title>
<screenshot>
<screeninfo>Front of card</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="flashkard3.png" format="PNG" /></imageobject>
<textobject><phrase>Front of card</phrase></textobject>
</mediaobject>
</screenshot>
</sect2>

<sect2 id="quiz-mode-back">
<title>Quiz Mode: Flash Cards Back</title>
<screenshot>
<screeninfo>Back of card</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="flashkard4.png" format="PNG" /></imageobject>
<textobject><phrase>Back of card</phrase></textobject>
</mediaobject>
</screenshot>
</sect2>

<sect2 id="quiz-mode-quiz">
<title>Quiz Mode: Quiz</title>
<screenshot>
<screeninfo>Quiz mode</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="flashkard2.png" format="PNG" /></imageobject>
<textobject><phrase>Quiz mode</phrase></textobject>
</mediaobject>
</screenshot>
</sect2>

</sect1>

</chapter>

<chapter id="menus">
<title>The Menubar</title>

<sect1 id="file-menu">
<title>The <guimenu>File</guimenu> Menu</title>

<variablelist>
<varlistentry>
<term>
<menuchoice>
<shortcut><keycombo action="simul">&Ctrl;<keycap>N</keycap>
</keycombo></shortcut>
<guimenu>File</guimenu>
<guimenuitem>New</guimenuitem>
</menuchoice>
</term>
<listitem><para><action>Creates</action> a new
 document.</para></listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice><shortcut>
<keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo></shortcut>
<guimenu>File</guimenu>
<guimenuitem>Open...</guimenuitem></menuchoice></term>
<listitem><para><action>Opens an existing document.</action>
</para></listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<shortcut><keycombo
 action="simul">&Ctrl;<keycap>S</keycap></keycombo></shortcut>
<guimenu>File</guimenu>
<guimenuitem>Save</guimenuitem></menuchoice></term>
<listitem><para><action>Saves the document.</action></para></listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Save As...</guimenuitem></menuchoice></term>
<listitem><para><action>Saves the document under another
 name.</action></para></listitem>
</varlistentry>

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

</sect1>

<sect1 id="edit-menu">
<title> The <guimenu>Edit</guimenu> menu</title>
<para>
The Edit menu is not implemented in the current version of &flashkard;.
</para>
</sect1>

<sect1 id="function-menu">
<title> The <guimenu>Function</guimenu> menu</title>

<variablelist>
<varlistentry>
<term>
<menuchoice>
<guimenu>Function</guimenu>
<guimenuitem>Data Entry</guimenuitem></menuchoice></term>
<listitem><para><action>Opens the Data Entry view of &flashkard;.</action>
</para></listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<guimenu>Function</guimenu>
<guimenuitem>Quiz</guimenuitem></menuchoice></term>
<listitem><para><action>Opens the Quiz view of &flashkard; . </action>
</para></listitem>
</varlistentry>
</variablelist>
</sect1>

<sect1 id="settings-menu">
<title> The <guimenu>Settings</guimenu> menu</title>
<variablelist>
<varlistentry>
<term>
<menuchoice>
<guimenu>Settings</guimenu>
<guisubmenu>Quiz mode</guisubmenu>
<guimenuitem>Flash Cards</guimenuitem>
</menuchoice></term>
<listitem><para><action>Sets the &flashkard; application in the card learning mode.</action>
</para></listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<guimenu>Settings</guimenu>
<guisubmenu>Quiz mode</guisubmenu>
<guimenuitem>Random Order Quiz</guimenuitem>
</menuchoice></term>
<listitem><para><action>Sets the &flashkard; application in the random quiz mode.</action>
</para></listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<guimenu>Settings</guimenu>
<guisubmenu>Quiz mode</guisubmenu>
<guimenuitem>Ordered Quiz</guimenuitem>
</menuchoice></term>
<listitem><para><action>Sets the &flashkard; application in the ordered quiz mode.</action>
</para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu>Settings</guimenu>
<guisubmenu>Show Answer For</guisubmenu>
</menuchoice></term>
<listitem>
<para><action>Choose how long the answer is displayed for when in Quiz
mode.</action>  You can choose between one and five seconds, in one
second increments.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Reverse Front and Back</guimenuitem>
</menuchoice>
</term>
<listitem><para><action>Switch which entries on the cards are
considered the front and the back</action>, which lets you quiz
yourself or your students back the other way.</para>
</listitem>
</varlistentry>

</variablelist>
</sect1>

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

</chapter>

<chapter id="credits-and-license">
<title>Credits and License</title>

<sect1 id="copyright">
<title>Copyright</title>

&underFDL;
&underGPL;

</sect1>
</chapter>

<!-- Commented out, no need for standard instructions any longer
     This app might benefit from instructions how to find and install
     prepared card sets though.
<appendix id="installation">
<title>Installation</title>

<sect1 id="obtaining">
<title>How to obtain flashkard</title>

&install.intro.documentation;

<para>Current snapshots and dictionary files
can be found on the <ulink
url="http://edu.kde.org/flashkard">flashkard
homepage</ulink>.</para>

</sect1>

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

&install.compile.documentation;

</sect1>
</appendix>
-->

&documentation.index;
</book>
