doc/amor/index.docbook

   1 <?xml version="1.0" ?>
   2 <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
   3   <!ENTITY kappname "&amor;">
   4   <!ENTITY package "kdetoys">
   5   <!ENTITY % addindex "IGNORE">
   6   <!ENTITY % English "INCLUDE">
   7 ]>
   8
   9 <book lang="&language;">
  10 <bookinfo>
  11 <title>The &amor; Handbook</title>
  12
  13 <authorgroup>
  14 <author>
  15 &Karl.Garrison; &Karl.Garrison.mail;
  16 </author>
  17
  18 <!-- TRANS:ROLES_OF_TRANSLATORS -->
  19 </authorgroup>
  20
  21 <copyright>
  22 <year>2001</year>
  23 <holder>&Karl.Garrison;</holder>
  24 </copyright>
  25
  26 <legalnotice>&FDLNotice;</legalnotice>
  27
  28 <date>2003-09-16</date>
  29 <releaseinfo>2.2</releaseinfo>
  30
  31 <abstract>
  32 <para>
  33 &amor; is a small animation which sits on top of your active window.
  34 </para>
  35 </abstract>
  36
  37 <keywordset>
  38 <keyword>KDE</keyword>
  39 <keyword>kdetoys</keyword>
  40 <keyword>amor</keyword>
  41 <keyword>helper</keyword>
  42 <keyword>assistant</keyword>
  43 </keywordset>
  44
  45 </bookinfo>
  46
  47 <chapter id="introduction">
  48 <title>Introduction</title>
  49
  50 <sect1 id="whats-amor">
  51 <title>What's &amor;?</title>
  52 <para>
  53 &amor; is an acronym which stands for Amusing Misuse of Resources.  It is
  54 actually an animation which sits on top of your active window.  In its default
  55 configuration, &amor; takes the form of a yellow spot which performs many
  56 tricks.  &amor; also has many different themes which change the appearance
  57 and behavior of the animation.
  58 </para>
  59
  60 <note><para>Since &amor; works with the &kde; window manager &kwin;, the
  61 application will only work from within &kde;.  It is possible that &amor;
  62 would work from within another &kde;-compliant window manager, but none are
  63 known to work at the time of this writing.</para></note>
  64 </sect1>
  65 </chapter>
  66
  67 <chapter id="configuration">
  68 <title>Configuration</title>
  69 <sect1 id="configuring-amor">
  70 <title>Configuring &amor;</title>
  71 <para>To configure &amor;, click on the animation using your &RMB;.  A menu
  72 will appear containing three items:
  73 <guimenuitem>Options...</guimenuitem>,
  74 <guimenuitem>About...</guimenuitem>, and
  75 <guimenuitem>Quit</guimenuitem>.  Choose
  76 <guimenuitem>Options...</guimenuitem> to configure &amor;
  77 </para>
  78 </sect1>
  79
  80 <sect1 id="general-options">
  81 <title>General Options</title>
  82 <para>The following settings for &amor; can be changed from the Options
  83 dialog:</para>
  84 <variablelist>
  85 <varlistentry><term><guilabel>Theme</guilabel></term>
  86 <listitem><para>This determines the appearance and behavior of &amor;.
  87 Themes are described in the next section.</para></listitem>
  88 </varlistentry>
  89 <varlistentry><term><guilabel>Offset</guilabel></term>
  90 <listitem><para>This slider controls where the animation appears in
  91 relation to the top of the active window.  The default middle setting will
  92 place the animation right above the window title bar, whereas setting the
  93 slider all the way to the top or bottom will result in the animation
  94 appearing a fair distance above or below the title bar, respectively.</para>
  95 <tip><para>Setting this slider to a lower setting will allow the
  96 animation to be visible even when the active window is maximized.</para>
  97 </tip></listitem>
  98 </varlistentry>
  99 <varlistentry><term><guilabel>Always on top</guilabel></term>
 100 <listitem><para>Checking this option will cause the animation to always
 101 appear in front of any existing windows on the screen, including the
 102 panel.</para></listitem>
 103 </varlistentry>
 104 <varlistentry><term><guilabel>Show random tips</guilabel></term>
 105 <listitem><para>If checked, the animation will display various
 106 &kde;-related tips at random intervals.</para></listitem>
 107 </varlistentry>
 108 <varlistentry><term><guilabel>Allow application tips</guilabel></term>
 109 <listitem><para>Any &kde; application can be designed to display helpful
 110 tips via &amor;.  If this option is checked, and an appropriate
 111 application is the active window, the animation will display tips for that
 112 application.</para>
 113 <note><para>At the time of this writing, no &kde; applications make use of
 114 this functionality.</para></note></listitem>
 115 </varlistentry>
 116 </variablelist>
 117 </sect1>
 118
 119 <sect1 id="amor-themes">
 120 <title>&amor; Themes</title>
 121 <para>&amor; comes with many built-in themes, which change the appearance and
 122 behavior of the animation.  In addition, it is possible to create new
 123 &amor; themes.  The built-in themes for &amor; are described in the table
 124 below</para>
 125
 126 <table>
 127 <title>Available &amor; Themes</title>
 128 <tgroup cols="2">
 129 <thead>
 130 <row>
 131 <entry>Theme</entry>
 132 <entry>Description</entry>
 133 </row>
 134 </thead>
 135 <tbody>
 136
 137 <row>
 138 <entry><mediaobject>
 139 <imageobject>
 140 <imagedata format="PNG" fileref="spot.png"/>
 141 </imageobject>
 142 <textobject><para>Multi-talented Spot</para></textobject>
 143 <caption><para>Multi-talented Spot</para></caption>
 144 </mediaobject></entry>
 145 <entry><para>This is the default theme for &amor;, and also the one with
 146 the most <quote>tricks</quote>.  This theme was created by &Martin.R.Jones;.  The jet-pack, beaming, and fire animations were contributed by
 147 <personname><firstname>Mark</firstname><surname>Grant</surname></personname>.</para></entry>
 148 </row>
 149
 150 <row>
 151 <entry><mediaobject>
 152 <imageobject>
 153 <imagedata format="PNG" fileref="ghost.png"/>
 154 </imageobject>
 155 <textobject><para>Spooky Ghost</para></textobject>
 156 <caption><para>Spooky Ghost</para></caption>
 157 </mediaobject></entry>
 158 <entry><para>A ghost theme based-on the &kde;
 159 <application>ghostview</application> icon.  Spooky Ghost was created by
 160 &Martin.R.Jones;.</para></entry>
 161 </row>
 162
 163 <row>
 164 <entry><mediaobject>
 165 <imageobject>
 166 <imagedata format="PNG" fileref="eyes.png"/>
 167 </imageobject>
 168 <textobject><para>Crazy Eyes</para></textobject>
 169 <caption><para>Crazy Eyes</para></caption>
 170 </mediaobject></entry>
 171 <entry><para>This theme consists of a moving pair of eyes, and was created
 172 by <personname><firstname>Jean-Claude</firstname><surname>Dumas</surname></personname>.</para></entry>
 173 </row>
 174
 175 <row>
 176 <entry><mediaobject>
 177 <imageobject>
 178 <imagedata format="PNG" fileref="bonhomme.png"/>
 179 </imageobject>
 180 <textobject><para>Bonhomme</para></textobject>
 181 <caption><para>Bonhomme</para></caption>
 182 </mediaobject></entry>
 183 <entry><para>A stick-figure animation, created by <personname><firstname>Jean-Claude</firstname><surname>Dumas</surname></personname>.</para></entry>
 184 </row>
 185
 186 <row>
 187 <entry><mediaobject>
 188 <imageobject>
 189 <imagedata format="PNG" fileref="neko.png"/>
 190 </imageobject>
 191 <textobject><para>Neko</para></textobject>
 192 <caption><para>Neko</para></caption>
 193 </mediaobject></entry>
 194 <entry><para>Neko is a cat theme by <personname><firstname>Chris</firstname><surname>Spiegel</surname></personname>.  The graphics are
 195 originally from <application>Oneko</application>, which was written by
 196 <personname><firstname>Masayuki</firstname><surname>Koba</surname></personname>.</para>
 197 <note><para><application>Oneko</application> is a small application which
 198 features a cat chasing the mouse cursor.  The application appears to no
 199 longer be maintained, but the
 200 <ulink url="ftp://sunsite.unc.edu/pub/Linux/X11/demos/oneko-1.1b.tar.gz">
 201 source code</ulink> from the last version is still
 202 available.</para></note></entry>
 203 </row>
 204
 205 <row>
 206 <entry><mediaobject>
 207 <imageobject>
 208 <imagedata format="PNG" fileref="pingus.png"/>
 209 </imageobject>
 210 <textobject><para>Tux</para></textobject>
 211 <caption><para>Tux</para></caption>
 212 </mediaobject></entry>
 213 <entry><para>This theme features Tux, the &Linux; mascot.  The actual
 214 graphics come from a <application>Lemmings</application>-style game
 215 called <ulink url="http://pingus.seul.org/">
 216 <application>Pingus</application></ulink>.  The Tux theme was created by
 217 <personname><firstname>Frank</firstname><surname>Pieczynski</surname></personname>.</para></entry>
 218 </row>
 219
 220 <row>
 221 <entry><mediaobject>
 222 <imageobject>
 223 <imagedata format="PNG" fileref="worm.png"/>
 224 </imageobject>
 225 <textobject><para>Little Worm</para></textobject>
 226 <caption><para>Little Worm</para></caption>
 227 </mediaobject></entry>
 228 <entry><para>A small inchworm theme.  Created by <personname><firstname>Bartosz</firstname><surname>Trudnowski</surname></personname> for
 229 his wife.</para></entry>
 230 </row>
 231
 232 <row>
 233 <entry><mediaobject>
 234 <imageobject>
 235 <imagedata format="PNG" fileref="billy.png"/>
 236 </imageobject>
 237 <textobject><para>Little Billy</para></textobject>
 238 <caption><para>Little Billy</para></caption>
 239 </mediaobject></entry>
 240 <entry><para>A static image taken from the game
 241 <ulink url="http://www.xbill.org/"><application>XBill</application>
 242 </ulink>.</para></entry>
 243 </row>
 244
 245 <row>
 246 <entry><mediaobject>
 247 <imageobject>
 248 <imagedata format="PNG" fileref="bsd.png"/>
 249 </imageobject>
 250 <textobject><para>BSD Mascot</para></textobject>
 251 <caption><para>BSD Mascot</para></caption>
 252 </mediaobject></entry>
 253 <entry><para>A static image of Beastie, the FreeBSD daemon.</para></entry>
 254 </row>
 255
 256 <row>
 257 <entry><mediaobject>
 258 <imageobject>
 259 <imagedata format="PNG" fileref="tux.png"/>
 260 </imageobject>
 261 <textobject><para>Unanimated Tux</para></textobject>
 262 <caption><para>Unanimated Tux</para></caption>
 263 </mediaobject></entry>
 264 <entry><para>An unanimated version of the Tux theme.</para></entry>
 265 </row>
 266
 267 <row>
 268 <entry><mediaobject>
 269 <imageobject>
 270 <imagedata format="PNG" fileref="tao.png"/>
 271 </imageobject>
 272 <textobject><para>Tao</para></textobject>
 273 <caption><para>Tao</para></caption>
 274 </mediaobject></entry>
 275 <entry><para>The Tao theme is an animated Yin Yang symbol.  This theme was
 276 created by <personname><firstname>Daniel</firstname><surname>Pfeiffer</surname></personname> <email>occitan@esperanto.org</email>, and was
 277 inspired by his Tai Chi practice.</para></entry>
 278 </row>
 279
 280 </tbody>
 281 </tgroup>
 282 </table>
 283
 284 </sect1>
 285 </chapter>
 286
 287 <chapter id="credits">
 288 <title>Credits and License</title>
 289
 290 <para>&amor;</para>
 291
 292 <para>Program Copyright &copy; 1999-2001 &Martin.R.Jones;
 293 &Martin.R.Jones.mail;</para>
 294
 295 <para>Documentation Copyright &copy; 2001 &Karl.Garrison;
 296 &Karl.Garrison.mail;</para>
 297
 298 <!-- TRANS:CREDIT_FOR_TRANSLATORS -->
 299 &underFDL;
 300 &underGPL;
 301 </chapter>
 302
 303 &documentation.index;
 304
 305 </book>
 306
 307 <!--
 308 Local Variables:
 309 mode: sgml
 310 sgml-minimize-attributes:nil
 311 sgml-general-insert-case:lower
 312 sgml-indent-step:0
 313 sgml-indent-data:nil
 314 End:
 315
 316 // vim:ts=0:sw=2:tw=78:noet
 317 -->