<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook V3.1-Based Variant V1.0//EN" [
 <!ENTITY kappname "&kfract;">
 <!ENTITY English "INCLUDE">
 <!ENTITY % addindex "IGNORE">
 <!ENTITY % ents PUBLIC "-//KDE//ENTITIES Documentation V2.0//EN">
 %ents; 
]>

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

<authorgroup>
<author>
<firstname>Uwe</firstname>
<surname>Thiem</surname>
<affiliation>
<address><email>uwe@uwix.alt.na</email></address>
</affiliation>
</author>
</authorgroup>

<date>13/06/1999</date>
<releaseinfo>0.01.02</releaseinfo>

<copyright>
<year>1999</year>
<holder>Uwe Thiem</holder>
</copyright>

<legalnotice>&FDLNotice;</legalnotice>

<abstract>
<para>This Handbook describes KFract Version 0.1.2</para>
</abstract>
<keywordset>
<keyword>KDE</keyword>
<keyword>graphics</keyword>
<keyword>fractal</keyword>
</keywordset>
</bookinfo>

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

<screenshot>
<screeninfo>KFract</screeninfo>
<mediaobject>
	<imageobject>
	  <imagedata fileref="kfract.png" format="PNG">
	</imageobject>
</mediaobject>
</screenshot>

<para>Kfract is a generator for fractals. Well, at this early stage it's 
only capable of mandelbrot sets and julia sets. Nothing fancy like Xfractint. 
And it's way far from being as fast as Xfractint. But it's much easier to use.</para>

<para>The code is a mess and reflects my stage of learning Qt und KDE. But it works.
;-)</para>

<para>Please feel free to contact me:</para>

<para>Uwe Thiem <ulink url="mailto:uwe@uwix.alt.na">&lt;uwe@uwix.alt.na&gt;</ulink></para>
</chapter>

<chapter id="OnscreenFundamentals">
<title>Onscreen Fundamentals</title>

<sect1 id="mouse-functions">
<title>Mouse functions</title>

<para><variablelist>
<varlistentry>
<term>Left mouse button</term>
<listitem>
<para>Left mouse button let you draw a rectangle which will become the next picture.
The center of the rectangle will be the center of the new picture. X/Y ratio 
will be adapted to fit into the window.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Middle mouse button</term>
<listitem>
<para>Middle mouse button zooms in.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Right mouse button</term>
<listitem>
<para>Right mouse button zooms out.</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</sect1>

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

<para><variablelist>
<varlistentry>
<term>Load params...</term>
<listitem>
<para>Loads a by KFract generated parameter file and calculates the picture.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Save params...</term>
<listitem>
<para>Saves the parameters of the current pictures. This file can be loaded later 
in order to re-calculate the picture. It consists of plain ASCII and can 
be exchanged emong different machines of even different architectures as long 
as KDE is installed.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Save pic...</term>
<listitem>
<para>Saves current picture as BMP. Sorry, no GIF support so far.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Quit</term>
<listitem>
<para>Well, here you leave Kfract.</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</sect1>

<sect1 id="the-types-menu">
<title>The Types Menu</title>

<para>Each entry switches to the displayed fractal type. So far implemented:
<variablelist>
<varlistentry>
<term>Mandelbrot</term>
<listitem>
<para>Switches to mandelbrot set. Parameters (like maximal iteration depth, 
co-ordinates, width,...) can be set.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Julia</term>
<listitem>
<para>Switches to julia set. Parameters (like maximal iteration depth, co-ordinates,
width,...) can be set.</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</sect1>

<sect1 id="the-options-menu">
<title>The Options Menu</title>

<para><variablelist>
<varlistentry>
<term>Max. iteration</term>
<listitem>
<para>Maximal iteration depth can be set.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Colour scheme</term>
<listitem>
<para>Here you switch between 2 different colour schemes.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Colour cycling</term>
<listitem>
<para>Not implemented yet.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Zoom factor</term>
<listitem>
<para>The factors for zoom in and zoom out can be set.</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</sect1>

<sect1 id="the-help-menu">
<title>The Help Menu</title>

<para><variablelist>
<varlistentry>
<term>Help</term>
<listitem>
<para>Shows this help page. ;-)</para>
</listitem>
</varlistentry>
<varlistentry>
<term>About</term>
<listitem>
<para>Pops up an info box with some information about this program and it's
author.</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</sect1>

<sect1 id="the-toolbar">
<title>The Toolbar</title>

<para><variablelist>
<varlistentry>
<term>Open</term>
<listitem>
<para>Like <emphasis remap="bf">File-&gt;Load params</emphasis>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Save as parameter file</term>
<listitem>
<para>Like <emphasis remap="bf">File-&gt;Save params</emphasis>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Save picture</term>
<listitem>
<para>Like <emphasis remap="bf">File-&gt;Save pic</emphasis></para>
</listitem>
</varlistentry>
<varlistentry>
<term>Zoom in</term>
<listitem>
<para>Zooms in like middle mouse button (MMB) except that the center of the actual 
picture becomes the center of the new picture.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Zoom out</term>
<listitem>
<para>Zooms out like right mouse button (RMB) except that the center of the actual 
picture becomes the center of the new picture.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Home</term>
<listitem>
<para>Sets all relevant parameters of the actual type to its defaults and 
re-calculates the set. Parameters which are not relevant to the actual type 
(like colour scheme) stay untouched. If you've got lost here you'll find back.</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</sect1>
</chapter>

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

<para>&kfract;</para>

<para>Program and Documentation copyright 1999 Uwe Thiem
<email>uwe@uwix.alt.na</email></para>


&underFDL;
&underGPL;

</chapter>

</book>
<!--
Local Variables:
mode: sgml
sgml-omittag: nil
sgml-shorttag: t
End:
-->
