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

body {
  margin: 0
}

a {
  color: #0000FF
}

#adhocCommands > ul {
  margin: 0
}

.btn {
  margin-right: 0.3em
}

.btn:last-child {
  margin-right: 0
}

#log_container {
  clear: both;
  display: none
}

#adhocCommands {
  border-right: solid 1px
}

#adhocCommands li {
  list-style: inside
}

#login {
  float: left;
  margin: 1em 2em 0 1em;
  padding-right: 1em;
  border: solid 1px;
  background: #eef0f2;
  color: #000000
}

#main {
  display: none;
  margin: 1em
}

#main p {
  margin: 0
}

#top {
  clear: both;
  width: 100%;
  padding: 0;
}

@media screen and (min-width: 757px) {
  #header {
    background: url(../images/blue_orange.png) repeat-x
  }
}

#header img {
  max-width: 100%;
  height: auto
}

#menu {
  display: none;
  color: #454748;
  font-size: 1.1em;
  background: #eef0f2;
  width: 100%;
}

#menu ul {
  display: inline;
  list-style-type: none;
  margin: 0;
  padding: 0.5em 0
}

#menu li {
  display: inline;
  padding: 0 0.5em
}

#menu a {
  color: #454748;
  text-decoration: none
}

#menu li a:hover {
  color: #6197DF;
  text-decoration: underline
}

#selector {
  display: inline-block
}

#s2sList h2, #c2sList h2 {
  color: #4b8ade;
  margin: 0
}

#s2sList li, #c2sList li {
  cursor: pointer
}

#host {
  margin: 0.25em;
}