diff options
author | Florian Bruhin <me@the-compiler.org> | 2021-03-27 11:39:36 +0100 |
---|---|---|
committer | Florian Bruhin <me@the-compiler.org> | 2021-03-27 15:35:25 +0100 |
commit | 12bcca9c479c7ea57f17bffb48bc71897e79a8e5 (patch) | |
tree | 9ad00aa2ffbe3f07606b659bf6c3b33b2e51fc35 /doc | |
parent | c7c9ed47e70020def51332130b9ca449dbad94cc (diff) | |
download | qutebrowser-12bcca9c479c7ea57f17bffb48bc71897e79a8e5.tar.gz qutebrowser-12bcca9c479c7ea57f17bffb48bc71897e79a8e5.zip |
notifications: Update docs
Diffstat (limited to 'doc')
-rw-r--r-- | doc/changelog.asciidoc | 12 | ||||
-rw-r--r-- | doc/help/settings.asciidoc | 22 |
2 files changed, 27 insertions, 7 deletions
diff --git a/doc/changelog.asciidoc b/doc/changelog.asciidoc index c25c6dd4c..2f7bd8301 100644 --- a/doc/changelog.asciidoc +++ b/doc/changelog.asciidoc @@ -46,6 +46,16 @@ Added `fileselect.handler = external` to customize the command to use to upload directories (`<input type="file" webkitdirectory />` elements, which are non-standard but in wide use). +- New `content.notifications.presenter` setting with various new ways to show + web notifications: + * auto (default): Automatically detect the best available option + * qt: Use Qt's built-in mechanism (like before this release) + * libnotify: Use a libnotify-compatible notification server (i.e. native + notifications on Linux) + * systray: Use a systray icon (very similar to `qt` but without some of its + drawbacks) + * messages: Use qutebrowser messages + * herbe: Use https://github.com/dudik/herbe[herbe] Changed ~~~~~~~ @@ -64,6 +74,8 @@ Changed clearer what kind of error occurred exactly. - The `content.site_specific_quirks` setting got renamed to `content.site_specific_quirks.enabled`. +- The `content.notifications` option got renamed to + `content.notifications.enabled`. - The completion now also shows bindings starting with `set-cmd-text` in its third column, such as `o` for `:open`. - When `:spawn` is used with the `-m` / `--output-messages` flag, the output now diff --git a/doc/help/settings.asciidoc b/doc/help/settings.asciidoc index fa71d7771..7accd8a2e 100644 --- a/doc/help/settings.asciidoc +++ b/doc/help/settings.asciidoc @@ -2522,7 +2522,15 @@ Default: +pass:[ask]+ [[content.notifications.presenter]] === content.notifications.presenter What notification presenter to use for web notifications. -Note that with Qt 5.14, certain JavaScript features for notifications will not work with the libnotify notification presenter (the `click` and `close` events, as well as the `tag` option to replace existing notifications). +Note that not all implementations support all features of notifications: +- With PyQt 5.14, any setting other than `qt` does not support the `click` and + `close` events, as well as the `tag` option to replace existing notifications. +- The `qt` and `systray` options only support showing one notification at the time + and ignore the `tag` option to replace existing notifications. +- The `herbe` option only supports showing one notification at the time and doesn't + show icons. +- The `messages` option doesn't show icons and doesn't support the `click` and + `close` events. On QtWebEngine, this setting requires Qt 5.14 or newer. @@ -2532,12 +2540,12 @@ Type: <<types,String>> Valid values: - * +auto+: Use a libnotify-compatible presenter if DBus is available, silently fall back to Qt's presenter otherwise. - * +qt+: Use Qt's native notification presenter. Switching from or to this value requires a restart of qutebrowser. - * +libnotify+: Use a libnotify-compatible presenter if DBus is available, show an error (and fall back to Qt's presenter) otherwise. - * +systray+: Use a notification presenter based on a systray icon. This is a reimplementation of the `qt` setting value, but with the possibility to switch to it at runtime. - * +messages+: Show notifications as qutebrowser messages. Most features (images, clicking/closing notifications) aren't available. - * +herbe+: Show notifications using herbe (github.com/dudik/herbe) + * +auto+: Tries `libnotify`, `systray` and `messages`, uses the first one available without showing error messages. + * +qt+: Use Qt's native notification presenter, based on a system tray icon. Switching from or to this value requires a restart of qutebrowser. Recommended over `systray` on PyQt 5.14. + * +libnotify+: Shows messages via DBus in a libnotify-compatible way. If DBus isn't available, falls back to `systray` or `messages`, but shows an error message. + * +systray+: Use a notification presenter based on a systray icon. Falls back to `libnotify` or `messages` if not systray is available. This is a reimplementation of the `qt` setting value, but with the possibility to switch to it at runtime. + * +messages+: Show notifications as qutebrowser messages. Most notification features aren't available. + * +herbe+: (experimental!) Show notifications using herbe (github.com/dudik/herbe). Most notification features aren't available. Default: +pass:[auto]+ |