diff --git a/doc/plasma-desktop/index.docbook b/doc/plasma-desktop/index.docbook --- a/doc/plasma-desktop/index.docbook +++ b/doc/plasma-desktop/index.docbook @@ -19,6 +19,13 @@ sebas@kde.org Claus Christensen + + +Ivan +Stanton + +2112871@jeffcoschools.us + @@ -27,10 +34,15 @@ Sebastian Kügler + +2017 +Ivan Stanton + + &FDLNotice; -2016-08-21 -Plasma 5.7 +2017-03-26 +Plasma 5.10 @@ -54,11 +66,12 @@ Introduction - -&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 -include advanced window management and desktop effects, support for KDE Plasma Widgets, -integrated search, hardware management and a high degree of customizability. + +&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 include advanced window management and desktop effects, support for &plasma; Widgets, integrated search, hardware management and a high degree of customizability. &plasma; is simple by default and powerful when needed. This means that a user can configure pretty much anything about the desktop, but doesn't have to. It is &kde;'s flagship product. + + + +This manual tells you how to use &plasma;. @@ -73,549 +86,542 @@ &plasma; Widgets and Containments -The essence of &plasma; revolves around two basic concepts: - - - - -&plasma; Widgets - - -Applets, or small applications that live on the desktop. - - - - -Containments - - -Applets that act as the container for the &plasma; widgets +&plasma; is based on the concepts of Widgets and Containments. Widgets are small applications that live in a containment. Containments are places to put these widgets. - - - -On a default desktop, there are two main elements: the Panel and the Desktop -itself. Both are containments in the &plasma; sense. +The containments of the &plasma; desktop are the panel and the desktop. + - + Default &plasma; Desktop -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. - -Similarly, the graphical appearance of the interface elements can be styled. These screenshots uses the &plasma; default style, Breeze. - -A fairly standard &plasma; Desktop - - - - - - - - - - - - - - - - - - - - - - - + + - + - - + + Default &plasma; Desktop + + - -The program starter. Usually this will be Application Launcher. -A couple of icons giving easy access to often used applications - -The Task Manager, which shows the titles of windows belonging to the applications currently running. No application had opened a window, when the screenshot was taken -The System Tray -The Digital Clock widget -The Panel Toolbox -The Desktop Toolbox -A Folder View widget, showing the content of the Desktop folder - - + +The default &plasma; desktop consists of: + + + + +The Desktop Toolbox, a menu in the top left corner, which gives you options regarding widgets and activities + + +Hovering over the same corner will show all open apps + + +A panel stretching across the bottom of the screen, including an application launcher, a pager, a task manager, a digital clock, a system tray, and a Panel Settings menu. Each of these are described in the following sections. + + - -The Panel + +Default Widgets -The default panel holds a few &plasma; widgets: starting from the left, there is the -application launcher. + +Widgets are small applications that live in either the &plasma; panel or the &plasma; desktop. + + + +To change a widget to one with a similar function, right click on it (preferably an empty space inside it) and choose Alternatives. + + + +To change the settings for a widget called Widget, right click on it (preferably an empty space inside it) and click Widget Settings. + + + +Application Launchers - + Application Launcher + -Application launcher + - + - - Application launcher + + Launcher -You can use it to start applications, open recently -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 Favorites tab that holds the most-used -entries. In the beginning, you'll probably find yourself using the -Applications tab more often. -Once you have found out what your most frequently started applications are, -right click on the items and select the -Add to Favorites to add them to your -Favorites (or directly into the panel or on the desktop. -Note that you need to unlock &plasma; by means of right -clicking on the desktop for any kind of modification). - + - -Application Menu + +The default launcher (cleverly named Application Launcher) consists of 5 menus. These are seen in the part of the launcher closest to the panel. + -If you prefer the -traditional menu-style application launcher, change it by -right clicking on the menu button and selecting -Alternatives. + +KDE launchers have five categories: Favorites, Applications, Computer, History, and Leave. - -Application menu - - - - - - Application menu - - - - - -Application Launcher Settings + +One can simply search their files and folders by typing when focused on the application launcher. + -If you want to configure the application launcher, change it by -right clicking on the menu button and selecting -Application Launcher Settings. + +Favorites lists apps you have marked as favorite. By default, these include a web browser, a software manager, a text editor, a setting manager, and a file manager. - -Application launcher settings - - - - - - Application launcher settings - - - - - -Taskbar + +Applications is divided into 10 categories. Most of them are self-explanatory. + + + + Development lists apps for those who create software. It has a subcategory for translation. + + + Education is divided into subcategories like Mathematics, Miscellaneous, and Science. It includes everything relevant to academics and learning. + + + Settings has configuration applications in it. + + + Games, Graphics, Multimedia, Internet, and Settings are self-explanatory. + + + Office, Utilities, Lost and Found, and System contain everything that does not belong in other categories. They are otherwise self-explanatory. + + -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 Only show tasks from the -current desktop 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 -AppearanceFonts -. Right-clicking on the taskbar -brings the Settings dialog where you can choose several options to customize -your taskbar. - -Here is a screenshot of the taskbar settings dialog - - - - - - Taskbar settings dialog - - - +Right clicking on an app under Applications allows you to add it to your Favorites or your panel. - - -System Tray + +Computer lists available data devices, along with system actions and important system folders. + -Another default panel item is the System Tray, which -is used by traditional applications and widgets as a dock. Right clicking on the -System Tray allows you to open the settings dialog, -where you can set entries to display and their visibility. +History lists recently opened files and applications. + + + +Leave has various actions for when you stop using your computer. It allows you lock the screen, log out, switch your user, reboot, suspend, or shut down. + + + + +Application Dashboard + + +In addition to the default launcher, &plasma; provides 2 other launchers: the Application Dashboard and the Application Menu. You can select an app menu by right-clicking on the current one and then Alternatives. - -System Tray settings dialog - - - - - - System Tray settings dialog - - - - - -Device Notifier + +Application Dashboard shows Favorites and Applications by default. On the right sidebar, all the default Applications categories are visible, in addition to Recent Applications and Recent Documents categories replacing History and a Power/Session category replacing Leave. + -An icon located usually in the system tray is the Device Notifier. -Plug in a USB disk and a dialog will open that allows you to -open the device in &dolphin; or another associated application. +Interestingly, by selecting the option in the top-bar, one can add widgets via the Application Dashboard. + + + +Application Menu + - + - + Menu -The Device Notifier 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. + + +Application Menu has the same categories as on the right sidebar of the Application Dashboard. Hovering over these categories opens a popup menu with the contents of them. Application Menu has a left sidebar with your favorite apps and some power options. -When you plug in an external device, or load a new medium into a drive, the Notifier 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. + + + + +Pagers + + +Desktop Pager + + +The Desktop Pager lets you switch between virtual desktops. It shows diagrams of all the windows on each desktop. Virtual desktops are explained in detail later. -The Notifier 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. + + + + +Activity Pager + + +The Activity Pager is like the Desktop Pager but with activities. Activities are explained later. + + + + + +Task Managers + + +Task Managers list open windows. Right-clicking on an app in a task manager other than Window List allows you to do most anything that could be done in the header-bar, as well as moving it between desktops, starting a new instance of the same application, and pinning it to the task manager. + + + +Task Manager + + +Task Manager shows a list of open windows in the current activity with icons and window titles. + + - + - + Task Manager settings -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 Device Notifier's context menu or from the &systemsettings; modules Device Actions and Removable Devices. Simply select one with the mouse or keyboard to launch that action. - -There is also a small icon to the right of each entry showing whether that device is currently accessible (or mounted) 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, ⪚ 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 Device Notifier's icon. + + + + +Icons-only Task Manager + + +Icons-only Task Manager shows a list of open windows in the current activity with icons only. - + - -Hidden Items + +Window List -The System Tray normally holds some more entries like -&klipper;, &kmix; &etc; + +Window List is a panel icon which, when clicked, shows a list of open windows in the current activity with icons and window titles. + + -Some of the default entries in the System Tray are hidden -to save space in the bar. To display these entries click on the small white triangle - -, then use -the &LMB; to launch a widget or the &RMB; to open its settings dialog. - + +Clocks + + +Clocks tell the time. Clicking on a clock opens a calendar. + + + Digital Clock -The right-most &plasma; widget in the default panel holds the Digital -Clock. -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 Small -font option from the &systemsettings; Font -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. +The Digital Clock shows the time in a digital format (Hour:Minute AM/PM). + + + + +Analog Clock + + +The Analog Clock shows the time like a mechanical clock would. + + + + + +Fuzzy Clock + + +The Fuzzy Clock shows the time in the imprecise format you might sometimes use when talking to friends. + + + + + +Calendar + + +The Calendar shows the date of the month. When at a large size on the desktop, it shows a calendar by default. + + - -Pager + +System Tray -An optional item on your panel is the Pager. -It allows you to switch between your virtual desktops. -If you change the layout of the Pager -through the Number of rows option, -which will also affect the layout and animations that are shown in &kwin;’s -Desktop Grid effect. -For larger pagers, selecting Display windows icons -typically makes sense. +The System Tray is a collection of various widgets: + + + + Menus/launchers for running, but closed applications + + + + Wifi manager. Click on it for a list of available networks. + + + + Device Notifier - Plug in a USB disk and a dialog will open that allows you to open the device in &dolphin; or another associated application. Can be used as a standalone widget. + + + + Clipboard - clipboard viewer. Can be used as a standalone widget. + + + + Volume Control - allows you to set volume for certain devices and applications. Can be used as a standalone widget. + + + + Notifications - notifications from various apps + + + + Battery Monitor - shows remaining batteries' capacity and whether it is charging. Also lets you change screen brightness + + + + Updates - allows you to upgrade when upgrades are available. Can be used as a standalone widget. + + + + Printers - lists connected printers + + + + KDE Connect - allows you to view and manage connected smartphones and Android tablets + + + + +The System Tray shows only currently relevant widgets. For example, if the battery is charging or discharging, the Battery Monitor displays. + + - - - - - + +Additional Widgets - -The Panel Toolbox + +2D Plots -If your desktop is unlocked (you can do that by -right clicking on the desktop, or when no -application has the focus, with &Alt;D, L), a small &plasma; -logo will appear in the bottom right corner in the panel. -Click on this toolbox, and the panel controller opens. + +The 2D Plot applet allows you to enter an equation in the top bar, then see it plotted in a random color below. + + - -Panel Settings - - - - - - Panel Settings - - - + +Activities -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. + +The Activities widget is meant for panels. Clicking on it opens the Activity Manager in a sidebar to the left. + + - + +Activity Bar - -Adding Applets + +The Activity Bar is like a task manager, except for activities. + + + + +Calculator -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. -Right click on an widget to remove it. +The Calculator is a basic elementary calculator app. + + - -Add Widgets - - - - - - Add Widgets - - - + +Color Picker -The Get New Widgets 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 X dashboard widgets. Widgets you install this way can then be -accessed just like regular, preinstalled widgets. + +Click on the dropper button and then on a color to pick a color from the desktop. Hover over the color to get its hex number. - + - -The Desktop + +Comic Viewer -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. +Allows you to view comics straight from the Internet. Requires one to install comics; this can be done through Discover or by going into the widget settings and clicking Get New Comics. + + + +Monitoring Widgets -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;. +Monitoring widgets include activity graphs for various things. -On the Tweaks page you can configure to hide the desktop Toolbox -and adjust the widget handling. + + +CPU Load Monitor + + +Monitors the overall CPU load as well as the load for each CPU core. + + - -Desktop Settings - - - - - - Desktop Settings - - - + +Fifteen Puzzle + +Fifteen Puzzle is a puzzle game in which fifteen number-blocks are scrambled and you have to reorganize them by sliding them around. It is similar to common sliding-image puzzles. + + + + + + + +Panel Settings -To change the &plasma; theme or download a new one through &knewstuff; -open the Appearance Desktop -Theme page in the &systemsettings;. + +If widgets are unlocked, then on the right of each panel there is a button which opens the Panel Settings menu. This menu allows you to change the size of the panel; drag the arrows pointing left to change the minimum width of the panel and drag the arrows pointing right to change the maximum width. The Screen Edge button acts like a handle to move the panel to any side of the screen. The Height button can be dragged up and down to change the height of the panel. Add Widgets and Add Spacer are self-explanatory. Under More Settings, one can change the panel's alignment and visibility. That menu also allows the user to increase the panel's minimum size to its maximum (Maximize Panel), remove the panel, and prevent widgets from being edited (Lock Widgets). + + + + +Adding Widgets -With open applications, it quickly gets hard to see the &plasma; widgets on your -desktop. The Dashboard gets those &plasma; widgets -in front of you, much like the Show desktop functionality -you are used to from traditional desktops. +To add widgets, right click on the desktop and go to Add Widgets... or click the same option under Panel Settings. This will open up a vertical menu on the left side of the screen to add widgets. + + + +The Get New Widgets 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 X dashboard widgets. Widgets you install this way can then be accessed just like regular, preinstalled widgets. - -Folder View -The Folder View widget is used to display entries like folders or -files from a folder, by default from $HOME/Desktop. + +The Desktop + + +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. -You can choose to view either all files, or filter either by specific regular expressions -(⪚, all files with a certain extension) or by file type (⪚ just images). + + +Right clicking on the desktop and clicking Configure 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;. -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. + + +On the Tweaks page you can configure to hide the desktop Toolbox and adjust the widget handling. - -Folder View - - - - - - Folder View - - - + +To change the &plasma; theme or download a new one through &knewstuff; open the Appearance Desktop Theme page in the &systemsettings;. + -If you select the layout Folder View in the Desktop Settings -you can use one Folder View as the whole desktop, effectively replicating the "old style" desktop paradigm. + +With open applications, it quickly gets hard to see the &plasma; widgets on your desktop. When opening menus that allow you to configure widgets and activities, the window view is replaced with a Dashboard. All of the windows are moved to the corners and made translucent. This can also be achieved via the Show Desktop widget. + &krunner; + + +&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 short equations, and many more. Pressing &Alt;Space or &Alt; F2 opens the &krunner; dialog. 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. + + -&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 -short equations, and many more. Pressing &Alt;Space or &Alt;F2 opens the &krunner; dialog. -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. - - -&krunner; dialog + - - &krunner; dialog + + &krunner; window + + +Use the Configure button to open the Plasma Search &systemsettings; module and configure where and what to search for in &krunner;. + -Use the - button to open the Plasma Search &systemsettings; -module and configure where and what to search for in &krunner; + +&krunner; supports Desktop Actions which are additional actions an application can offer to perform common actions or jump directly to a certain task from Task Manager. Common examples are Open New Incognito Window to open your browser directly in private mode, Compose Email without launching the full-fledged email client first or take photos with the actions provided by Spectacle. -&krunner; supports Desktop Actions which are additional actions an application can -offer to perform common actions or jump directly to a certain task from Task Manager. -Common examples are Open New Incognito Window to open your browser directly in private mode, -Compose Email without launching the full-fledged email client first or the actions -provided by &spectacle;: + +If you press the Down key in an empty &krunner; a history of the recent entities is shown. After invoking a search result, its query will move to the top, so repeatedly used commands never fall out of the list. - -&krunner; Desktop Actions - - - - - - &krunner; Desktop Actions - - - + +Remove single entries from the list using the red cross button or clear the complete history in the &krunner; settings. + -If you press the Down key in an empty &krunner; a history of the recent entities -is shown. After invoking a search result, its query will move to the top, so repeatedly used -commands never fall out of the list. + +If you want to know what is going on on your system, pressing &Ctrl; &Esc; gives you quick access to a list of windows and processes, with options to monitor their output and kill processes. -Remove single entries from the list using the - button or clear the complete history in the -&krunner; settings. + + + + +Activities and Virtual Desktops + + +Virtual Desktops + + +Each virtual desktop contains its own windows. -If you want to know what is going on on your system, pressing &Ctrl;&Esc; gives you quick access to a list of windows -and processes, with options to monitor their output and kill processes. +Virtual Desktops are disabled by default. To change this, go to &systemsettings; Desktop Behavior Virtual Desktops and increase the number of desktops. - + - + Activities -The desktop toolbox, accessed via the upper left corner has a button for -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 Activities bar, select one of the predefined activities -or choose Create Activity -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 Free time activity, with -comic strips, a puzzle and other &plasma; widgets, and a Work activity, -with relevant RSS feeds, calculator and calendar, for example. +Each Activity has its own widgets and windows. + + + +The desktop toolbox, accessed via the upper left corner has a button for 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 Activities bar, select one of the predefined activities or choose Create Activity 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 Free time activity, with comic strips, a puzzle and other &plasma; widgets, and a Work activity, with relevant RSS feeds, calculator and calendar, for example. -To delete an activity, press the Stop Activity button on -Activities bar (press &Alt;D then &Alt;A to open this bar) then click -the red 'X' (or press &Alt;D -then &Alt;R) and confirm the -deletion. +To delete an activity, press the Stop Activity button on Activities bar (press &Alt;D then &Alt;A to open this bar) then click the red X (or press &Alt;D then &Alt;R) and confirm the deletion. + @@ -731,6 +737,10 @@ Documentation Copyright © 2008–2010 Sebastian Kügler sebas@kde.org + +Partially rewritten in 2017 by Ivan Stanton 2112871@jeffcoschools.us + + &underFDL;