mirror of
https://github.com/moparisthebest/xeps
synced 2024-11-21 16:55:07 -05:00
Ensure examples use .example
This commit is contained in:
Steve Kille
parent
f9d7d56b87
commit
fa14d86332
124
xep-0369.xml
124
xep-0369.xml
@ -52,8 +52,8 @@
|
||||
Creating Channel Clarification,
|
||||
Address security concerns on Converting a 1:1 Conversation to a Channel,
|
||||
Remove requirement for all user clients to support MIX,
|
||||
Change Retract to use MAM-ID,
|
||||
|
||||
Change Retract to use MAM-ID;
|
||||
Ensure use of .example throughout (follow RFC conventions);
|
||||
</p></remark>
|
||||
</revision> <revision>
|
||||
<version>0.9.3</version>
|
||||
@ -621,7 +621,7 @@ This approach enables flexible support of multiple clients for a MIX channel pa
|
||||
the three witches meet</value>
|
||||
</field>
|
||||
<field var='Contact'>
|
||||
<value>greymalkin@shakespeare.lit</value>
|
||||
<value>greymalkin@shakespeare.example</value>
|
||||
</field>
|
||||
<field var='JID Visibility'>
|
||||
<value>jid-visible</value>
|
||||
@ -638,8 +638,8 @@ This approach enables flexible support of multiple clients for a MIX channel pa
|
||||
</p>
|
||||
<example caption="Allowed Node"><![CDATA[
|
||||
<items node='urn:xmpp:mix:nodes:allowed'>
|
||||
<item id='shakespeare.lit'/>
|
||||
<item id='alice@wonderland.lit'/>
|
||||
<item id='shakespeare.example'/>
|
||||
<item id='alice@wonderland.example'/>
|
||||
</items>
|
||||
]]></example>
|
||||
</section3>
|
||||
@ -649,8 +649,8 @@ This approach enables flexible support of multiple clients for a MIX channel pa
|
||||
</p>
|
||||
<example caption="Banned Node"><![CDATA[
|
||||
<items node='urn:xmpp:mix:nodes:banned'>
|
||||
<item id='lear@shakespeare.lit'/>
|
||||
<item id='macbeth@shakespeare.lit'/>
|
||||
<item id='lear@shakespeare.example'/>
|
||||
<item id='macbeth@shakespeare.example'/>
|
||||
</items>
|
||||
]]></example>
|
||||
</section3>
|
||||
@ -694,10 +694,10 @@ This approach enables flexible support of multiple clients for a MIX channel pa
|
||||
<value>urn:xmpp:mix:1</value>
|
||||
</field>
|
||||
<field var='Owner'>
|
||||
<value>hecate@shakespeare.lit</value>
|
||||
<value>hecate@shakespeare.example</value>
|
||||
</field>
|
||||
<field var='Owner'>
|
||||
<value>greymalkin@shakespeare.lit</value>
|
||||
<value>greymalkin@shakespeare.example</value>
|
||||
</field>
|
||||
<field var='Messages Node Subscription'>
|
||||
<value>allowed</value>
|
||||
@ -794,13 +794,13 @@ This approach enables flexible support of multiple clients for a MIX channel pa
|
||||
<example caption='Client Queries for Channels on MIX Service'><![CDATA[
|
||||
<iq from='hag66@shakespeare.example/UUID-c8y/1573'
|
||||
id='kl2fax27'
|
||||
to='mix.shakespeare.lit'
|
||||
to='mix.shakespeare.example'
|
||||
type='get'>
|
||||
<query xmlns='http://jabber.org/protocol/disco#items'/>
|
||||
</iq>
|
||||
]]></example>
|
||||
<example caption='MIX Service Returns Disco Items Result'><![CDATA[
|
||||
<iq from='mix.shakespeare.lit'
|
||||
<iq from='mix.shakespeare.example'
|
||||
id='kl2fax27'
|
||||
to='hag66@shakespeare.example/UUID-c8y/1573'
|
||||
type='result'>
|
||||
@ -817,14 +817,14 @@ This approach enables flexible support of multiple clients for a MIX channel pa
|
||||
<example caption='Entity Queries for Information about a Specific Channel'><![CDATA[
|
||||
<iq from='hag66@shakespeare.example/UUID-c8y/1573'
|
||||
id='ik3vs715'
|
||||
to='coven@mix.shakespeare.lit'
|
||||
to='coven@mix.shakespeare.example'
|
||||
type='get'>
|
||||
<query xmlns='http://jabber.org/protocol/disco#info' node='mix'/>
|
||||
</iq>
|
||||
]]></example>
|
||||
<p>If the querying user is allowed to subscribe, the channel MUST return its identity and the features it supports. Note that a MIX channel MUST support MAM and so the response will always include both MIX and MAM support. All disco queries on a MIX channel and results returned MUST include the attribute node='mix'. The reason for this is to facilitate MIX channels and &xep0045; MUC rooms sharing the same JID. This extra parameter will enable a server to return appropriate information.</p>
|
||||
<example caption='Channel Returns Disco Info Result'><![CDATA[
|
||||
<iq from='coven@mix.shakespeare.lit'
|
||||
<iq from='coven@mix.shakespeare.example'
|
||||
id='ik3vs715'
|
||||
to='hag66@shakespeare.example/UUID-c8y/1573'
|
||||
type='result'>
|
||||
@ -844,13 +844,13 @@ This approach enables flexible support of multiple clients for a MIX channel pa
|
||||
<example caption='Entity Queries for Nodes at a Channel'><![CDATA[
|
||||
<iq from='hag66@shakespeare.example/UUID-c8y/1573'
|
||||
id='kl2fax27'
|
||||
to='coven@mix.shakespeare.lit'
|
||||
to='coven@mix.shakespeare.example'
|
||||
type='get'>
|
||||
<query xmlns='http://jabber.org/protocol/disco#items'/ node='mix'>
|
||||
</iq>
|
||||
]]></example>
|
||||
<example caption='Channel Returns Disco Items Result'><![CDATA[
|
||||
<iq from='coven@mix.shakespeare.lit'
|
||||
<iq from='coven@mix.shakespeare.example'
|
||||
id='kl2fax27'
|
||||
to='hag66@shakespeare.example/UUID-c8y/1573'
|
||||
type='result'>
|
||||
@ -872,7 +872,7 @@ This approach enables flexible support of multiple clients for a MIX channel pa
|
||||
<example caption='Client Requests Channel Information'><![CDATA[
|
||||
<iq from='hag66@shakespeare.example/UUID-c8y/1573'
|
||||
id='kl2fax27'
|
||||
to='coven@mix.shakespeare.lit'
|
||||
to='coven@mix.shakespeare.example'
|
||||
type='get'>
|
||||
<pubsub xlns='http://jabber.org/protocol/pubsub'>
|
||||
<items node='urn:xmpp:mix:nodes:info'/>
|
||||
@ -880,7 +880,7 @@ This approach enables flexible support of multiple clients for a MIX channel pa
|
||||
</iq>
|
||||
]]></example>
|
||||
<example caption='MIX Service Returns Channel Information'><![CDATA[
|
||||
<iq from='coven@mix.shakespeare.lit'
|
||||
<iq from='coven@mix.shakespeare.example'
|
||||
id='kl2fax27'
|
||||
to='hag66@shakespeare.example/UUID-c8y/1573'
|
||||
type='result'>
|
||||
@ -900,7 +900,7 @@ This approach enables flexible support of multiple clients for a MIX channel pa
|
||||
the three witches meet</value>
|
||||
</field>
|
||||
<field var='Contact'>
|
||||
<value>greymalkin@shakespeare.lit</value>
|
||||
<value>greymalkin@shakespeare.example</value>
|
||||
</field>
|
||||
</x>
|
||||
</item>
|
||||
@ -915,7 +915,7 @@ This approach enables flexible support of multiple clients for a MIX channel pa
|
||||
<example caption='User's Client Requests Participant List'><![CDATA[
|
||||
<iq from='hag66@shakespeare.example/UUID-c8y/1573'
|
||||
id='kl2fax27'
|
||||
to='coven@mix.shakespeare.lit'
|
||||
to='coven@mix.shakespeare.example'
|
||||
type='get'>
|
||||
<pubsub xlns='http://jabber.org/protocol/pubsub'>
|
||||
<items node='urn:xmpp:mix:nodes:participants'/>
|
||||
@ -923,7 +923,7 @@ This approach enables flexible support of multiple clients for a MIX channel pa
|
||||
</iq>
|
||||
]]></example>
|
||||
<example caption='MIX Service Returns Participant List'><![CDATA[
|
||||
<iq from='coven@mix.shakespeare.lit'
|
||||
<iq from='coven@mix.shakespeare.example'
|
||||
id='kl2fax27'
|
||||
to='hag66@shakespeare.example/UUID-c8y/1573'
|
||||
type='result'>
|
||||
@ -953,17 +953,17 @@ This approach enables flexible support of multiple clients for a MIX channel pa
|
||||
Where a client supports MIX, it MUST advertise this capability in response to a Disco request. This will enable other entities to determine if a client supports MIX, and in particular it facilitates the client's server to determine client support. This can be optimized by use of CAPS. The following example shows a Disco request to and response from a client that supports both MIX and MUC.
|
||||
</p>
|
||||
<example caption='Disco Query for MIX support'><![CDATA[
|
||||
<iq from='juliet@capulet.lit/UUID-e3r/9264'
|
||||
<iq from='juliet@capulet.example/UUID-e3r/9264'
|
||||
id='d1rt87mr4w'
|
||||
to='romeo@montague.lit/UUID-m2t/3945'
|
||||
to='romeo@montague.example/UUID-m2t/3945'
|
||||
type='get'>
|
||||
<query xmlns='http://jabber.org/protocol/disco#info'/>
|
||||
</iq>
|
||||
|
||||
|
||||
<iq from='romeo@montague.lit/UUID-m2t/3945'
|
||||
<iq from='romeo@montague.example/UUID-m2t/3945'
|
||||
id='d1rt87mr4w'
|
||||
to='juliet@capulet.lit/UUID-e3r/9264'
|
||||
to='juliet@capulet.example/UUID-e3r/9264'
|
||||
type='result'>
|
||||
<query xmlns='http://jabber.org/protocol/disco#info'>
|
||||
<feature var='http://jabber.org/protocol/caps'/>
|
||||
@ -1566,7 +1566,7 @@ This approach enables flexible support of multiple clients for a MIX channel pa
|
||||
<example caption='Client looks up Real JID from Proxy JID'><![CDATA[
|
||||
<iq from='hag66@shakespeare.example/UUID-c8y/1573'
|
||||
id='kl2fax27'
|
||||
to='coven@mix.shakespeare.lit'
|
||||
to='coven@mix.shakespeare.example'
|
||||
type='get'>
|
||||
<pubsub xlns='http://jabber.org/protocol/pubsub'>
|
||||
<items node='urn:xmpp:mix:nodes:jidmap'>
|
||||
@ -1575,7 +1575,7 @@ This approach enables flexible support of multiple clients for a MIX channel pa
|
||||
</pubsub>
|
||||
</iq>
|
||||
|
||||
<iq from='coven@mix.shakespeare.lit'
|
||||
<iq from='coven@mix.shakespeare.example'
|
||||
id='kl2fax27'
|
||||
to='hag66@shakespeare.example/UUID-c8y/1573'
|
||||
type='result'>
|
||||
@ -1600,7 +1600,7 @@ This approach enables flexible support of multiple clients for a MIX channel pa
|
||||
<example caption='Client looks up Real JID from Proxy JID in MAM Archive'><![CDATA[
|
||||
<iq from='hag66@shakespeare.example/UUID-c8y/1573'
|
||||
id='kl2fax27'
|
||||
to='coven@mix.shakespeare.lit'
|
||||
to='coven@mix.shakespeare.example'
|
||||
type='set'>
|
||||
<query xlns='urn:xmpp:mam:2'
|
||||
queryid='f28'
|
||||
@ -1635,7 +1635,7 @@ This approach enables flexible support of multiple clients for a MIX channel pa
|
||||
</result>
|
||||
</message>
|
||||
|
||||
<iq from='coven@mix.shakespeare.lit'
|
||||
<iq from='coven@mix.shakespeare.example'
|
||||
to='hag66@shakespeare.example/UUID-c8y/1573'
|
||||
id='kl2fax27'
|
||||
type='result'>
|
||||
@ -1781,12 +1781,12 @@ This approach enables flexible support of multiple clients for a MIX channel pa
|
||||
With this approach, the original message <body> is removed and replaced with a tombstone using the <retracted> element qualified by the 'urn:xmpp:mix:1' namespace that shows the JID of user performing the retraction and the time of the retraction.
|
||||
</p>
|
||||
<example caption="Retracted message tombstone in a MAM result"><![CDATA[
|
||||
<message id='aeb213' to='juliet@capulet.lit/UUID-e3r/9264'>
|
||||
<message id='aeb213' to='juliet@capulet.example/UUID-e3r/9264'>
|
||||
<result xmlns='urn:xmpp:mam:1' queryid='f27' id='28482-98726-73623'>
|
||||
<forwarded xmlns='urn:xmpp:forward:0'>
|
||||
<delay xmlns='urn:xmpp:delay' stamp='2010-07-10T23:08:25Z'/>
|
||||
<message xmlns='jabber:client' from="hag66@shakespeare.example"
|
||||
to="macbeth@shakespeare.lit">
|
||||
to="macbeth@shakespeare.example">
|
||||
<retracted xmlns='urn:xmpp:mix:1' by='hag66@shakespeare.example'
|
||||
time='2010-07-10T23:08:25Z'/>
|
||||
</message>
|
||||
@ -1818,25 +1818,25 @@ This approach enables flexible support of multiple clients for a MIX channel pa
|
||||
The first step is for the inviter to request an invitation from the channel. The invitation contains inviter, invitee and a token. The channel will evaluate if the inviter has rights to issue the invitation. This will be because the inviter is a channel administrator or if the inviter is a channel participant and the channel allows invitation by participants. If the inviter has rights to make the invitation, the channel will return a token. The token is a string that the channel can subsequently use to validate an invitation. The format of the token is not specified in this standard. The encoded token MAY reflect a validity time. The invitation request is encoded as an <invite/> child element of an <iq/> element. The <invite/> element is qualified by the 'urn:xmpp:mix:1' namespace. <invite/> contains an <invitation/> child element, which contain <inviter/>, <invitee/>, <channel/> and <token/> child elements.
|
||||
</p>
|
||||
<example caption='Inviter Requests and Receives Invitation'><![CDATA[
|
||||
<iq from='hag66@shakespeare.lit/UUID-h5z/0253'
|
||||
<iq from='hag66@shakespeare.example/UUID-h5z/0253'
|
||||
id='kl2fax27'
|
||||
to='coven@mix.shakespeare.lit'
|
||||
to='coven@mix.shakespeare.example'
|
||||
type='get'>
|
||||
<invite xmlns='urn:xmpp:mix:1'>
|
||||
<invitee>cat@shakespeare.lit</invitee>
|
||||
<invitee>cat@shakespeare.example</invitee>
|
||||
</invite>
|
||||
</iq>
|
||||
|
||||
|
||||
<iq from='coven@mix.shakespeare.lit'
|
||||
<iq from='coven@mix.shakespeare.example'
|
||||
id='kl2fax27'
|
||||
to='hag66@shakespeare.lit/UUID-h5z/0253'
|
||||
to='hag66@shakespeare.example/UUID-h5z/0253'
|
||||
type='result'>
|
||||
<invite xmlns='urn:xmpp:mix:1'>
|
||||
<invitation>
|
||||
<inviter>hag66@shakespeare.lit</inviter>
|
||||
<invitee>cat@shakespeare.lit</invitee>
|
||||
<channel>coven@mix.shakespeare.lit</channel>
|
||||
<inviter>hag66@shakespeare.example</inviter>
|
||||
<invitee>cat@shakespeare.example</invitee>
|
||||
<channel>coven@mix.shakespeare.example</channel>
|
||||
<token>ABCDEF</token>
|
||||
</invitation>
|
||||
<invite/>
|
||||
@ -1846,14 +1846,14 @@ This approach enables flexible support of multiple clients for a MIX channel pa
|
||||
The inviter can now send the invitee a message containing the invitation within the <message/> element, as shown in the following example.
|
||||
</p>
|
||||
<example caption='Inviter sends Invitation to Invitee'><![CDATA[
|
||||
<message from='hag66@shakespeare.lit/UUID-h5z/0253'
|
||||
<message from='hag66@shakespeare.example/UUID-h5z/0253'
|
||||
id='f5pp2toz'
|
||||
to='cat@shakespeare.lit'>
|
||||
to='cat@shakespeare.example'>
|
||||
<body>Would you like to join the coven?<body>
|
||||
<invitation xmlns='urn:xmpp:mix:1'>
|
||||
<inviter>hag66@shakespeare.lit</inviter>
|
||||
<invitee>cat@shakespeare.lit</invitee>
|
||||
<channel>coven@mix.shakespeare.lit</channel>
|
||||
<inviter>hag66@shakespeare.example</inviter>
|
||||
<invitee>cat@shakespeare.example</invitee>
|
||||
<channel>coven@mix.shakespeare.example</channel>
|
||||
<token>ABCDEF</token>
|
||||
</invitation>
|
||||
</iq>
|
||||
@ -1867,9 +1867,9 @@ This approach enables flexible support of multiple clients for a MIX channel pa
|
||||
<join xmlns='urn:xmpp:mix:1'>
|
||||
<subscribe node='urn:xmpp:mix:nodes:messages'/>
|
||||
<invitation>
|
||||
<inviter>hag66@shakespeare.lit</inviter>
|
||||
<invitee>cat@shakespeare.lit</invitee>
|
||||
<channel>coven@mix.shakespeare.lit</channel>
|
||||
<inviter>hag66@shakespeare.example</inviter>
|
||||
<invitee>cat@shakespeare.example</invitee>
|
||||
<channel>coven@mix.shakespeare.example</channel>
|
||||
<token>ABCDEF</token>
|
||||
</invitation>
|
||||
</join>
|
||||
@ -1884,16 +1884,16 @@ This approach enables flexible support of multiple clients for a MIX channel pa
|
||||
<li>'Acknowledged': The invitation is acknowledged, without information on action taken or planned.</li>
|
||||
</ul>
|
||||
<example caption='Invitee sends Acknowledgement to Inviter'><![CDATA[
|
||||
<message from='cat@shakespeare.lit/UUID-l1w/8813'
|
||||
<message from='cat@shakespeare.example/UUID-l1w/8813'
|
||||
id='b6p9llze'
|
||||
to='hag66@shakespeare.lit/UUID-h5z/0253'>
|
||||
to='hag66@shakespeare.example/UUID-h5z/0253'>
|
||||
<body>No Thanks - too busy chasing mice....<body>
|
||||
<invitation-ack xmlns='urn:xmpp:mix:1'>
|
||||
<value>Declined</value>
|
||||
<invitation>
|
||||
<inviter>hag66@shakespeare.lit</inviter>
|
||||
<invitee>cat@shakespeare.lit</invitee>
|
||||
<channel>coven@mix.shakespeare.lit</channel>
|
||||
<inviter>hag66@shakespeare.example</inviter>
|
||||
<invitee>cat@shakespeare.example</invitee>
|
||||
<channel>coven@mix.shakespeare.example</channel>
|
||||
<token>ABCDEF</token>
|
||||
</invitation>
|
||||
</invitation-ack>
|
||||
@ -1936,7 +1936,7 @@ This approach enables flexible support of multiple clients for a MIX channel pa
|
||||
<example caption="Channel passes on vCard request to the User's Server" ><![CDATA[
|
||||
<iq from='123456#coven@mix.shakespeare.example/6789'
|
||||
id='lx09df27'
|
||||
to='peter@shakespeare.lit'
|
||||
to='peter@shakespeare.example'
|
||||
type='get'>
|
||||
<vCard xmlns='vcard-temp'/>
|
||||
</iq>
|
||||
@ -1945,7 +1945,7 @@ This approach enables flexible support of multiple clients for a MIX channel pa
|
||||
The user's server, on behalf of the user, MAY send a response or reject with an error. The user's server will send the vCard back to the channel.
|
||||
</p>
|
||||
<example caption="User's Server sends vCard Response via MIX channel" ><![CDATA[
|
||||
<iq from='peter@shakespeare.lit'
|
||||
<iq from='peter@shakespeare.example'
|
||||
id='lx09df27'
|
||||
to='123456#coven@mix.shakespeare.example/6789'
|
||||
type='result'>
|
||||
@ -2104,8 +2104,8 @@ This approach enables flexible support of multiple clients for a MIX channel pa
|
||||
<value>urn:xmpp:mix:1</value>
|
||||
</field>
|
||||
<field var='Owner'>
|
||||
<value>hecate@shakespeare.lit</value>
|
||||
<value>greymalkin@shakespeare.lit</value>
|
||||
<value>hecate@shakespeare.example</value>
|
||||
<value>greymalkin@shakespeare.example</value>
|
||||
</field>
|
||||
<field var='Messages Node Subscription'>
|
||||
<value>allowed</value>
|
||||
@ -2269,7 +2269,7 @@ This approach enables flexible support of multiple clients for a MIX channel pa
|
||||
the three witches meet</value>
|
||||
</field>
|
||||
<field var='Contact'>
|
||||
<value>greymalkin@shakespeare.lit</value>
|
||||
<value>greymalkin@shakespeare.example</value>
|
||||
</field>
|
||||
</x>
|
||||
</publish>
|
||||
@ -2333,8 +2333,8 @@ This approach enables flexible support of multiple clients for a MIX channel pa
|
||||
<value>urn:xmpp:mix:1</value>
|
||||
</field>
|
||||
<field var='Owner'>
|
||||
<value>hecate@shakespeare.lit</value>
|
||||
<value>greymalkin@shakespeare.lit</value>
|
||||
<value>hecate@shakespeare.example</value>
|
||||
<value>greymalkin@shakespeare.example</value>
|
||||
</field>
|
||||
<field var='Messages Node Subscription'>
|
||||
<value>allowed</value>
|
||||
@ -2383,8 +2383,8 @@ This approach enables flexible support of multiple clients for a MIX channel pa
|
||||
type='result'>
|
||||
<pubsub xmlns='http://jabber.org/protocol/pubsub'>
|
||||
<items node='urn:xmpp:mix:nodes:allowed'>
|
||||
<item id='shakespeare.lit'/>
|
||||
<item id='alice@wonderland.lit'/>
|
||||
<item id='shakespeare.example'/>
|
||||
<item id='alice@wonderland.example'/>
|
||||
</items>
|
||||
</pubsub>
|
||||
</iq>
|
||||
@ -2399,7 +2399,7 @@ This approach enables flexible support of multiple clients for a MIX channel pa
|
||||
type='set'>
|
||||
<pubsub xmlns='http://jabber.org/protocol/pubsub'>
|
||||
<publish node='urn:xmpp:mix:nodes:allowed'>
|
||||
<item id='marlow.lit'/>
|
||||
<item id='marlow.example'/>
|
||||
</items>
|
||||
</pubsub>
|
||||
</iq>
|
||||
@ -2421,7 +2421,7 @@ This approach enables flexible support of multiple clients for a MIX channel pa
|
||||
type='set'>
|
||||
<pubsub xmlns='http://jabber.org/protocol/pubsub'>
|
||||
<retract node='urn:xmpp:mix:nodes:banned'>
|
||||
<item id='lear@shakespeare.lit'/>
|
||||
<item id='lear@shakespeare.example'/>
|
||||
</items>
|
||||
</pubsub>
|
||||
</iq>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user