annotate mod_pep_vcard_avatar/README.markdown @ 5907:d194d1012fd3

Updating dox for mod_rest. Ideas expressed / clarified: 1) Making clear that mod_rest isn't to be installed under VirtualHosts AND as a component. 2) Understanding some of the implications of this choice: A) Changes to user authentication B) How it affects subdomains 3) More consistent use of domain names for clarity. 4) Using different heading sizes to show scope of section. Essentially, I added all the tidbits I had to clarify in getting this to work in my own example.
author Ben Smith <bens@effortlessis.com>
date Mon, 13 May 2024 13:25:13 -0700
parents 41dd405efb5a
children
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:
diff changeset
1 ---
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
2 labels:
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
3 - 'Stage-Alpha'
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
4 summary: Sync avatars between vCards and PEP
3179
84f50531a192 mod_pep_vcard_avatar: Normalize syntax in README
Kim Alvefur <zash@zash.se>
parents: 3178
diff changeset
5 ---
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
6
3179
84f50531a192 mod_pep_vcard_avatar: Normalize syntax in README
Kim Alvefur <zash@zash.se>
parents: 3178
diff changeset
7 ## Introduction
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
8
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
9 This module pushes the users nickname and avatar from vCards into PEP,
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
10 or into vCards from PEP. This allows interop between older clients that
3179
84f50531a192 mod_pep_vcard_avatar: Normalize syntax in README
Kim Alvefur <zash@zash.se>
parents: 3178
diff changeset
11 use [XEP-0153: vCard-Based Avatars] to see the avatars of clients that
84f50531a192 mod_pep_vcard_avatar: Normalize syntax in README
Kim Alvefur <zash@zash.se>
parents: 3178
diff changeset
12 use [XEP-0084: User Avatar] and vice versa.
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
13
3178
bd28da2f813c mod_pep_vcard_avatar: Mention XEP-398
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
14 Also see [XEP-0398: User Avatar to vCard-Based Avatars Conversion].
bd28da2f813c mod_pep_vcard_avatar: Mention XEP-398
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
15
3179
84f50531a192 mod_pep_vcard_avatar: Normalize syntax in README
Kim Alvefur <zash@zash.se>
parents: 3178
diff changeset
16 ## Configuration
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
17
3179
84f50531a192 mod_pep_vcard_avatar: Normalize syntax in README
Kim Alvefur <zash@zash.se>
parents: 3178
diff changeset
18 Simply [enable it like most other modules][doc:installing_modules#prosody-modules],
84f50531a192 mod_pep_vcard_avatar: Normalize syntax in README
Kim Alvefur <zash@zash.se>
parents: 3178
diff changeset
19 no further configuration needed.
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
20
3179
84f50531a192 mod_pep_vcard_avatar: Normalize syntax in README
Kim Alvefur <zash@zash.se>
parents: 3178
diff changeset
21 ## Compatibility
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
22
3421
41dd405efb5a mod_pep_vcard_avatar: Update docs to point at mod_vcard_legacy
Kim Alvefur <zash@zash.se>
parents: 3215
diff changeset
23 ------- --------------------------------
41dd405efb5a mod_pep_vcard_avatar: Update docs to point at mod_vcard_legacy
Kim Alvefur <zash@zash.se>
parents: 3215
diff changeset
24 trunk Use mod\_vcard\_legacy instead
41dd405efb5a mod_pep_vcard_avatar: Update docs to point at mod_vcard_legacy
Kim Alvefur <zash@zash.se>
parents: 3215
diff changeset
25 0.11 Use mod\_vcard\_legacy instead
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
26 0.10 Works
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
27 0.9 Does not work
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
diff changeset
28 0.8 Does not work
3421
41dd405efb5a mod_pep_vcard_avatar: Update docs to point at mod_vcard_legacy
Kim Alvefur <zash@zash.se>
parents: 3215
diff changeset
29 ------- --------------------------------