index.docbook 28.6 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
  <!ENTITY kappname "&plasma;">
  <!ENTITY package "kde-module">
  <!ENTITY % addindex "IGNORE">
  <!ENTITY % English "INCLUDE">
]>
<book id="plasma-desktop" lang="&language;">

<bookinfo>
<title>The &plasma; Handbook</title>

<authorgroup>
<author>
<personname>
<firstname>Sebastian</firstname>
<surname>Kügler</surname>
</personname>
<email>sebas@kde.org</email>
</author>
<author><firstname>Claus</firstname> <surname>Christensen</surname></author>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>

<copyright>
<year>2008&ndash;2010</year>
<holder>Sebastian Kügler</holder>
</copyright>

<legalnotice>&FDLNotice;</legalnotice>

Burkhard Lück's avatar
Burkhard Lück committed
32 33
<date>2016-08-21</date>
<releaseinfo>Plasma 5.7</releaseinfo>
34 35 36

<abstract>
<para>
Burkhard Lück's avatar
Burkhard Lück committed
37
&plasma; is the core user interface to the desktop.
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
</para>
</abstract>

<keywordset>
<keyword>KDE</keyword>
<keyword>Plasma</keyword>
<keyword>Plasmoid</keyword>
<keyword>Widget</keyword>
<keyword>Containments</keyword>
<keyword>Desktop</keyword>
<keyword>Runner</keyword>
<keyword>Kicker</keyword>
</keywordset>

</bookinfo>

<chapter id="introduction">
<title>Introduction</title>

Burkhard Lück's avatar
Burkhard Lück committed
57 58 59
<para><!--https://www.kde.org/workspaces/-->
&plasma; provides a modern and customizable environment for running your favorite applications 
and accessing your information wherever it may be. Other common attributes of the &plasma; Desktop 
60
include advanced window management and desktop effects, support for &kde; &plasma; Widgets,
Burkhard Lück's avatar
Burkhard Lück committed
61
integrated search, hardware management and a high degree of customizability.
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
</para>

</chapter>

<chapter id="using-kapp">
<title>Using &plasma;</title>

<sect1 id="plasma-components">
<title>&plasma; Components</title>

<sect2 id="plasmoids-and-containments">
<title>&plasma; Widgets and Containments</title>

<para>
The essence of &plasma; revolves around two basic concepts:
</para>

<variablelist>
<varlistentry>
<term>&plasma; Widgets</term>
<listitem>
<para>
Applets, or small applications that live on the desktop.
</para>
</listitem>
</varlistentry>
<varlistentry>
Burkhard Lück's avatar
Burkhard Lück committed
89
<term>Containments</term><!--FIXME remove it, just a technical term with no meaning for joe user?-->
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
<listitem>
<para>
Applets that act as the container for the &plasma; widgets
</para>
</listitem>
</varlistentry>
</variablelist>

<para>
On a default desktop, there are two main elements: the Panel and the Desktop
itself. Both are containments in the &plasma; sense.
</para>

</sect2>

<sect2 id="default-plasma-desktop">
<title>Default &plasma; Desktop</title>

<para><note><para>The &plasma; Desktop can be configured in countless ways. The screenshot seen below shows a fairly standard desktop. Some distributions apply extensive customizations, so your desktop may look different.
</para>
Burkhard Lück's avatar
Burkhard Lück committed
110
<para>Similarly, the graphical appearance of the interface elements can be styled. These screenshots uses the &plasma; default style, Breeze.</para></note>
111 112 113 114 115 116 117
</para>
<para>
<screenshot>
<screeninfo>A fairly standard &plasma; Desktop</screeninfo>
  <mediaobjectco>
    <imageobjectco>
      <areaspec units="other" otherunits="imagemap">
Burkhard Lück's avatar
Burkhard Lück committed
118 119
        <area id="im1" linkends="panel-launcher" coords="0,519,31,551"/> <!-- #1 kickoff launcher #-->
        <area id="im2" linkends="panel-launcher" coords="0,735,30,598"/><!-- #1 kickoff launcher icon -->
120 121 122 123 124 125 126 127 128 129
        <!--area linkends="FIXME" coords="37,483,69,516"/--><!-- #2 panel icons # -->
        <!--area linkends="FIXME" coords="23,558,83,597"/--><!-- #2 panel icons red box -->
        <!--area linkends="FIXME" coords="97,666,137,707"/--><!-- #3 pager # -->
        <!--area linkends="FIXME" coords="76,519,107,551"/--><!-- #3 pager plasmoid -->
        <area id="im3" linkends="panel-taskbar" coords="288,519,320,551"/><!-- #4 task manager # -->
        <area id="im4" linkends="panel-taskbar" coords="102,558,615,598"/><!-- #4 task manager red box -->
        <area id="im5" linkends="panel-system-tray" coords="652,519,683,551"/><!-- #5 system tray # -->
        <area id="im6" linkends="panel-system-tray" coords="618,557,728,598"/><!-- #5 system tray red box -->
        <area id="im7" linkends="panel-digital-clock" coords="739,534,772,566"/><!-- #6 clock # -->
        <area id="im8" linkends="panel-digital-clock" coords="729,573,781,598"/><!-- #6 clock plasmoid -->
Burkhard Lück's avatar
Burkhard Lück committed
130 131
        <area id="im9" linkends="panel-toolbox" coords="750,477,782,508"/><!-- #7 panel cashew # -->
        <area id="im10" linkends="panel-toolbox" coords="783,573,800,598"/><!-- #7 panel cashew icon --> 
132 133 134 135
        <!--area linkends="FIXME" coords="733,11,765,44"/--><!-- #8 desktop cashew # -->
        <!--area linkends="FIXME" coords="772,0,800,25"/--><!-- #8 desktop cashew icon -->
        <!--area linkends="FIXME" coords="374,88,406,119"/--><!-- #9 folder view # -->
        <!--area linkends="FIXME" coords="10,18,361,204"/--><!-- #9 folder view plasmoid -->
Burkhard Lück's avatar
Burkhard Lück committed
136
       <area id = "im11" linkends="panel-launcher" coords="0,665,40,707"/> <!-- #1 kickoff launcher #-->
137 138 139 140 141 142 143 144 145
      </areaspec>
    <imageobject>
      <imagedata fileref="plasma-desktop-annotated.png" format="PNG"/>
    </imageobject>
    </imageobjectco>
  </mediaobjectco>
</screenshot>
</para>
<orderedlist>
Burkhard Lück's avatar
Burkhard Lück committed
146
<listitem><para>The program starter. Usually this will be <link linkend="panel-launcher">Application Launcher</link>.</para></listitem>
147
<listitem><para>A couple of icons giving easy access to often used applications</para></listitem>
Burkhard Lück's avatar
Burkhard Lück committed
148
<!--listitem><para>The Pager widget</para></listitem-->
149 150 151
<listitem><para>The <link linkend="panel-taskbar">Task Manager</link>, which shows the titles of windows belonging to the applications currently running. No application had opened a window, when the screenshot was taken</para></listitem>
<listitem><para>The <link linkend="panel-system-tray">System Tray</link></para></listitem>
<listitem><para>The <link linkend="panel-digital-clock">Digital Clock</link> widget</para></listitem>
Burkhard Lück's avatar
Burkhard Lück committed
152 153
<listitem><para>The <link linkend="panel-toolbox">Panel Toolbox</link></para></listitem>
<listitem><para>The <link linkend="desktop">Desktop</link> Toolbox</para></listitem>
154 155 156 157 158 159 160 161 162
<listitem><para>A Folder View widget, showing the content of the Desktop folder</para></listitem>
</orderedlist>

</sect2>
</sect1>

<sect1 id="panel">
<title>The Panel</title>

Burkhard Lück's avatar
Burkhard Lück committed
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
<para>The default panel holds a few &plasma; widgets: starting from the left, there is the
application launcher.</para>

<sect2 id="panel-launcher">
<title>Application Launcher</title>

<screenshot>
<screeninfo>Application launcher</screeninfo>
  <mediaobject>
    <imageobject>
      <imagedata fileref="application-launcher.png" format="PNG"/>
    </imageobject>
      <textobject>
      <phrase>Application launcher</phrase>
    </textobject>
  </mediaobject>
</screenshot>
<para>You can use it to start applications, open recently
181 182 183 184 185 186 187 188 189 190 191
opened files and the usual logout/shutdown options. There is also a structure
that allows you to browse through your applications. The layout has been
optimized for the use case that is most common: starting an application. The
default tab is the <guilabel>Favorites</guilabel> tab that holds the most-used
entries. In the beginning, you'll probably find yourself using the
<guilabel>Applications</guilabel> tab more often.
Once you have found out what your most frequently started applications are,
<mousebutton>right</mousebutton> click on the items and select the
<guimenuitem>Add to Favorites</guimenuitem> to add them to your
<guilabel>Favorites</guilabel> (or directly into the panel or on the desktop.
Note that you need to <quote>unlock</quote> &plasma; by means of <mousebutton>right</mousebutton>
Burkhard Lück's avatar
Burkhard Lück committed
192 193 194 195 196 197 198
clicking on the desktop for any kind of modification).</para>
</sect2>

<sect2 id="panel-menu">
<title>Application Menu</title>

<para>If you prefer the
199 200
traditional menu-style application launcher, change it by
<mousebutton>right</mousebutton> clicking on the menu button and selecting
Burkhard Lück's avatar
Burkhard Lück committed
201
<guimenuitem>Alternatives</guimenuitem>.
202
</para>
Burkhard Lück's avatar
Burkhard Lück committed
203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237
<screenshot>
<screeninfo>Application menu</screeninfo>
  <mediaobject>
    <imageobject>
      <imagedata fileref="application-menu.png" format="PNG"/>
    </imageobject>
      <textobject>
      <phrase>Application menu</phrase>
    </textobject>
  </mediaobject>
</screenshot>
</sect2>

<sect2 id="panel-launcher-settings">
<title>Application Launcher Settings</title>

<para>If you want to configure the application launcher, change it by
<mousebutton>right</mousebutton> clicking on the menu button and selecting
<guimenuitem>Application Launcher Settings</guimenuitem>.
</para>
<screenshot>
<screeninfo>Application launcher settings</screeninfo>
  <mediaobject>
    <imageobject>
      <imagedata fileref="application-launcher-settings.png" format="PNG"/>
    </imageobject>
      <textobject>
      <phrase>Application launcher settings</phrase>
    </textobject>
  </mediaobject>
</screenshot>
</sect2>

<sect2 id="panel-taskbar">
<title>Taskbar</title>
238

Burkhard Lück's avatar
Burkhard Lück committed
239
<para>
240 241 242 243 244 245
The taskbar is another widget on the panel. It shows an area for all open windows on
all desktops by default. You can make it show all open windows on the current
desktop only by checking <guimenuitem>Only show tasks from the
current desktop</guimenuitem> when you right click on the task manager, between
two windows. The size of the text on the taskbar items can be set
in &systemsettings; under the
Burkhard Lück's avatar
Burkhard Lück committed
246 247
<menuchoice><guimenu>Appearance</guimenu><guisubmenu>Fonts</guisubmenu>
</menuchoice>. Right-clicking on the taskbar
248 249 250 251 252 253 254 255 256 257 258 259 260 261
brings the Settings dialog where you can choose several options to customize
your taskbar.
<screenshot>
<screeninfo>Here is a screenshot of the taskbar settings dialog</screeninfo>
  <mediaobject>
    <imageobject>
      <imagedata fileref="taskbar-settings.png" format="PNG"/>
    </imageobject>
      <textobject>
      <phrase>Taskbar settings dialog</phrase>
    </textobject>
  </mediaobject>
</screenshot>
</para>
Burkhard Lück's avatar
Burkhard Lück committed
262 263 264 265
</sect2>

<sect2 id="panel-system-tray">
<title>System Tray</title>
266

Burkhard Lück's avatar
Burkhard Lück committed
267
<para>
268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
Another default panel item is the <application>System Tray</application>, which
is used by traditional applications and widgets as a dock. Right clicking on the
<application>System Tray</application> allows you to open the settings dialog,
where you can set entries to display and their visibility.
</para>
<screenshot>
<screeninfo>System Tray settings dialog</screeninfo>
  <mediaobject>
    <imageobject>
      <imagedata fileref="system-tray-settings.png" format="PNG"/>
    </imageobject>
      <textobject>
      <phrase>System Tray settings dialog</phrase>
    </textobject>
  </mediaobject>
</screenshot>
Burkhard Lück's avatar
Burkhard Lück committed
284 285 286 287 288 289
</sect2>

<sect2 id="device-notifier">
<title>Device Notifier</title>

<para>
290
An icon located usually in the system tray is the <application>Device Notifier</application>.
291
Plug in a &USB; disk and a dialog will open that allows you to
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306
open the device in &dolphin; or another associated application.
</para>
<para>
<screenshot>
<screeninfo></screeninfo>
  <mediaobject>
    <imageobject>
      <imagedata fileref="device_notifier_widget.png" format="PNG"/>
    </imageobject>
    <textobject>
      <phrase></phrase>
    </textobject>
  </mediaobject>
</screenshot>
</para>
307
<para>The <application>Device Notifier</application> is used for handling pluggable devices such as &USB; pendrives (also called flash drives or thumb drives), digital cameras, external &USB; hard drives, &etc; It also comes into play when a medium such as a &CD; or DVD is loaded into an optical drive.
308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329
</para>
<para>When you plug in an external device, or load a new medium into a drive, the <guilabel>Notifier</guilabel> window pops up (you can also open it explicitly by clicking on its Panel icon.) It stays open while the cursor is over it, otherwise it hides itself after a few seconds.
</para>
<para>The <guilabel>Notifier</guilabel> window shows a list of all the devices it currently knows about. Moving the mouse cursor over a device will highlight how many possible actions are associated with that device.
</para>
<para>
<screenshot>
<screeninfo></screeninfo>
  <mediaobject>
    <imageobject>
      <imagedata fileref="device_notifier_widget_actions.png" format="PNG"/>
    </imageobject>
    <textobject>
      <phrase></phrase>
    </textobject>
  </mediaobject>
</screenshot>
</para>
<para>Clicking anywhere in the shaded box around the device name (but not on the eject/unmount icon if present) expands the entry to show the list of possible actions for that device.  The set of actions depends on the device; it is configurable from the <application>Device Notifier</application>'s context menu or from the &systemsettings; modules <ulink url="help:/kcontrol/solid-actions/index.html">Device Actions</ulink> and <ulink url="help:/kcontrol/solid-device-automounter/index.html">Removable Devices</ulink>. Simply select one with the mouse or keyboard to launch that action.
</para>
<para>There is also a small icon to the right of each entry showing whether that device is currently accessible (or <emphasis>mounted</emphasis>) or not. Only when a device is not mounted is it safe to physically disconnect it from the computer. Clicking on the icon causes the device to be unmounted and/or the medium to be ejected if it is currently mounted, and will mount it if it is not. Note that unmounting/ejecting might fail if the device still has open files on it, &eg; if a large file copy hasn't finished. In most cases you can just wait a while and try again. When an unmounting has succeeded, a success icon will be shown on the <application>Device Notifier</application>'s icon.
</para>
Burkhard Lück's avatar
Burkhard Lück committed
330 331 332 333
</sect2>

<sect2 id="panel-hidden">
<title>Hidden Items</title>
334 335 336 337 338 339 340 341 342

<para>The <application>System Tray</application> normally holds some more entries like
&klipper;, &kmix; &etc;</para>

<para>Some of the default entries in the <application>System Tray</application> are hidden
to save space in the bar. To display these entries click on the small white triangle
<inlinemediaobject><imageobject><imagedata fileref="system-tray-up-arrow.png" format="PNG"/>
</imageobject></inlinemediaobject>, then use
the &LMB; to launch a widget or the &RMB; to open its settings dialog.</para>
Burkhard Lück's avatar
Burkhard Lück committed
343 344 345 346
</sect2>

<sect2 id="panel-digital-clock">
<title>Digital Clock</title>
347

Burkhard Lück's avatar
Burkhard Lück committed
348
<para>
349 350 351 352 353 354 355 356 357 358 359 360
The right-most &plasma; widget in the default panel holds the <application>Digital
Clock</application>.
This clock can display the time in different timezones as well as have its size
changed. The clock will adjust its font size to the area it is given by the
surrounding containment (that is the panel in this case). If you choose to
display the date, this date will be rendered using the <guimenuitem>Small
font</guimenuitem> option from the &systemsettings; <guilabel>Font</guilabel>
dialog. The time will take the rest of the space. So in the end, you'll choose
yourself the amount of information displayed, and if that fits. If you want to
display more information, make the panel larger or put the clock on the desktop
where it can grow freely.
</para>
Burkhard Lück's avatar
Burkhard Lück committed
361 362 363 364
</sect2>

<sect2 id="panel-pager">
<title>Pager</title>
365 366 367 368 369 370 371 372 373 374 375 376 377

<para>
An optional item on your panel is the <application>Pager</application>.
It allows you to switch between your virtual desktops.
If you change the layout of the <application>Pager</application>
through the <guimenuitem>Number of rows</guimenuitem> option,
which will also affect the layout and animations that are shown in &kwin;’s
<guimenuitem>Desktop Grid</guimenuitem> effect.<!-- &ndash; (Switch on desktop effect,
press <keycombo action="simul">&Ctrl;<keycap>F8</keycap></keycombo> to see it.)
don't see that in 4.7-->
For larger pagers, selecting <guimenuitem>Display windows icons</guimenuitem>
typically makes sense.
</para>
Burkhard Lück's avatar
Burkhard Lück committed
378
</sect2>
379 380 381 382 383 384 385
<!-- other items in a kde compiled from sources -->
<!-- Activity Manager -->
<!-- Notifications -->
<!-- Show the Desktop -->

</sect1>

Burkhard Lück's avatar
Burkhard Lück committed
386 387
<sect1 id="panel-toolbox">
<title>The Panel Toolbox</title>
388 389 390 391 392

<para>If your desktop is unlocked (you can do that by
<mousebutton>right</mousebutton> clicking on the desktop, or when no
application has the focus, with <keycombo
action="simul">&Alt;<keycap>D</keycap></keycombo>, <keycap>L</keycap>), a small &plasma;
Burkhard Lück's avatar
Burkhard Lück committed
393 394
logo will appear in the bottom right corner in the panel.
Click on this toolbox, and the panel controller opens.</para>
395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465

<screenshot>
<screeninfo>Panel Settings</screeninfo>
  <mediaobject>
    <imageobject>
      <imagedata fileref="panel-settings.png" format="PNG"/>
    </imageobject>
      <textobject>
      <phrase>Panel Settings</phrase>
    </textobject>
  </mediaobject>
</screenshot>

<para>The panel controller allows you to reposition, resize and realign the panel. The
&plasma; widgets living in this panel will adjust their size automatically.
&plasma; widgets have basic knowledge about sizing, provided by the containment. They
are programmed to take advantage of that size, and inform the applet about how
much space they possibly need. In the end, the containment gives a possible size
to the applets, the applets obey.</para>

</sect1>

<sect1 id="add-applets">
<title>Adding Applets</title>

<para>
Unlock the desktop and you'll be able to add and remove &plasma; widgets from panel
or desktop. You add &plasma; widgets by simply dragging them where you want them.
<mousebutton>Right</mousebutton> click on an widget to remove it.

<screenshot>
<screeninfo>Add Widgets</screeninfo>
  <mediaobject>
    <imageobject>
      <imagedata fileref="add-widgets.png" format="PNG"/>
    </imageobject>
      <textobject>
      <phrase>Add Widgets</phrase>
    </textobject>
  </mediaobject>
</screenshot>

The <guibutton>Get New Widgets</guibutton> button allows you to add widgets
you've previously downloaded and download new &plasma; widgets.
Currently it supports native &plasmagik; packages
and some &Mac; OS&nbsp;X dashboard widgets. Widgets you install this way can then be
accessed just like regular, preinstalled widgets.
</para>
</sect1>

<sect1 id="desktop">
<title>The Desktop</title>

<para>
The desktop is in fact another containment. One that does not put size
constraints on the applets. Applets can be moved and sized freely. On the
unlocked desktop, &plasma; widgets will show a frame when you move the mouse over
them. This applet handle allows you to move, resize, relocate and realign the
panel. It also allows you to drag &plasma; widgets on the desktop. The buttons in the
corner are used to resize, rotate configure and remove the applet. When
rotated, a &plasma; widget will act magnetic towards 12 o'clock, so it is easy to get
them back into sensible position. By default, most applets keep their aspect
ratio when they are being resized. If you want to freely resize an applet,
hold the &Ctrl; key pressed while resizing.
</para>

<para>
Right clicking on the desktop also offers you to configure aspects such as the
wallpaper and the layout used, and the mouse actions. It offers to download new
wallpapers through &knewstuff;.
</para>
Burkhard Lück's avatar
Burkhard Lück committed
466 467 468
<para>On the <guilabel>Tweaks</guilabel> page you can configure to hide the desktop Toolbox
and adjust the widget handling.
</para>
469 470 471 472 473 474 475 476 477 478 479 480 481 482

<screenshot>
<screeninfo>Desktop Settings</screeninfo>
  <mediaobject>
    <imageobject>
      <imagedata fileref="desktop-settings.png" format="PNG"/>
    </imageobject>
      <textobject>
      <phrase>Desktop Settings</phrase>
    </textobject>
  </mediaobject>
</screenshot>

<para>To change the &plasma; theme or download a new one through &knewstuff;
Burkhard Lück's avatar
Burkhard Lück committed
483
open the <menuchoice><guimenu>Appearance</guimenu> <guimenuitem>Desktop
484 485 486 487 488 489 490 491 492 493 494
Theme</guimenuitem></menuchoice> page in the &systemsettings;.</para>

<para>
With open applications, it quickly gets hard to see the &plasma; widgets on your
desktop. The <emphasis role="bold">Dashboard</emphasis> gets those &plasma; widgets
in front of you, much like the <guilabel>Show desktop</guilabel> functionality
you are used to from traditional desktops.
</para>

</sect1>

Burkhard Lück's avatar
Burkhard Lück committed
495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523
<sect1 id="folder-view">
<title>Folder View</title>
<para>The <guilabel>Folder View</guilabel> widget is used to display entries like folders or
files from a folder, by default from <filename class="directory">$<envar>HOME</envar>/Desktop</filename>.
</para>
<para>You can choose to view either all files, or filter either by specific regular expressions
(&eg;, all files with a certain extension) or by file type (&eg; just images).
</para>
<para>This widget also supports basic file management properties (moving, copying, cutting
and pasting for example), and you can have as many as you want on your desktop.
</para>

<screenshot>
<screeninfo>Folder View</screeninfo>
  <mediaobject>
    <imageobject>
      <imagedata fileref="folder-view.png" format="PNG"/>
    </imageobject>
      <textobject>
      <phrase>Folder View</phrase>
    </textobject>
  </mediaobject>
</screenshot>

<para>If you select the layout <guilabel>Folder View</guilabel> in the <guilabel>Desktop Settings</guilabel>
you can use one Folder View as the whole desktop, effectively replicating the "old style" desktop paradigm.
</para>
</sect1>

524 525 526 527 528
<sect1 id="krunner">
<title>&krunner;</title>
<para>
&krunner; is a versatile mini command-line. You can use it to start applications,
open web pages, access bookmarks, search through your desktop data, calculate
Burkhard Lück's avatar
Burkhard Lück committed
529
short equations, and many more. Pressing <keycombo
530
action="simul">&Alt;&Space;</keycombo> or <keycombo
Burkhard Lück's avatar
Burkhard Lück committed
531
action="simul">&Alt;<keysym>F2</keysym></keycombo> opens the &krunner; dialog.
532 533 534 535 536 537
You just start typing and &krunner; will start searching matches as soon as
you've entered more than two characters. You can open the settings dialog to
learn about &krunner;’s functionality, provided by plugins. You can
navigate through the matches using the tab and arrow keys.
</para>
<!-- whitout tab no arrow keys-->
Burkhard Lück's avatar
Burkhard Lück committed
538 539 540 541 542 543 544 545 546 547 548 549
<screenshot>
<screeninfo>&krunner; dialog</screeninfo>
  <mediaobject>
    <imageobject>
      <imagedata fileref="krunner.png" format="PNG"/>
    </imageobject>
      <textobject>
      <phrase>&krunner; dialog</phrase>
    </textobject>
  </mediaobject>
</screenshot>

Yuri Chornoivan's avatar
Yuri Chornoivan committed
550
<para>Use the <inlinemediaobject><imageobject><imagedata fileref="krunner-configure.png" format="PNG"/>
Nate Graham's avatar
Nate Graham committed
551
</imageobject></inlinemediaobject> button to open the <guilabel>KRunner</guilabel> &systemsettings;
552
module and configure where and what to search for in &krunner;.
Burkhard Lück's avatar
Burkhard Lück committed
553 554
</para>

Yuri Chornoivan's avatar
Yuri Chornoivan committed
555
<para>&krunner; supports <quote>Desktop Actions</quote> which are additional actions an application can
Burkhard Lück's avatar
Burkhard Lück committed
556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573
offer to perform common actions or jump directly to a certain task from Task Manager.
Common examples are <guilabel>Open New Incognito Window</guilabel> to open your browser directly in private mode,
<guilabel>Compose Email</guilabel> without launching the full-fledged email client first or the actions
provided by &spectacle;:
</para>

<screenshot>
<screeninfo>&krunner; Desktop Actions</screeninfo>
  <mediaobject>
    <imageobject>
      <imagedata fileref="krunner-desktop-actions.png" format="PNG"/>
    </imageobject>
      <textobject>
      <phrase>&krunner; Desktop Actions</phrase>
    </textobject>
  </mediaobject>
</screenshot>

574
<para>If you press the &Down; key in an empty &krunner; a history of the recent entities
Burkhard Lück's avatar
Burkhard Lück committed
575 576 577 578 579 580 581 582
is shown. After invoking a search result, its query will move to the top, so repeatedly used
commands never fall out of the list.
</para>
<para>Remove single entries from the list using the <inlinemediaobject><imageobject><imagedata fileref="remove.png" format="PNG"/>
</imageobject></inlinemediaobject> button or clear the complete history in the
&krunner; settings.
</para>

583
<para>
Burkhard Lück's avatar
Burkhard Lück committed
584 585
If you want to know what is going on on your system, pressing <keycombo
action="simul">&Ctrl;&Esc;</keycombo> gives you quick access to a list of windows
586 587 588 589
and processes, with options to monitor their output and kill processes.
</para>
</sect1>

Burkhard Lück's avatar
Burkhard Lück committed
590
<sect1 id="activities-interface">
591 592 593
<title>Activities</title>

<para>
Burkhard Lück's avatar
Burkhard Lück committed
594
The desktop toolbox, accessed via the upper left corner has a button for
595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649
displaying your activities, of which &plasma; allows you to have more than one.
Basically, that is multiple desktop containments hosting multiple sets of &plasma; widgets.
Display the <quote>Activities</quote> bar, select one of the predefined activities
or choose <guilabel>Create Activity</guilabel>
to create a new containment, select your new containment and customize suiting your taste.
&plasma;’s activities and &kwin;’s desktop grid are similar in that respect, but there
is a fundamental difference. While virtual desktop are used to group and organize windows,
&plasma;’s activities are used to group and organize &plasma; widgets. This way, you can
switch between activities and have relevant &plasma; widgets supporting the task you are
currently trying to accomplish. You can create a <quote>Free time</quote> activity, with
comic strips, a puzzle and other &plasma; widgets, and a <quote>Work</quote> activity,
with relevant <acronym>RSS</acronym> feeds, calculator and calendar, for example.
</para>

<para>
To delete an activity, press the <guibutton>Stop Activity</guibutton> button on
<quote>Activities</quote> bar (press <keycombo
action="simul">&Alt;<keycap>D</keycap></keycombo> then <keycombo
action="simul">&Alt;<keycap>A</keycap></keycombo> to open this bar) then click
the red 'X' (or press <keycombo action="simul">&Alt;<keycap>D</keycap></keycombo>
then <keycombo action="simul">&Alt;<keycap>R</keycap></keycombo>) and confirm the
deletion.
</para>

</sect1>

<sect1 id="shortcuts">
<title>Shortcuts</title>

<para>
Most of &plasma;’s functionality is also accessible through keyboard
shortcuts. The various combinations should be pressed in sequence, that
is for example <keycombo action="simul">&Alt;<keycap>D</keycap></keycombo>, <keycap>A</keycap>
means: Press &Alt; and <keycap>D</keycap>, release and press <keycap>A</keycap>.
</para>
<para>Currently, the following default shortcuts can be used:
</para>

<variablelist>
<varlistentry>
<term><keycombo action="simul">&Alt;<keycap>D</keycap></keycombo>, <keycap>A</keycap></term>
<listitem><para>Add Widgets</para></listitem>
</varlistentry>

<varlistentry>
<term><keycombo action="simul">&Alt;<keycap>D</keycap></keycombo>, <keycap>R</keycap></term>
<listitem><para>Remove Widget</para></listitem>
</varlistentry>

<varlistentry>
<term><keycombo action="simul">&Alt;<keycap>D</keycap></keycombo>, <keycap>L</keycap></term>
<listitem><para>Lock/Unlock Widgets</para></listitem>
</varlistentry>

<varlistentry>
650
<term><keycombo action="simul">&Meta;<keycap>=</keycap></keycombo></term>
651 652 653 654
<listitem><para>Zoom out</para></listitem>
</varlistentry>

<varlistentry>
655
<term><keycombo action="simul">&Meta;<keycap>-</keycap></keycombo></term>
656 657
<listitem><para>Zoom in</para></listitem>
</varlistentry>
Burkhard Lück's avatar
Burkhard Lück committed
658

659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685
<varlistentry>
<term><keycombo action="simul">&Alt;<keycap>D</keycap></keycombo>, <keycap>N</keycap></term>
<listitem><para>Next Widget</para></listitem>
</varlistentry>

<varlistentry>
<term><keycombo action="simul">&Alt;<keycap>D</keycap></keycombo>, <keycap>P</keycap></term>
<listitem><para>Previous Widget</para></listitem>
</varlistentry>

<varlistentry>
<term><keycombo action="simul">&Alt;<keycap>D</keycap></keycombo>, <keycap>S</keycap></term>
<listitem><para>Widget settings</para></listitem>
</varlistentry>

<varlistentry>
<term><keycombo action="simul">&Alt;<keycap>D</keycap></keycombo>, <keycombo action="simul">&Alt;<keycap>A</keycap></keycombo></term>
<listitem><para>Activities</para></listitem>
</varlistentry>

<varlistentry>
<term><keycombo action="simul">&Alt;<keycap>D</keycap></keycombo>, <keycombo action="simul">&Alt;<keycap>R</keycap></keycombo></term>
<listitem><para>Remove this Activity</para></listitem>
</varlistentry>

<varlistentry>
<term><keycombo action="simul">&Alt;<keycap>D</keycap></keycombo>, <keycombo action="simul">&Alt;<keycap>S</keycap></keycombo></term>
Burkhard Lück's avatar
Burkhard Lück committed
686
<listitem><para>Desktop Settings</para></listitem> <!--FIXME also Panel Settings?-->
687 688 689
</varlistentry>

<varlistentry>
690
<term><keycombo action="simul">&Meta;&Tab;</keycombo></term>
691 692 693 694
<listitem><para>Next Activity</para></listitem>
</varlistentry>

<varlistentry>
695
<term><keycombo action="simul">&Meta;&Shift;&Tab;</keycombo></term>
696 697 698 699 700
<listitem><para>Previous Activity</para></listitem>
</varlistentry>

<varlistentry>
<term><keycombo action="simul">&Ctrl;<keycap>F12</keycap></keycombo></term>
Burkhard Lück's avatar
Burkhard Lück committed
701
<listitem><para>Show Desktop</para></listitem>
702 703 704 705 706 707 708 709
</varlistentry>

<varlistentry>
<term><keycombo action="simul">&Alt;<keycap>D</keycap></keycombo>, <keycap>T</keycap></term>
<listitem><para>Run the Associated Application</para></listitem>
</varlistentry>

<varlistentry>
710
<term><keycombo action="simul">&Meta;&Tab;</keycombo></term>
Burkhard Lück's avatar
Burkhard Lück committed
711
<listitem><para>Open the Activities panel</para></listitem>
712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754
</varlistentry>

</variablelist>

</sect1>

</chapter>

<chapter id="credits">
<title>Credits and License</title>

<para>
&plasma;
</para>
<para>
Program copyright 2008 &Aaron.J.Seigo; &Aaron.J.Seigo.mail;
</para>

<para>
Documentation Copyright &copy; 2008&ndash;2010 Sebastian Kügler <email>sebas@kde.org</email>
</para>

<!-- TRANS:CREDIT_FOR_TRANSLATORS -->

&underFDL;

</chapter>

&documentation.index;
</book>

<!--
Local Variables:
mode: xml
sgml-minimize-attributes:nil
sgml-general-insert-case:lower
sgml-indent-step:0
sgml-indent-data:nil
End:

vim:tabstop=2:shiftwidth=2:expandtab
kate: space-indent on; indent-width 2; tab-width 2; indent-mode none;
-->