prosody-modules
e9e41e75c5a0
mod_muc_hats_api/README.markdown

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody-modules

Comparison

mod_muc_hats_api/README.markdown @ 3950:e9e41e75c5a0

mod_muc_hats_*/README: Linkify XEP references
author Kim Alvefur <zash@zash.se>
date Thu, 19 Mar 2020 16:18:36 +0100
parent 3947:1f90e333b1d8
comparison
equal deleted inserted replaced
3949:f02885673215 3950:e9e41e75c5a0
5 # Introduction 5 # Introduction
6 6
7 This module provides an internal API (i.e. to other modules) to manage 7 This module provides an internal API (i.e. to other modules) to manage
8 'hats' for users in MUC rooms. 8 'hats' for users in MUC rooms.
9 9
10 Hats (first defined in XEP-0317, currently deferred) are additional identifiers 10 Hats (first defined in [XEP-0317], currently deferred) are additional identifiers
11 that can be attached to users in a group chat. For example in an educational 11 that can be attached to users in a group chat. For example in an educational
12 context, you may have a 'Teacher' hat that allows students to identify their 12 context, you may have a 'Teacher' hat that allows students to identify their
13 teachers. 13 teachers.
14 14
15 Hats consist of a machine-readable unique identifier (a URI), and optionally 15 Hats consist of a machine-readable unique identifier (a URI), and optionally
16 a human-readable label. 16 a human-readable label.
17 17
18 XEP-0317 suggests a protocol for users to manage their own hats, but though the 18 [XEP-0317] suggests a protocol for users to manage their own hats, but though the
19 API in this module allows for both user-managed and system-managed hats, there is 19 API in this module allows for both user-managed and system-managed hats, there is
20 currently no protocol implemented for users to manage their own hats, which is 20 currently no protocol implemented for users to manage their own hats, which is
21 rarely desired in real-world implementations. 21 rarely desired in real-world implementations.
22 22
23 The rest of this documentation is designed for developers who use this module. 23 The rest of this documentation is designed for developers who use this module.