Mercurial > prosody-modules
annotate mod_pubsub_text_interface/README.md @ 6253:502963b86fbc
:multble modules: fix tab-> space
diff --git a/mod_admin_blocklist/README.md b/mod_admin_blocklist/README.md
--- a/mod_admin_blocklist/README.md
+++ b/mod_admin_blocklist/README.md
@@ -24,9 +24,9 @@ admin_blocklist_roles = { "prosody:opera
# Compatibility
Prosody-Version Status
- -------------- ------
- trunk* Works
- 13 Works
- 0.12 Works
+ ------------ ------
+ trunk* Works
+ 13 Works
+ 0.12 Works
*as of 2025-06-13
diff --git a/mod_csi_grace_period/README.md b/mod_csi_grace_period/README.md
--- a/mod_csi_grace_period/README.md
+++ b/mod_csi_grace_period/README.md
@@ -16,9 +16,9 @@ pocket is not the best use of radio time
Works with [mod_csi_simple][doc:modules:mod_csi_simple] which is
included with Prosody.
- ------- -------
- trunk* Works
- 13 Works
- 0.12 Works
+ ------- -------
+ trunk* Works
+ 13 Works
+ 0.12 Works
*as of 2025-06-13
diff --git a/mod_http_upload_external/README.md b/mod_http_upload_external/README.md
--- a/mod_http_upload_external/README.md
+++ b/mod_http_upload_external/README.md
@@ -87,10 +87,10 @@ Compatibility
=============
Prosody-Version Status
- ---------------- --------------------
- trunk Works as of 25-06-13
- 13 Works
- 0.12 Works
+ ---------------- --------------------
+ trunk Works as of 25-06-13
+ 13 Works
+ 0.12 Works
Implementation
==============
diff --git a/mod_muc_moderation/README.md b/mod_muc_moderation/README.md
--- a/mod_muc_moderation/README.md
+++ b/mod_muc_moderation/README.md
@@ -27,11 +27,10 @@ modules_enabled = {
# Compatibility
- ------- ---------------
- trunk Works^[as of 2025-06-13]
- 13 Works
- 0.12 Works
- ------- ---------------
+ ------- ---------------
+ trunk Works^[as of 2025-06-13]
+ 13 Works
+ 0.12 Works
## XEP version
diff --git a/mod_s2s_idle_timeout/README.md b/mod_s2s_idle_timeout/README.md
--- a/mod_s2s_idle_timeout/README.md
+++ b/mod_s2s_idle_timeout/README.md
@@ -25,10 +25,9 @@ Compatibility
=============
Prosody Version Status
- ----------------- -----------
- trunk[^1] Works
- 13 Works
- 0.12 Works
- ----------------- -----------
+ ----------------- -----------
+ trunk[^1] Works
+ 13 Works
+ 0.12 Works
[^1]: as of 2025-06-13
diff --git a/mod_s2s_keepalive/README.md b/mod_s2s_keepalive/README.md
--- a/mod_s2s_keepalive/README.md
+++ b/mod_s2s_keepalive/README.md
@@ -34,10 +34,9 @@ Compatibility
=============
Prosody Version Status
- ----------------- -----------
- trunk[^1] Works
- 13 Works
- 0.12 Works
- ----------------- -----------
+ ----------------- -----------
+ trunk[^1] Works
+ 13 Works
+ 0.12 Works
[^1]: as of 2025-06-13
| author | Menel <menel@snikket.de> |
|---|---|
| date | Fri, 13 Jun 2025 09:58:51 +0200 |
| parents | fe081789f7b5 |
| children |
| rev | line source |
|---|---|
|
3244
2b888a7aa21c
mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
1 # Introduction |
|
2b888a7aa21c
mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
2 |
|
2b888a7aa21c
mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
3 This module lets you manage subscriptions to pubsub nodes via simple |
|
2b888a7aa21c
mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
4 chat messages. Subscriptions are always added based on bare JID. The |
|
3410
a0e0ec729aab
mod_pubsub_text_interface/README: Normalize Markdown syntax
Kim Alvefur <zash@zash.se>
parents:
3244
diff
changeset
|
5 `include_body` flag is enabled so that a plain text body version of |
|
a0e0ec729aab
mod_pubsub_text_interface/README: Normalize Markdown syntax
Kim Alvefur <zash@zash.se>
parents:
3244
diff
changeset
|
6 events can be included, where supported. |
|
3244
2b888a7aa21c
mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
7 |
|
2b888a7aa21c
mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
8 # Configuring |
|
2b888a7aa21c
mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
9 |
|
3410
a0e0ec729aab
mod_pubsub_text_interface/README: Normalize Markdown syntax
Kim Alvefur <zash@zash.se>
parents:
3244
diff
changeset
|
10 ``` {.lua} |
|
3436
12c7c0d7e1b0
mod_pubsub_text_interface/README: Fix typo (thanks perflyst)
Kim Alvefur <zash@zash.se>
parents:
3413
diff
changeset
|
11 Component "pubsub.example.com" "pubsub" |
|
3244
2b888a7aa21c
mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
12 modules_enabled = { |
|
2b888a7aa21c
mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
13 "pubsub_text_interface", |
|
2b888a7aa21c
mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
14 } |
|
2b888a7aa21c
mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
15 ``` |
|
2b888a7aa21c
mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
16 |
|
2b888a7aa21c
mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
17 # Commands |
|
2b888a7aa21c
mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
18 |
|
2b888a7aa21c
mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
19 The following commands are supported. Simply send a normal chat message |
|
2b888a7aa21c
mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
20 to the PubSub component where this module is enabled. When subscribing |
|
2b888a7aa21c
mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
21 or unsubscribing, be sure to replace `node` with the node you want to |
|
2b888a7aa21c
mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
22 subscribe to or unsubscribe from. |
|
2b888a7aa21c
mod_pubsub_text_interface: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
23 |
|
3410
a0e0ec729aab
mod_pubsub_text_interface/README: Normalize Markdown syntax
Kim Alvefur <zash@zash.se>
parents:
3244
diff
changeset
|
24 - `help` - a help message, listing these commands |
|
a0e0ec729aab
mod_pubsub_text_interface/README: Normalize Markdown syntax
Kim Alvefur <zash@zash.se>
parents:
3244
diff
changeset
|
25 - `list` - list available nodes |
|
a0e0ec729aab
mod_pubsub_text_interface/README: Normalize Markdown syntax
Kim Alvefur <zash@zash.se>
parents:
3244
diff
changeset
|
26 - `subscribe node` - subscribe to a node |
|
a0e0ec729aab
mod_pubsub_text_interface/README: Normalize Markdown syntax
Kim Alvefur <zash@zash.se>
parents:
3244
diff
changeset
|
27 - `unsubscribe node` - unsubscribe from a node |
|
3411
c479e39ff547
mod_pubsub_text_interface/README: Document the 'last' command
Kim Alvefur <zash@zash.se>
parents:
3410
diff
changeset
|
28 - `last node` - sends the last published item from the node to you |
|
3412
d50d1dfab9eb
mod_pubsub_text_interface/README: Add a Compatibility section
Kim Alvefur <zash@zash.se>
parents:
3411
diff
changeset
|
29 |
|
d50d1dfab9eb
mod_pubsub_text_interface/README: Add a Compatibility section
Kim Alvefur <zash@zash.se>
parents:
3411
diff
changeset
|
30 # Compatibility |
|
d50d1dfab9eb
mod_pubsub_text_interface/README: Add a Compatibility section
Kim Alvefur <zash@zash.se>
parents:
3411
diff
changeset
|
31 |
|
d50d1dfab9eb
mod_pubsub_text_interface/README: Add a Compatibility section
Kim Alvefur <zash@zash.se>
parents:
3411
diff
changeset
|
32 Should work with Prosody since 0.9, when |
|
3413
6421c9f05e02
mod_pubsub_text_interface/README: Add lost _
Kim Alvefur <zash@zash.se>
parents:
3412
diff
changeset
|
33 [mod\_pubsub][doc:modules:mod_pubsub] was introduced. |
|
3412
d50d1dfab9eb
mod_pubsub_text_interface/README: Add a Compatibility section
Kim Alvefur <zash@zash.se>
parents:
3411
diff
changeset
|
34 |
|
d50d1dfab9eb
mod_pubsub_text_interface/README: Add a Compatibility section
Kim Alvefur <zash@zash.se>
parents:
3411
diff
changeset
|
35 The `last` command is available from Prosody 0.11. |
