annotate mod_profile/README.markdown @ 3296:a1ef6a46841e

mod_muc_badge/README: Add an example
author Kim Alvefur <zash@zash.se>
date Thu, 06 Sep 2018 18:10:44 +0200
parents 1fe5b156d220
children 65dd8ebbd82c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
1 ---
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
2 labels:
2376
f0e611e40e3f mod_profile/README: Set a stage label
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
3 - 'Stage-Alpha'
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
4 summary: 'Replacement for mod\_vcard with vcard4 support and PEP integration'
2376
f0e611e40e3f mod_profile/README: Set a stage label
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
5 ---
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
6
3180
00034d0cc05a mod_profile: Reformat README
Kim Alvefur <zash@zash.se>
parents: 2490
diff changeset
7 # Introduction
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
8
3180
00034d0cc05a mod_profile: Reformat README
Kim Alvefur <zash@zash.se>
parents: 2490
diff changeset
9 This module provides a replacement for [mod\_vcard]. In addition to
00034d0cc05a mod_profile: Reformat README
Kim Alvefur <zash@zash.se>
parents: 2490
diff changeset
10 the ageing protocol defined by [XEP-0054], it also supports the [new
00034d0cc05a mod_profile: Reformat README
Kim Alvefur <zash@zash.se>
parents: 2490
diff changeset
11 vCard 4 based protocol][xep0292] and integrates with [Personal
00034d0cc05a mod_profile: Reformat README
Kim Alvefur <zash@zash.se>
parents: 2490
diff changeset
12 Eventing Protocol][xep0163].
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
13
3186
1fe5b156d220 mod_profile: Add support for XEP-0398
Kim Alvefur <zash@zash.se>
parents: 3180
diff changeset
14 Also supports [XEP-0398: User Avatar to vCard-Based Avatars Conversion].
1fe5b156d220 mod_profile: Add support for XEP-0398
Kim Alvefur <zash@zash.se>
parents: 3180
diff changeset
15
3180
00034d0cc05a mod_profile: Reformat README
Kim Alvefur <zash@zash.se>
parents: 2490
diff changeset
16 The vCard 4, [User Avatar][xep0084] and [User Nickname][xep0172]
00034d0cc05a mod_profile: Reformat README
Kim Alvefur <zash@zash.se>
parents: 2490
diff changeset
17 PEP nodes are updated when the vCard is changed..
00034d0cc05a mod_profile: Reformat README
Kim Alvefur <zash@zash.se>
parents: 2490
diff changeset
18
00034d0cc05a mod_profile: Reformat README
Kim Alvefur <zash@zash.se>
parents: 2490
diff changeset
19 # Configuration
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
20
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
21 modules_enabled = {
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
22 -- "pep"; -- These two modules must be removed
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
23 -- "vcard";
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
24
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
25 "profile";
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
26 }
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
27
3180
00034d0cc05a mod_profile: Reformat README
Kim Alvefur <zash@zash.se>
parents: 2490
diff changeset
28 # Compatibility
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
29
3180
00034d0cc05a mod_profile: Reformat README
Kim Alvefur <zash@zash.se>
parents: 2490
diff changeset
30 Requires Prosody **trunk** as of 2014-05-29. Won't work in 0.10.x.
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
31
3180
00034d0cc05a mod_profile: Reformat README
Kim Alvefur <zash@zash.se>
parents: 2490
diff changeset
32 It depends on the new [mod\_pep\_plus][doc:modules:mod_pep_plus] for PEP support.