diff options
Diffstat (limited to 'gnome-users-guide/gnome-users-guide-1.4/C/applets/odometer-ug.sgml')
| -rw-r--r-- | gnome-users-guide/gnome-users-guide-1.4/C/applets/odometer-ug.sgml | 308 |
1 files changed, 308 insertions, 0 deletions
diff --git a/gnome-users-guide/gnome-users-guide-1.4/C/applets/odometer-ug.sgml b/gnome-users-guide/gnome-users-guide-1.4/C/applets/odometer-ug.sgml new file mode 100644 index 0000000..1f84c4c --- /dev/null +++ b/gnome-users-guide/gnome-users-guide-1.4/C/applets/odometer-ug.sgml @@ -0,0 +1,308 @@ +<sect2 id="odometer"> + <title>Odometer Applet</title> + + <para> + The GNOME panel <application>Odometer</application> applet, shown in <xref + linkend="odometer-applet-fig"> is an applet which tracks and measures the + movements of your mouse pointer across the desktop. It is part of the + gnome-applets package. To add this + applet to a <interface>Panel</interface>, + right-click on the <interface>Panel</interface> and choose + <menuchoice> + <guimenu>Panel</guimenu> + <guisubmenu>Add to panel</guisubmenu> + <guisubmenu>Applet</guisubmenu> + <guisubmenu>Amusements</guisubmenu> + <guimenuitem>Odometer</guimenuitem> + </menuchoice>. + </para> + + <figure id="odometer-applet-fig"> + <title>Odometer Applet</title> + <screenshot> + <screeninfo>Odometer Applet</screeninfo> + <graphic format="png" fileref="figures/odometer_applet" + srccredit="acscherp"> + </graphic> + </screenshot> + </figure> + + <!-- ============= Usage ================================ --> + <sect3 id="odometer-usage"> + <title>Usage</title> + <para> + Once it is present, you don't need to do anything to the odometer. + It just sits quietly in your panel and keeps track of all your mouse movements. + In addition, moving the mouse pointer over the odometer produces + a <guilabel>tooltip</guilabel> telling you whether the distance + is expressed in metric units (centimeters, meters, kilometers) + of in feet (inches, feet, miles). + The upper value indicates your total trip distance, + and the lower value is the partial trip distance, that + can be resetted at will. + </para> + + <para> + Right-clicking on the applet brings up a menu containing the + following items: + <itemizedlist> + + <listitem> + <para> + <guimenuitem>Reset</guimenuitem> — + This resets the odometer applet to zero again. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>Properties…</guimenuitem> — + opens the <link linkend="odometer-prefs"> + <guilabel>Properties</guilabel></link> dialog. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>Help</guimenuitem> — + displays this document. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>About…</guimenuitem> — + shows basic information about <application>odometer + Applet</application>, including the applet's version and the + author's name. + </para> + </listitem> + + </itemizedlist> + </para> + </sect3> + + + <!-- ============= Customization ============================= --> + <sect3 id="odometer-prefs"> + <title>Customization</title> + <para> + You can customize <application>odometer</application> + applet by right-clicking on it and choosing + <guimenuitem>Properties…</guimenuitem>. This will open the + <interface>Properties</interface> dialog(shown in <xref + linkend="odometer-settings-fig">), which allows you to + change various settings. + </para> + + <para> + The <interface>properties dialog box</interface> (which calls + itself "Odometer setting" rather than properties) is divided into + two sections, one for general options, and one for themes. + + <variablelist> + <varlistentry> + <term>General</term> + <listitem> + + <figure id="odometer-settings-fig"> + <title>Properties dialog (general preferences tab)</title> + <screenshot> + <screeninfo>General preferences tab</screeninfo> + <graphic format="png" fileref="figures/odometer_settings" + srccredit="accscherp"> + </graphic> + </screenshot> + </figure> + + <para> + The <guilabel>general preferences tab</guilabel>, shown in <xref + linkend="odometer-settings-fig">, has four options: + </para> + <variablelist> + <varlistentry> + <term>Use metric</term> + <listitem> + <para> + If the <guibutton>use metric checkbox</guibutton> is checked, + mouse pointer distance travelled is shown in meters + (centimeters, meters, and kilometers) . If it + is not checked, the distance travelled is shown in feet + (inches, feet and miles). By + moving the pointer over the odometer you can produce a + <guilabel>tooltip</guilabel> which shows you whether it is + currently displaying meters or feet. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>auto_reset</term> + <listitem> + <para> + If the <guibutton>auto_reset checkbox</guibutton> is checked, + the odometer numbers return to zero each time it's + started or each time the session is started. This allows + you to display your daily mouse trip distance if you + used to restart you gnome session every morning. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>enabled</term> + <listitem> + <para> + If the <guibutton>enabled checkbox</guibutton> is checked, then + the odometer will keep counting how far you have moved your + pointer. If not, it will return the numbers to zero until you + re-enable it. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>digits number</term> + <listitem> + <para> + The <guibutton>digits number field</guibutton> determines how + many digits the odometer will display. The default is four, and + the range is from 1 to 10. + </para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + + <varlistentry> + <term>Theme</term> + <listitem> + + <figure id="odometer-themes-fig"> + <title>Properties dialog (theme preferences tab)</title> + <screenshot> + <screeninfo>Theme preferences tab</screeninfo> + <graphic format="png" fileref="figures/odometer_themes" + srccredit="accscherp"> + </graphic> + </screenshot> + </figure> + + <para> + The <guilabel>theme preferences tab</guilabel>, shown in <xref + linkend="odometer-themes-fig">, has a variety of + themes you can choose from. They are found by default in + <filename>$PREFIX/odometer/</filename>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + + <para> + After you have made all the changes you want, click on + <guibutton>OK</guibutton> to apply the changes and close the + <interface>Properties</interface> dialog. To cancel the changes + and return to previous values, click the + <guibutton>Close</guibutton> button. + </para> + </sect3> + + + <!-- ============= Bugs ================================== --> + <!-- This section should describe known bugs and limitations of + the program if there are any - please be frank and list all + problems you know of --> + <sect3 id="odometer-bugs"> + <title>Known Bugs and Limitations</title> + <para> + This applet has no known bugs. + </para> + </sect3> + + + <!-- ============= Authors ================================ --> + + <sect3 id="odometer-authors"> + <title>Authors</title> + <para> + The <application>odometer applet</application> was written by + Fabrice Bellet (<email>Fabrice.Bellet@creatis.insa-lyon.fr</email>), + and based on the <application>Mouspedometa</application> for KDE by + Armen Nakashian, which in turn was based on the + Motif-based <application>Xodometer</application> by Mark H. Granoff. + Please send all comments, + suggestions, and bug + reports to the <ulink url="http://bugs.gnome.org" type="http">GNOME + bug tracking database</ulink>. (Instructions for submitting bug + reports can be found <ulink + url="http://bugs.gnome.org/Reporting.html" type="http"> + on-line</ulink>.) If you are using + GNOME 1.1 or later, you can also use <application>Bug Report + Tool</application> (<command>bug-buddy</command>), available in the + <guisubmenu>Utilities</guisubmenu> submenu of <guimenu>Main + Menu</guimenu>, for submitting bug reports. + </para> + + <para> + This manual was written by Arjan Scherpenisse + (<email>acscherp@wins.uva.nl</email>). Please send all comments and + suggestions regarding this manual to the <ulink type="http" + url="http://www.gnome.org/gdp">GNOME Documentation Project</ulink> + by sending an email to <email>docs@gnome.org</email>. You can also + submit comments online by using the <ulink type="http" + url="http://www.gnome.org/gdp/doctable/">GNOME Documentation Status + Table</ulink>. + </para> + + <!-- For translations: uncomment this: + + <para> + Latin translation was done by ME + (<email>MYNAME@MYADDRESS</email>). Please send all comments and + suggestions regarding this translation to SOMEWHERE. + </para> + + --> + + </sect3> + + + <!-- ============= Application License ============================= --> + + <!-- + <sect3 id="license"> + <title>License</title> + <para> + This program is free software; you can redistribute it and/or + modify it under the terms of the <citetitle>GNU General Public + License</citetitle> as published by the Free Software Foundation; + either version 2 of the License, or (at your option) any later + version. + </para> + <para> + This program is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + <citetitle>GNU General Public License</citetitle> for more details. + </para> + <para> + A copy of the <citetitle>GNU General Public License</citetitle> is + included as an appendix to the <citetitle>GNOME Users + Guide</citetitle>. You may also obtain a copy of the + <citetitle>GNU General Public License</citetitle> from the Free + Software Foundation by visiting <ulink type="http" + url="http://www.fsf.org">their Web site</ulink> or by writing to + <address> + Free Software Foundation, Inc. + <street>59 Temple Place</street> - Suite 330 + <city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode> + <country>USA</country> + </address> + </para> + </sect3> + +--> + </sect2> + + + + |