diff --git a/doc/kcontrol/CMakeLists.txt b/doc/kcontrol/CMakeLists.txt --- a/doc/kcontrol/CMakeLists.txt +++ b/doc/kcontrol/CMakeLists.txt @@ -21,7 +21,7 @@ ecm_optional_add_subdirectory(paths) ecm_optional_add_subdirectory(kcmsmserver) ecm_optional_add_subdirectory(kcmlaunchfeedback) -ecm_optional_add_subdirectory(kcmnotify) +ecm_optional_add_subdirectory(notifications) ecm_optional_add_subdirectory(formats) ecm_optional_add_subdirectory(spellchecking) ecm_optional_add_subdirectory(componentchooser) diff --git a/doc/kcontrol/kcmnotify/index.docbook b/doc/kcontrol/kcmnotify/index.docbook deleted file mode 100644 --- a/doc/kcontrol/kcmnotify/index.docbook +++ /dev/null @@ -1,117 +0,0 @@ - - - -]> - -
-System Notification Settings - - - -&Mike.McBride; &Mike.McBride.mail; - - - -2018-03-25 -Plasma 5.12 - - -KDE -Systemsettings -system notification -notification - - - - -System Notification Settings - -&plasma;, like all applications, needs to inform the user when a -problem occurs, a task is completed, or something has happened. &plasma; -uses a set of System Notifications to keep the user -informed on what is happening. - -Using this module, you can determine what &plasma; does to communicate -each event. - -To configure a notification, simply select the application from the drop down box at the top -of the dialog labeled Event source:. This will lead to a list of -all configurable notifications for the application. The list of notifications includes 6 columns to -the left of the notification name. These columns (from left to right) are: - - - -Play a sound -This does exactly what you think it does. If an icon is present in this column, &plasma; will play a specific sound over the speakers. This is commonly used by games in &plasma; for starting a new game, or other action within the game. - - - -Show a message in a pop up -If an icon is present in this column, &plasma; will open a message box and inform the user of the notification. This is probably the most commonly selected option for alerting users to an error. - - - -Log to a file -If an icon is present in this column, &plasma; will write certain information to a file on disk for later retrieval. This is useful for tracking problems or important system changes. - - - -Mark taskbar entry -If an icon is present in this column, &plasma; will cause the taskbar to flash until the user has clicked the taskbar entry. This is most useful when you want the user to look at the program (such as a new email message was received, or the users name was said on an IRC channel). - - - -Run command -If an icon is present in this column, a separate program will be executed when this notification is performed. This can be used to execute a program to help restore data, shutdown a potentially compromised system or email another user to alert them to a problem. - - - - -If you want to remove sound notifications from all applications with a single click use Disable sounds for all of these events - - -Change a notification -To make a change to a notification, click on the name of the notification once with the &LMB;. The notification will be highlighted -and the checkboxes for all notification types are enabled. - -You can have more than one event triggered by a single notification. As an example, it is easy to have a sound played and -a message box appear in response to a system notification. One notification does not prevent other notifications from operating. - -The following list details each of the notification types and how to use them. - - - -Play a sound -If a mark is in this checkbox, &plasma; will play a sound everytime this notification is initiated. To specify the sound, use the text box to the right of the checkbox to enter the folder location of the sound file you want &plasma; to play. You can use the folder button (located to the far right of the dialog box) to browse your directory tree. To hear a test of your sound, simply click on the play button (small button directly to the right of Play a sound.) - - - -Show a message in a pop up -If a mark is in this checkbox, &plasma; will open a message box and inform the user of the notification. The text of the box can not be changed from this dialog. - - - -Log to a file -If a mark is in this checkbox, &plasma; will write certain information to a file on disk for later retrieval. To specify the log file to use, enter the pathname in the text box to the right of the checkbox. You can use the folder button (located to the far right of the dialog box) to browse your directory tree. - - - -Mark taskbar entry -If a mark is in this checkbox, &plasma; will cause the taskbar of the program sending the notification to flash until the user has clicked the taskbar entry. - - - -Run command -If a mark is in this checkbox, a separate program will be executed when this notification is performed. To specify the program to execute, enter the pathname in the text box to the right of the checkbox. You can use the folder button (located to the far right of the dialog box) to browse your directory tree. - - - - -You can use the icon columns (located to the left of the notifications) to quickly select or deselect the options. Clicking in the column with the &LMB; will toggle the notification on and off. - - - - -
diff --git a/doc/kcontrol/kcmnotify/CMakeLists.txt b/doc/kcontrol/notifications/CMakeLists.txt rename from doc/kcontrol/kcmnotify/CMakeLists.txt rename to doc/kcontrol/notifications/CMakeLists.txt --- a/doc/kcontrol/kcmnotify/CMakeLists.txt +++ b/doc/kcontrol/notifications/CMakeLists.txt @@ -1,2 +1,2 @@ ########### install files ############### -kdoctools_create_handbook(index.docbook INSTALL_DESTINATION ${KDE_INSTALL_DOCBUNDLEDIR}/en SUBDIR kcontrol/kcmnotify) +kdoctools_create_handbook(index.docbook INSTALL_DESTINATION ${KDE_INSTALL_DOCBUNDLEDIR}/en SUBDIR kcontrol/notifications) diff --git a/doc/kcontrol/notifications/index.docbook b/doc/kcontrol/notifications/index.docbook new file mode 100644 --- /dev/null +++ b/doc/kcontrol/notifications/index.docbook @@ -0,0 +1,199 @@ + + + +]> + +
+System Notification Settings + + + +&Mike.McBride; &Mike.McBride.mail; +Kai Uwe Broulik kde@broulik.de + + + +2020-01-14 +Plasma 5.18 + + +KDE +Systemsettings +system notification +notification + + + + +System Notification Settings + +&plasma;, like all applications, needs to inform the user when a +problem occurs, a task is completed, or something has happened. &plasma; +uses a set of System Notifications to keep the user +informed on what is happening. + +Using this module, you can determine what &plasma; does to communicate +each event. + + +Notification Settings + + +Do Not Disturb mode + + 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. + + + + + Enable when screens are mirrored + Automatically enable do not disturb mode when you mirror your screens, for example during a presentation. + + + + Show critical notifications + Whether to show critical notifications, such as your battery is almost empty, to show even when in do not disturb mode. + + + + Toggle with: + A global shortcut you can press to enable and disable do not disturb mode anytime. + + + + + + + + Filters + + + + + Critical notifications: Always keep on top + 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. + + + + Low priority notifications: Show popup and Show in history + Whether low priority notifications, such as track changes in your media player, will be shown as popups or in the history, respectively. + + + + + + + Behavior + + + + + Popup: Show near notification icon + Show notification popups close to where your notification icon is located in your panel. + + + + Choose Custom Position... + Lets you choose a fixed screen corner where notification popups will be positioned. + + + + Hide after: + After how many seconds the notification popup will automatically disappear. You can choose anywhere between 1 and 120 seconds. + + + + + + + Application Progress and Badges + + + Application progress + + Options in this section control how application progress, such as copying or downloading a file, is presented. + + + + + Show in task manager + Colorize the window in the panel based on the progress. + + + + Show in notifications + Show a notification popup during the progress. + + + + Keep popup open during progress + 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. + + + + + + + Notification badges + + + + + Show in task manager + Let applications show badges, such as an unread message count, in the panel. + + + + + + + + + + +Application Settings + +Clicking the Configure... 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. + +Use the sidebar on the left to choose an entry from the Applications or System Services category. + +General warning popups as well as startup and shutdown sounds are located under the Plasma Workspace service. + +Applications that do not provide proper identification, such as shell scripts, can be configured using the Other Applications entry. + + + + + Show popups + Whether this application may show popup notifications. + + + + Show in do not disturb mode + Whether this application may show popup notifications even when in do not disturb mode. + + + + Show in history + Whether this application's notifications will be kept in the notification history. + + + + Show notification badges + Whether this application may show badges, such as an unread message count, in the panel. + + + + Configure Events... + For &kde; applications you can also configure each notification individually. + + + + + + + + +