[Standards] Example Resources in XEPs (XEP-0369)

Georg Lukas georg at op-co.de
Mon Feb 20 09:36:07 UTC 2017


* Jonas Wielicki <jonas at wielicki.name> [2017-02-20 10:20]:
> I feel that using BIND2 resources---albeit this is likely to become the new 
> standard---harms readability a lot. However, I can also see that using 
> examples which do not fit the current standards lead to developers 
> implementing the wrong things, such as clients which encourage the use of 
> descriptive and user-chosen resources.

I think that we need readable examples in the XEPs over anything else.
My suggestion would be to use human-readable, short resource
identifiers, both in the client case and in the auto-generated proxy
case. It is possible to convey the same information in another, indirect
way, that does not harm understanding:

For example:

The full user JID "alice at xmpp.example/client1-uuid" is mapped to the
proxy JID "channel+alice-uuid at mix/uuid-alice-A"

with a footnote or another remark clarifying that the in the examples,
generated UUIDs are replaced with the verbatim string "uuid", and that
actual JIDs will be unreadably-long and hard-to-debug.


Georg
-- 
|| http://op-co.de ++  GCS d--(++) s: a C+++ UL+++ !P L+++ !E W+++ N  ++
|| gpg: 0x962FD2DE ||  o? K- w---() O M V? PS+ PE-- Y++ PGP+ t+ 5 R+  ||
|| Ge0rG: euIRCnet ||  X(+++) tv+ b+(++) DI+++ D- G e++++ h- r++ y?   ||
++ IRCnet OFTC OPN ||_________________________________________________||
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 811 bytes
Desc: Digital signature
URL: <http://mail.jabber.org/pipermail/standards/attachments/20170220/cd9dac7b/attachment.sig>


More information about the Standards mailing list