From ebed317c3b3e7184cf34ec02363b99324c6a415e Mon Sep 17 00:00:00 2001 From: Goffi Date: Wed, 29 Jun 2022 14:23:16 +0200 Subject: [PATCH] doc (components/AP): identity and avatar: fix 368 --- doc/components.rst | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/doc/components.rst b/doc/components.rst index f5dd3a9b..249b26cf 100644 --- a/doc/components.rst +++ b/doc/components.rst @@ -584,6 +584,27 @@ many clients support it, and you can use Libervia CLI to do it from command-line .. _XEP-0191 (Blocking Command): https://xmpp.org/extensions/xep-0191.html +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): https://xmpp.org/extensions/xep-0292.html +.. _XEP-0084 (User Avatar): https://xmpp.org/extensions/xep-0084.html +.. _XEP-0054 (vcard-temp): https://xmpp.org/extensions/xep-0054.html + Using the Component (for developers) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~