update documentation

(Old svn revision: 5762)

doc/C/images/Makefile.am

@@ -4,7 +4,9 @@ images_DATA = cpu-settings.png	\
 	      general-settings.png	\
 	      battery-settings.png	\
 	      monitor-settings.png	\
-	      button-settings.png
+	      button-settings.png	\
+	      battery.png		\
+	      battery-discharging.png
 
 EXTRA_DIST = $(images_DATA)
 

doc/C/xfce4-power-manager.html

@@ -17,10 +17,10 @@
   the available manageabale interfaces.  
   </p><p>
   In this section we will describe the possible configuration for the power manager.
-  </p><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="xfpm-general"></a>General Settings</h3></div></div></div><div class="figure"><a name="id2537129"></a><p class="title"><b>Figure&#160;1.&#160;General settings</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="images/general-settings.png" alt="General settings"></div></div></div></div><p><br class="figure-break"></p><p>
+  </p><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="xfpm-general"></a>General Settings</h3></div></div></div><div class="figure"><a name="id2550762"></a><p class="title"><b>Figure&#160;1.&#160;General settings</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="images/general-settings.png" alt="General settings"></div></div></div></div><p><br class="figure-break"></p><p>
 	Here you can select the configuration of the system tray icon, enable/disable cpu frequency and DPMS controls, 
 	typical reason to disable DPMS control for example if you are watching a movie.	
-	</p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="xfpm-cpu"></a>CPU Settings</h3></div></div></div><div class="figure"><a name="id2550520"></a><p class="title"><b>Figure&#160;2.&#160;CPU Linux governors</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="images/cpu-settings.png" alt="CPU Linux governors"></div></div></div></div><p><br class="figure-break"></p><p>
+	</p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="xfpm-cpu"></a>CPU Settings</h3></div></div></div><div class="figure"><a name="id2535409"></a><p class="title"><b>Figure&#160;2.&#160;CPU Linux governors</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="images/cpu-settings.png" alt="CPU Linux governors"></div></div></div></div><p><br class="figure-break"></p><p>
 	The linux governors found in the system are listed for choice as a radio buttons,
 	if the acpi_cpufreq module is not loaded in the kernel or the cpu itself doesn't support
 	changes in it's frequency these options might not be shown.
@@ -37,7 +37,7 @@
 	 the CPU speed rather than jumping to max speed the moment there is any load on the CPU.
 	</p></dd></dl></div><p>
 NOTE:In <strong class="application"><code>xfce4-power-manager</code></strong> version 0.6.0 only Linux is supported for changing the CPU frequency.
-</p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="xfpm-battery"></a>Battery settings</h3></div></div></div><div class="figure"><a name="id2530494"></a><p class="title"><b>Figure&#160;3.&#160;Battery settings</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="images/battery-settings.png" alt="Battery settings"></div></div></div></div><p><br class="figure-break"></p><p>
+</p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="xfpm-battery"></a>Battery settings</h3></div></div></div><div class="figure"><a name="id2539716"></a><p class="title"><b>Figure&#160;3.&#160;Battery settings</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="images/battery-settings.png" alt="Battery settings"></div></div></div></div><p><br class="figure-break"></p><p>
 	The user can select the percentage of the battery to be considered as critical, usually this is for a laptop or
 	UPS battery, this option is important as for a broken battery for example, the battery when it is 10% charged 
 	can last	5 minutes, so the user can increase the level at wish the battery charge will be considered critical.    
@@ -48,18 +48,32 @@ NOTE:In <strong class="application"><code>xfce4-power-manager</code></strong> ve
    The battery notification is a way to notify the user when the battery state changes ( ex: battery charge is full )
    <p>
    
-   </p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="xfpm-button"></a>Keyboard shortcuts</h3></div></div></div><div class="figure"><a name="id2537576"></a><p class="title"><b>Figure&#160;4.&#160;button control</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="images/button-settings.png" alt="button control"></div></div></div></div><p><br class="figure-break"></p>
+   </p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="xfpm-button"></a>Keyboard shortcuts</h3></div></div></div><div class="figure"><a name="id2532806"></a><p class="title"><b>Figure&#160;4.&#160;button control</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="images/button-settings.png" alt="button control"></div></div></div></div><p><br class="figure-break"></p>
    For those buttons you can define an action to be taken by the power manager when happen to press one of them, 
    for example when you close the laptop screen. 
     
-  </div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="xfpm-monitor"></a>Monitor settings</h3></div></div></div><div class="figure"><a name="id2530546"></a><p class="title"><b>Figure&#160;5.&#160;Monitor DPMS and lcd brightness</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="images/monitor-settings.png" alt="Monitor DPMS and lcd brightness"></div></div></div></div><p><br class="figure-break"></p><p>
+  </div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="xfpm-monitor"></a>Monitor settings</h3></div></div></div><div class="figure"><a name="id2523830"></a><p class="title"><b>Figure&#160;5.&#160;Monitor DPMS and lcd brightness</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="images/monitor-settings.png" alt="Monitor DPMS and lcd brightness"></div></div></div></div><p><br class="figure-break"></p><p>
 	DPMS is an old X extension that allows standby/suspend/turn off options of the monitor, usually the timeouts 
 	have to be succesitive, so standby timeout less than suspend timeout and so on, but one always can disable any option.
 	</p><p>
 	For a laptop users by clicking on the checkbox allows the power manager to reduce the screen luminosity when
 	it detects that system in running on battery power and set it again to the maximum value when system is running
 	on AC power.
-	</p></div></div><p>&#160;</p><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="xfpm-systray-notify"></a>System Tray Icon and Notification</h2></div></div></div></div><p>&#160;</p><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="xfpm-faq"></a>FAQ</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">Q: Why the icons look very similar to the icon of gnome power manager</span></dt><dd><p>A: No, they are not similar, they are the same, just there is no point of re-drawing icons,
+	</p></div></div><p>&#160;</p><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="xfpm-systray-notify"></a>System Tray Icon and Notification</h2></div></div></div><p>
+</p><div class="figure"><a name="id2548474"></a><p class="title"><b>Figure&#160;6.&#160;Battery icon in the system tray</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="images/battery.png" alt="Battery icon in the system tray"></div></div></div></div><p><br class="figure-break"></p><p>
+
+The "system tray" is an application running on a given X screen that can display small icons 
+provided by running applications. In Xfce it's a panel plugin that catch the icon and resize it
+to the size of the panel, if you don't have this plugin added to the panel you will not see any 
+tray icon, for example pidgin places an icon in the system tray as well as many other applications.
+</p><p>
+<strong class="application"><code>xfce4-power-manager</code></strong> uses GtkStatusIcon to display the different kinds of  batteries found in the system.
+</p><p>
+</p><div class="figure"><a name="id2527214"></a><p class="title"><b>Figure&#160;7.&#160;Battery Notification</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="images/battery-discharging.png" alt="Battery Notification"></div></div></div></div><p><br class="figure-break"></p><p>
+
+To notify the user about the status of the battery, serious errors occured, the notification daemon is used
+to display such messages.
+</p></div><p>&#160;</p><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="xfpm-faq"></a>FAQ</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">Q: Why the icons look very similar to the icon of gnome power manager</span></dt><dd><p>A: No, they are not similar, they are the same, just there is no point of re-drawing icons,
 	gnome power manager icons are good enough. not all of them are used.  
 	</p></dd><dt><span class="term">Q: What is the difference between suspend and hibernate</span></dt><dd><p>A: Suspend if a power save feature, when suspending, the computer is still using power,
 	since the running applications are kept in the memory, but is the lowest power level the computer

doc/C/xfce4-power-manager.xml

@@ -252,6 +252,43 @@ NOTE:In &app; version &appversion; only Linux is supported for changing the CPU
   
 <sect1 id="xfpm-systray-notify">
 <title>System Tray Icon and Notification</title>
+<para>
+<para><figure float="0">
+	<title>Battery icon in the system tray</title>
+	<screenshot><mediaobject>
+	<imageobject>
+	<imagedata fileref="images/battery.png" format="PNG"/>
+	</imageobject>
+	<textobject>
+	<phrase></phrase>
+	</textobject>
+	</mediaobject></screenshot>
+</figure></para>
+
+The "system tray" is an application running on a given X screen that can display small icons 
+provided by running applications. In Xfce it's a panel plugin that catch the icon and resize it
+to the size of the panel, if you don't have this plugin added to the panel you will not see any 
+tray icon, for example pidgin places an icon in the system tray as well as many other applications.
+</para>
+<para>
+&app; uses GtkStatusIcon to display the different kinds of  batteries found in the system.
+</para>
+<para>
+<para><figure float="0">
+	<title>Battery Notification</title>
+	<screenshot><mediaobject>
+	<imageobject>
+	<imagedata fileref="images/battery-discharging.png" format="PNG"/>
+	</imageobject>
+	<textobject>
+	<phrase></phrase>
+	</textobject>
+	</mediaobject></screenshot>
+</figure></para>
+
+To notify the user about the status of the battery, serious errors occured, the notification daemon is used
+to display such messages.
+</para>
 </sect1>
 
  <!-- extra space -->