mirror of
https://github.com/moparisthebest/xeps
synced 2024-11-24 10:12:19 -05:00
Merge branch 'xep-0449' into premerge
This commit is contained in:
Jonas Schäfer
commit
17f235c3da
30
xep-0449.xml
30
xep-0449.xml
@ -1,12 +1,5 @@
|
||||
<?xml version='1.0' encoding='UTF-8'?>
|
||||
<!--
|
||||
Note to editor:
|
||||
- Remove xep-sfs entity declared below and change all references from &xep-sfs; to respective &xepXXXX; to refeence sfs when moving to experimental.
|
||||
- Remove xep-file-metadata entity declared below and change all references from &xep-file-metadata; to respective &xepXXXX; to refeence file metadata when moving to experimental.
|
||||
-->
|
||||
<!DOCTYPE xep SYSTEM 'xep.dtd' [
|
||||
<!ENTITY xep-file-metadata "<span class='ref'><link url='./file-metadata.html'>File metadata element (XEP-xxxx)</link></span> <note>XEP-xxxx: File metadata element <<link url='./file-metadata.html'>https://xmpp.org/extensions/inbox/file-metadata.html</link>>.</note>" >
|
||||
<!ENTITY xep-sfs "<span class='ref'><link url='./sfs.html'>Stateless file sharing (XEP-xxxx)</link></span> <note>XEP-xxxx: Stateless file sharing <<link url='./sfs.html'>https://xmpp.org/extensions/inbox/sfs.html</link>>.</note>" >
|
||||
<!ENTITY % ents SYSTEM 'xep.ent'>
|
||||
%ents;
|
||||
<!ENTITY sepl4 "0x1f (ASCII Unit Separator)">
|
||||
@ -33,6 +26,17 @@ Note to editor:
|
||||
<supersededby/>
|
||||
<shortname>stickers</shortname>
|
||||
&larma;
|
||||
<revision>
|
||||
<version>0.1.1</version>
|
||||
<date>2022-02-10</date>
|
||||
<initials>egp</initials>
|
||||
<remark>
|
||||
<ul>
|
||||
<li>Replace ProtoXEP references with actual XEP references.</li>
|
||||
<li>Use XEP-0446’s <tt><descriptions/></tt> instead of the typo’d <tt><description/></tt>.</li>
|
||||
</ul>
|
||||
</remark>
|
||||
</revision>
|
||||
<revision>
|
||||
<version>0.1.0</version>
|
||||
<date>2020-11-24</date>
|
||||
@ -82,7 +86,7 @@ Note to editor:
|
||||
The <tt><pack/></tt> element MAY include a <tt><restricted/></tt> element to indicate that this sticker pack may not be used or imported by other users.
|
||||
</p>
|
||||
<p>
|
||||
The <tt><pack/></tt> element contains one or more <tt><item/></tt> elements that include details on the stickers in the pack. Each <tt><item/></tt> element has <tt><file/></tt> element as described in &xep-file-metadata;. The metadata MUST include one or multiple <tt><hash/></tt> elements as described in &xep0300;. All stickers in a pack MUST use the same algorithm for their <tt><hash/></tt> elements. The metadata MUST include one <tt><desc/></tt> element that is not qualified by a <tt>xml:lang</tt> attribute and describes the textual fallback (often an emoji or a sequence of emojis) of the sticker. Each <tt><item/></tt> element further has a <tt><sources/></tt> element as described in &xep-sfs; describing how to retrieve the image file of the sticker. Each <tt><item/></tt> element MAY include one or more <tt><suggest/></tt> elements that include a text that clients may replace with the sticker. <tt><suggest/></tt> elements MAY have an <tt>xml:lang</tt> attribute.
|
||||
The <tt><pack/></tt> element contains one or more <tt><item/></tt> elements that include details on the stickers in the pack. Each <tt><item/></tt> element has <tt><file/></tt> element as described in &xep0446;. The metadata MUST include one or multiple <tt><hash/></tt> elements as described in &xep0300;. All stickers in a pack MUST use the same algorithm for their <tt><hash/></tt> elements. The metadata MUST include one <tt><desc/></tt> element that is not qualified by a <tt>xml:lang</tt> attribute and describes the textual fallback (often an emoji or a sequence of emojis) of the sticker. Each <tt><item/></tt> element further has a <tt><sources/></tt> element as described in &xep0447; describing how to retrieve the image file of the sticker. Each <tt><item/></tt> element MAY include one or more <tt><suggest/></tt> elements that include a text that clients may replace with the sticker. <tt><suggest/></tt> elements MAY have an <tt>xml:lang</tt> attribute.
|
||||
</p>
|
||||
<p>
|
||||
Finally, the <tt><pack/></tt> element includes a single <tt><hash/></tt> element as described in &xep0300;, specifying the hash of the sticker pack. See <link url='#pack-hash'>next section</link> on how such hash is generated.
|
||||
@ -150,7 +154,7 @@ Note to editor:
|
||||
<media-type>image/png</media-type>
|
||||
<desc>👍</desc>
|
||||
<size>71045</size>
|
||||
<dimension>512x512</dimension>
|
||||
<dimensions>512x512</dimensions>
|
||||
<hash xmlns='urn:xmpp:hashes:2' algo='sha-256'>0AdP8lJOWJrugSKOIAqfEKqFatIpG5JBCjjxY253ojQ=</hash>
|
||||
</file>
|
||||
<sources xmlns='urn:xmpp:sfs:0'>
|
||||
@ -163,7 +167,7 @@ Note to editor:
|
||||
<media-type>image/png</media-type>
|
||||
<desc>😘</desc>
|
||||
<size>67016</size>
|
||||
<dimension>512x512</dimension>
|
||||
<dimensions>512x512</dimensions>
|
||||
<hash xmlns='urn:xmpp:hashes:2' algo='sha-256'>gw+6xdCgOcvCYSKuQNrXH33lV9NMzuDf/s0huByCDsY=</hash>
|
||||
</file>
|
||||
<sources xmlns='urn:xmpp:sfs:0'>
|
||||
@ -180,7 +184,7 @@ Note to editor:
|
||||
]]></example>
|
||||
</section2>
|
||||
<section2 topic='Sending a sticker' anchor='send'>
|
||||
<p>The sending entity uses &xep-sfs; to send the image file from the sticker pack. The <tt><item/></tt>'s <tt><file/></tt> and <tt><sources/></tt> elements from the sticker pack are used as a template. The sending entity MAY add additional <tt><hash/></tt> elements or sources.</p>
|
||||
<p>The sending entity uses &xep0447; to send the image file from the sticker pack. The <tt><item/></tt>'s <tt><file/></tt> and <tt><sources/></tt> elements from the sticker pack are used as a template. The sending entity MAY add additional <tt><hash/></tt> elements or sources.</p>
|
||||
<p>Additionally, the sending entity adds an element <tt><sticker/></tt> to the message. This element carries an attribute <tt>pack</tt> referring to the id of the pubsub item carrying the sticker pack. If the sticker pack resides on a pubsub item other than the senders personal eventing (PEP) node named "urn:xmpp:stickers:0", the sending entity must add additional attributes <tt>jid</tt> and <tt>node</tt>, referring to the jid of the pubsub node and the name of the node, respectively.</p>
|
||||
<p>The sending entity SHOULD use the <tt><file/></tt>'s <tt><desc/></tt> content as the message body, except if the sticker was selected based on a suggestion, in which case the content of the corresponding <tt><suggest/></tt> SHOULD be used.</p>
|
||||
<example caption='Sending a sticker'><![CDATA[
|
||||
@ -192,7 +196,7 @@ Note to editor:
|
||||
<media-type>image/png</media-type>
|
||||
<desc>😘</desc>
|
||||
<size>67016</size>
|
||||
<dimension>512x512</dimension>
|
||||
<dimensions>512x512</dimensions>
|
||||
<hash xmlns='urn:xmpp:hashes:2' algo='sha-256'>gw+6xdCgOcvCYSKuQNrXH33lV9NMzuDf/s0huByCDsY=</hash>
|
||||
</file>
|
||||
<sources>
|
||||
@ -221,7 +225,7 @@ Note to editor:
|
||||
</section1>
|
||||
<section1 topic='Security Considerations' anchor='security'>
|
||||
<p>
|
||||
The security considerations of &xep-sfs; apply.
|
||||
The security considerations of &xep0447; apply.
|
||||
</p>
|
||||
</section1>
|
||||
<section1 topic='IANA Considerations' anchor='iana'>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user