changeset 3827:23b53ac87e0f

doc (components/AP): identity and avatar: fix 368
author Goffi <>
date Wed, 29 Jun 2022 14:23:16 +0200
parents 81c79b7cafa7
children 432aaba0d7fe
files doc/components.rst
diffstat 1 files changed, 21 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/doc/components.rst	Wed Jun 29 14:06:33 2022 +0200
+++ b/doc/components.rst	Wed Jun 29 14:23:16 2022 +0200
@@ -584,6 +584,27 @@
 .. _XEP-0191 (Blocking Command):
+Identity and Avatar
+The gateway does the conversion between XMPP identity and AP actor metadata.
+XMPP "identity" is actually a compilaton of data coming from various locations and in
+particular `XEP-0292 (vCard4 Over XMPP)`_. In those data, vCard's ``nickname`` (first
+found) is used as AP ``name`` field, and vCard's ``note`` is used as AP's ``summary``
+(it's generally a self-description of users).
+For avatars, `XEP-0084 (User Avatar)`_ is used (and actor's ``icon`` field is used on AP
+side). Avatars are downloaded the first time that they are requested, and kept in cache
+for future requests.
+Even if XEP-0292 and XEP-0084 are the main XEPs used, Libervia checks various locations,
+and other extensions like `XEP-0054 (vcard-temp)`_ may be used as fallback.
+.. _XEP-0292 (vCard4 Over XMPP):
+.. _XEP-0084 (User Avatar):
+.. _XEP-0054 (vcard-temp):
 Using the Component (for developers)