mod_cloud_notify: Readme: fix links and labels that were removed in the last commit diff --git a/mod_cloud_notify/README.md b/mod_cloud_notify/README.md --- a/mod_cloud_notify/README.md +++ b/mod_cloud_notify/README.md @@ -1,3 +1,9 @@ +---- +-labels: +-- 'Stage-Beta' +-summary: 'XEP-0357: Cloud push notifications' +---- + # Introduction This module enables support for sending "push notifications" to clients @@ -32,15 +38,15 @@ notification to your device. When your d it will display it or wake up the app so it can connect to XMPP and receive any pending messages. -This protocol is described for developers in \[XEP-0357: Push -Notifications\]. +This protocol is described for developers in [XEP-0357: Push +Notifications]. -For this module to work reliably, you must have \[mod_smacks\], -\[mod_mam\] and \[mod_carbons\] also enabled on your server. +For this module to work reliably, you must have [mod_smacks], +[mod_mam] and [mod_carbons] also enabled on your server. Some clients, notably Siskin and Snikket iOS need some additional extensions that are not currently defined in a standard XEP. To support -these clients, see \[mod_cloud_notify_extensions\]. +these clients, see [mod_cloud_notify_extensions]. # Configuration @@ -58,18 +64,18 @@ these clients, see \[mod_cloud_notify_ex # Internal design notes App servers are notified about offline messages, messages stored by -\[mod_mam\] or messages waiting in the smacks queue. The business rules +[mod_mam] or messages waiting in the smacks queue. The business rules outlined [here](//mail.jabber.org/pipermail/standards/2016-February/030925.html) are all honored[^2]. -To cooperate with \[mod_smacks\] this module consumes some events: +To cooperate with [mod_smacks] this module consumes some events: `smacks-ack-delayed`, `smacks-hibernation-start` and `smacks-hibernation-end`. These events allow this module to send out notifications for messages received while the session is hibernated by -\[mod_smacks\] or even when smacks acknowledgements for messages are +[mod_smacks] or even when smacks acknowledgements for messages are delayed by a certain amount of seconds configurable with the -\[mod_smacks\] setting `smacks_max_ack_delay`. +[mod_smacks] setting `smacks_max_ack_delay`. The `smacks_max_ack_delay` setting allows to send out notifications to clients which aren't already in smacks hibernation state (because the

@charset "UTF-8";
/* Style for mod_http_muc_log */
:link, :visited { color: #3465a4; text-decoration: none; }

:link:hover, :link:hover, :visited:hover, :visited:hover { color: #6197df; }

body { background-color: #eeeeec; margin: 1ex 0; padding-bottom: 3em; font-family: Arial,Helvetica,sans-serif; }

ul, ol { padding: 0; }

li { list-style: none; }

li.edited { display: none; }

li:target { outline: 1px gray dotted; display: inherit; }

hr { visibility: hidden; clear: both; }

br { clear: both; }

header, footer { margin: 1ex 1em; }

footer { font-size: smaller; color: #babdb6; }

footer nav .up { display: none; }

nav { font-size: large; margin: 1ex 1ex; clear: both; line-height: 1.5em; }

nav a { padding: 1ex; }

nav li, nav dt { margin: 1ex; }

nav .up { font-size: smaller; display: block; clear: both; }

nav .up::before { content: "↑ "; }

nav .prev { float: left; }

nav .prev::before { content: "← "; }

nav .next { float: right; }

nav .next::after { content: " →"; }

nav .last::after { content: " ⇥"; }

nav :empty::after, nav :empty::before { content: ""; }

@media screen and (min-width: 460px) { nav { font-size: x-large; margin: 1ex 1em; } }

table { display: inline-block; margin: 1ex 1em; vertical-align: top; }

th { font-size: x-small; }

td { text-align: right; color: #bababa; }

td > a, td > span { padding: 0.4em; }

.content { background-color: white; padding: 1em; list-style-position: inside; }

.time { margin-left: 1em; font-size: small; }

.description { font-size: smaller; }

.body { white-space: pre-line; margin: 1pt 0 1ex; }

.presence .verb { font-style: normal; color: #30c030; }

.unavailable .verb { color: #c03030; }

.button { display: inline-block; }

.button > a { color: white; background-color: orange; border-radius: 4px; }

.reaction { font-size: smaller; outline: 1px solid silver; border-radius: 2px; }

form { text-align: right; }

figure img { max-height: 9em; max-width: 16em; }

@media (prefers-color-scheme: dark) { html { color: #eee; } body { background-color: #161616; } .content { background-color: #1c1c1c; } footer { color: #444; } td { color: #444; } .button > a { background-color: #282828; } }