Differential D26684 Diff 73618 doc/kcontrol/notifications/index.docbook

Changeset View

Standalone View

doc/kcontrol/notifications/index.docbook

This file was added.

1		<?xml version="1.0" ?>
2		<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN"
3		"dtd/kdedbx45.dtd" [
4		<!ENTITY % addindex "IGNORE">
5		<!ENTITY % English "INCLUDE" > <!-- change language only here -->
6		]>
7
8		<article id="kcmnotify" lang="&language;">
9		<title>System Notification Settings</title>
10		<articleinfo>
11
12		<authorgroup>
13		<author>&Mike.McBride; &Mike.McBride.mail;</author>
14		<author><personname><firstname>Kai Uwe</firstname> <surname>Broulik</surname></personname> <email>kde@broulik.de</email></author>
15		<!-- TRANS:ROLES_OF_TRANSLATORS -->
16		</authorgroup>
17
18		<date>2020-01-14</date>
19		<releaseinfo>Plasma 5.18</releaseinfo>
20
21		<keywordset>
22		<keyword>KDE</keyword>
23		<keyword>Systemsettings</keyword>
24		<keyword>system notification</keyword>
25		<keyword>notification</keyword>
26		</keywordset>
27		</articleinfo>
28
29		<sect1 id="sys-notify">
30		<title>System Notification Settings</title>
31
32		<para>&plasma;, like all applications, needs to inform the user when a
33		problem occurs, a task is completed, or something has happened. &plasma;
34		uses a set of <quote>System Notifications</quote> to keep the user
35		informed on what is happening.</para>
36
37		<para>Using this module, you can determine what &plasma; does to communicate
38		each event.</para>
39
40		<sect2 id="notification-settings">
41		<title>Notification Settings</title>
42
43		<sect3 id="do-not-disturb">
44		<title>Do Not Disturb mode</title>
45
46		<para>This mode disables all visual and most audible notifications to let you focus on your current task. Settings in this section let you configure under which circumstances &plasma; automatically enables do not disturb mode.</para>
47
48		<variablelist>
49
50		<varlistentry>
51		<term><guiicon>Enable when screens are mirrored</guiicon></term>
52		<listitem><para>Automatically enable do not disturb mode when you mirror your screens, for example during a presentation.</para></listitem>
53		</varlistentry>
54
55		<varlistentry>
56		<term><guiicon>Show critical notifications</guiicon></term>
57		<listitem><para>Whether to show critical notifications, such as your battery is almost empty, to show even when in do not disturb mode.</para></listitem>
58		</varlistentry>
59
60		<varlistentry>
61		<term><guiicon>Toggle with:</guiicon></term>
62		<listitem><para>A global shortcut you can press to enable and disable do not disturb mode anytime.</para></listitem>
63		</varlistentry>
64
65		</variablelist>
66
67		</sect3>
68
69		<sect3 id="notification-filters">
70		<title>Filters</title>
71
72		<variablelist>
73
74		<varlistentry>
75		<term>Critical notifications: <guiicon>Always keep on top</guiicon></term>
76		<listitem><para>Keep critical notifications, such as your battery is almost empty, always on top. This ensures they will also be visible while watching a fullscreen video or giving a presentation.</para></listitem>
77		</varlistentry>
78
79		<varlistentry>
80		<term>Low priority notifications: <guiicon>Show popup</guiicon> and <guiicon>Show in history</guiicon></term>
81		<listitem><para>Whether low priority notifications, such as track changes in your media player, will be shown as popups or in the history, respectively.</para></listitem>
82		</varlistentry>
83
84		</variablelist>
85		</sect3>
86
87		<sect3 id="notification-behavior">
88		<title>Behavior</title>
89
90		<variablelist>
91
92		<varlistentry>
93		<term>Popup: <guiicon>Show near notification icon</guiicon></term>
94		<listitem><para>Show notification popups close to where your notification icon is located in your panel.</para></listitem>
95		</varlistentry>
96
97		<varlistentry>
98		<term><guiicon>Choose Custom Position...</guiicon></term>
99		<listitem><para>Lets you choose a fixed screen corner where notification popups will be positioned.</para></listitem>
100		</varlistentry>
101
102		<varlistentry>
103		<term><guiicon>Hide after:</guiicon></term>
104		<listitem><para>After how many seconds the notification popup will automatically disappear. You can choose anywhere between 1 and 120 seconds.</para></listitem>
105		</varlistentry>
106
107		</variablelist>
108		</sect3>
109
110		<sect3 id="progress-and-badges">
111		<title>Application Progress and Badges</title>
112
113		<sect4 id="application-progress">
114		<title>Application progress</title>
115
116		<para>Options in this section control how application progress, such as copying or downloading a file, is presented.</para>
117
118		<variablelist>
119
120		<varlistentry>
121		<term><guiicon>Show in task manager</guiicon></term>
122		<listitem><para>Colorize the window in the panel based on the progress.</para></listitem>
123		</varlistentry>
124
125		<varlistentry>
126		<term><guiicon>Show in notifications</guiicon></term>
127		<listitem><para>Show a notification popup during the progress.</para></listitem>
128		</varlistentry>
129
130		<varlistentry>
131		<term><guiicon>Keep popup open during progress</guiicon></term>
132		<listitem><para>Whether the popup should remain visible for the entire duration of the progress or automatically hide. It will always be shown again when the task finishes or fails.</para></listitem>
133		</varlistentry>
	yurchorUnsubmitted Done Typo: It will always shown -> It will always be shown yurchor: Typo: It will always shown -> It will always be shown
134
135		</variablelist>
136		</sect4>
137
138		<sect4 id="badges">
139		<title>Notification badges</title>
140
141		<variablelist>
142
143		<varlistentry>
144		<term><guiicon>Show in task manager</guiicon></term>
145		<listitem><para>Let applications show badges, such as an unread message count, in the panel.</para></listitem>
146		</varlistentry>
147
148		</variablelist>
149		</sect4>
150
151		</sect3>
152
153		</sect2>
154
155		<sect2 id="application-settings">
156		<title>Application Settings</title>
157
158		<para>Clicking the <guilabel>Configure...</guilabel> button at the end of the list opens the application settings page which lets you configure notification behavior on a per-application and per-service basis.</para>
159
160		<para>Use the sidebar on the left to choose an entry from the <guilabel>Applications</guilabel> or <guilabel>System Services</guilabel> category.</para>
161
162		<para>General warning popups as well as startup and shutdown sounds are located under the <guilabel>Plasma Workspace</guilabel> service.</para>
163
164		<para>Applications that do not provide proper identification, such as shell scripts, can be configured using the <guilabel>Other Applications</guilabel> entry.</para>
165
166		<variablelist>
167
168		<varlistentry>
169		<term><guiicon>Show popups</guiicon></term>
170		<listitem><para>Whether this application may show popup notifications.</para></listitem>
171		</varlistentry>
172
173		<varlistentry>
174		<term><guiicon>Show in do not disturb mode</guiicon></term>
175		<listitem><para>Whether this application may show popup notifications even when in do not disturb mode.</para></listitem>
176		</varlistentry>
177
178		<varlistentry>
179		<term><guiicon>Show in history</guiicon></term>
180		<listitem><para>Whether this application's notifications will be kept in the notification history.</para></listitem>
181		</varlistentry>
182
183		<varlistentry>
184		<term><guiicon>Show notification badges</guiicon></term>
185		<listitem><para>Whether this application may show badges, such as an unread message count, in the panel.</para></listitem>
186		</varlistentry>
187
188		<varlistentry>
189		<term><guiicon>Configure Events...</guiicon></term>
190		<listitem><para>For &kde; applications you can also configure each notification individually.</para></listitem>
191		</varlistentry>
192
193		</variablelist>
194
195		</sect2>
196
197		</sect1>
198
199		</article>