annotate mod_bob/README.markdown @ 4065:92152437ecfe

mod_muc_markers: replace configurable multi-marker tracking with better system Now tracks a single marker, but automatically applies rules from the XEP about "higher" markers implying "lower" markers - i.e. "displayed" implies "received". Still, just a single marker is tracked and synthesized at all times (the one configured with muc_marker_name).
author Matthew Wild <mwild1@gmail.com>
date Tue, 07 Jul 2020 17:08:08 +0100
parents 3aa5419e3576
children db75772afb28
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3342
3aa5419e3576 mod_bob: Add this new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
1 ---
3aa5419e3576 mod_bob: Add this new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
2 summary: Cache Bits of Binary on MUC services
3aa5419e3576 mod_bob: Add this new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
3 ---
3aa5419e3576 mod_bob: Add this new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
4
3aa5419e3576 mod_bob: Add this new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
5 Description
3aa5419e3576 mod_bob: Add this new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
6 ===========
3aa5419e3576 mod_bob: Add this new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
7
3aa5419e3576 mod_bob: Add this new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
8 This module extracts cid: URIs (as defined in XEP-0231) from messages, and
3aa5419e3576 mod_bob: Add this new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
9 replies with their content whenever another client asks for the actual data.
3aa5419e3576 mod_bob: Add this new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
10
3aa5419e3576 mod_bob: Add this new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
11 Usage
3aa5419e3576 mod_bob: Add this new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
12 =====
3aa5419e3576 mod_bob: Add this new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
13
3aa5419e3576 mod_bob: Add this new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
14 ```lua
3aa5419e3576 mod_bob: Add this new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
15 Component "rooms.example.org" "muc"
3aa5419e3576 mod_bob: Add this new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
16 modules_enabled = {
3aa5419e3576 mod_bob: Add this new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
17 "bob";
3aa5419e3576 mod_bob: Add this new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
18 ...
3aa5419e3576 mod_bob: Add this new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
19 }
3aa5419e3576 mod_bob: Add this new module.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
20 ```