annotate mod_pep_vcard_png_avatar/README.markdown @ 2323:35ae59a8196d

Add some documentation stubs
author Kim Alvefur <zash@zash.se>
date Sat, 01 Oct 2016 20:34:43 +0200
parents 0ca0fdad3b2c
children 557dc366838e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2218
0ca0fdad3b2c mod_pep_vcard_png_avatar: Add a README
Michel Le Bihan <michel@lebihan.pl>
parents:
diff changeset
1 Introduction
0ca0fdad3b2c mod_pep_vcard_png_avatar: Add a README
Michel Le Bihan <michel@lebihan.pl>
parents:
diff changeset
2 ============
0ca0fdad3b2c mod_pep_vcard_png_avatar: Add a README
Michel Le Bihan <michel@lebihan.pl>
parents:
diff changeset
3
0ca0fdad3b2c mod_pep_vcard_png_avatar: Add a README
Michel Le Bihan <michel@lebihan.pl>
parents:
diff changeset
4 Conversations (an XMPP client for Android) is publishing PEP avatars in the webp file format. However Pidgin and other XMPP desktop clients can only show vcard avatars, that are in the PNG file format. This module is the [mod_pep_vcard_avatar](https://modules.prosody.im/mod_pep_vcard_avatar.html) module extended to also change the avatar file format to PNG.
0ca0fdad3b2c mod_pep_vcard_png_avatar: Add a README
Michel Le Bihan <michel@lebihan.pl>
parents:
diff changeset
5
0ca0fdad3b2c mod_pep_vcard_png_avatar: Add a README
Michel Le Bihan <michel@lebihan.pl>
parents:
diff changeset
6 Configuration
0ca0fdad3b2c mod_pep_vcard_png_avatar: Add a README
Michel Le Bihan <michel@lebihan.pl>
parents:
diff changeset
7 =============
0ca0fdad3b2c mod_pep_vcard_png_avatar: Add a README
Michel Le Bihan <michel@lebihan.pl>
parents:
diff changeset
8
0ca0fdad3b2c mod_pep_vcard_png_avatar: Add a README
Michel Le Bihan <michel@lebihan.pl>
parents:
diff changeset
9 Enable the module as any other:
0ca0fdad3b2c mod_pep_vcard_png_avatar: Add a README
Michel Le Bihan <michel@lebihan.pl>
parents:
diff changeset
10
0ca0fdad3b2c mod_pep_vcard_png_avatar: Add a README
Michel Le Bihan <michel@lebihan.pl>
parents:
diff changeset
11 modules_enabled = {
0ca0fdad3b2c mod_pep_vcard_png_avatar: Add a README
Michel Le Bihan <michel@lebihan.pl>
parents:
diff changeset
12 "mod_pep_vcard_png_avatar";
0ca0fdad3b2c mod_pep_vcard_png_avatar: Add a README
Michel Le Bihan <michel@lebihan.pl>
parents:
diff changeset
13 }
0ca0fdad3b2c mod_pep_vcard_png_avatar: Add a README
Michel Le Bihan <michel@lebihan.pl>
parents:
diff changeset
14
0ca0fdad3b2c mod_pep_vcard_png_avatar: Add a README
Michel Le Bihan <michel@lebihan.pl>
parents:
diff changeset
15 You MUSTN'T load mod\_pep\_vcard\_avatar if this module is loaded.
0ca0fdad3b2c mod_pep_vcard_png_avatar: Add a README
Michel Le Bihan <michel@lebihan.pl>
parents:
diff changeset
16
0ca0fdad3b2c mod_pep_vcard_png_avatar: Add a README
Michel Le Bihan <michel@lebihan.pl>
parents:
diff changeset
17 Compatibility
0ca0fdad3b2c mod_pep_vcard_png_avatar: Add a README
Michel Le Bihan <michel@lebihan.pl>
parents:
diff changeset
18 =============
0ca0fdad3b2c mod_pep_vcard_png_avatar: Add a README
Michel Le Bihan <michel@lebihan.pl>
parents:
diff changeset
19
0ca0fdad3b2c mod_pep_vcard_png_avatar: Add a README
Michel Le Bihan <michel@lebihan.pl>
parents:
diff changeset
20 ----- -------------
0ca0fdad3b2c mod_pep_vcard_png_avatar: Add a README
Michel Le Bihan <michel@lebihan.pl>
parents:
diff changeset
21 trunk Works
0ca0fdad3b2c mod_pep_vcard_png_avatar: Add a README
Michel Le Bihan <michel@lebihan.pl>
parents:
diff changeset
22 0.10 Should work
0ca0fdad3b2c mod_pep_vcard_png_avatar: Add a README
Michel Le Bihan <michel@lebihan.pl>
parents:
diff changeset
23 0.9 Should work
0ca0fdad3b2c mod_pep_vcard_png_avatar: Add a README
Michel Le Bihan <michel@lebihan.pl>
parents:
diff changeset
24 ----- -------------
0ca0fdad3b2c mod_pep_vcard_png_avatar: Add a README
Michel Le Bihan <michel@lebihan.pl>
parents:
diff changeset
25
0ca0fdad3b2c mod_pep_vcard_png_avatar: Add a README
Michel Le Bihan <michel@lebihan.pl>
parents:
diff changeset
26