<?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 legal SYSTEM "legal.xml">
  <!ENTITY appletversion "2.9.7">
  <!ENTITY manrevision "2.10">
  <!ENTITY date "September 2004">
  <!ENTITY applet "Battery Charge Monitor">
]>

<!-- 
      (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 Feb 12, 2002
-->

<!-- =============Document Header ============================= -->
<article id="index" lang="en">
<!-- please do not change the id; for translations, change lang to -->
<!-- appropriate code -->
  <articleinfo> 
    <title>&applet; Applet Manual</title> 
    <copyright>
      <year>2005</year>
      <holder>Davyd Madeley</holder>
    </copyright>
    <copyright>
      <year>2004</year>
      <holder>Angela Boyle</holder>
    </copyright>
    <copyright>
      <year>2004</year>
      <holder>Sun Microsystems</holder>
    </copyright>
    <copyright>
      <year>2002</year>
      <holder>Trevor Curtis</holder>
    </copyright>
    <copyright> 
      <year>1999</year> 
      <year>2000</year> 
      <holder>Jorgen Pehrson</holder> 
    </copyright>
<!-- translators: uncomment this:

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

   -->

    <publisher> 
      <publishername> GNOME Documentation Project </publishername> 
    </publisher> 
  
    &legal;
<!-- This file  contains link to license for the documentation (GNU FDL), and 
     other legal stuff such as "NO WARRANTY" statement. Please do not change 
     any of this. -->

    <authorgroup> 
      <author>
        <firstname>Sun</firstname>
        <surname>GNOME Documentation Team</surname>
        <affiliation><orgname>Sun Microsystems</orgname></affiliation>
      </author>
      <author>
        <firstname>Trevor</firstname>
        <surname>Curtis</surname>
        <affiliation>
          <orgname>GNOME Documentation Project</orgname>
          <address> <email>tcurtis@somaradio.ca</email> </address>
        </affiliation>
      </author>
      <author> 
        <firstname>Jorgen </firstname> 
        <surname> Pehrson</surname> 
        <affiliation> 
          <orgname>GNOME Documentation Project</orgname> 
          <address> <email>jp@spektr.eu.org</email> </address> 
        </affiliation> 
      </author> 
      <author>
	<firstname>Angela</firstname>
	<surname>Boyle</surname>
	<affiliation>
	  <orgname>GNOME Documentation Project</orgname>
	</affiliation>
      </author>
      <author>
        <firstname>Davyd</firstname>
	<surname>Madeley</surname>
	<affiliation>
	  <orgname>GNOME Project</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>

    <revhistory>
      <revision>
        <revnumber>Version 2.10</revnumber>
	<date>March 2005</date>
	<revdescription>
	 <para role="author">Davyd Madeley</para>
	</revdescription>
      </revision>
      <revision>
	<revnumber>Version 2.8</revnumber>
	<date>Unknown</date>
	<revdescription>
	  <para role="author">Angela Boyle</para>
	  <para role="publisher">GNOME Documentation Project</para>
	</revdescription>
      </revision>
      <revision>
        <revnumber>Battery Charge Monitor Applet Manual V2.2</revnumber>
        <date>August 2004</date>
        <revdescription>
          <para role="author">Sun GNOME Documentation Team</para>
          <para role="publisher">GNOME Documentation Project</para>
        </revdescription>
      </revision>
      <revision>
        <revnumber>Battery Charge Monitor Applet Manual V2.0</revnumber>
        <date>May 2002</date>
        <revdescription>
          <para role="author">Trevor Curtis
            <email>tcurtis@somaradio.ca</email>
          </para>
          <para role="author">Jorgen Pehrson
            <email>jp@spektr.eu.org</email>
          </para>
          <para role="publisher">GNOME Documentation Project</para>
        </revdescription>
      </revision>
    </revhistory>
                                                                                                  
    <releaseinfo>This manual describes version &appletversion; of &applet;.
    </releaseinfo>
                                                                                                  
    <legalnotice>
      <title>Feedback</title>
      <para>
        To report a bug or make a suggestion regarding the &applet; applet or
        this manual, follow the directions in the <ulink url="ghelp:gnome-feedback"
        type="help">GNOME Feedback Page</ulink>.
      </para>
    </legalnotice> 
  </articleinfo> 

  <indexterm zone="index"> 
	 <primary>Battery Charge Monitor Applet</primary> 
  </indexterm> 

  <indexterm zone="index"> 
	 <primary>Battstat Applet</primary> 
  </indexterm> 

<!-- ============= Document Body ============================= -->
<!-- ============= Introduction ============================== -->
  <sect1 id="battstat-introduction"> 
    <title>Introduction</title> 

    <figure id="battstat-applet-fig"> 
      <title>&applet; Applet</title> 
      <screenshot> 
        <mediaobject> 
          <imageobject><imagedata
            fileref="figures/battstat-applet_window.png" format="PNG"/> 
          </imageobject>
          <textobject> 
            <phrase>The &applet; applet.</phrase>
          </textobject> 
        </mediaobject> 
      </screenshot> 
    </figure>

    <para>
      The <application>&applet;</application> panel application shows the status of any batteries in your laptop computer. You can configure the applet to show any of the following pieces of information on your panel:
    </para>
    <itemizedlist>
      <listitem>
        <para>
          Power connection status (battery or mains power);
        </para>
      </listitem>
      <listitem>
        <para>
          A graphical representation of battery charge;
        </para>
      </listitem>
      <listitem>
        <para>
          The current battery charge as a percentage; or
        </para>
      </listitem>
      <listitem>
       <para>Battery time remaining/time remaining for recharge</para>
      </listitem>
    </itemizedlist>

    <sect2 id="battstat-introduction-add">
      <title>To Add &applet; to a Panel</title>
      <para>To add <application>&applet;</application> to a panel,
      right-click on the panel, then choose <guimenuitem>Add to
      Panel</guimenuitem>.  Select <application>&applet;</application>
      in the <application>Add to the panel</application> dialog, then
      click <guibutton>OK</guibutton>.</para>
      <para>
        The layout of the <application>&applet;</application> applet varies depending on the size and type of panel in which the applet resides.
      </para>
    </sect2>

</sect1>

<!-- ================ Determining Status ================================ -->

  <sect1 id="battstat-status">
    <title>Determining Status</title>

    <sect2 id="battstat-usage-power">
      <title>Determining the Power Connection Status</title>
      <para>
        The power connection status shows the current status of the laptop power supply:
      </para>
      <informaltable frame="all">
        <tgroup cols="2" colsep="1" rowsep="1">
          <colspec colname="COLSPEC0" colwidth="50*"/>
          <colspec colname="COLSPEC1" colwidth="50*"/>
          <thead>
            <row valign="top">
              <entry colname="COLSPEC0">
                <para>Icon</para></entry>
              <entry colname="COLSPEC1">
                <para>Power Status</para></entry>
            </row>
          </thead>
          <tbody>
            <row valign="top">
              <entry>
                <para>
                  <inlinemediaobject>
                    <imageobject>
                      <imagedata fileref="figures/ac_small.png" format="PNG"/>
                    </imageobject>
                    <textobject>
                      <phrase>Shows icon for AC power.</phrase>
                    </textobject>
                  </inlinemediaobject>
                </para>
              </entry>
              <entry>
                <para>
                  The laptop is connected to a power supply. 
                </para>
              </entry>
            </row>
            <row valign="top">
              <entry>
                <para>
                  <inlinemediaobject>
                    <imageobject>
                      <imagedata fileref="figures/flash_small.png" format="PNG"/>
                    </imageobject>
                    <textobject>
                      <phrase>Shows icon for battery recharging.</phrase>
                    </textobject>
                  </inlinemediaobject>
                </para>
              </entry>
              <entry>
                <para>
                  The laptop battery is recharging.
                </para>
              </entry>
            </row>
            <row valign="top">
              <entry>
                <para>
                  <inlinemediaobject>
                    <imageobject>
                      <imagedata fileref="figures/battery_small.png" format="PNG"/>
                    </imageobject>
                    <textobject>
                      <phrase>Shows icon for battery power.</phrase>
                    </textobject>
                  </inlinemediaobject>
                </para>
              </entry>
              <entry>
                <para>
                  The laptop is using battery power.
                </para>
              </entry>
            </row>
            <row valign="top">
              <entry>
                <para>
                  <inlinemediaobject>
                    <imageobject>
                      <imagedata fileref="figures/warning_small.png" format="PNG"/>
                    </imageobject>
                    <textobject>
                      <phrase>Shows icon for low power.</phrase>
                    </textobject>
                  </inlinemediaobject>
                </para>
              </entry>
              <entry>
                <para>
                  The laptop power is very low.
                </para>
              </entry>
            </row>
          </tbody>
        </tgroup>
      </informaltable>
    </sect2>

    <sect2 id="battstat-usage-progress">
      <title>Determining the Battery Status</title>
      <para>
        The battery-status icon is a progress bar within a battery image. The size and color of the progress bar indicate how much charge remains in the battery:
      </para>
      <informaltable frame="all">
        <tgroup cols="2" colsep="1" rowsep="1">
          <colspec colname="COLSPEC0" colwidth="50*"/>
          <colspec colname="COLSPEC1" colwidth="50*"/>
          <thead>
            <row valign="top">
              <entry colname="COLSPEC0">
                <para>Icon</para></entry>
              <entry colname="COLSPEC1">
                <para>Battery Charge Level</para></entry>
            </row>
          </thead>
          <tbody>
            <row valign="top">
              <entry>
                <para>
                  <inlinemediaobject>
                    <imageobject>
                      <imagedata fileref="figures/batt_green.png" format="PNG"/>
                    </imageobject>
                    <textobject>
                      <phrase>Shows icon for high battery-charge level.</phrase>
                    </textobject>
                  </inlinemediaobject>
                </para>
              </entry>
              <entry>
                <para>
                  High
                </para>
              </entry>
            </row>
            <row valign="top">
              <entry>
                <para>
                  <inlinemediaobject>
                    <imageobject>
                      <imagedata fileref="figures/batt_yellow.png" format="PNG"/>
                    </imageobject>
                    <textobject>
                      <phrase>Shows icon for medium battery-charge level.</phrase>
                    </textobject>
                  </inlinemediaobject>
                </para>
              </entry>
              <entry>
                <para>
                  Medium
                </para>
              </entry>
            </row>
            <row valign="top">
              <entry>
                <para>
                  <inlinemediaobject>
                    <imageobject>
                      <imagedata fileref="figures/batt_orange.png" format="PNG"/>
                    </imageobject>
                    <textobject>
                      <phrase>Shows icon for low battery-charge level.</phrase>
                    </textobject>
                  </inlinemediaobject>
                </para>
              </entry>
              <entry>
                <para>
                  Low
                </para>
              </entry>
            </row>
            <row valign="top">
              <entry>
                <para>
                  <inlinemediaobject>
                    <imageobject>
                      <imagedata fileref="figures/batt_red.png" format="PNG"/>
                    </imageobject>
                    <textobject>
                      <phrase>Shows icon for very low battery-charge level.</phrase>
                    </textobject>
                  </inlinemediaobject>
                </para>
              </entry>
              <entry>
                <para>
                  Very low
                </para>
              </entry>
            </row>
          </tbody>
        </tgroup>
      </informaltable>
      <para>
        For information about how to display the current battery charge as a percentage, see <xref linkend="battstat-appearance"/>.
      </para>
    </sect2>
</sect1>
<!-- ================ Customizing the Appearance ================================ -->

  <sect1 id="battstat-appearance">
    <title>Customizing the &applet;</title>
          <para>Right-click on the applet, then choose
	  <guimenuitem>Preferences</guimenuitem></para>
    <figure id="battstat-applet-prefs"> 
      <title>Preferences Dialog</title> 
      <screenshot> 
        <mediaobject> 
          <imageobject><imagedata
            fileref="figures/battstat-preferences.png" format="PNG"/> 
          </imageobject>
          <textobject> 
            <phrase>Preferences Dialog</phrase>
          </textobject> 
        </mediaobject> 
      </screenshot> 
    </figure>
      <variablelist>
        <varlistentry>
          <term><guilabel>Appearance</guilabel></term>
	  <listitem>
	  <variablelist>
	    <varlistentry>
	      <term><guilabel>Show battery status</guilabel></term>
	      <listitem><para>The battery status is a progress bar within
	      a battery image.  Select this option to display a graphical
	      representation of the the battery status.
	      For more details on what this representation means, a table is
	      available in <xref linkend="battstat-usage-progress" />.
	      </para></listitem>
	    </varlistentry>
	    <varlistentry>
	      <term><guilabel>Show power connection status</guilabel></term>
	      <listitem><para>The power connection status shows the current
	      status of the laptop power supply.  Select this option to display
	      an icon representing the power connection status.
	      A table of icons is available in
	      <xref linkend="battstat-usage-power" />.
	      </para></listitem>
	    </varlistentry>
	    <varlistentry>
	      <term><guilabel>Show time/percentage remaining</guilabel></term>
	      <listitem><para>Selecting this option will display one of two
	      pieces of information. <guilabel>Show time remaining</guilabel>
	      will tell you how many hours and minutes until the battery is
	      fully discharged or recharged. <guilabel>Show percentage
	      remaining</guilabel> will tell you the percentage charge remaining
	      in the battery.</para></listitem>
	    </varlistentry>
	  </variablelist>
	  </listitem>
        </varlistentry>
        <!-- varlistentry>
          <term><guilabel>Battery Color Levels (%)</guilabel></term>
          <listitem><para>Right-click on the applet, then choose <guimenuitem>Preferences</guimenuitem> and then the <guilabel>General</guilabel> tab. Use this spin box to set the battery-charge level at which the progress bar changes from one color to the next. The color sequence, from full to empty battery, is green, yellow, orange, red.</para> 
                <para><guilabel>Preview</guilabel> shows you how the progress bar changes when the battery level changes by moving the slider left and right. The percentage is shown above the slider on the right.</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><guilabel>Progress Bar Direction</guilabel></term>
          <listitem><para>Right-click on the applet, then choose <guimenuitem>Preferences</guimenuitem> and then the <guilabel>Appearance</guilabel> tab.</para>
            <itemizedlist>
              <listitem>
                <para>
                  <guilabel>Moves towards top</guilabel>
                </para>
                <para>
                  Specify that the progress bar decreases from right to left.
                </para>
              </listitem>
              <listitem>
                <para>
                  <guilabel>Moves towards bottom</guilabel>
                </para>
                <para>
                  Specify that the progress bar decreases from left to right.
                </para>
              </listitem>
            </itemizedlist>
          </listitem>
        </varlistentry -->
	<varlistentry>
	 <term><guilabel>Warnings</guilabel></term>
	  <listitem>
	  <itemizedlist>
	   <listitem><para><guilabel>Warn when battery charge is
	   low</guilabel></para>
	   <para>
	    Selecting this displays a warning dialog whenever your laptop
	    battery reaches the Red Zone, indicating a critically low remaining
	    charge. This warning dialog can either be closed by you, or will
	    vanish automatically when you plug your laptop into mains power.
	   </para>
	   </listitem>
	   <listitem>
	    <para><guilabel>Warn when battery is fully
	    re-charged</guilabel></para>
	    <para>
	     Selecting this options displays a warning dialog whenever your
	     laptop has fully recharged.
	    </para>
	   </listitem>
	  </itemizedlist>
	  </listitem>
	</varlistentry>
	<varlistentry>
	 <term><guilabel>Suspend</guilabel></term>
	  <listitem><para>
	  This is the command that will be run when you right click on the
	  &applet; and select <guilabel>Suspend Computer</guilabel>.
	  </para></listitem>
	</varlistentry>
      </variablelist>
   </sect1>

<!-- ==================== Suspending the Computer ======================== -->

<sect1 id="battstat-usage-suspend">
      <title>Suspending the Computer</title>
      <para>
         To suspend the computer, right-click on the applet, then choose <guimenuitem>Suspend Computer</guimenuitem>. </para>
      <para>
       To configure the command that is run when you suspend the computer see
       <xref linkend="battstat-appearance" />.
      </para>
  </sect1>

</article> 
