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

<book lang="&language;">

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

<authorgroup>
<author>
<firstname>Primoz</firstname>
<surname>Anzur</surname>
<affiliation>
<address><email>zerokode@yahoo.com</email></address>
</affiliation>
</author>
</authorgroup>

<copyright>
<year>2001</year>
<holder>KDE Edutainment team</holder>
</copyright>

<legalnotice>&FDLNotice;</legalnotice>

<date>2001-11-25</date>
<releaseinfo>0.0.1</releaseinfo>

<abstract>
<para>
&kmessedwords; is the simple mind-training word game
</para>
</abstract>

<keywordset>
<keyword>KDE</keyword>
<keyword>kdeedu</keyword>
<keyword>KMessedWords</keyword>
<keyword>mess</keyword>
<keyword>words</keyword>
</keywordset>

</bookinfo>

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

<para>
&kmessedwords; is the game, that is based on the word/letter puzzles
that I have played as a child.  It is a very simple constructed game,
with 3 dificulty levels of play, and each level deserves it's value.
It is fully customizable game, that allows you to write in your own
words, and set your own <quote>look and feel</quote>" of the game.  It
is aimed for children aged 10+, because of the dificulty, but,
hey... Everyone is welcome to try.  A word is picked in random, and
displayed out in the messed order, with dificulty dependant on the
chosen level.  You have unlimited numbers of tryes, and the scores are
kept.
</para>
</chapter>

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

<screenshot>
<screeninfo>Here's a screenshot of &kmessedwords;</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="kmw1.png" format="PNG"/></imageobject>
<textobject><phrase>KMessedWords screenshot</phrase></textobject>
</mediaobject>
</screenshot>

<sect1 id="general-usage">
<title>General usage</title>

<para>A word is displayed in the random order of the letters... You guess the entire word at once. If you missed or
guessed, the game will tell you.
</para>
<important>
<para>
IMPORTANT : Words are case sensitive, so, that <quote>michelle</quote> is NOT <quote>Michelle</quote>...
</para></important>
<para>
Each time you start the game, the default level is easy.
</para>
<para>
There are 3 levels : easy, medium and hard:
</para>
<para>
As of all levels are completly customizable, you can set the level of difficulty of each level by yourself.
And, as the dificulty level of the game is dependant on the length of
the word, by default is this:</para>
<variablelist>
<varlistentry>
<term>Easy</term>
<listitem><para>4 letters, everyday words</para></listitem>
</varlistentry>
<varlistentry>
<term>Medium</term>
<listitem><para>Special 4 letter words, and longer everyday words, up
to 7 letters.</para></listitem>
</varlistentry>
<varlistentry>
<term>Hard</term>
<listitem><para>Words at least 6 letters long, both everyday words and
special words.</para></listitem>
</varlistentry>
</variablelist>


<para>After a word is guessed, you are prompted for another word and
you can either use the <guibutton>Yes</guibutton> or
<guibutton>No</guibutton>.</para>

</sect1>
</chapter>
<chapter id="commands">
<title>Game Reference</title>

<screenshot>
<screeninfo>Here's a screenshot of &kmessedwords;</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="kmw1.png" format="PNG"/></imageobject>
<textobject><phrase>&kmessedwords; screenshot</phrase></textobject>
</mediaobject>
</screenshot>

<sect1 id="kmessedwords-mainwindow">
<title>The main &kmessedwords; window</title>

<para>Button <guibutton>Bye!</guibutton>, just as well as <keycombo
action="simul">&Alt;<keycap>F4</keycap></keycombo>, can exit the game at any
time.</para>

<para><guibutton>Help</guibutton> button will show you this window,
containing all of the avaliable help.</para>

<para><guibutton>Configure</guibutton> button hides 2 options inside:
<guilabel>Configuration</guilabel> will popup the main configuration
screen to setup the &kmessedwords;, and the
<guilabel>Dictionary</guilabel>, where you will be able to write /
erase the words.</para>

<para><guibutton>Scores</guibutton> will show you top 10
scores.</para>

<para>On push on button <guibutton>Messup</guibutton> You will start
the game.</para>

<para>Dropdown menu <guimenu>Level</guimenu> will set the level that
you are playing.</para>

</sect1>
</chapter>

<chapter id="configuration">
<title>Configuring &kmessedwords;</title>

<screenshot>
<screeninfo>Configuration window of &kmessedwords;</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="kmw2.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>&kmessedwords; configuration window</phrase>
</textobject>
</mediaobject>
</screenshot>

<sect1 id="kmessedwords-themes">
<title>Changing themes</title>

<para>&kmessedwords; allows you to change view of the application
itself. You do that very simply by selecting which theme you
want. just by clicking on the dropdown box. You can also select the
parts, which you want to apply to the application; Weither this is
just graphical buttons, background or both together, just select the
checkboxes under theme name.</para>

<para>By default there is just one theme, called
<quote>default</quote>. In some time, there will probably many more
themes to be worked on, but created seperatly.</para>

</sect1>

<sect1 id="kmessedwords-players">
<title>Changing player name</title>

<para>Due to some mismatched features and programming problems, the
login window from the previous version of the game was dropped and
replaced with the splash screen. But now changing users is almost easy
as before. In the configuration window you just select the tab named
<guilabel>User</guilabel>, change your name and press
<guibutton>Ok</guibutton>.</para>

</sect1>
</chapter>

<chapter id="kmessedwords-dictionary">
<title>Setting word dictionary</title>

<screenshot>
<screeninfo>Wordlist editor of &kmessedwords;</screeninfo>
	<mediaobject>
	  <imageobject>
	    <imagedata fileref="kmw4.png" format="PNG"/>
	  </imageobject>
	    <textobject>
	    <phrase>&kmessedwords; dictionary window</phrase>
	  </textobject>
	</mediaobject>
</screenshot>

<sect1 id="changing-words">
<title>Changing words in &kmessedwords;</title>

<para>To get to the word-editor, you need to choose
<menuchoice><guimenu>Configure</guimenu><guimenuitem>Dictionary</guimenuitem></menuchoice>.
For each level there is own list of the words, as for easy, medium and
hard. The word editor is [for now?] just a plain text editor, that you
just put words into them. The separator is a line divider, or press
<keycap>Enter</keycap>.</para>

<para>The editor will refuse to read blank lines or lines with equal
letters and characters.  To save the words, just press
<guibutton>OK</guibutton> or <guibutton>Save words</guibutton>.  You
<emphasis>don't</emphasis> need to be a <systemitem
class="username">superuser</systemitem> for the program to change the
words, because the dictionary files are saved into local user
configuration.</para>

</sect1>
</chapter>

<chapter id="kmessedwords-scoring">
<title>Previewing scores</title>
<para>

<screenshot>
<screeninfo>&kmessedwords; scores window</screeninfo>
	<mediaobject>
	  <imageobject>
	    <imagedata fileref="kmw3.png" format="PNG"/>
	  </imageobject>
	    <textobject>
	    <phrase>&kmessedwords; scores window</phrase>
	  </textobject>
	</mediaobject>
</screenshot>
</para>
<sect1 id="checking-scores">
<title>Checking scores in &kmessedwords;</title>

<para>To check scores, all you have to do is to click on  the button
<guibutton>scoring</guibutton> in the non-graphical window or on  the
<guiicon>3-1-2</guiicon> stars in the default theme.</para>

</sect1>
</chapter>

<chapter id="developers">
<title>Developer's Guide to &kmessedwords;</title>

<sect1 id="interface">
<title>&kmessedwords; &GUI; - The Graphical User Interface</title>

<para>The &kmessedwords;' core is already built in full, for the
reading / storing and messing up the words. Now my goal is to make the
most easy to use, good looking graphical front-end for that. I am
working on that as much as I can, but everything changes in non-stop
action with my spare time.  I still have some ideas, but I would
really like any other opinions, too.
</para>
</sect1>
</chapter>

<chapter id="faq">
<title>Questions and Answers</title>
&reporting.bugs;
&updating.documentation;

<qandaset id="faqlist">
<qandaentry>
<question>
<para>I have an error message telling me the pictures cannot be found.</para>
</question>
<answer>
<para>If you installed the program from the RPM, then I should be the
one, that is supposed to fix that rpm file. But if you compiled the
application on your own, note, that there is still something with the
default prefix. The default prefix will install the app into the
<filename class="directory">/usr/local/</filename>, so all you have to
do is to change the prefix with
<userinput><option>--prefix=<replaceable>path_to_your_kde_dir</replaceable></option></userinput></para>
</answer> </qandaentry>
</qandaset>
</chapter>

<chapter id="credits">

<title>Credits and License</title>

<para>
&kmessedwords;
</para>
<para>
Idea, main developer, graphics and maintainer: Primoz Anzur<email>zerokode@yahoo.com</email>
</para>
<para>
Contributors:
<itemizedlist>
<listitem><para>Coding help (engine creation): Waldo bastian
<email>bastian@kde.org</email></para> 
</listitem>
<listitem><para>Coding help (includemoc and all that stuff...): Daniel Molkentin
<email>molkentin@kde.org</email></para> 
</listitem>
<listitem><para>Coding help (helped making the &kmessedwords; workimg properly under KDE2 and KDE3): Haavard Froeiland
<email>haavardf@operamail.com</email></para> 
</listitem>
<listitem><para>Moral support: Anne-Marie Mahfouf
<email>annma@kde.org</email></para> 
</listitem>
</itemizedlist>
</para>

<para>
Documentation copyright 2001 Primoz Anzur and &kde; Edutainment team<email>zerokode@yahoo.com</email>
</para>


&underFDL;               <!-- FDL: do not remove -->
&underGPL;        	 <!-- GPL License -->

</chapter>

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

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

&install.intro.documentation;

</sect1>

<sect1 id="requirements">
<title>Requirements</title>

<para>In order to successfully use &kmessedwords;, you need &kde; 3
and &Qt; 3 on your system.</para>

<para>&kmessedwords; can be found on <ulink url="http://edu.kde.org/kmessedwords/">The
&kmessedwords; home page</ulink>.</para>

</sect1>

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

&install.compile.documentation;

</sect1>
</appendix>

&documentation.index;
</book>
<!--
Local Variables:
mode: sgml
sgml-minimize-attributes: nil
sgml-general-insert-case: lower
sgml-indent-step:0
sgml-indent-data:nil
End:
-->



