-
Notifications
You must be signed in to change notification settings - Fork 0
/
xep-0393.xml
604 lines (600 loc) · 20.4 KB
/
xep-0393.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE xep SYSTEM 'xep.dtd' [
<!ENTITY % ents SYSTEM 'xep.ent'>
%ents;
]>
<?xml-stylesheet type='text/xsl' href='xep.xsl'?>
<xep>
<header>
<title>Message Styling</title>
<abstract>
This specification defines a formatted text syntax for use in instant
messages with simple text styling.
</abstract>
&LEGALNOTICE;
<number>0393</number>
<status>Draft</status>
<lastcall>2020-05-26</lastcall>
<type>Standards Track</type>
<sig>Standards</sig>
<approver>Council</approver>
<dependencies>
<spec>XMPP Core</spec>
<spec>XEP-0001</spec>
</dependencies>
<supersedes><spec>XEP-0071</spec></supersedes>
<supersededby/>
<shortname>styling</shortname>
&sam;
<revision>
<version>1.0.0</version>
<date>2020-10-13</date>
<initials>XEP Editor (jsc)</initials>
<remark><p>Accepted as Draft as per Council vote from 2020-10-07.</p></remark>
</revision>
<revision>
<version>0.4.0</version>
<date>2020-06-02</date>
<initials>ssw</initials>
<remark>
<p>
Remove description of mechanism for disabling styling on individual
spans and blocks, users can do this themselves without us documenting
the use of a codepoint that's not specifically for this purpose.
</p>
</remark>
</revision>
<revision>
<version>0.3.0</version>
<date>2020-06-02</date>
<initials>ssw</initials>
<remark>
<p>
Add ability to disable styling, further clarify accessibility
considerations, and mention that Styling is not Markdown in the security
considerations section.
</p>
</remark>
</revision>
<revision>
<version>0.2.2</version>
<date>2020-05-20</date>
<initials>ssw</initials>
<remark>
<p>
Clarify accessibility considerations section and be consistent about use
of the term "styling directives".
</p>
</remark>
</revision>
<revision>
<version>0.2.1</version>
<date>2020-01-02</date>
<initials>ssw</initials>
<remark>
<p>
Make rules consistent with examples that show multiple styling
directives being applied to the same text.
</p>
</remark>
</revision>
<revision>
<version>0.2.0</version>
<date>2019-09-02</date>
<initials>ssw</initials>
<remark>
<p>
Clarify block quote termination and white space trimming.
</p>
</remark>
</revision>
<revision>
<version>0.1.4</version>
<date>2018-05-01</date>
<initials>ssw</initials>
<remark>
<p>
Clarify language around strong emphasis.
</p>
</remark>
</revision>
<revision>
<version>0.1.3</version>
<date>2018-02-14</date>
<initials>ssw</initials>
<remark>
<p>
Reorder block and span sections, simplify block parsing, and update the
definition of a span.
</p>
</remark>
</revision>
<revision>
<version>0.1.2</version>
<date>2018-01-13</date>
<initials>ssw</initials>
<remark>
<p>
Clarify block quote and plain text parsing and formatting behavior.
</p>
</remark>
</revision>
<revision>
<version>0.1.1</version>
<date>2018-01-12</date>
<initials>ssw</initials>
<remark>
<p>
Minor clarifications and updates, add security considerations, and
expand the glossary.
</p>
</remark>
</revision>
<revision>
<version>0.1.0</version>
<date>2017-11-22</date>
<initials>XEP Editor (ssw)</initials>
<remark><p>First draft approved by the XMPP Council.</p></remark>
</revision>
<revision>
<version>0.0.1</version>
<date>2017-10-28</date>
<initials>ssw</initials>
<remark><p>First draft.</p></remark>
</revision>
</header>
<section1 topic='Introduction' anchor='intro'>
<p>
Historically, XMPP has had no system for simple text styling.
Instead, specifications like &xep0071; that require full layout engines have
been used, leading to numerous security issues with implementations.
Some entities have also performed their own styling based on identifiers in
the body.
While this has worked well in the past, it is not interoperable and leads to
entities each supporting their own informal styling languages.
</p>
<p>
This specification aims to provide a single, interoperable formatted text
syntax that can be used by entities that do not require full layout engines.
</p>
</section1>
<section1 topic='Requirements' anchor='reqs'>
<ul>
<li>
Clients that do not support this specification MUST still be able to
receive messages sent by clients using this specification and display them
in a human-readable form.
</li>
<li>
Clients that support this specification MUST NOT be required to use a
layout engine such as HTML or LaTeX.
</li>
<li>
Messages formatted using this specification MUST NOT hinder readability on
receiving clients regardless of client background color, contrast, or
window size.
</li>
<li>
Messages formatted using this specification MUST NOT hinder readability by
users with color vision deficiency or impaired vision.
</li>
<li>
Messages formatted with this specification MUST render correctly in
locales with right-to-left (RTL) layouts without causing confusion.
</li>
<li>
Clients that support this specification MUST NOT be required to extract
metadata unrelated to formatting or text style from the message.
</li>
<li>
Servers MUST NOT need to implement any new functionality for this
specification to be supported.
</li>
</ul>
</section1>
<section1 topic='Use Cases' anchor='usecases'>
<ul>
<li>
As a user sending an instant message to a friend, I want to be able to
emphasize an important part of my message.
</li>
<li>
As a software developer, I want to be able to send code as pre-formatted,
monospace, block or inline text to another developer.
</li>
<li>
As a multi-user chat user I want to add context to my reply by quoting an
earlier message in the chat.
</li>
</ul>
</section1>
<section1 topic='Glossary' anchor='glossary'>
<p>
Many important terms used in this document are defined in &unicode;.
The terms "left-to-right" (LTR) and "right-to-left" (RTL) are defined in
&uax9;.
The term "formatted text" is defined in &rfc7764;.
</p>
<dl>
<di>
<dt>Block</dt>
<dd>
Any chunk of text that can be parsed unambiguously in one pass.
Blocks may contain one or more children which may be other blocks or
spans.
For example:
<ul>
<li>A single line of text comprising one or more spans</li>
<li>A block quotation</li>
<li>A preformatted code block</li>
</ul>
</dd>
</di>
<di>
<dt>Formal markup language</dt>
<dd>
A structured markup language such as LaTeX, SGML, HTML, or XML that is
formally defined and may include metadata unrelated to formatting or
text style.
</dd>
</di>
<di>
<dt>Plain text</dt>
<dd>
Text that does not convey any particular formatting or interpretation of
the text by computer programs.
</dd>
</di>
<di>
<dt>Span</dt>
<dd>
A group of text that may be rendered inline alongside other spans.
Spans may be either plain text with no formatting applied, or may be
formatted text that is enclosed by two styling directives.
Spans are always children of blocks and may not escape from their
containing block.
Some spans may contain child spans.
The following all contain spans marked by parenthesis:
<ul>
<li>(plain span)</li>
<li>(<strong>*strong span*</strong>)</li>
<li>(<em>_emphasized span_</em>)</li>
<li>(<em>_emphasized span containing </em>(<em><strong>*strong span*</strong></em>)<em>_</em>)</li>
<li>(span one )(<strong>*span two*</strong>)</li>
</ul>
</dd>
</di>
<di>
<dt>Styling directive</dt>
<dd>
A character or set of characters that indicates the beginning of a span
or block.
For example, in certain contexts the characters '*' (U+002A ASTERISK),
and '_' (U+005F LOW LINE) may be styling directives that indicate the
beginning of a strong or emphasis span and the string '```' (U+0060
GRAVE ACCENT) may be a styling directive that indicate the beginning of
a preformatted code block.
</dd>
</di>
<di>
<dt>Whitespace character</dt>
<dd>
Any Unicode scalar value which has the property "White_Space" or is in
category Z in the Unicode Character Database.
</dd>
</di>
</dl>
</section1>
<section1 topic='Discovering Support' anchor='disco'>
<p>
Clients that support message styling MUST advertise the fact by including a
feature of "urn::xmpp:styling:0" in response to &xep0030; information
requests and in their &xep0115; profiles.
</p>
<example caption='Disco info response'><![CDATA[
<query xmlns='http://jabber.org/protocol/disco#info'>
…
<feature var='urn:xmpp:styling:0' />
…
</query>]]></example>
</section1>
<section1 topic='Business Rules' anchor='rules'>
<section2 topic='Blocks' anchor='block'>
<p>
Parsers implementing message styling will first parse blocks and then
parse child blocks or spans if allowed by the specific block type.
</p>
<section3 topic='Plain' anchor='line-block'>
<p>
Individual lines of text that are not inside of a preformatted text
block are considered a "plain" block.
Plain blocks are not bound by styling directives and do not imply
formatting themselves, but they may contain spans which imply
formatting.
Plain blocks may not contain child blocks.
</p>
<example caption='Plain block text'><![CDATA[
<body>
(There are three blocks in this body marked by parens,)
(but there is no *formatting)
(as spans* may not escape blocks.)
</body>
]]></example>
</section3>
<section3 topic='Preformatted Text' anchor='pre-block'>
<p>
A preformatted text block is started by a line beginning with "```"
(U+0060 GRAVE ACCENT), and ended by a line containing only three grave
accents or the end of the parent block (whichever comes first).
Preformatted text blocks cannot contain child blocks or spans.
Text inside a preformatted block SHOULD be displayed in a monospace font.
</p>
<example caption='Preformatted block text'><![CDATA[
<body>
```ignored
(println "Hello, world!")
```
This should show up as monospace, preformatted text ⤴
</body>
]]></example>
<example caption='No closing preformatted text sequence'><![CDATA[
<body>
> ```
> (println "Hello, world!")
The entire blockquote is a preformatted text block, but this line
is plaintext!
</body>
]]></example>
</section3>
<section3 topic='Quotations' anchor='quote'>
<p>
A quotation is indicated by one or more lines with a byte stream
beginning with a '>' (U+003E GREATER-THAN SIGN).
They are terminated by the first new line that is not followed by a
greater-than sign, or the end of the parent block (whichever comes
first).
Block quotes may contain any child block, including other quotations.
Lines inside the block quote MUST have the first leading whitespace
character trimmed before parsing the child block.
It is RECOMMENDED that text inside of a block quote be indented or
distinguished from the surrounding text in some other way.
</p>
<example caption='Quotation (LTR)'><![CDATA[
<body>
> That that is, is.
Said the old hermit of Prague.
</body>
]]></example>
<example caption='Nested Quotation'><![CDATA[
<body>
>> That that is, is.
> Said the old hermit of Prague.
Who?
</body>
]]></example>
</section3>
</section2>
<section2 topic='Spans' anchor='span'>
<p>
Matches of spans between two styling directives MUST contain some text
between the two styling directives and the opening styling directive
MUST be located at the beginning of the line, after a whitespace
character, or after a different opening styling directive.
The opening styling directive MUST NOT be followed by a whitespace
character and the closing styling directive MUST NOT be preceeded by a
whitespace character.
Spans are always parsed from the beginning of the byte stream to the end
and are lazily matched.
Characters that would be styling directives but do not follow these rules
are not considered when matching and thus may be present between two other
styling directives.
</p>
<p>
For example, each of the following would be styled as indicated:
</p>
<ul>
<li><strong>*strong*</strong></li>
<li>plain <strong>*strong*</strong> plain</li>
<li><strong>*strong*</strong> plain <strong>*strong*</strong></li>
<li><strong>*strong*</strong>plain*</li>
<li>* plain <strong>*strong*</strong></li>
</ul>
<p>
Nothing would be styled in the following messages (where "\n" represents a
new line):
</p>
<ul>
<li>not strong*</li>
<li>*not strong</li>
<li>*not \n strong*</li>
<li>*not *strong</li>
<li>**</li>
<li>****</li>
</ul>
<section3 topic='Plain' anchor='plain'>
<p>
Any text inside of a block that is not part of another span is
implicitly considered to be inside of a "plain text" span.
</p>
<example caption='Plain'><![CDATA[
<body>
(Two spans, both )(*alike in dignity*)
</body>
]]></example>
</section3>
<section3 topic='Emphasis' anchor='emph'>
<p>
Text enclosed by '_' (U+005F LOW LINE) is emphasized and SHOULD be
displayed in italics.
</p>
<example caption='Italic'><![CDATA[
<body>
The full title is _Twelfth Night, or What You Will_ but
_most_ people shorten it.
</body>
]]></example>
</section3>
<section3 topic='Strong Emphasis' anchor='strong'>
<p>
Text enclosed by '*' (U+002A ASTERISK) is strongly emphasized and SHOULD
be displayed with a heavier font weight than the surrounding text
(bold).
</p>
<example caption='Strong'><![CDATA[
<body>
The full title is "Twelfth Night, or What You Will" but
*most* people shorten it.
</body>
]]></example>
</section3>
<section3 topic='Strike through' anchor='strike'>
<p>
Text enclosed by '~' (U+007E TILDE) SHOULD be displayed with a horizontal
line through the middle.
</p>
<example caption='Strike through'><![CDATA[
<body>
Everyone ~dis~likes cake.
</body>
]]></example>
</section3>
<section3 topic='Preformatted Span' anchor='mono'>
<p>
Text enclosed by a '`' (U+0060 GRAVE ACCENT) is a preformatted span SHOULD
be displayed inline in a monospace font.
A preformatted span may only contain a single plain span.
Inline formatting directives inside the preformatted span are not
rendered.
For example, the following all contain valid preformatted spans:
</p>
<ul>
<li>This is <tt>`monospace`</tt></li>
<li>This is <tt>`*monospace*`</tt></li>
<li>This is <strong><tt>*`monospace and bold`*</tt></strong></li>
</ul>
<example caption='Monospace text'><![CDATA[
<body>
Wow, I can write in `monospace`!
</body>
]]></example>
</section3>
</section2>
</section1>
<section1 topic='Disabling Styling' anchor='disable'>
<p>
On rare occasions styling hints may conflict with the contents of a message.
For example, if the user sends the emoji "> _ <" it would be
interpreted as a block quote.
Senders may indicate to the receiver that a particular message SHOULD NOT be
styled by adding an empty <unstyled> element qualified by the
"urn:xmpp:styling:0" namespace.
</p>
<example caption='Sender indicates that styling is disabled'><![CDATA[
<message>
<body>> _ <</body>
<unstyled xmlns="urn:xmpp:styling:0"/>
</message>
]]></example>
</section1>
<section1 topic='Implementation Notes' anchor='impl'>
<p>
This document does not define a regular grammar and thus styling cannot be
matched by a regular expression.
Instead, a simple parser can be constructed by first parsing all text into
blocks and then recursively parsing the child-blocks inside block
quotations, the spans inside individual lines, and by returning the text
inside preformatted blocks without modification.
</p>
<p>
It is RECOMMENDED that styling directives be displayed and formatted in the
same manner as the text they apply to.
For example, the string "*emphasis*" would be rendered as
"<strong>*emphasis*</strong>".
</p>
<p>
This specification does not provide a mechanism for removing styling from
individual spans or blocks within a styled message.
Implementations are free to implement their own workarounds, for example by
inserting Unicode non-printable characters to invalidate styling directives,
but no specific technique is known to be widely supported.
</p>
</section1>
<section1 topic='Accessibility Considerations' anchor='access'>
<p>
When displaying styling directives, developers should ensure sufficient
contrast so that visually impaired users are able to distinguish the styling
directives from the background color.
Care should also be taken to ensure that formatting designed to
differentiate styling directives from surrounding text does not make the
text more difficult to read for visually impaired users.
</p>
<p>
Styled text may be rendered poorly by screen readers.
When applying formatting it may be desirable to include directives to
exclude styling directives from being read, or to add markers to the final
output that have semantic meaning for screen readers.
For example, in an web based client an emphasis span might be converted to
an HTML <em> element.
</p>
</section1>
<section1 topic='Security Considerations' anchor='security'>
<p>
Authors of message styling parsers should take care that improperly
formatted messages cannot lead to buffer overruns or code execution.
</p>
<p>
Though message styling is not compatible with Markdown, some of its styles
are similar.
Markdown parsers often allow arbitrary HTML to be inserted into documents
and therefore MUST NOT be used to parse the format defined in this document
even if they are flexible enough to do so.
</p>
</section1>
<section1 topic='IANA Considerations' anchor='iana'>
<p>
This document requires no interaction with &IANA;.
</p>
</section1>
<section1 topic='XMPP Registrar Considerations' anchor='registrar'>
<section2 topic='Protocol Namespaces' anchor='registrar-ns'>
<p>This specification defines the following XML namespace:</p>
<ul>
<li>urn:xmpp:styling:0</li>
</ul>
<p>
Upon advancement of this specification from a status of Experimental to a
status of Draft, the ®ISTRAR; shall add the foregoing namespace to the
registries located at &DISCOFEATURES;, as described in Section 4 of
&xep0053;.
</p>
<code caption='Service Discovery Features Registry Submission'><![CDATA[
<var>
<name>urn:xmpp:styling:0</name>
<desc>Support for rendering message styling.</desc>
<doc>&xep0393;</doc>
</var>]]></code>
<p>
The ®ISTRAR; shall also add the foregoing namespace to the Jabber/XMPP
Protocol Namespaces Registry located at &NAMESPACES;.
Upon advancement of this specification from a status of Experimental to a
status of Draft, the ®ISTRAR; shall remove the provisional status from
this registry entry.
</p>
<code caption='Jabber/XMPP Protocol Namespaces Registry Submission'><![CDATA[
<ns>
<name>urn:xmpp:styling:0</name>
<doc>&xep0393;</doc>
<status>provisional</status>
</ns>]]></code>
</section2>
<section2 topic='Namespace Versioning' anchor='registrar-versioning'>
&NSVER;
</section2>
</section1>
<section1 topic='XML Schema' anchor='schema'>
<p>This document does not define any new XML structure requiring a schema.</p>
</section1>
<section1 topic='Acknowledgements' anchor='ack'>
<p>The author wishes to thank Kevin Smith for his review and feedback.</p>
</section1>
</xep>