File

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

:root
{
	color-scheme:light dark;
}
body
{
	text-align:center;
	font-family:sans-serif
}

h1
{
	font-size:xx-large;
}

legend {
	font-size:x-large;
}
p
{
	font-size:large;
}

.error
{
	margin: 0.75em auto;
	background-color: #f8d7da;
	color: #842029;
	border: solid 1px #f5c2c7;
}

.oob
{
	background-color: #d7daf8;
	border: solid 1px #c2c7f5;
	color: #202984;
	margin: 0.75em;
}
.oob input {
	font-size: xx-large;
	font-family: monospace;
	background-color: inherit;
	color: inherit;
	border: none;
	padding: 1ex 2em;
}

input {
	margin: 0.3rem;
	padding: 0.2rem;
	line-height: 1.5rem;
	font-size: 110%;
}
h1, h2 {
	text-align: left;
}

header, main, footer {
	max-width: 600px;
	padding: 0 1.5em 1.5em 1.5em;
}

dt
{
	font-weight: bold;
	margin: 0.5em 0 0 0;
}

dd
{
	margin: 0;
}

button, input[type=submit]
{
	padding: 0.5rem;
	margin: 0.75rem;
}

@media(prefers-color-scheme:dark)
{
	.error {
		color: #f8d7da;
		background-color: #842029;
	}
	.oob {
		color: #d7daf8;
		background-color: #202984;
	}
}

@media(min-width: 768px)
{
	body {
		margin-top:14vh;
	}
	header, main, footer
	{
		margin-left: auto;
		margin-right: auto;
	}

}