<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook V3.1-Based Variant V1.0//EN">

<book lang="en">
<bookinfo>
<title>The KDE Icon Editor Documentation</title>
<authorgroup>
<author>
<firstname>Thomas</firstname>
<surname>Tanghus</surname>
<affiliation>
<address><email>tanghus@earthling.net</email></address>
</affiliation>
</author>
</authorgroup>
<date>08/08/1998</date>
<releaseinfo>0.03.00</releaseinfo>
<abstract>
<para>This Handbook describes The KDE Icon Editor Version 0.3.0</para>
</abstract>
<keywordset>
<keyword>KDE</keyword>
<keyword>KIconEdit</keyword>
<keyword>icon</keyword>
</keywordset>
</bookinfo>

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

<para><emphasis remap="bf">The KDE Icon Editor</emphasis> is designed to help create icons for KDE using the standard icon palette.</para>

<para>I hope you will find this program somehow useful and I would
appreciate any suggestions and comments.</para>

<para><literal remap="tt">Thomas Tanghus</literal>
<ulink url="mailto:tanghus@earthling.net">tanghus@earthling.net</ulink>.</para>
</chapter>

<chapter id="Installation">
<title>Installation</title>

<sect1 id="how-to-obtain-the-icon-editor">
<title>How to obtain the Icon Editor</title>

<para><emphasis remap="bf">The KDE Icon Editor</emphasis> can be found on <ulink url="ftp://ftp.kde.org/pub/kde/unstable/apps/graphics">ftp://ftp.kde.org/pub/kde/unstable/apps/graphics</ulink>, the main ftp site of the KDE project or at
<ulink url="http://w1.1358.telia.com/~u135800018">my homepage</ulink>.</para>
</sect1>

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

<para>In order to successfully compile the icon editor, you need kdelibs-1.0 or the latest versions
of <literal remap="tt"> libkdecore</literal>, <literal remap="tt"> libkdeui</literal>, <literal remap="tt"> libkfile</literal> and <literal remap="tt"> libkfm</literal>.
All required libraries as well as The KDE Icon Editor itself can be found on <ulink url="ftp://ftp.kde.org/pub/kde/">ftp://ftp.kde.org/pub/kde/</ulink>.</para>
</sect1>

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

<para>In order to compile and install the <emphasis remap="bf">KDE Icon Editor</emphasis> on your system, type the
following in the base directory of the Icon Editor distribution:
<screen> 
% ./configure 
% make 
% make install 
</screen>
</para>

<para>Since the Icon Editor uses <literal remap="tt">autoconf</literal> and <literal remap="tt">automake</literal> you should have not trouble
compiling it.  Should you run into problems please report them to the
<emphasis remap="bf">KDE</emphasis> mailing lists.</para>
</sect1>

<sect1 id="configuration">
<title>Configuration</title>
<para>
</para>
</sect1>
</chapter>

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

<para>In this section will be briefly described the Icon Editor user interface. </para>

<para>The Icon Editor window is separated in four areas: main toolbar, tools toolbar
grid and statusbar.</para>

<sect1 id="main-toolbar">
<title>Main toolbar</title>

<para><variablelist>
<varlistentry>
<term>New File</term>
<listitem>
<para>Create a new ikon. If the current file has been modified you will be asked if you
want to save the changes. After that a dialog will open where you can choose to create
the ikon from scratch or from a template (templates requires kdelibs &gt; 1.0).</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Open</term>
<listitem>
<para>Open an existing icon file.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Save</term>
<listitem>
<para>Save the currently open icon.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Print</term>
<listitem>
<para>Print the icon</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Cut</term>
<listitem>
<para>Cuts out the entire icon and put it onto the clipboard.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Copy</term>
<listitem>
<para>Copies the entire icon to the clipboard.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Paste</term>
<listitem>
<para>Paste the contents of the clipboard as a new image (if the clipboard contains a valid icon).</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Resize</term>
<listitem>
<para>Resize icon to width X height (req. kdelibs &gt; 1.0)</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Gray scale</term>
<listitem>
<para>Gray scale the icon image. This may create colors not conformant to the KDE icon palette.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Zoom in</term>
<term>Zoom out</term>
<term>Zoom factor</term>
<listitem>
<para>Zoom to predefined zoom factor.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Toggle grid</term>
<listitem>
<para>Toggle grid on/off.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>New Icon Editor</term>
<listitem>
<para>Open a new Icon Editor window.</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</sect1>

<sect1 id="tools-toolbar">
<title>Tools toolbar</title>

<para>This toolbar contains the tools you can use to manipulate the icon.
<variablelist>
<varlistentry>
<term>Find color</term>
<listitem>
<para>Doesn't change the icon but changes the current drawcolor to the color clicked on.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Freehand</term>
<listitem>
<para>Draw free hand.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Select</term>
<listitem>
<para>Select (mark) a part of the icon.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Line</term>
<listitem>
<para>Draw a line.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Rectangle</term>
<listitem>
<para>Draw a rectangle.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Filled rectangle</term>
<listitem>
<para>Draw a filled rectangle.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Circle</term>
<listitem>
<para>Draw a circle.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Filled circle</term>
<listitem>
<para>Draw a filled circle.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Ellipse</term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry>
<term>Filled ellipse</term>
<listitem>
<para>Almost the same as drawing a circle.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Spray</term>
<listitem>
<para>Draws a randow dotted pattern like a spraycan.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Flood fill</term>
<listitem>
<para>Fill an area with the current color..</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Eraser</term>
<listitem>
<para>Draw transparent (invisible).</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</sect1>

<sect1 id="grid">
<title>Grid</title>

<para>The grid is where you manipulate the icon contents.</para>
</sect1>

<sect1 id="statusbar">
<title>Statusbar</title>
<para>
</para>
</sect1>
</chapter>

<chapter id="TheMenuEntries">
<title>The Menu Entries</title>

<sect1 id="file">
<title>File</title>

<para>The following functions are available from the file menu:
<variablelist>
<varlistentry>
<term>New Window</term>
<listitem>
<para>Open a new Icon Editor window.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>New ...</term>
<listitem>
<para>Lets you create a new Icon either from a <emphasis remap="bf">template</emphasis> or by specifying the size.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Open</term>
<listitem>
<para>Open an existing icon file.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Save</term>
<listitem>
<para>Save the currently open icon.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Save as</term>
<listitem>
<para>Save the currently open icon under a new name.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Print</term>
<listitem>
<para>Print the icon</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Close</term>
<listitem>
<para>Close the icon Editor window.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Exit</term>
<listitem>
<para>Close all Icon Editor windows opened ( by this instance ),</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</sect1>

<sect1 id="edit">
<title>Edit</title>

<para>The Edit menu contains the following entries:
<variablelist>
<varlistentry>
<term>Cut</term>
<listitem>
<para>Cuts out the entire icon and put it onto the clipboard.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Copy</term>
<listitem>
<para>Copies the entire icon to the clipboard.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Paste</term>
<listitem>
<para>Paste the contents of the clipboard as a new image (if the clipboard contains a valid icon).</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Clear</term>
<listitem>
<para>Clear the grid and fill it with transparent color.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Select all</term>
<listitem>
<para>Marks the entire icon as selected.</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</sect1>

<sect1 id="view">
<title>View</title>

<para><variablelist>
<varlistentry>
<term>Zoom in</term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry>
<term>Zoom out</term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry>
<term>Zoom factor</term>
<listitem>
<para>Zoom to a predefined zoom factor</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</sect1>

<sect1 id="tools">
<title>Tools</title>

<para><variablelist>
<varlistentry>
<term>Freehand</term>
<listitem>
<para>Draw free hand.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Select</term>
<listitem>
<para>Select (mark) a part of the icon.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Line</term>
<listitem>
<para>Draw a line.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Rectangle</term>
<listitem>
<para>Draw a rectangle.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Filled rectangle</term>
<listitem>
<para>Draw a filled rectangle.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Circle</term>
<listitem>
<para>Draw a circle.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Filled circle</term>
<listitem>
<para>Draw a filled circle.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Ellipse</term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry>
<term>Filled ellipse</term>
<listitem>
<para>Almost the same as drawing a circle.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Spray</term>
<listitem>
<para>Draws a randow dotted pattern like a spraycan.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Flood fill</term>
<listitem>
<para>Fill an area with the current color..</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Eraser</term>
<listitem>
<para>Draw transparent (invisible).</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</sect1>

<sect1 id="options">
<title>Options </title>

<para><variablelist>
<varlistentry>
<term>Toggle grid</term>
<listitem>
<para>Toggle grid on/off.</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</sect1>

<sect1 id="help">
<title>Help</title>

<para>From this menu user can show information about The Icon Editor.</para>
</sect1>
</chapter>
</book>
<!--
Local Variables:
mode: sgml
sgml-omittag: nil
sgml-shorttag: t
End:
-->
