XEP-xxxx: Body Markup Hints

Abstract
This document specifies hints about the markup language used in <body/> elements.
Author
Florian Schmaus
Copyright
© 2017 – 2017 XMPP Standards Foundation. SEE LEGAL NOTICES.
Status

ProtoXEP

WARNING: This document has not yet been accepted for consideration or approved in any official manner by the XMPP Standards Foundation, and this document is not yet an XMPP Extension Protocol (XEP). If this document is accepted as a XEP by the XMPP Council, it will be published at <https://xmpp.org/extensions/> and announced on the <standards@xmpp.org> mailing list.
Type
Standards Track
Version
0.0.1 (2017-10-14)
Document Lifecycle
  1. Experimental
  2. Proposed
  3. Stable
  4. Final

1. Introduction

This document specifies hints about the markup language used in <body/> elements found in <message/> stanzas. It also specifies a mechanism to discover support of various markup dialects

2. Markup Languages

This list is not comprehensive and not meant to be.

Table 1: Defined Markup Languages
Language Identifier Name Specification Link
urn:xmpp:bmh:commonmark:0 CommonMark http://spec.commonmark.org/
urn:xmpp:bmh:rst:0 reStructuredText http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html

TODO: Shall we define your own subset of e.g. CommonMark, XMPPMark? :)

3. Exchanging messages with markup formatted bodies

If the <body/> element contains text which is "formatted" with a markup language, then the sending client MAY adds a <body-markup-hint/> element qualified by the 'https://xmpp.org/extensions/bmh/0/' namespace with the 'language' attribute set to the Language Identifier of the used markup language.

Example 1. A message stanza with a body markup hint
<message from='holden@rocinante.example.org' to='naomi@rocinante.example.org'>
  <body>
1. Ingredients

    - spaghetti
    - marinara sauce
    - salt

2. Cooking

   Bring water to boil, add a pinch of salt and spaghetti. Cook until pasta is **tender**.

3. Serve

   Drain the pasta on a plate. Add heated sauce.

   > No man is lonely eating spaghetti; it requires so much attention.

*Bon appetit!*
  </body>
  <body-markup-hint xmlns='https://xmpp.org/extensions/bmh/0/'
                    language='urn:xmpp:bmh:commonmark:0'/>
</message>

4. Discovering Support

It is RECOMMENDED that entities announce the supported body markup languages in its service discovery information as specified in Service Discovery (XEP-0030) [1]. Every markup language is announced as a <feature/> element with the 'var' attribute set to the language identifier of the supported language.

Example 2. A service discovery information with the supported body markup languages
<iq from='julie@eros.example.org'
    to='miller@rocinante.example.org'
    id='info1'
    type='result'>
  <query xmlns='http://jabber.org/protocol/disco#info'>
    ...
    <feature var='urn:xmpp:bmh:commonmark:0'/>
    ...
  </query>
</iq>

5. Business Rules

There MUST be only one <body-markup-hint/> per <message/> stanza, and it applies to all <body/> elements within the same stanza.

6. Security Considerations

TODO: Discuss.

7. IANA Considerations

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

8. XMPP Registrar Considerations

TODO: Is it sensible to establish a registry for this?

9. XML Schema

TODO: Add after the XEP leaves the 'experimental' state.

10. Acknowledgements

Thanks to everyone who provided feedback.

Appendices

Appendix A: Document Information

Series
XEP
Number
xxxx
Publisher
XMPP Standards Foundation
Status
ProtoXEP
Type
Standards Track
Version
0.0.1
Last Updated
2017-10-14
Approving Body
XMPP Council
Dependencies
XMPP Core
Supersedes
None
Superseded By
None
Short Name
bmh

This document in other formats: XML  PDF

Appendix B: Author Information

Florian Schmaus
Email
flo@geekplace.eu
JabberID
flo@geekplace.eu

Copyright

This XMPP Extension Protocol is copyright © 1999 – 2024 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).

Visual Presentation

The HTML representation (you are looking at) is maintained by the XSF. It is based on the YAML CSS Framework, which is licensed under the terms of the CC-BY-SA 2.0 license.

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 <https://xmpp.org/community/> 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. 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/>.

Appendix H: Revision History

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

  1. Version 0.0.1 (2017-10-14)

    First draft.

    fs

Appendix I: Bib(La)TeX Entry

@report{schmaus2017bmh,
  title = {Body Markup Hints},
  author = {Schmaus, Florian},
  type = {XEP},
  number = {xxxx},
  version = {0.0.1},
  institution = {XMPP Standards Foundation},
  url = {https://xmpp.org/extensions/xep-xxxx.html},
  date = {2017-10-14/2017-10-14},
}

END