XEP-0382: Spoiler messages

Abstract: This specification defines an XMPP protocol extension that provides a method for indicating a message is a spoiler and should be displayed as such.
Authors:Severino Ferrer de la Peñita, Xavier Ferrer de la Peñita
Copyright:© 1999 – 2017 XMPP Standards Foundation. SEE LEGAL NOTICES.
Status:Experimental
Type:Standards Track
Version:0.1
Last Updated:2016-12-07

WARNING: This Standards-Track document is Experimental. Publication as an XMPP Extension Protocol does not imply approval of this proposal by the XMPP Standards Foundation. Implementation of the protocol described herein is encouraged in exploratory implementations, but production systems are advised to carefully consider whether it is appropriate to deploy implementations of this protocol before it advances to a status of Draft.


Table of Contents


1. Introduction
2. Discovering support
3. Use Cases
4. Business Rules
5. Security Considerations
6. IANA Considerations
7. XMPP Registrar Considerations
    7.1. Protocol Namespaces
8. XML Schema

Appendices
    A: Document Information
    B: Author Information
    C: Legal Notices
    D: Relation to XMPP
    E: Discussion Venue
    F: Requirements Conformance
    G: Notes
    H: Revision History


1. Introduction

Sometimes, people have the need to send large texts related to the current topic but because of their length, make it hard to follow the conversation (specially on mobile devices). On other occasions, people may want to discuss or just make a little quick comment related to a film or a book in a conversation with multiple people that may or may not know the plot. Also, every now and then, people may want to send a private message (in the sense that people near the receiver must not be able to read) or inline images to someone is known is in a public enviroment like libraries, coffehouses, bars, etc.

This specification defines a way to indicate message's content does not have to be displayed until receiver requests to do so.

2. Discovering support

If a client implements spoiler messages, it MUST specify the 'urn:xmpp:spoiler:0' feature in its service discovery information features as specified in Service Discovery (XEP-0030) [1] and the Entity Capabilities profile specified in Entity Capabilities (XEP-0115) [2].

Example 1. Client requests information about a chat partner's client

<iq from='romeo@montague.net/orchard'
    id='disco1'
    to='juliet@capulet.lit/balcony'
    type='get'>
  <query xmlns='http://jabber.org/protocol/disco#info'/>
</iq>

Example 2. Partner's client advertises support for spoiler messages

<iq to='romeo@montague.net/orchard'
    id='disco1'
    from='juliet@capulet.lit/balcony'
    type='result'>
  <query xmlns='http://jabber.org/protocol/disco#info'>
…
    <feature var='urn:xmpp:spoiler:0'/>
…
  </query>
</iq>

3. Use Cases

Messages user wants to be sent as spoilers, MUST contain a <spoiler> element qualified by the 'urn:xmpp:spoiler:0' namespace and optionally, <spoiler> elements may contain character data as a hint that warns about the topic of the spoiler message. They may also possess the 'xml:lang' attribute.

Example 3. User sends a spoiler message without the hint

<message to='romeo@montague.net/orchard' from='juliet@capulet.net/balcony' id='spoiler1'>
  <body>This is a very long message so I'm going to hide inside a spoiler [...] </body>
  <spoiler xmlns='urn:xmpp:spoiler:0'/>
</message>

Example 4. User sends a spoiler message with the hint

<message to='romeo@montague.net/orchard' from='juliet@capulet.net/balcony' id='spoiler2'>
  <body>And at the end of the story, both of them die! It is so tragic!</body>
  <spoiler xmlns='urn:xmpp:spoiler:0'>Love story end</spoiler>
</message>

Example 5. User sends a spoiler message with the hint in two languages

<message to='romeo@montague.net/orchard' from='juliet@capulet.net/balcony' id='spoiler3'>
  <body>holidays.png</body>
  <spoiler xml:lang='en' xmlns='urn:xmpp:spoiler:0'>Trip to the beach</spoiler>
  <spoiler xml:lang='ca' xmlns='urn:xmpp:spoiler:0'>Viatge a la platja</spoiler>
</message>

Example 6. User sends a spoiler message with the hint and body in two languages

<message to='romeo@montague.net/orchard' from='juliet@capulet.net/balcony' id='spoiler4'>
  <body xml:lang='en'>And at the end of the story, both of them die! It is so tragic!</body>
  <body xml:lang='ca'>I al final de la història, els dos moren! És tan tràgic!</body>
  <spoiler xml:lang='en' xmlns='urn:xmpp:spoiler:0'>Love story end</spoiler>
  <spoiler xml:lang='ca' xmlns='urn:xmpp:spoiler:0'>Fi de la història d'amor</spoiler>
</message>

4. Business Rules

  1. It MUST be clear that a message is in fact a spoiler and its content MUST only be displayed upon user's request.
  2. Clients MAY provide a way to display spoilers always uncovered, without the need of interaction by the user (e.g. in the client's settings).
  3. Clients SHOULD display spoiler's hint, if any, before showing message's content.
  4. Clients MAY display spoiler's hint even after showing message's content (e.g. as a header or title of the message).
  5. Users SHOULD uncover or hide a spoiler message at will, anytime.

5. Security Considerations

This document introduces no additional security considerations above and beyond those defined in the documents on which it depends.

6. IANA Considerations

This document requires no interaction with the Internet Assigned Numbers Authority (IANA) [3].

7. XMPP Registrar Considerations

7.1 Protocol Namespaces

This specification defines the following XML namespace:

Upon advancement of this specification to draft status, the XMPP Registrar [4] shall include the foregoing namespaces in its registry of protocol namespaces <https://xmpp.org/registrar/namespaces.html> and in its disco features registry <https://xmpp.org/registrar/disco-features.html> as defined in Service Discovery (XEP-0030) [1].

Registration

<var>
  <name>urn:xmpp:spoiler:0</name>
  <desc>Indicates that a message's content should not be displayed by default.</desc>
  <doc>0382</doc>
</var>

8. XML Schema

<?xml version='1.0' encoding='UTF-8'?>

<xs:schema
    xmlns:xs='http://www.w3.org/2001/XMLSchema'
    targetNamespace='urn:xmpp:spoiler:0'
    xmlns='urn:xmpp:spoiler:0'
    elementFormDefault='qualified'>

  <xs:element name='spoiler'>
    <xs:complexType>
      <xs:simpleContent>
        <xs:extension base='xs:string'>
          <xs:attribute ref='xml:lang' use='optional'/>
        </xs:extension>
      </xs:simpleContent>
    </xs:complexType>
  </xs:element>


</xs:schema>

Appendices


Appendix A: Document Information

Series: XEP
Number: 0382
Publisher: XMPP Standards Foundation
Status: Experimental
Type: Standards Track
Version: 0.1
Last Updated: 2016-12-07
Approving Body: XMPP Council
Dependencies: XMPP Core
Supersedes: None
Superseded By: None
Short Name: spoilers
Source Control: HTML
This document in other formats: XML  PDF


Appendix B: Author Information

Severino Ferrer de la Peñita

Email: soul@blastersklan.com
JabberID: soul@blastersklan.com

Xavier Ferrer de la Peñita

Email: vaulor@openmailbox.org
JabberID: vaulor@blastersklan.com


Appendix C: Legal Notices

Copyright

This XMPP Extension Protocol is copyright © 1999 – 2017 by the XMPP Standards Foundation (XSF).

Permissions

Permission is hereby granted, free of charge, to any person obtaining a copy of this specification (the "Specification"), to make use of the Specification without restriction, including without limitation the rights to implement the Specification in a software program, deploy the Specification in a network service, and copy, modify, merge, publish, translate, distribute, sublicense, or sell copies of the Specification, and to permit persons to whom the Specification is furnished to do so, subject to the condition that the foregoing copyright notice and this permission notice shall be included in all copies or substantial portions of the Specification. Unless separate permission is granted, modified works that are redistributed shall not contain misleading information regarding the authors, title, number, or publisher of the Specification, and shall not claim endorsement of the modified works by the authors, any organization or project to which the authors belong, or the XMPP Standards Foundation.

Disclaimer of Warranty

## NOTE WELL: This Specification is provided on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. ##

Limitation of Liability

In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall the XMPP Standards Foundation or any author of this Specification be liable for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising from, out of, or in connection with the Specification or the implementation, deployment, or other use of the Specification (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if the XMPP Standards Foundation or such author has been advised of the possibility of such damages.

IPR Conformance

This XMPP Extension Protocol has been contributed in full conformance with the XSF's Intellectual Property Rights Policy (a copy of which can be found at <https://xmpp.org/about/xsf/ipr-policy> or obtained by writing to XMPP Standards Foundation, P.O. Box 787, Parker, CO 80134 USA).

Appendix D: Relation to XMPP

The Extensible Messaging and Presence Protocol (XMPP) is defined in the XMPP Core (RFC 6120) and XMPP IM (RFC 6121) specifications contributed by the XMPP Standards Foundation to the Internet Standards Process, which is managed by the Internet Engineering Task Force in accordance with RFC 2026. Any protocol defined in this document has been developed outside the Internet Standards Process and is to be understood as an extension to XMPP rather than as an evolution, development, or modification of XMPP itself.


Appendix E: Discussion Venue

The primary venue for discussion of XMPP Extension Protocols is the <standards@xmpp.org> discussion list.

Discussion on other xmpp.org discussion lists might also be appropriate; see <http://xmpp.org/about/discuss.shtml> for a complete list.

Errata can be sent to <editor@xmpp.org>.


Appendix F: Requirements Conformance

The following requirements keywords as used in this document are to be interpreted as described in RFC 2119: "MUST", "SHALL", "REQUIRED"; "MUST NOT", "SHALL NOT"; "SHOULD", "RECOMMENDED"; "SHOULD NOT", "NOT RECOMMENDED"; "MAY", "OPTIONAL".


Appendix G: Notes

1. XEP-0030: Service Discovery <https://xmpp.org/extensions/xep-0030.html>.

2. XEP-0115: Entity Capabilities <https://xmpp.org/extensions/xep-0115.html>.

3. The Internet Assigned Numbers Authority (IANA) is the central coordinator for the assignment of unique parameter values for Internet protocols, such as port numbers and URI schemes. For further information, see <http://www.iana.org/>.

4. The XMPP Registrar maintains a list of reserved protocol namespaces as well as registries of parameters used in the context of XMPP extension protocols approved by the XMPP Standards Foundation. For further information, see <https://xmpp.org/registrar/>.


Appendix H: Revision History

Note: Older versions of this specification might be available at http://xmpp.org/extensions/attic/

Version 0.1 (2016-12-07)

Initial version approved by the council.

(XEP Editor: ssw)

Version 0.0.2 (2016-10-31)

First draft.

(sfp, xfp)

END