Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features.

BUG:215923


git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdegames@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da

2 files changed, 333 insertions, 0 deletions

diff --git a/doc/klines/Makefile.am b/doc/klines/Makefile.am
new file mode 100644
index 00000000..8c761fb4
--- /dev/null
+++ b/doc/klines/Makefile.am
@@ -0,0 +1,5 @@
+
+KDE_LANG = en
+KDE_DOCS = klines
+
+
diff --git a/doc/klines/index.docbook b/doc/klines/index.docbook
new file mode 100644
index 00000000..d86d25bf
--- /dev/null
+++ b/doc/klines/index.docbook
@@ -0,0 +1,328 @@
+<?xml version="1.0" ?>
+<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
+  <!ENTITY kappname "&kolorlines;">
+  <!ENTITY package "kdegames">
+  <!ENTITY % addindex "IGNORE">
+  <!ENTITY % English "INCLUDE">
+]>
+	
+<book lang="&language;">
+
+<bookinfo>
+<title>The &kolorlines; Handbook</title>
+
+<authorgroup>
+<author>
+<firstname>Roman</firstname>
+<surname>Razilov</surname>
+<affiliation>
+<address><email>[email protected]</email></address>
+</affiliation>
+</author>
+<author>
+<firstname>Roman</firstname>
+<surname>Merzlyakov</surname>
+<affiliation>
+<address><email>[email protected]</email></address>
+</affiliation>
+</author>
+<!-- TRANS:ROLES_OF_TRANSLATORS -->
+
+</authorgroup>
+
+<copyright>
+<year>2000</year>
+<year>2001</year>
+<holder>Roman Razilov,</holder>
+<holder>Roman Merzlyakov</holder>
+</copyright>
+<legalnotice>&FDLNotice;</legalnotice>
+
+<date>2001-05-20</date>
+<releaseinfo>1.00.00</releaseinfo>
+
+<abstract><para>&kolorlines; is a nice little game meant to amuse you for
+anywhere from 3 minutes to 6 days(straight).</para></abstract>
+
+<keywordset>
+<keyword>KDE</keyword>
+<keyword>kdegames</keyword>
+<keyword>klines</keyword>
+</keywordset>
+
+</bookinfo>
+
+<chapter id="introduction">
+<title>Introduction</title>
+
+<para>&kolorlines; is a simple game. It is played by one player, so there is
+only one winner :-) You play for fun and against the high score. It has
+been inspired by well known game - <application>Color
+lines</application>, written for DOS by Olga Demina, Igor Ivkin and
+Gennady Denisov back at 1992.</para>
+
+<para>In 2000 Roman Merzlyakov wrote a original version for &kde;. Roman
+Roazilov added to it a cool <application>povray</application> generated
+animation. Later in 2001 he ported it to &kde; 2 and made it conform to
+the &kde; games standard.</para>
+
+</chapter>
+
+
+<chapter id="using-klines">
+<title>Using &kolorlines;</title>
+
+<para>The main rules of game is as simple as possible: you move (using
+mouse) marbles from cell to cell and build lines (horizontal, vertical
+or diagonal).  When a line contains 5 or more marbles - they are removed
+from the field and your score grows. After each of your turns computer
+drops three more marbles onto the field.</para>
+
+<para> The increase in score depends on the amount of erased marbles
+and if &kolorlines; shows the next balls.  The increase will be smaller if
+you use the information of what's next.</para>
+
+<sect1 id="klines-features">
+<title>More &kolorlines; features</title>
+
+<para>&kolorlines; is wonderful in that it will allow you to kill 5 minutes
+while you wait for that program to compile.</para> <para>Or, if nothing
+else, it will allow you to kill 5 minutes.</para>
+
+</sect1>
+</chapter>
+
+<chapter id="commands">
+<title>Command Reference</title>
+
+<sect1 id="klines-mainwindow">
+<title>The main &kolorlines; window</title>
+
+<para>There is a large area with marbles.  At the right side a bar
+showing the next three marbles to be dropped on the field. Underneath
+the field is the status bar. Above it is the menu bar.</para>
+
+<sect2>
+<title>The <guimenu>Game</guimenu> Menu</title>
+
+<variablelist>
+<varlistentry>
+<term><menuchoice>
+<shortcut>
+<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>
+</shortcut>
+<guimenu>Game</guimenu>
+<guimenuitem>New game</guimenuitem>
+</menuchoice></term>
+<listitem><para><action>Starts a new game</action></para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term><menuchoice>
+<shortcut>
+<keycombo action="simul">&Ctrl;<keycap>H</keycap></keycombo>
+</shortcut>
+<guimenu>Game</guimenu>
+<guimenuitem>Show Highscores</guimenuitem>
+</menuchoice></term>
+<listitem><para><action>Displays the high score table</action></para></listitem>
+</varlistentry>
+<!-- 
+
+-->
+<varlistentry>
+<term><menuchoice>
+<shortcut>
+<keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
+</shortcut>
+<guimenu>Game</guimenu>
+<guimenuitem>Quit</guimenuitem>
+</menuchoice></term>
+<listitem><para><action>Quits</action> &kolorlines;</para></listitem>
+</varlistentry>
+</variablelist>
+
+</sect2>
+
+<sect2>
+<title>The <guimenu>Move</guimenu> Menu</title>
+
+<variablelist>
+<varlistentry>
+<term><menuchoice>
+<shortcut>
+<keycombo action="simul">&Ctrl;<keycap>Z</keycap></keycombo>
+</shortcut>
+<guimenu>Move</guimenu>
+<guimenuitem>Undo</guimenuitem>
+</menuchoice></term>
+<listitem><para><action>This will undo the last move.</action></para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term><menuchoice>
+<guimenu>Move</guimenu><guimenuitem>End Turn</guimenuitem></menuchoice>
+</term>
+<listitem>
+<para>Skip your move, immediately play the next marbles without you moving
+any.</para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
+<term><menuchoice>
+<shortcut><keycap>D</keycap></shortcut>
+<guimenu>Move</guimenu>
+<guimenuitem>Start Tutorial</guimenuitem>
+</menuchoice></term>
+<listitem><para>Show a short, animated, non-interactive demonstration of how
+to play the game.  If the tutorial is running, the statusbar will show
+<guilabel>Level: Tutorial</guilabel>, and this menu entry will now show
+<guimenuitem>Stop Tutorial</guimenuitem>.</para></listitem>
+</varlistentry>
+</variablelist>
+
+</sect2>
+
+<sect2>
+<title>The <guimenu>Settings</guimenu> Menu</title>
+
+<variablelist>
+<varlistentry>
+<term><menuchoice>
+<guimenu>Settings</guimenu>
+<guimenuitem>Show Statusbar</guimenuitem>
+</menuchoice></term>
+<listitem><para><action>Toggles the display of the statusbar.</action></para></listitem>
+</varlistentry>
+<varlistentry>
+<term><menuchoice>
+<shortcut>
+<keycombo action="simul">&Ctrl;<keycap>P</keycap></keycombo>
+</shortcut>
+<guimenu>Settings</guimenu>
+<guimenuitem>Show Next</guimenuitem>
+</menuchoice></term>
+<listitem><para><action>Toggles the information on next
+marbles.</action></para></listitem>
+</varlistentry>
+<varlistentry>
+<term><menuchoice>
+<guimenu>Settings</guimenu><guimenuitem>Use Numbered Balls</guimenuitem>
+</menuchoice></term>
+<listitem>
+<para>Number the balls according to color. This may be of assistance to
+players who are color blind, have other vision impairments that make the
+colors hard to distinguish, or those of you who simply like the look.</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term><menuchoice><guimenu>Settings</guimenu><guisubmenu>Choose Game
+Type</guisubmenu></menuchoice></term>
+<listitem>
+<para>Choose a difficulty level, from <guimenuitem>Very Easy</guimenuitem>
+through <guimenuitem>Very Hard</guimenuitem>.</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term><menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure
+Shortcuts</guimenuitem></menuchoice></term>
+<listitem>
+<para>Displays a standard &kde; shortcut configuration dialog, allowing you
+to customize the keys used in the game.</para></listitem>
+</varlistentry>
+</variablelist>
+</sect2>
+
+<sect2>
+<title>The <guimenu>Help</guimenu> Menu</title>
+
+&help.menu.documentation;
+
+</sect2>
+</sect1>
+
+</chapter>
+
+<chapter id="credits">
+
+<title>Credits and License</title>
+
+<para>&kolorlines;</para>
+
+<para>Program copyright 2000 Roman Merzlyakov
+<email>[email protected]</email></para>
+<para>Contributors:</para>
+<itemizedlist>
+<listitem><para>Roman Razilov <email>[email protected]</email>
+Redesign, Graphik, animation, partial re-write. Special thanks to my wife Larissa Juschkin for
+testing and discussions.</para>
+</listitem>
+
+</itemizedlist>
+
+<para>Documentation copyright 2001 Roman Razilov
+<email>[email protected]</email></para>
+
+<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
+
+&underFDL;               <!-- FDL: do not remove -->
+
+
+&underGPL;        	 <!-- GPL License -->
+
+</chapter>
+
+<appendix id="installation">
+<title>Installation</title>
+
+<sect1 id="getting-klines">
+<title>How to obtain &kolorlines;</title>
+
+&install.intro.documentation;
+
+</sect1>
+
+<sect1 id="compilation">
+<title>Compilation and Installation</title>
+
+&install.compile.documentation;
+
+</sect1>
+
+<sect1 id="customize">
+<title>Generating marbles with <application>Povray</application></title>
+
+<para>All pictures (<filename>klines/*.jpg</filename>) are
+rendered with <application>Povray</application> 3.0 and manipulated 
+with <application>ImageMagick</application>.
+Povray &amp; bash scripts are in the folder <filename class="directory">>klines/povray</filename>.
+Customize <filename>balls.pov</filename> as you want, 
+render and install it.</para>
+
+<note><para>You need Povray 3.0 to render. In newer Versions &ie; 3.1
+<quote>halo</quote> is suppressed. </para></note>
+
+<para>In order to generate marbles on your system, type the following
+in the base folder of the &package; distribution:</para>
+
+<screen width="40">
+
+<prompt>%</prompt> <userinput><command>cd</command> klines</userinput>
+<prompt>%</prompt> <userinput><command>make</command> install</userinput>
+</screen>
+
+</sect1>
+
+</appendix>
+
+&documentation.index;
+
+</book>
+<!--
+Local Variables:
+sgml-minimize-attributes: nil
+sgml-general-insert-case: lower
+End:
+-->
+