<?xml version="1.0"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY appversion "0.4.2">
<!ENTITY manrevision "1.0">
<!ENTITY date "February 2007">
<!ENTITY app "Agave">
]>
<!--
(Do not remove this comment block.)
Maintained by the GNOME Documentation Project
http://developer.GNOME.org/projects/gdp
Template version: 2.0 beta
Template last modified Jan 30, 2002

-->
<!-- =============Document Header ============================= -->
<?yelp:chunk-depth 2?>
<article id="index" lang="en">
    <!-- please do not change the id; for translations, change lang to -->
    <!-- appropriate code -->
    <articleinfo>
        <title>&app; Manual</title>
        <copyright>
            <year>2007</year>
            <holder>GNOME Documentation Project</holder> </copyright>

        <!-- translators: uncomment this:

        <copyright>
            <year>2003</year>
            <holder>ME-THE-TRANSLATOR (Latin translation)</holder>
        </copyright>

        -->
        <publisher role="maintainer">
            <publishername>GNOME Documentation Project</publishername>
        </publisher>

        <xi:include href="legal.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

        <authorgroup>
            <author>
                <firstname>GNOME Documentation Project</firstname>
                <surname></surname>
                <affiliation>
                    <orgname>GNOME</orgname>
                </affiliation>
            </author>

            <!-- This is appropriate place for other contributors: translators,
            maintainers,  etc. Commented out by default.
            <othercredit role="translator">
                <firstname>Latin</firstname>
                <surname>Translator 1</surname>
                <affiliation>
                    <orgname>Latin Translation Team</orgname>
                    <address> <email>translator@gnome.org</email> </address>
                </affiliation>
                <contrib>Latin translation</contrib>
            </othercredit>
            -->
        </authorgroup>

        <!-- According to GNU FDL, revision history is mandatory if you are -->
        <!-- modifying/reusing someone else's document.  If not, you can omit it. -->
        <revhistory>
            <!-- Remember to remove the &manrevision; entity from the revision entries other
            than the current revision. -->
            <revision>
                <revnumber>1.0</revnumber>
                <date>2007</date>
                <revdescription>
                    <para>Initial version</para>
                </revdescription>
            </revision>
        </revhistory>
        <releaseinfo> This manual describes version &appversion; of &app;.
        </releaseinfo>
        <legalnotice>
            <title>Feedback</title>
            <para>To report a bug or make a suggestion regarding the <application>&app;</application> application or this manual, follow the directions in the <ulink url="ghelp:gnome-feedback" type="help">GNOME Feedback Page</ulink>.
            </para>
            <!-- Translators may also add here feedback address for translations -->
        </legalnotice>
        <abstract role="description">
            <para>&app; is a colorscheme designer for the GNOME desktop.</para>
        </abstract>
    </articleinfo>
    <indexterm><primary>agave</primary></indexterm>
    <indexterm><primary>colorscheme designer</primary></indexterm>

    <!-- ============= Document Body ============================= -->
    <!-- ============= Introduction ============================== -->
    <sect1 id="agave-intro">
        <title>Introduction</title>

        <para>
            <application>&app;</application> is an application for the GNOME
            desktop that allows you to select an initial color and generate a
            variety of different colorschemes from that color.  The primary
            audience of this application is graphic designers (and particularly web
            designers) though it can be used for anything where you might need to
            pick several colors that go well together, such as painting rooms in
            your house.
        </para>

    </sect1>
    <sect1>
        <title>Getting Started</title>
        <para>
            This section explains how to start &app; and gives a basic overview
            of the application.
        </para>
        <sect2>
            <title>Starting &app;</title>
            <para>
                You can start &app; in the following ways:
            </para>
            <variablelist>
                <varlistentry>
                    <term><guimenu>Applications</guimenu> menu</term>
                    <listitem>
                        <para>
                            Choose <menuchoice> <guisubmenu>Graphics</guisubmenu>
                                <guimenuitem>&app;</guimenuitem> </menuchoice>.
                        </para>
                    </listitem>
                </varlistentry>
                <varlistentry>
                    <term>Command line</term>
                    <listitem>
                        <para>
                            Type <command>agave</command>, then press 
                            <keycap>Return</keycap>.
                        </para>
                    </listitem>
                </varlistentry>
            </variablelist>

        </sect2>
        <sect2>
            <title>The &app; window</title>
            <para>
                When you start &app;, you will see a window that looks very much like the following:
            </para>
            <figure id="agave-window">
                <title>&app; Window</title>
                <screenshot>
                    <mediaobject>
                        <imageobject>
                            <imagedata fileref="figures/main-window.png" format="PNG"/>
                        </imageobject>
                        <textobject> <phrase>Shows &app; main window.</phrase>
                        </textobject>
                    </mediaobject>
                </screenshot>
            </figure>
            <para>The <application>&app;</application> window contains the following
                elements: </para>
            <variablelist>
                <varlistentry> <term>Menubar</term>
                    <listitem>
                        <para>The menus on the menubar contain all of the commands you need to use <application>&app;</application>.</para>
                    </listitem>
                </varlistentry>
                <varlistentry> <term>Toolbar</term>
                    <listitem>
                        <para> The toolbar contains a subset of the commands that you can access from the menubar.</para>
                    </listitem>
                </varlistentry>
                <varlistentry> <term>Scheme Display Box</term>
                    <listitem>
                        <para>
                            The scheme display box contains several large color swatches
                            which display a color scheme based on the current
                            settings.  It also contains controls that allow you
                            to select a new base color and scheme type.
                        </para>
                    </listitem>
                </varlistentry>
                <varlistentry> <term>Palette</term>
                    <listitem>
                        <para>
                            The palette offers a selection of color presets that
                            you can click in order to change the current base
                            color.  You can choose from several built-in
                            palettes and you can also create and add your own
                            palettes. (add reference)
                        </para>
                    </listitem>
                </varlistentry>
                <varlistentry> <term>Favorites</term>
                    <listitem>
                        <para>
                            The favorites list displays a list of colors that
                            you have saved, as well as a small toolbar that
                            allows you to modify the list.
                        </para>
                    </listitem>
                </varlistentry>
                <varlistentry> <term>Status bar</term>
                    <listitem>
                        <para> The status bar is pretty much useless.  I should just get rid of it. </para>
                    </listitem>
                </varlistentry>
            </variablelist>
        </sect2>
    </sect1>

    <sect1>
        <title>Using &app;</title>
        <sect2>
            <title>Choosing a Base Color</title>
            <para>
                There are several different ways of choosing a color that will
                be used as the  base of your colorschemes.
            </para>
            <sect3>
                <title>The Color Selector Button</title>
                <para>
                    The most basic way to choose a color is by using the Color
                    selector button.  Clicking on this button will bring up the
                    dialog shown below:
                </para>
                <figure id="gtk-color-selector">
                    <title>Color Selection Dialog</title>
                    <screenshot>
                        <mediaobject>
                            <imageobject>
                                <imagedata fileref="figures/gtk-color-selector.png" format="PNG"/>
                            </imageobject>
                            <textobject>
                                <phrase>Color Selection Dialog</phrase>
                            </textobject>
                        </mediaobject>
                    </screenshot>
                </figure>
                <para>
                    The color selection dialog allows you to choose a base color in a variety of ways, including:
                </para>
                <itemizedlist>
                    <listitem>
                        <para>Specifying Hue, Saturation, and Value</para>
                    </listitem>
                    <listitem>
                        <para>Specifying Red, Green, and Blue components</para>
                    </listitem>
                    <listitem>
                        <para>Choosing from a color wheel</para>
                    </listitem>
                    <listitem>
                        <para>Choosing a color from any point on the screen (eyedropper tool)</para>
                    </listitem>
                </itemizedlist>
                <para>
                    Using the color selector button is probably the best method to
                    use if you already know which color you want to use as your base
                    color.
                </para>
            </sect3>
            <sect3>
                <title>Palettes</title>
                <para>
                    Another way to select a base color is by using one of the
                    color palettes in the bottom part of the application window.
                    These palettes provide a number of preset colors that you
                    can use as a starting point.  You can select one of the
                    colors in the palette as your base color by simply clicking
                    on it.
                </para>
            </sect3>
            <sect3>
                <title>Favorites</title>
                <para>
                    If you've previously saved colors to your favorites list,
                    you can use any of those colors as the basis of your
                    colorscheme by selecting it from the list.
                </para>
            </sect3>
            <sect3>
                <title>Random</title>
                <para>
                    If you're really stuck and need some inspiration, you can
                    also have &app; generate a random base color for you.  You
                    can do this by clicking the <guibutton>Random</guibutton>
                    button on the toolbar.  Alternately, you can select
                    <menuchoice>
                        <shortcut>
                            <keycombo>
                                <keycap>Ctrl</keycap>
                                <keycap>R</keycap>
                            </keycombo>
                        </shortcut>
                        <guimenu>Edit</guimenu>
                        <guimenuitem>Random</guimenuitem>
                    </menuchoice>
                    from the menu.
                </para>
            </sect3>
        </sect2>
        <sect2 id="sect-choosing-scheme-type">
            <title>Choosing a Scheme Type</title>
            <para>
                &app; allows you choose from several different types of color
                schemes.  These color schemes are explained below.  In addition,
                a diagram is provided for each scheme which shows the
                relationships between the generated colors on a color wheel.
            </para>
            <variablelist>
                <varlistentry>
                    <term>Complements</term>
                    <listitem>
                        <para>
                            Generates a 2-color scheme consisting of the base
                            color and a color directly across the color wheel
                            from the base color
                        </para>
                        <figure id="complements-scheme">
                            <title>Complements</title>
                            <mediaobject>
                                <imageobject>
                                    <imagedata fileref="figures/complements.png" format="PNG"/>
                                </imageobject>
                                <textobject> <phrase>Shows complementary color scheme</phrase>
                                </textobject>
                            </mediaobject>
                        </figure>
                    </listitem>
                </varlistentry>
                <varlistentry>
                    <term>Split-Complements</term>
                    <listitem>
                        <para>
                            Generates a 3-color scheme consisting of the base
                            color and two colors that are slightly offset from
                            its complement
                        </para>
                        <figure id="split-complements-scheme">
                            <title>Split Complements</title>
                            <mediaobject>
                                <imageobject>
                                    <imagedata fileref="figures/split-complements.png" format="PNG"/>
                                </imageobject>
                                <textobject> <phrase>Shows split-complementary color scheme</phrase>
                                </textobject>
                            </mediaobject>
                        </figure>
                    </listitem>
                </varlistentry>
                <varlistentry>
                    <term>Triads</term>
                    <listitem>
                        <para>
                            Generates a 3-color scheme consisting of the base
                            color and two other colors that are equally spaced
                            around the color wheel
                        </para>
                        <figure id="triads-scheme">
                            <title>Triads</title>
                            <mediaobject>
                                <imageobject>
                                    <imagedata fileref="figures/triads.png" format="PNG"/>
                                </imageobject>
                                <textobject> <phrase>Shows triads color scheme</phrase>
                                </textobject>
                            </mediaobject>
                        </figure>
                    </listitem>
                </varlistentry>
                <varlistentry>
                    <term>Tetrads</term>
                    <listitem>
                        <para>
                            Generates a 4-color scheme consisting of the base
                            color and three other colors that are equally spaced
                            around the color wheel
                        </para>
                        <figure id="tetrads-scheme">
                            <title>Tetrads</title>
                            <mediaobject>
                                <imageobject>
                                    <imagedata fileref="figures/tetrads.png" format="PNG"/>
                                </imageobject>
                                <textobject> <phrase>Shows tetrads color scheme</phrase>
                                </textobject>
                            </mediaobject>
                        </figure>
                    </listitem>
                </varlistentry>
                <varlistentry>
                    <term>Analogous</term>
                    <listitem>
                        <para>
                            Generates a 3-color scheme consisting of the base
                            color and two other colors that are slightly offset
                        </para>
                        <figure id="analogous-scheme">
                            <title>Analogous</title>
                            <mediaobject>
                                <imageobject>
                                    <imagedata fileref="figures/analogous.png" format="PNG"/>
                                </imageobject>
                                <textobject> <phrase>Shows analogous color scheme</phrase>
                                </textobject>
                            </mediaobject>
                        </figure>
                    </listitem>
                </varlistentry>
                <varlistentry>
                    <term>Monochromatic</term>
                    <listitem>
                        <para>
                            Generates a 3-color scheme consisting of the base
                            color and two other colors that are the same hue,
                            but vary in saturation or value
                        </para>
                    </listitem>
                </varlistentry>
            </variablelist>
        </sect2>
    </sect1>

    <!-- This should be the last section in the manual -->
    <sect1>
        <title>About &app;</title>
        <para>
            <application>&app;</application> was written by Jonathon Jongsma.
            To find more information about &app;, please visit the <ulink
                url="http://home.gna.org/colorscheme/" type="http">&app; project
                website</ulink>.
        </para>
        <para>
            To report a bug or make a suggestion regarding this application or
            this manual, see the Feedback section of the <ulink
                url="ghelp:user-guide?feedback-bugs" type="help">GNOME User
                Guide</ulink>.
        </para>

        <para>
            This program is distributed under the terms of the GNU General
            Public license as published by the Free Software Foundation; either
            version 2 of the License, or (at your option) any later version. A
            copy of this license can be found at this <ulink url="ghelp:gpl"
                type="help">link</ulink>, or in the file COPYING included with
            the source code of this program.
        </para>
  </sect1>
</article>
