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

<book lang="&language;">
<bookinfo>
<title>The &kiconedit; Manual</title>
<authorgroup>
<author>
<firstname>Thomas</firstname>
<surname>Tanghus</surname>
<affiliation>
<address><email>tanghus@earthling.net</email></address>
</affiliation>
</author>

<!-- TRANS:ROLES_OF_TRANSLATORS -->

</authorgroup>

<copyright>
<year>1997</year>
<holder>Thomas Tanghus</holder>
</copyright>
<copyright>
<year>2001</year>
<holder>Lauri Watts</holder>
</copyright>

<legalnotice>
&FDLNotice;
</legalnotice>

<date>2001-05-02</date>
<releaseinfo>2.02.01</releaseinfo>

<abstract>
<para>
&kiconedit; is designed to help create icons for &kde; using the
standard icon palette.
</para>
</abstract>

<keywordset>
<keyword>KDE</keyword>
<keyword>kdegraphics</keyword>
<keyword>KIconEdit</keyword>
<keyword>icon</keyword>
</keywordset>
</bookinfo>

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

<blockquote>
<attribution>Thomas Tanghus
<email>tanghus@earthling.net</email></attribution>

<para>
&kiconedit; 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>

</blockquote>

</chapter>

<chapter id="onscreen-fundamentals">
<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>

<variablelist>
<varlistentry>
<term><guiicon>New File</guiicon></term>
<listitem>
<para>
<action>Create a new icon.</action> 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 icon from scratch or
from a template.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><guiicon>Open</guiicon></term>
<listitem>
<para>
<action>Open an existing icon file.</action>
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><guiicon>Save</guiicon></term>
<listitem>
<para>
<action>Save the currently open icon.</action>
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><guiicon>Print</guiicon></term>
<listitem>
<para>
<action>Print the icon.</action>
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><guiicon>Cut</guiicon></term>
<listitem>
<para>
<action>Cuts out the entire icon and put it onto the clipboard.</action>
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><guiicon>Copy</guiicon></term>
<listitem>
<para>
<action>Copies the entire icon to the clipboard.</action>
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><guiicon>Paste</guiicon></term>
<listitem>
<para>
<action>Paste the contents of the clipboard as a new image (if the
clipboard contains a valid icon).</action>
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><guiicon>Resize</guiicon></term>
<listitem>
<para>
<action>Resize icon to width X height.</action>
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><action>Gray scale</action></term>
<listitem>
<para>
<action>Gray scale the icon image.</action> This may create colors not
conformant to the &kde; icon palette.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><guiicon>Zoom in</guiicon></term>
<term><guiicon>Zoom out</guiicon></term>
<term><guiicon>Zoom factor</guiicon></term>
<listitem>
<para>
<action>Zoom to predefined zoom factor.</action>
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><guiicon>Toggle grid</guiicon></term>
<listitem>
<para>
<action>Toggle grid on/off.</action>
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><guiicon>New Icon Editor</guiicon></term>
<listitem>
<para>
<action>Open a new Icon Editor window.</action>
</para>
</listitem>
</varlistentry>
</variablelist>

</sect1>

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

<para>
This toolbar contains the tools you can use to manipulate the
icon.
</para>

<variablelist>
<varlistentry>
<term><guiicon>Find color</guiicon></term>
<listitem>
<para>
Doesn't change the icon but <action>changes the current drawcolor to the
color clicked on.</action>
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><guiicon>Freehand</guiicon></term>
<listitem>
<para>
<action>Draw free hand.</action>
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><guiicon>Select</guiicon></term>
<listitem>
<para>
<action>Select (mark) a part of the icon.</action>
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><guiicon>Line</guiicon></term>
<listitem>
<para>
<action>Draw a line.</action>
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><guiicon>Rectangle</guiicon></term>
<listitem>
<para>
<action>Draw a rectangle.</action>
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><guiicon>Filled rectangle</guiicon></term>
<listitem>
<para>
<action>Draw a filled rectangle.</action>
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><guiicon>Circle</guiicon></term>
<listitem>
<para>
<action>Draw a circle.</action>
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><guiicon>Filled circle</guiicon></term>
<listitem>
<para>
<action>Draw a filled circle.</action>
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><guiicon>Ellipse</guiicon></term>
<listitem>
<para>
<action>Draw an ellipse</action>
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><guiicon>Filled ellipse</guiicon></term>
<listitem>
<para>
<action>Draw a filled ellipse</action> (almost the same thing as drawing
a circle.)
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><guiicon>Spray</guiicon></term>
<listitem>
<para>
<action>Draws a randow dotted pattern like a spraycan.</action>
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><guiicon>Flood fill</guiicon></term>
<listitem>
<para>
<action>Fill an area with the current color.</action>
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><guiicon>Eraser</guiicon></term>
<listitem>
<para>
<action>Draw transparent (invisible).</action>
</para>
</listitem>
</varlistentry>
</variablelist>

</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>
The status bar keeps you informed of current operations.  From left to
right, it tells you the x,y coordinates of the pixel you are working on,
the size of the current canvas, the zoom factor, and the current number
of colors in the icon.
</para>

</sect1>
</chapter>

<chapter id="the-menu-entries">
<title>The Menu Entries</title>

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

<para>
The following functions are available from the <guimenu>File</guimenu>
menu:
</para>

<variablelist>
<varlistentry>
<term>
<menuchoice>
<guimenu>File</guimenu>
<guimenuitem>New Window</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Open a new Icon Editor window.</action>
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>New...</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Lets you create a new icon</action>, either from a template or
by specifying the size.
</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>Open an existing icon file.</action>
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<guimenu>File</guimenu>
<guisubmenu>Open Recent</guisubmenu>
</menuchoice>
</term>
<listitem>
<para>
<action>Displays a list of recently opened icons to choose
from.</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>Save the currently open icon.</action>
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Save as...</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Save the currently open icon under a new name.</action>
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>P</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Print...</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Print the icon</action>
</para>
</listitem>
</varlistentry>

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

</sect1>

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

<para>
The <guimenu>Edit</guimenu> menu contains the following entries:
</para>

<variablelist>
<varlistentry>
<term>
<menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>X</keycap></keycombo>
</shortcut>
<guimenu>Edit</guimenu>
<guimenuitem>Cut</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Cuts out the entire icon and put it onto the clipboard.</action>
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>C</keycap></keycombo>
</shortcut>
<guimenu>Edit</guimenu>
<guimenuitem>Copy</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Copies the entire icon to the clipboard.</action>
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>V</keycap></keycombo>
</shortcut>
<guimenu>Edit</guimenu>
<guimenuitem>Paste</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Paste the contents of the clipboard (if the clipboard contains a
valid icon).</action>
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<guimenu>Edit</guimenu>
<guimenuitem>Paste as New</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Paste the contents of the clipboard as a new image (if the
clipboard contains a valid icon).</action>
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<guimenu>Edit</guimenu>
<guimenuitem>Clear</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Clear the grid and fill it with transparent color.</action>
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>A</keycap></keycombo>
</shortcut>
<guimenu>Edit</guimenu>
<guimenuitem>Select all</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Marks the entire icon as selected.</action>
</para>
</listitem>
</varlistentry>
</variablelist>

</sect1>

<sect1 id="icon">
<title><guimenu>Icon</guimenu></title>

<variablelist>
<varlistentry>
<term>
<menuchoice>
<guimenu>Icon</guimenu>
<guimenuitem>Resize</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
Opens a dialog where you can <action>change the size of the
icon</action>.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<guimenu>Icon</guimenu>
<guimenuitem>Grayscale</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Gray scale the icon image.</action> This may create colors not
conformant to the &kde; icon palette.
</para>
</listitem>
</varlistentry>
</variablelist>

</sect1>

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

<variablelist>
<varlistentry>
<term>
<menuchoice>
<guimenu>View</guimenu>
<guimenuitem>Zoom in</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Magnify the view of the icon</action>.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<guimenu>View</guimenu>
<guimenuitem>Zoom out</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Shrink the view icon to a smaller screen size</action>
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<guimenu>View</guimenu>
<guisubmenu>Zoom factor</guisubmenu>
</menuchoice>
</term>
<listitem>
<para>Zoom to a predefined zoom factor</para>
</listitem>
</varlistentry>
</variablelist>

</sect1>

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

<variablelist>
<varlistentry>
<term>
<menuchoice>
<guimenu>Tools</guimenu>
<guimenuitem>Freehand</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
Draw free hand.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<guimenu>Tools</guimenu>
<guimenuitem>Rectangle</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
Draw a rectangle.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<guimenu>Tools</guimenu>
<guimenuitem>Filled Rectangle</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
Draw a filled rectangle.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<guimenu>Tools</guimenu>
<guimenuitem>Circle</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
Draw a circle.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<guimenu>Tools</guimenu>
<guimenuitem>Filled Circle</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
Draw a filled circle.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<guimenu>Tools</guimenu>
<guimenuitem>Ellipse</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
Draw an ellipse
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<guimenu>Tools</guimenu>
<guimenuitem>Filled Ellipse</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Draw a filled ellipse</action> (almost the same thing as drawing
a circle.)
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<guimenu>Tools</guimenu>
<guimenuitem>Spray</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
Draws a random dotted pattern like a spraycan.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<guimenu>Tools</guimenu>
<guimenuitem>Flood fill</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
Fill an area with the current color.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<guimenu>Tools</guimenu>
<guimenuitem>Line</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
Draw a line.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<guimenu>Tools</guimenu>
<guimenuitem>Eraser (Transparent)</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>Draw transparent (invisible).</para>
</listitem>
</varlistentry>
</variablelist>

</sect1>

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

<variablelist>
<varlistentry>
<term>
<menuchoice>
<guimenu>Options</guimenu>
<guimenuitem>Configure</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
Opens the &kiconedit; configuration dialog, described separately.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<guimenu>Options</guimenu>
<guimenuitem>Show Grid</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Toggle on and off the grid.</action>
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<guimenu>Options</guimenu>
<guimenuitem>Show Toolbar</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Toggle on and off the display of the toolbar.</action>
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<guimenu>Options</guimenu>
<guimenuitem>Show drawing tools</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Toggle on and off the display of the drawing tools.</action>
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<guimenu>Options</guimenu>
<guimenuitem>Show Statusbar</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Toggle on and off the display of the status bar.</action>
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<guimenu>Options</guimenu>
<guimenuitem>Save options</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
Save the current state of the &kiconedit; options.
</para>
</listitem>
</varlistentry>

</variablelist>

</sect1>

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

&help.menu.documentation;

</sect1>
</chapter>

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

<para>
&kiconedit;
</para>

<para>
Program copyright Thomas Tanghus <email>tanghus@kde.org</email>
</para>

<itemizedlist>
<title>Contributors</title>
<listitem>
<para>
John Califf <email>jcaliff@compuzone.net</email>
</para>
</listitem>
<listitem>
<para>
Laurent Montel <email>lmontel@mandrakesoft.com</email>
</para>
</listitem>
</itemizedlist>

<!-- TRANS:CREDIT_FOR_TRANSLATORS -->

&underFDL; 
&underGPL;

</chapter>

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

<sect1 id="how-to-obtain-the-icon-editor">
<title>How to obtain &kiconedit;</title>

&install.intro.documentation;

</sect1>

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

&install.compile.documentation;

</sect1>

<!-- 
<sect1 id="configuration">
<title>Configuration</title>
<para>
</para>
</sect1>

-->
</appendix>


</book>

<!--
Local Variables:
mode: sgml
sgml-indent-step:0
sgml-indent-data:nil
sgml-omittag:nil
sgml-shorttag:t
End:
-->

