mirror of
https://github.com/moparisthebest/xeps
synced 2024-11-22 01:02:17 -05:00
908 lines
67 KiB
XML
908 lines
67 KiB
XML
<?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>In-Band Real Time Text</title>
|
||
<abstract>This is a specification for real-time text transmitted in-band over an XMPP session.</abstract>
|
||
&LEGALNOTICE;
|
||
<number>0301</number>
|
||
<status>Experimental</status>
|
||
<type>Standards Track</type>
|
||
<sig>Standards</sig>
|
||
<approver>Council</approver>
|
||
<dependencies>
|
||
<spec>XMPP Core</spec>
|
||
<spec>XEP-0020</spec>
|
||
</dependencies>
|
||
<supersedes/>
|
||
<supersededby/>
|
||
<shortname>NOT_YET_ASSIGNED</shortname>
|
||
<author>
|
||
<firstname>Mark</firstname>
|
||
<surname>Rejhon</surname>
|
||
<email>mark@realjabber.org</email>
|
||
<jid>markybox@gmail.com</jid>
|
||
<org>RealJabber.org and Rejhon Technologies Inc.</org>
|
||
<uri>http://www.realjabber.com</uri>
|
||
</author>
|
||
<revision>
|
||
<version>0.1</version>
|
||
<date>2011-06-29</date>
|
||
<initials>psa</initials>
|
||
<remark><p>Initial published version.</p></remark>
|
||
</revision>
|
||
<revision>
|
||
<version>0.0.3</version>
|
||
<date>2011-06-24</date>
|
||
<initials>MDR</initials>
|
||
<remark><p>Third draft, minor edits.</p></remark>
|
||
</revision>
|
||
<revision>
|
||
<version>0.0.2</version>
|
||
<date>2011-06-15</date>
|
||
<initials>MDR</initials>
|
||
<remark><p>Second draft.</p></remark>
|
||
</revision>
|
||
<revision>
|
||
<version>0.0.1</version>
|
||
<date>2011-02-21</date>
|
||
<initials>MDR</initials>
|
||
<remark><p>First draft.</p></remark>
|
||
</revision>
|
||
</header>
|
||
|
||
|
||
|
||
<section1 topic="Introduction" anchor="introduction">
|
||
<p>This document defines a specification for real-time text transmitted in-band over an XMPP session.</p>
|
||
<p>Real-time text is text that is sent as it is created. The recipient can watch the sender type "as written words are typed" – similar to a telephone conversation where one listens to a conversation "as words are spoken". It provides a sense of contact in conversation, eliminates waiting times found in messaging, and is also favored by the deaf who prefer text conversation. For a visual animation of real-time text, see <span class="ref"><strong><link url="http://www.realjabber.org">RealJabber.org</link></strong></span>
|
||
<note>RealJabber.org is the author's web site containing work related to this specification, including animation examples of what real time text looks like. <<link url="http://www.realjabber.org">http://www.realjabber.org</link>>.</note>.</p>
|
||
<p>Real-time text has been around for decades in various implementations:</p>
|
||
<ul>
|
||
<li>The 'talk' command on UNIX systems since the 1970's.</li>
|
||
<li>ICQ had a split screen mode from 1996-1999 before this feature was removed.</li>
|
||
<li>In 2008, AOL AIM 6.8 gained the <span class="ref"><strong><link url="http://help.aol.com/help/microsites/microsite.do?cmd=displayKC&externalId=223568">AOL Real-Time IM</link></strong></span> <note>AOL AIM Real Time Text: <<link url="http://help.aol.com/help/microsites/microsite.do?cmd=displayKC&externalId=223568">http://help.aol.com/help/microsites/microsite.do?cmd=displayKC&externalId=223568</link>>.</note> feature.</li>
|
||
<li>Hobby BBS chat programs from the 1990's.</li>
|
||
<li>TDD, TTY and text telephones for the deaf.</li>
|
||
<li>In SIP calls, real-time text is sent using an <span class="ref"><strong><link url="http://tools.ietf.org/html/rfc4103">IETF RFC 4103</link></strong></span> <note>IETF RFC 4103: RTP Payload for Text Conversation. <<link url="http://tools.ietf.org/html/rfc4103">http://tools.ietf.org/html/rfc4103</link>>.</note> transport, with <span class="ref"><strong><link url="http://www.itu.int/rec/T-REC-T.140">ITU-T T.140</link></strong></span> <note>ITU-T T.140: Protocol for multimedia application text conversation. <<link url="http://www.itu.int/rec/T-REC-T.140">http://www.itu.int/rec/T-REC-T.140</link>>.</note> presentation coding.</li>
|
||
</ul>
|
||
</section1>
|
||
<section1 topic="Requirements" anchor="requirements">
|
||
<section2 topic="Fluid Real-Time Text" anchor="fluid_realtime_text">
|
||
<ol>
|
||
<li>Allow transmission of real-time text with a low latency.</li>
|
||
<li>Support real-time message editing, including text insertions, deletions and cursor movements.</li>
|
||
<li>Support transmission of the original intervals between key presses, to preserve look-and-feel of typing independently of transmission intervals.</li>
|
||
</ol>
|
||
</section2>
|
||
<section2 topic="Interoperable" anchor="interoperable">
|
||
<ol>
|
||
<li>Balance low latencies versus system, network and server limitations.</li>
|
||
<li>Be backwards compatible with XMPP clients that do not support real-time text.</li>
|
||
<li>Be interoperable with other real-time text protocols via gateways, including RFC 4103 and other standards.</li>
|
||
</ol>
|
||
</section2>
|
||
<section2 topic="In-Band Transmission" anchor="inband_transmission">
|
||
<ol>
|
||
<li>Reliable real-time text delivery.</li>
|
||
<li>Provide a high level XML mechanism of transmitting real-time text.</li>
|
||
<li>Minimize reliance on knowledge of network transversal protocols and/or out-of-band transmission protocols.</li>
|
||
</ol>
|
||
</section2>
|
||
<section2 topic="Flexible" anchor="flexible">
|
||
<ol>
|
||
<li>Allow use within existing instant-messaging user interfaces, with minimal modifications.</li>
|
||
<li>Allow alternate presentations of real-time text, including split screen and/or other layouts.</li>
|
||
<li>Protocol design extensible for new features.</li>
|
||
<li>Protocol recovery from lost/missing messages.</li>
|
||
</ol>
|
||
</section2>
|
||
</section1>
|
||
<section1 topic="Glossary" anchor="glossary">
|
||
<p><strong>real-time text</strong> – Text transmitted and displayed in real-time as it is typed or entered.</p>
|
||
<p><strong>real-time message</strong> – A chat message that changes in real-time, via real-time text, and as it is edited by the remote sender.</p>
|
||
<p><strong>real-time action</strong> – An action done to a real-time message, such as an edit action or a presentation action.</p>
|
||
<p><strong>real-time chat session</strong> – A chat session that supports real-time messages.</p>
|
||
<p><strong>RTT</strong> – Acronym for real-time text. This is also the name of the main XML element used by this standard.</p>
|
||
<p><strong>action element</strong> – An XML element that indicates a single edit action, or presentation action.</p>
|
||
|
||
|
||
|
||
<p><strong>edit action</strong> – A text modification of any kind, including text insertion or deletion. This may be as small as a single key press.</p>
|
||
<p><strong>presentation action</strong> – A presentation behavior such as the movement of a visible cursor, a pause, or a flash.</p>
|
||
</section1>
|
||
<section1 topic="Protocol" anchor="protocol">
|
||
<section2 topic="RTT Element" anchor="rtt_element">
|
||
<p>Real-time text is transmitted via an <rtt> child element of a <message> stanza. The <rtt> element is transmitted at regular intervals by the sender while a chat message is being composed, to allow the recipient to watch the sender type (and edit) the message before the full message is sent.</p>
|
||
<p>This is a basic example of a <em><strong>real-time message</strong></em> "Hello, my Juliet!", transmitted in three real-time text fragments, followed by a final message delivery:</p>
|
||
<p><strong>Example 1: Introductory Example</strong></p>
|
||
<p><code><![CDATA[<message to='juliet@capulet.lit' from='romeo@montague.lit/orchard' type='chat' id='a01'>
|
||
<rtt xmlns='urn:xmpp:rtt:0' seq='0' event='new'>
|
||
<t>Hello, </t>
|
||
</rtt>
|
||
</message>
|
||
|
||
<message to='juliet@capulet.lit' from='romeo@montague.lit/orchard' type='chat' id='a02'>
|
||
<rtt xmlns='urn:xmpp:rtt:0' seq='1'>
|
||
<t>my </t>
|
||
</rtt>
|
||
</message>
|
||
|
||
<message to='juliet@capulet.lit' from='romeo@montague.lit/orchard' type='chat' id='a03'>
|
||
<rtt xmlns='urn:xmpp:rtt:0' seq='2'>
|
||
<t>Juliet!</t>
|
||
</rtt>
|
||
</message>
|
||
|
||
<message to='juliet@capulet.lit' from='romeo@montague.lit/orchard' type='chat' id='a04'>
|
||
<body>Hello, my Juliet!</body>
|
||
</message>]]></code></p>
|
||
|
||
|
||
|
||
<p>The <rtt> element contains a series of one or more child elements representing <em><strong>real-time actions</strong></em> including <em><strong>edit actions</strong></em> and/or <em><strong>presentation actions</strong></em>. Example 1 illustrates only a single edit action, the <t> <em><strong>action element</strong></em>, which simply adds text to the end of a message. For more information about action elements, see <link url="#realtime_actions">Real-Time Actions</link>.</p>
|
||
<p>If the recipient client does not support this real-time text standard, the sender SHOULD NOT transmit the <rtt> element. For more information, see <link url="#determining_support">Determining Support</link>.</p>
|
||
</section2>
|
||
<section2 topic="RTT Attributes" anchor="rtt_attributes">
|
||
<section3 topic="xmlns" anchor="xmlns">
|
||
<p>This REQUIRED attribute MUST be <strong>urn:xmpp:rtt:0</strong></p>
|
||
</section3>
|
||
<section3 topic="seq" anchor="seq">
|
||
<p>This REQUIRED attribute indicates the sequence number, and MUST begin at 0 in the first <rtt> element sent at the start of a <em><strong>real-time chat session</strong></em>. This attribute MUST increment by 1 for every <rtt> element sent until the end of the session. This value may be used by the receiver to detect lost <message> elements, which affects the integrity of real-time text. For more information, see <link url="#error_recovery_of_realtime_text">Error Recovery of Real-Time Text</link>.</p>
|
||
</section3>
|
||
<section3 topic="event" anchor="event">
|
||
<p>This attribute signals session events for real-time messages, such as the start of a new real-time message. The <strong>event</strong> attribute is omitted from the <rtt> element, when it is not needed.</p>
|
||
<ol>
|
||
<li><p><strong>event='new'</strong><br />
|
||
The sender MUST use this value on the first <rtt> element of a new real-time message. The recipient MUST initialize a blank real-time message for display, before processing the <rtt> payload, if any is provided.</p></li>
|
||
<li><p><strong>event='reset'</strong><br />
|
||
The sender MAY use this value to retransmit a real-time message. The recipient MUST clear the existing real-time message, before processing the <rtt> payload. One use case is for error recovery. Another use case is where the recipient logs off and on, all while the sender is still composing a message. This allows the recipient re-display the real-time message.</p></li>
|
||
<li><p><strong>event='start'</strong><br />
|
||
The sender MAY use this value to indicate the start of a real-time session. The <rtt> payload MUST be empty, with no real-time actions.</p></li>
|
||
<li><p><strong>event='cancel'</strong><br />
|
||
The sender MAY use this value to indicate the end of a real-time session. The recipient SHOULD clear or close the current real-time message, if any is still displayed. An example case is closing a chat window before a message is delivered. The <rtt> payload MUST be empty, with no real-time actions.</p></li>
|
||
</ol>
|
||
<p>Only one <rtt> element is allowed per <message>. Therefore, to transmit multiple events, use multiple consecutive <message>'s.</p>
|
||
</section3>
|
||
</section2>
|
||
<section2 topic="Body Element" anchor="body_element">
|
||
<p>To turn a real-time message into a permanent delivered message, the sender MUST transmit the whole message as a standard <body> child element within the <message> stanza.</p>
|
||
<section3 topic="Backwards Compatible" anchor="backwards_compatible">
|
||
<p>The <body> element continues to follow the &xmppcore; standard. This keeps backwards compatibility with XMPP clients that do not support this specification. Such clients will continue to behave normally, displaying complete lines of messages as they are delivered.</p>
|
||
</section3>
|
||
<section3 topic="Behavior in Clients Supporting This Specification" anchor="behavior_in_clients_supporting_this_specification">
|
||
<p>Upon receipt of <body>, the recipient MUST replace the real-time message with the final delivered message from <body>. The message is thus becomes permanent and can not be edited any further.</p>
|
||
<p>In the ideal case, the message in a <body> is redundant since it simply repeats the entire contents of the real-time message. In the event that there are lost <messages>, the delivery of the <body> permits <link url="#error_recovery_of_realtime_text">Error Recovery of Real-Time Text</link>.</p>
|
||
<p>After sending a completed message as a <body>, the sender may begin a real-time message, using the <strong>event='new'</strong> attribute.</p>
|
||
</section3>
|
||
</section2>
|
||
<section2 topic="Transmission Interval" anchor="transmission_interval">
|
||
<p>For the best balance between interoperability and usability, the interval of transmission of <rtt> for a continuously-changing real-time message SHOULD be once every <strong>1 second</strong>. If there has been no changes to the real-time message, no transmission should take place.</p>
|
||
<p>A much shorter interval may more frequently trigger the flooding protection algorithms in XMPP servers, leading to dropped <message> elements and/or <link url="#congestion_considerations">Congestion Considerations</link>. A longer interval will lead to a less optimal user experience. One second is a balance that meets the requirements of real-time text. This interval is mentioned in other real-time text standards, including section 5.4 of IETF RFC 4103 and section 5.2.2 of <span class="ref"><strong><link url="http://tools.ietf.org/html/rfc5194">IETF RFC 5194</link></strong></span> <note>IETF RFC 5194: Framework for Real-Time Text over IP Using the Session Initiation Protocol (SIP). <<link url="http://tools.ietf.org/html/rfc5194">http://tools.ietf.org/html/rfc5194</link>>.</note>, used for SIP.</p>
|
||
<p>To smooth the output of text, this specification supports transmission of the sender's original <link url="#key_press_intervals">Key Press Intervals</link>. This allows the recipient software to display the sender's typing at the original speed, regardless of the transmission interval.</p>
|
||
</section2>
|
||
<section2 topic="Real-Time Actions" anchor="realtime_actions">
|
||
<p>The <rtt> element is used to transmit a series of one or more real-time actions, including edit actions and presentation actions.</p>
|
||
<p>Most chat clients allow a sender to edit their message before sending (i.e. via a Send button, or hitting Enter). The inclusion of real-time functionality to existing chat client software must not degrade the sender's existing expectation of being able to edit their messages before sending. Thus, in a real-time chat session, the recipient can watch the sender compose and edit their message before it is delivered.</p>
|
||
<p>Edit actions include typing of text, backspacing, and blocks of text being inserted or deleted. In addition, a real-time chat session may also include presentation actions, including:</p>
|
||
<ul>
|
||
<li>Key press intervals, to smooth the flow of real-time text independently of the transmission interval;</li>
|
||
<li>Cursor movements, to make it easier for the recipient to watch edits being made by the sender;</li>
|
||
<li>Visual flash (beep) to allow the sender to catch the attention of the recipient.</li>
|
||
</ul>
|
||
<p>Each real-time action is represented by an <em><strong>action element</strong></em><em>.</em> Examples can be found in <link url="#use_cases">Use Cases</link>.</p>
|
||
<section3 topic="Summary of Action Elements" anchor="summary_of_action_elements">
|
||
<p>The following is a short summary. For more detailed information, see <link url="#action_elements">Action Elements</link>.</p>
|
||
<section4 topic="Edit Actions (Tier 1)" anchor="edit_actions_tier_1">
|
||
<table>
|
||
<tr>
|
||
<th>Action</th>
|
||
<th>Element</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td>Insert Text</td>
|
||
<td><t ='#'>text</t></td>
|
||
<td>REQUIRED. Insert specified <em><strong>text</strong></em> at position <em><strong>p</strong></em> in message.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Backspace</td>
|
||
<td><e p='#' n='#'/></td>
|
||
<td>REQUIRED. Remove <em><strong>n</strong></em> characters to the left of position <em><strong>p</strong></em> in message<em>.</em></td>
|
||
</tr>
|
||
<tr>
|
||
<td>Forward Delete</td>
|
||
<td><d p='#' n='#'/></td>
|
||
<td>REQUIRED. Remove <em><strong>n</strong></em> characters starting at position <em><strong>p</strong></em> in message<em>.</em></td>
|
||
</tr>
|
||
</table>
|
||
</section4>
|
||
<section4 topic="Presentation Actions (Tier 2)" anchor="presentation_actions_tier_2">
|
||
<table>
|
||
<tr>
|
||
<th>Action</th>
|
||
<th>Element</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td>Interval</td>
|
||
<td><w n='#'/></td>
|
||
<td>RECOMMENDED. Execute a pause of <em><strong>n</strong></em> thousandths of a second.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Cursor Position</td>
|
||
<td><c p='#'/></td>
|
||
<td>OPTIONAL. Move cursor to position <em><strong>p</strong></em> in message.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>Flash</td>
|
||
<td><g/></td>
|
||
<td>OPTIONAL. Execute a visual flash, beep, or buzz.</td>
|
||
</tr>
|
||
</table>
|
||
</section4>
|
||
<section4 topic="Rules for Attribute Values" anchor="rules_for_attribute_values">
|
||
<ul>
|
||
<li>The <em><strong>n</strong></em> and <em><strong>p</strong></em> attributes are unsigned 32-bit integers, represented as a string.</li>
|
||
<li>If the <em><strong>n</strong></em> attribute is omitted, the default value for <em><strong>n</strong></em> is 1.</li>
|
||
<li>If the <em><strong>p</strong></em> attribute is omitted, the default value for <em><strong>p</strong></em> is the length of the current real-time message.</li>
|
||
<li>A <em><strong>p</strong></em> value of 0 represents the start of the message.</li>
|
||
<li><em><strong>n</strong></em> and <em><strong>p</strong></em> values are counts of individual Unicode code points.</li>
|
||
</ul>
|
||
<p>For interoperability of <em><strong>p</strong></em> and <em><strong>n</strong></em> values, processing MUST be done on the original Unicode real-time message. For both senders and receivers, this is the version of the Unicode message text without Unicode normalization, emoticon graphics images, display text formatting, processing of Unicode combining marks, etc. For recipients obtaining text from the <t> element, this is the Unicode text immediately after XML processing, and before any further processing. From the perspective of <em><strong>p</strong></em> and <em><strong>n</strong></em> values, a real-time message is treated as an editable array of Unicode code points.</p>
|
||
<p>Regardless of the original format of line breaks during XMPP transmission, line breaks are treated as a single code unit (LINE FEED U+000A) for the purposes of real-time message processing. Conversion of line breaks into a single U+000A character is REQUIRED for XML processors, according to section 2.11 of <span class="ref"><strong><link url="http://www.w3.org/TR/xml/">XML</link></strong></span> <note>XML: Extensible Markup Language 1.0 (Fifth Edition). <<link url="http://www.w3.org/TR/xml/">http://www.w3.org/TR/xml/</link>>.</note>, so a compliant XML processor already do this automatically, and already provide the correct original Unicode text for interoperability.</p>
|
||
<p><strong>NOTE WELL</strong>: Extreme care MUST be taken to correctly calculate n and p values based on Unicode code points, to avoid corruption of the real-time message during real-time editing. For more information, see <link url="#internationalization_considerations">Internationalization Considerations</link>.</p>
|
||
</section4>
|
||
</section3>
|
||
<section3 topic="Action Elements" anchor="action_elements">
|
||
<section4 topic="Element <t> – Insert Text" anchor="element_t_insert_text">
|
||
<p>(Tier 1) REQUIRED. Supports the transmission of key presses, text block inserts, and text being pasted.<br />
|
||
<em>Note:</em> <em>Any text permitted in the <body> element of a <message> may be used, subject to the rules in XMPP Core. More examples can be found in <link url="#use_cases">Use Cases</link>.</em></p>
|
||
<p><code><![CDATA[<t p='#'>text</t>]]></code></p>
|
||
<p>Inserts specified <em><strong>text</strong></em> at position <em><strong>p</strong></em> in the message text.</p>
|
||
<p><code><![CDATA[<t>text</t>]]></code></p>
|
||
<p>Appends specified <em><strong>text</strong></em> at the end of message. (<em><strong>p</strong></em> defaults to message length)</p>
|
||
</section4>
|
||
<section4 topic="Element <e> – Backspace" anchor="element_e_backspace">
|
||
<p>(Tier 1) REQUIRED. Supports the behavior of Backspace key presses.<br />
|
||
<em>Note: Direction 'left' represents the numeric direction. Thus, for right-to-left text (i.e. Arabic), numeric 'left' represents visible 'right'.</em></p>
|
||
<p><code><![CDATA[<e n='#' p='#'/>]]></code></p>
|
||
<p>Remove <em><strong>n</strong></em> characters to the left of position <em><strong>p</strong></em> in message.</p>
|
||
<p><code><![CDATA[<e p='#'/>]]></code></p>
|
||
<p>Remove 1 character to the left of position <em><strong>p</strong></em> in message. (<em><strong>n</strong></em> defaults to 1)</p>
|
||
<p><code><![CDATA[<e n='#'/>]]></code></p>
|
||
<p>Remove <em><strong>n</strong></em> characters from end of message. (<em><strong>p</strong></em> defaults to message length)</p>
|
||
<p><code><![CDATA[<e/>]]></code></p>
|
||
<p>Remove 1 character from end of message. (Both <em><strong>n</strong></em> and <em><strong>p</strong></em> at default values)</p>
|
||
</section4>
|
||
<section4 topic="Element <d> – Forward Delete" anchor="element_d_forward_delete">
|
||
<p>(Tier 1) REQUIRED. Supports the behavior of Delete key presses, text block deletes, and text being cut.<br />
|
||
<em>Note: Direction 'right' represents the numeric direction. Thus, for right-to-left text (i.e. Arabic), numeric 'right' represents visible 'left'.</em></p>
|
||
<p><code><![CDATA[<d p='#' n='#'/>]]></code></p>
|
||
<p>Remove <em><strong>n</strong></em> characters to the right of position <em><strong>p</strong></em> in message.</p>
|
||
<p><code><![CDATA[<d p='#'/>]]></code></p>
|
||
<p>Remove 1 character to the right of position <em><strong>p</strong></em> in message. (<em><strong>n</strong></em> defaults to 1)</p>
|
||
</section4>
|
||
<section4 topic="Element <w> – Interval" anchor="element_w_interval">
|
||
<p>(Tier 2) RECOMMENDED. Allows the transmission of the original intervals between real-time actions, including the pauses between key presses. For more information, see <link url="#key_press_intervals">Key Press Intervals</link>.</p>
|
||
<p><code><![CDATA[<w n='#'/>]]></code></p>
|
||
<p>Executes a pause of <em><strong>n</strong></em> thousandths of a second. The <em><strong>n</strong></em> value SHOULD NOT exceed the <link url="#transmission_interval">Transmission Interval</link>. Also, if a <link url="#body_element">Body Element</link> arrives, pauses SHOULD be interrupted to prevent message delivery delay.</p>
|
||
</section4>
|
||
<section4 topic="Element <c> – Cursor Position" anchor="element_c_cursor_position">
|
||
<p>(Tier 2) OPTIONAL. Allows the transmission of cursor positions. This allows the recipient to see the sender's cursor in their real-time message, and makes it easier to track the sender's message edits. For more information, see <link url="#remote_cursor">Remote Cursor</link>.</p>
|
||
<p><code><![CDATA[<c p='#'/>]]></code></p>
|
||
<p>Moves cursor (caret) to the character position <em><strong>p</strong></em> in message.</p>
|
||
</section4>
|
||
<section4 topic="Element <g> – Flash" anchor="element_g_flash">
|
||
<p>(Tier 2) OPTIONAL. Allows a flash/beep/buzz feature. This feature is the real-time version of &xep0224;, and MAY execute the same alerting method.<br />
|
||
<em>Note: This supports real-time text interoperability with similar features in text telephones for the deaf (TTY / TDD), ITU-T T.140 implementations, and Control-G beep at consoles.</em></p>
|
||
<p><code><![CDATA[<g/>]]></code></p>
|
||
<p>Executes a brief flash, sound, vibration, etc.</p>
|
||
</section4>
|
||
</section3>
|
||
<section3 topic="Processing Rules" anchor="processing_rules">
|
||
<ul>
|
||
<li>There MUST not be more than one <rtt> child element per <message>.</li>
|
||
<li>The <rtt> element MAY be an empty element, or contain one or more action elements.</li>
|
||
<li>Action elements MUST be immediate children of <rtt>. Nesting is not allowed.</li>
|
||
<li>Support of all Tier 1 edit actions is REQUIRED.</li>
|
||
<li>Tier 2 presentation actions MUST NOT affect the contents of the real-time message string.</li>
|
||
<li>Excess Backspaces and Forward Deletes beyond start/end of the message, MUST be ignored.</li>
|
||
<li>Recipients MUST process supported action elements in the same order as received within the <rtt> element. Unrecognized action elements MUST be ignored.</li>
|
||
<li>Real-time actions work only within the boundaries of the current real-time message, and MUST NOT affect previous messages.</li>
|
||
<li>Values for <em><strong>p</strong></em> and <em><strong>n</strong></em> attributes MUST be calculated according to <link url="#rules_for_attribute_values">Rules for Attribute Values</link>.</li>
|
||
</ul>
|
||
</section3>
|
||
</section2>
|
||
<section2 topic="Error Recovery of Real-Time Text" anchor="error_recovery_of_realtime_text">
|
||
<p>In a real-time chat session, it is critical that the real-time message is identical on both the sender and recipient ends. The loss of a single <rtt> transmission can represent missing text, or a missing edit. This leads to the real-time message getting out of sync, the message becoming different on the sender versus the recipient ends.</p>
|
||
<p>Transmissions of <message> elements may be lost for several reasons. One reason is that a recipient may disconnect and reconnect while a sender is still typing a message. Another reason is some XMPP servers may drop <message> elements automatically (i.e. flooding protection).</p>
|
||
<section3 topic="Staying In Sync" anchor="staying_in_sync">
|
||
<p>To stay synchronized:</p>
|
||
<ol>
|
||
<li>The sender MUST increment the <strong>seq</strong> attribute for each consecutive <rtt> element sent.</li>
|
||
<li>The recipients MUST monitor the <strong>seq</strong> attribute value of received <rtt> elements, to verify that it is incrementing.</li>
|
||
<li>The seq values for the sender, and for the recipient, are independent and kept track of separately.</li>
|
||
</ol>
|
||
</section3>
|
||
<section3 topic="Detecting Loss of Sync" anchor="detecting_loss_of_sync">
|
||
<p>The sync is considered lost if the <strong>seq</strong> attribute of the <rtt> element does not increment as expected. Trying to process certain real-time edit actions after loss of sync, will result in scrambled text. Therefore, to avoid this situation:</p>
|
||
<ol>
|
||
<li>The recipient MUST stop processing all subsequent real-time action elements, and freeze the current real-time message.</li>
|
||
<li>An indicator (i.e. reception bars, color code, missing text indicator) or a chat state message (i.e. “Typing Frozen...”) MAY be used by the recipient to indicate the loss of sync.</li>
|
||
</ol>
|
||
</section3>
|
||
<section3 topic="Recovery From Loss of Sync" anchor="recovery_from_loss_of_sync">
|
||
<p>Recovery occurs when any of the following happens:</p>
|
||
<ol>
|
||
<li>A message <body> is delivered. The frozen real-time message MUST be replaced with this delivered message.</li>
|
||
<li>The <strong>event</strong> attribute of <rtt> has a value of <strong>new</strong> or <strong>reset</strong>. Processing of real-time text MUST resume, with the new correct <strong>seq</strong> value obtained from this <rtt> element.</li>
|
||
</ol>
|
||
</section3>
|
||
<section3 topic="Helping The Recipient Stay In Sync" anchor="helping_the_recipient_stay_in_sync">
|
||
<p>The sender MAY help the recipient stay in sync by automatically retransmitting the real-time message whenever the recipient status changes from offline to online. The entire contents of the real-time message, may be retransmitted using the <rtt> attribute <strong>event='reset'</strong> with a single Insert Text action.</p>
|
||
<p><code><![CDATA[<rtt event='reset' seq='#'>
|
||
<t>This is a retransmission of the entire real-time message.</t>
|
||
</rtt>]]></code></p>
|
||
</section3>
|
||
</section2>
|
||
</section1>
|
||
<section1 topic="Determining Support" anchor="determining_support">
|
||
<p>If a client supports the Real Time Text protocol, it MUST advertise that fact in its responses via &xep0030; information ("disco#info") requests by returning a feature of <strong>urn:xmpp:rtt:0</strong></p>
|
||
<p><strong>Example 1. A disco#info query</strong></p>
|
||
<p><code><![CDATA[<iq from='romeo@montague.lit/orchard'
|
||
id='disco1'
|
||
to='juliet@capulet.lit/balcony'
|
||
type='get'>
|
||
<query xmlns='http://jabber.org/protocol/disco#info'/>
|
||
</iq>
|
||
|
||
]]></code></p>
|
||
<p><strong>Example 2. A disco#info response</strong></p>
|
||
<p><code><![CDATA[<iq from='juliet@capulet.lit/balcony'
|
||
id='disco1'
|
||
to='romeo@montague.lit/orchard'
|
||
type='result'>
|
||
<query xmlns='http://jabber.org/protocol/disco#info'>
|
||
<feature var='urn:xmpp:rtt:0'/>
|
||
</query>
|
||
</iq>
|
||
|
||
]]></code></p>
|
||
<p>If this successful response of <strong><feature var='urn:xmpp:rtt:0'/></strong> is not received, the client SHOULD NOT transmit any outgoing <rtt> elements in <message> transmissions. This avoids unnecessary consumption of bandwidth to clients that do not support this protocol.</p>
|
||
</section1>
|
||
<section1 topic="Implementation Notes" anchor="implementation_notes">
|
||
<section2 topic="Key Press Intervals" anchor="key_press_intervals">
|
||
<section3 topic="Avoid Bursty Text Presentation" anchor="avoid_bursty_text_presentation">
|
||
<p>To prevent flooding the public XMPP network, transmissions of messages containing real-time text is rate-limited to the recommended <rtt> message transmission interval, usually 1 second according to <link url="#transmission_interval">Transmission Interval</link>. If the display of text is not smoothed, text will appear in intermittent bursts. This hurts usability of real-time text.</p>
|
||
</section3>
|
||
<section3 topic="Preserving Key Press Intervals" anchor="preserving_key_press_intervals">
|
||
<p>Through the use of the RECOMMENDED <link url="#element_w_interval">Element <w> – Interval</link>, the original look-and-feel of typing can be preserved, despite the long transmission interval. Using the <w> element, the sender can record multiple key presses including key press intervals, and transmit them over the XMPP network in a single <message>. The recipient can then play back the sender's typing in real-time at original typing speed including the intervals between key presses. The text is displayed exactly as it was typed.</p>
|
||
<p>Much like VoIP is a packetization of sound, this spec enables packetization of typing including the original key press intervals. This enables the real-time feel of typing over virtually any Internet connection, and without requiring shorter transmission intervals. Look and feel of typing is also preserved over polled XMPP including &xep0206;, as well as over satellite and long international connections with heavy packet-bursting tendencies and variable latencies.</p>
|
||
<p>The recipient can watch the sender fluidly compose/edit their message in real-time without any “bursting” effects. This is “Natural Typing”, and appears indistinguishable from local typing. Since all key press intervals are preserved at a high precision, all subtleties of typing are preserved, including the 'mood' (calm typing versus panicked or emphatic typing, etc).</p>
|
||
<p>For an example transmission of key intervals, see <link url="#real_world_message_with_key_press_intervals">Real World Message With Key Press Intervals</link>.</p>
|
||
</section3>
|
||
</section2>
|
||
<section2 topic="Real-time Transmission" anchor="realtime_transmission">
|
||
<section3 topic="Monitoring Message Edits" anchor="monitoring_message_edits">
|
||
<p>For sending clients, there are several methods of capturing typing and message edits, in order to generate action elements for an <rtt> transmission. The most reliable and practical method is to monitor the <strong>text change event</strong> of a text box field (rather than monitoring key press events) since:</p>
|
||
<ul>
|
||
<li>it captures all typing, including edits and deletes.</li>
|
||
<li>it captures cut & paste operations, as well as edits made via a pointing device.</li>
|
||
<li>it captures automatic text changes, such as done by spell checker, macros, assistive devices, etc.</li>
|
||
<li>it captures accented characters, Chinese, Arabic and other characters that require multiple key presses to compose.</li>
|
||
<li>it makes no assumptions about different keyboards or input entry methods.</li>
|
||
<li>text change events are more cross-platform portable, including on mobile phones.</li>
|
||
</ul>
|
||
<p>In the text change event, the current message string can be compared to the previous message string in order to calculate what text changes took place. For more information, see <link url="#rules_for_attribute_values">Rules for Attribute Values</link>. The appropriate action elements are then generated, to represent text insertions and deletions. The key press interval can be measured as the time elapsed in milliseconds between text change events.</p>
|
||
</section3>
|
||
<section3 topic="Guidelines for Senders" anchor="guidelines_for_senders">
|
||
<ul>
|
||
<li><p>Monitor typing via the technique in <link url="#monitoring_message_edits">Monitoring Message Edits</link> to generate action elements, and add these action elements to a buffer. This is equivalent to recording a small sequence of typing.</p></li>
|
||
<li><p>During every <link url="#transmission_interval">Transmission Interval</link>, all buffered action elements are transmitted in <rtt> element of a <message>. This is equivalent to transmitting a small sequence of typing at a time.</p></li>
|
||
<li><p>If there are no changes to the real-time message, and no cursor movements, no unnecessary <rtt> transmission takes place.</p></li>
|
||
</ul>
|
||
</section3>
|
||
<section3 topic="Guidelines for Receivers" anchor="guidelines_for_receivers">
|
||
<ul>
|
||
<li><p>Upon receipt of a <message> containing an <rtt> element, the action elements in <rtt> should be added to a queue, in the order that they are received. This provides immunity to variable network conditions, since the buffering action smooths out the latency fluctuations of <message> delivery.</p></li>
|
||
<li><p>The recipient software should interpret the action elements in the playback queue in sequential order, including <w> elements (intervals), into a real-time message. This is equivalent to playing back the sender's original typing, including key press intervals.</p></li>
|
||
<li><p>Processing of intervals (<w> elements) SHOULD be done via non-blocking programming techniques.</p></li>
|
||
<li><p>Upon receiving a <message> containing <body> indicating a completed message, the full message SHOULD be displayed immediately in place of the real-time message, and unprocessed action elements cleared from the playback queue. This ensures final message delivery is not delayed by late processing of action elements.</p></li>
|
||
<li><p>If support for the <w> element is not possible, receiving software SHOULD use an alternate text-smoothing method, such as time-smoothed progressive output of received text.</p></li>
|
||
</ul>
|
||
</section3>
|
||
</section2>
|
||
<section2 topic="Remote Cursor" anchor="remote_cursor">
|
||
<p>Senders MAY choose to transmit changes to cursor positions. Recipient clients MAY choose to display a cursor (or caret) within incoming real-time messages. This enhances usability of real-time text further, since it becomes easier for a recipient to observe the sender's real-time message edits.</p>
|
||
<section3 topic="Calculating Cursor Position" anchor="calculating_cursor_position">
|
||
<p>The <c> element (Cursor Position) MAY be used to specify an exact cursor position, as a zero-based index into the real-time message string. While between <c> elements, the current cursor position MAY be calculated from the last edit action element as follows:</p>
|
||
<ul>
|
||
<li>For <t> element (Insert Text), the cursor position is moved to the end of the inserted text.</li>
|
||
<li>For <e> element (Backspace), the cursor position is moved left as text is deleted.</li>
|
||
<li>For <d> element (Forward Delete) and all other action elements, the cursor position is unaffected.</li>
|
||
<li>The current cursor position does not affect the behavior of subsequent edit elements.</li>
|
||
</ul>
|
||
</section3>
|
||
<section3 topic="Guidelines for Senders" anchor="_guidelines_for_senders">
|
||
<p>The sender MAY choose to transmit cursor positions via <c> elements, only whenever the actual cursor position is different from the calculated position according to <link url="#calculating_cursor_position">Calculating Cursor Position</link> above.</p>
|
||
<p>Monitoring the actual cursor position may need to be done via a “selection changed” event of a text box field in many programming platforms. This event typically monitors the start/end indexes of a text marking operation, and usually doubles as the event for monitoring the cursor position. In this case, the start index should be used, since the transmission of the visual appearance of text marking operations is not supported in this current specification.</p>
|
||
</section3>
|
||
<section3 topic="Guidelines for Receivers" anchor="_guidelines_for_receivers">
|
||
<p>Recipient software MAY choose to display a remote cursor within received real-time messages. The remote cursor SHOULD be clearly distinguishable from the sender's local cursor. One example is to use a non-blinking cursor, easily emulated with the vertical bar character '|'.</p>
|
||
<p>While waiting for the next <c> element (if any), the cursor position MAY be calculated from the last edit action element according to <link url="#calculating_cursor_position">Calculating Cursor Position</link>.</p>
|
||
</section3>
|
||
</section2>
|
||
<section2 topic="Other Guidelines" anchor="other_guidelines">
|
||
<p><link name="_Hlk168620696"></link>There are other special basic considerations for real-time message transmissions that need to be considered by implementors.</p>
|
||
<section3 topic="Message Length Limit" anchor="message_length_limit">
|
||
<p>A large sequence of rapid message changes may generate a large series of action elements in an <rtt> element, resulting in the <message> exceeding the XMPP server's maximum allowed length of a <message> stanza. This may result in dropped messages. It is acceptable to simply retransmit the whole real-time message using <rtt event='reset'> if the length of the <rtt> element would otherwise exceed the application's maximum chat message length. The process of retransmitting the whole real-time message, has the disadvantage of discarding <link url="#key_press_intervals">Key Press Intervals</link> for one <rtt> element.</p>
|
||
<p>For long messages, the final <rtt> transmission may be made in a separate <message> than the <message> containing the <body>. For example:</p>
|
||
<p><code><![CDATA[<message to='alice@example.com' from='bob@example.com/home' type='chat' id='dda'>
|
||
<rtt xmlns='urn:xmpp:rtt:0' seq='95'>
|
||
<t>Hello World...In a Super Long Message! [etc]</t>
|
||
</rtt>
|
||
<body>Hello World...In a Super Long Message! [etc]</body>
|
||
</message>]]></code></p>
|
||
|
||
|
||
|
||
<p>The message MAY be split into two separate message transmissions:</p>
|
||
<p><code><![CDATA[<message to='alice@example.com' from='bob@example.com/home' type='chat' id='dda'>
|
||
<rtt xmlns='urn:xmpp:rtt:0' seq='95'>
|
||
<t>Hello World...In a Super Long Message! [etc]</t>
|
||
</rtt>
|
||
</message>
|
||
|
||
<message to='alice@example.com' from='bob@example.com/home' type='chat' id='ddb'>
|
||
<rtt xmlns='urn:xmpp:rtt:0' seq='96' />
|
||
<body>Hello World...In a Super Long Message! [etc]</body>
|
||
</message>]]></code></p>
|
||
</section3>
|
||
<section3 topic="Performance" anchor="performance">
|
||
<p>The user interface display of the real-time text output, is usually the main performance bottleneck. Care should be taken not to do inefficient entire-screen repainting during every single key press, since fast typists may type over 10 key presses per second. This is especially important for slower platforms. To improve performance, the display of real-time messages may need to be implemented as a separate display element, rather than as a string concatenated to the current message history, so that the display can efficiently be refreshed every key press.</p>
|
||
</section3>
|
||
<section3 topic="Battery Life" anchor="battery_life">
|
||
<p>Battery life considerations are closely related to Performance. The addition of real-time text to a mobile device, will typically significantly impact battery life due mostly to more frequent screen refreshes. The specific implementation of interval action elements (play back of key press intervals) may play a factor, and this should be programmed efficiently. Also, in cases where screen updates are the primary inefficient bottleneck on a specific mobile device, and the code cannot be sufficiently optimized, the number of repaints per second may need to be throttled in order to prolong battery life, at the slight expense of the look-and-feel of typing transmissions. Also see &xep0286;.</p>
|
||
</section3>
|
||
</section2>
|
||
</section1>
|
||
<section1 topic="Use Cases" anchor="use_cases">
|
||
<p>The first examples are deliberately kept simple instead of real-world, and are designed to educate in a progressively more difficult manner. For simplicity, most examples do not include the RECOMMENDED <link url="#key_press_intervals">Key Press Intervals</link> except for the last Use Case example. For real-world communications in software implementations supporting key press intervals, most transmissions will tend to resemble the last Use Case example, <link url="#real_world_message_with_key_press_intervals">Real World Message With Key Press Intervals</link>.</p>
|
||
<section2 topic="Three Backspaces" anchor="three_backspaces">
|
||
<p><code><![CDATA[<message to='bob@example.com' from='alice@example.com/home' id='a01' type='chat'>
|
||
<rtt xmlns='urn:xmpp:rtt:0' seq='0' event='new'>
|
||
<t>Hello bcak</t><e/><e/><e/><t>ack</t>
|
||
</rtt>
|
||
</message>]]></code></p>
|
||
|
||
|
||
|
||
<p>Resulting real-time message: "Hello back"<br />
|
||
This code sends the misspelled "Hello bcak", then <e/><e/><e/> backspaces 3 times, then sends "ack".</p>
|
||
</section2>
|
||
<section2 topic="Three Backspaces In One Action Element" anchor="three_backspaces_in_one_action_element">
|
||
<p><code><![CDATA[<message to='bob@example.com' from='alice@example.com/home' type='chat' id='a01'>
|
||
<rtt xmlns='urn:xmpp:rtt:0' seq='0' event='new'>
|
||
<t>Hello bcak</t><e n='3'/><t>ack</t>
|
||
</rtt>
|
||
</message>]]></code></p>
|
||
|
||
|
||
|
||
<p>Resulting real-time message: "Hello back"<br />
|
||
This code is the same as the previous example, demonstrating that <e n='3'/> does the same thing as <e/><e/><e/>.</p>
|
||
</section2>
|
||
<section2 topic="Message Edits Split Into Multiple Transmissions" anchor="message_edits_split_into_multiple_transmissions">
|
||
<p><code><![CDATA[<message to='bob@example.com' from='alice@example.com/home' type='chat' id='a01'>
|
||
<rtt xmlns='urn:xmpp:rtt:0' seq='0' event='new'>
|
||
<t>Hello</t>
|
||
</rtt>
|
||
</message>
|
||
|
||
<message to='bob@example.com' from='alice@example.com/home' type='chat' id='b02'>
|
||
<rtt xmlns='urn:xmpp:rtt:0' seq='1'>
|
||
<t> bcak</t>
|
||
</rtt>
|
||
</message>
|
||
|
||
<message to='bob@example.com' from='alice@example.com/home' type='chat' id='c03'>
|
||
<rtt xmlns='urn:xmpp:rtt:0' seq='2'>
|
||
<e n='3'/>
|
||
</rtt>
|
||
</message>
|
||
|
||
<message to='bob@example.com' from='alice@example.com/home' type='chat' id='d04'>
|
||
<rtt xmlns='urn:xmpp:rtt:0' seq='3'>
|
||
<t>ack</t>
|
||
</rtt>
|
||
</message>]]></code></p>
|
||
|
||
|
||
|
||
<p>Resulting real-time message: "Hello back"<br />
|
||
This code results in the same final text as the previous two examples, segmented into four separate messages.</p>
|
||
</section2>
|
||
<section2 topic="Deleting Text From Message" anchor="deleting_text_from_message">
|
||
<p><code><![CDATA[<message to='bob@example.com' from='alice@example.com/home' type='chat' id='a01'>
|
||
<rtt xmlns='urn:xmpp:rtt:0' seq='0' event='new'>
|
||
<t>Hello Bob, this is Alice!</t><d n='4' p='5'/>
|
||
</rtt>
|
||
</message>]]></code></p>
|
||
|
||
|
||
|
||
<p>Resulting real-time message: "Hello, this is Alice!"<br />
|
||
This code outputs "Hello Bob, this is Alice!" then <d n='4' p='5'/> deletes 4 characters from position 5.<br />
|
||
(This erases the text " Bob" including the preceding space character).</p>
|
||
</section2>
|
||
<section2 topic="Inserting Text Into Message" anchor="inserting_text_into_message">
|
||
<p><code><![CDATA[<message to='bob@example.com' from='alice@example.com/home' type='chat' id='a01'>
|
||
<rtt xmlns='urn:xmpp:rtt:0' seq='0' event='new'>
|
||
<t>Hello, this is Alice!</t><t p='5'> Bob</t>
|
||
</rtt>
|
||
</message>]]></code></p>
|
||
|
||
|
||
|
||
<p>Resulting real-time message: "Hello Bob, this is Alice!"<br />
|
||
This is because the code outputs "Hello, this is Alice!" then the <t p='5'> inserts the specified text " Bob" at position 5.</p>
|
||
</section2>
|
||
<section2 topic="Deleting And Replacing Text In Message" anchor="deleting_and_replacing_text_in_message">
|
||
<p><code><![CDATA[<message to='bob@example.com' from='alice@example.com/home' type='chat' id='a01'>
|
||
<rtt xmlns='urn:xmpp:rtt:0' seq='0' event='new'>
|
||
<t>Hello Bob, tihsd is Alice!</t>
|
||
<d p='11' n='5'/>
|
||
<t p='11'>this</t>
|
||
</rtt>
|
||
</message>]]></code></p>
|
||
|
||
|
||
|
||
<p>Resulting real-time message: "Hello Bob, this is Alice!"<br />
|
||
This code outputs "Hello Bob, tihsd is Alice!", then <d p='11' n='5'/> deletes 5 characters at position 11 in the string of text. (erases the mistyped word "tihsd"). Finally, <t p='11'>this</t> inserts the text "this" place of the original misspelled word.</p>
|
||
</section2>
|
||
<section2 topic="Multiple Message Edits" anchor="multiple_message_edits">
|
||
<p>This is an example message containing multiple consecutive edit actions.</p>
|
||
<p><code><![CDATA[<message to='bob@example.com' from='alice@example.com/home' type='chat' id='a01'>
|
||
<rtt xmlns='urn:xmpp:rtt:0' seq='0' event='new'>
|
||
<t>Helo</t>
|
||
<e/>
|
||
<t>lo...planet</t>
|
||
<e n='6'/>
|
||
<t> World</t>
|
||
<d n='3' p='5'/>
|
||
<t p='5'> there,</t>
|
||
<c p='18'/>
|
||
</rtt>
|
||
</message>]]></code></p>
|
||
|
||
|
||
|
||
<p>Resulting real-time message: "Hello there, World", completed in the following series of steps:</p>
|
||
<table>
|
||
<tr>
|
||
<th>Element</th>
|
||
<th>Action</th>
|
||
<th>Real -Time Message</th>
|
||
<th>Cursor Pos</th>
|
||
</tr>
|
||
<tr>
|
||
<td><t>Helo</t></td>
|
||
<td>Output "Helo"</td>
|
||
<td>Helo</td>
|
||
<td>4</td>
|
||
</tr>
|
||
<tr>
|
||
<td><e/></td>
|
||
<td>Backspace 1 character from end of line.</td>
|
||
<td>Hel</td>
|
||
<td>3</td>
|
||
</tr>
|
||
<tr>
|
||
<td><t>lo...planet</t></td>
|
||
<td>Output "lo...planet"</td>
|
||
<td>Hello...planet</td>
|
||
<td>14</td>
|
||
</tr>
|
||
<tr>
|
||
<td><e n='6'/></td>
|
||
<td>Backspace 6 characters from end of line</td>
|
||
<td>Hello...</td>
|
||
<td>8</td>
|
||
</tr>
|
||
<tr>
|
||
<td><t> World</t></td>
|
||
<td>Output " World"</td>
|
||
<td>Hello... World</td>
|
||
<td>14</td>
|
||
</tr>
|
||
<tr>
|
||
<td><d n='3' p='5'/></td>
|
||
<td>Delete 3 characters at position 5</td>
|
||
<td>Hello World</td>
|
||
<td>5</td>
|
||
</tr>
|
||
<tr>
|
||
<td><t p='5'> there,</t></td>
|
||
<td>Output " there," at position 5</td>
|
||
<td>Hello there, World</td>
|
||
<td>12</td>
|
||
</tr>
|
||
<tr>
|
||
<td><c p='18'/></td>
|
||
<td>Move cursor to end</td>
|
||
<td>Hello there, World</td>
|
||
<td>18</td>
|
||
</tr>
|
||
</table>
|
||
<p>Normally, the action elements are split into multiple separate transmissions, with <link url="#key_press_intervals">Key Press Intervals</link> added.</p>
|
||
</section2>
|
||
<section2 topic="Three Consecutive Messages" anchor="three_consecutive_messages">
|
||
<p>Representing a short chat session of three separate messages:<br />
|
||
Bob says: "Hello Alice"<br />
|
||
Bob says: "This is Bob"<br />
|
||
Bob says: "How are you?"</p>
|
||
<p><code><![CDATA[<message to='alice@example.com' from='bob@example.com/home' type='chat' id='a01'>
|
||
<rtt xmlns='urn:xmpp:rtt:0' seq='0' event='new'>
|
||
<t>Hello</t>
|
||
</rtt>
|
||
</message>
|
||
|
||
<message to='alice@example.com' from='bob@example.com/home' type='chat' id='b02'>
|
||
<rtt xmlns='urn:xmpp:rtt:0' seq='1'>
|
||
<t> Alice</t>
|
||
</rtt>
|
||
<body>Hello Alice</body>
|
||
</message>
|
||
|
||
<message to='alice@example.com' from='bob@example.com/home' type='chat' id='c03'>
|
||
<rtt xmlns='urn:xmpp:rtt:0' seq='2' event='new'>
|
||
<t>This i</t>
|
||
</rtt>
|
||
</message>
|
||
|
||
<message to='alice@example.com' from='bob@example.com/home' type='chat' id='d04'>
|
||
<rtt xmlns='urn:xmpp:rtt:0' seq='3'>
|
||
<t>s Bob</t>
|
||
</rtt>
|
||
<body>This is Bob</body>
|
||
</message>
|
||
|
||
<message to='alice@example.com' from='bob@example.com/home' type='chat' id='e05'>
|
||
<rtt xmlns='urn:xmpp:rtt:0' seq='4' event='new'>
|
||
<t>How a</t>
|
||
</rtt>
|
||
</message>
|
||
|
||
<message to='alice@example.com' from='bob@example.com/home' type='chat' id='f06'>
|
||
<rtt xmlns='urn:xmpp:rtt:0' seq='5'>
|
||
<t>re yo</t>
|
||
</rtt>
|
||
</message>
|
||
|
||
<message to='alice@example.com' from='bob@example.com/home' type='chat' id='g07'>
|
||
<rtt xmlns='urn:xmpp:rtt:0' seq='6'>
|
||
<t>u?</t>
|
||
</rtt>
|
||
<body>How are you?</body>
|
||
</message>]]></code></p>
|
||
|
||
|
||
|
||
<p>This example also illustrates the following:</p>
|
||
<ul>
|
||
<li>The <strong>type</strong> attribute equals 'new' for the start of every new message.</li>
|
||
<li>The <strong>seq</strong> attribute always increments.</li>
|
||
</ul>
|
||
</section2>
|
||
<section2 topic="Real World Message With Key Press Intervals" anchor="real_world_message_with_key_press_intervals">
|
||
<p>This is the most important example. It is a transmission of “Hello there!” with <link url="#key_press_intervals">Key Press Intervals</link>. It illustrates a four-second typing sequence:</p>
|
||
<ul>
|
||
<li>The misspelled phrase “Hello tehre!” is typed;</li>
|
||
<li>Three cursor-left movements back to the mis-typed letters;</li>
|
||
<li>Two backspaces to delete the two mis-typed letters;</li>
|
||
<li>Two correct key presses to correctly spell the word “there”.</li>
|
||
</ul>
|
||
<p>In between each key press, is <link url="#element_w_interval">Element <w> – Interval</link> to allow the receiving client execute a small pause between action elements, which allows the play back of the typing at its original look-and-feel.</p>
|
||
<p><code><![CDATA[<message to='bob@example.com' from='alice@example.com/home' type='chat' id='a01'>
|
||
<rtt xmlns='urn:xmpp:rtt:0' seq='0' event='new'>
|
||
<t>H</t>
|
||
<w n='215'/><t>e</t>
|
||
<w n='154'/><t>l</t>
|
||
<w n='251'/><t>l</t>
|
||
<w n='115'/><t>o</t>
|
||
<w n='265'/>
|
||
</rtt>
|
||
</message>
|
||
|
||
<message to='bob@example.com' from='alice@example.com/home' type='chat' id='b02'>
|
||
<rtt xmlns='urn:xmpp:rtt:0' seq='1'>
|
||
<w n='40'/><t> </t>
|
||
<w n='161'/><t>t</t>
|
||
<w n='237'/><t>e</t>
|
||
<w n='135'/><t>h</t>
|
||
<w n='234'/><t>r</t>
|
||
<w n='193'/>
|
||
</rtt>
|
||
</message>
|
||
|
||
<message to='bob@example.com' from='alice@example.com/home' type='chat' id='c03'>
|
||
<rtt xmlns='urn:xmpp:rtt:0' seq='2'>
|
||
<w n='109'/><t>e</t>
|
||
<w n='215'/><t>!</t>
|
||
<w n='530'/><c p='11'/>
|
||
<w n='108'/><c p='10'/>
|
||
<w n='38'/>
|
||
</rtt>
|
||
</message>
|
||
|
||
<message to='bob@example.com' from='alice@example.com/home' type='chat' id='d04'>
|
||
<rtt xmlns='urn:xmpp:rtt:0' seq='3'>
|
||
<w n='109'/><c p='9'>
|
||
<w n='161'/><e p='9'/>
|
||
<w n='150'/><e p='8'/>
|
||
<w n='144'/><t>h</t>
|
||
<w n='209'/><t>e</t>
|
||
<w n='227'/>
|
||
</rtt>
|
||
</message>
|
||
|
||
<message to='bob@example.com' from='alice@example.com/home' type='chat' id='d04'>
|
||
<rtt xmlns='urn:xmpp:rtt:0' seq='4'>
|
||
<w n='445'/><c p='12'>
|
||
</rtt>
|
||
<body>Hello there!</body>
|
||
</message>]]></code></p>
|
||
|
||
|
||
|
||
<p>This real-world example also illustrate the following:</p>
|
||
<ul>
|
||
<li>Typing is done via <link url="#element_t_insert_text">Element <t> – Insert Text</link>.</li>
|
||
<li>Cursor movements are done via <link url="#element_c_cursor_position">Element <c> – Cursor Position</link>.</li>
|
||
<li>Backspaces are done via <link url="#element_e_backspace">Element <e> – Backspace</link>.</li>
|
||
<li>Intervals between key presses are done via <link url="#element_w_interval">Element <w> – Interval</link>.</li>
|
||
<li>Each <message> is delivered every one second, the default <link url="#transmission_interval">Transmission Interval</link>.</li>
|
||
<li>To achieve the smoothest playback of typing, the total sum of all values in <w> elements in one <message> equal the <link url="#transmission_interval">Transmission Interval</link> during periods of continuous typing.</li>
|
||
<li>Some <w> interval elements are split between consecutive messages, since key presses are not timed with transmission intervals.</li>
|
||
<li>The <w> interval elements also apply to cursor movements of the <link url="#remote_cursor">Remote Cursor</link>.</li>
|
||
<li>There is a final transmission with a <link url="#body_element">Body Element</link>, transmitted immediately when the message is finished.</li>
|
||
<li>These action elements are generated automatically via <link url="#monitoring_message_edits">Monitoring Message Edits</link>.</li>
|
||
</ul>
|
||
</section2>
|
||
</section1>
|
||
<section1 topic="Interoperability Considerations" anchor="interoperability_considerations">
|
||
<p>There are other real-time text formats with interoperability considerations relating to the session setup level, the media transport level, and presentation level. For each environment where interoperability is supported, an interoperability specification should be documented that covers addressing, session control, media negotiation and media transcoding.</p>
|
||
<section2 topic="RFC 4103 and T.140" anchor="rfc_4103_and_t140">
|
||
<p>One environment for such interoperability considerations is SIP with real-time text (also called Text over IP, or ToIP) as specified in ITU-T T.140 and IETF RFC 4103. One reason for its importance is that this protocol combination is specified by IETF and by regional emergency service organizations to be the protocols supported for IP based real-time emergency calls that support real-time text. Another reason is that SIP is the currently dominating peering protocol between services, and many implementations of real-time text in SIP exist.</p>
|
||
<p>Interoperability implies addressing translation, media negotiation and translation, and media transcoding. For media transcoding between this specification and T.140/RFC 4103, the real-time text transcoding is straight forward, except the editing feature of this specification. Backwards positioning and insertion or deletion far back in the message can cause a large number of erase operations in T.140, that takes time and bandwidth to convey.</p>
|
||
<p>It should be noted that T.140 specifies use of ISO 6429 control codes for presentation characteristics such as text color etc, that are not possible to represent in plain text according to this specification. All control codes from both sides that cannot be presented on the other side of the conversion, must be filtered off in order to not disturb the presentation of text.</p>
|
||
<p>Note that a future version of this specification may support real-time transmission of XHTML-IM formatting, in order to support transcoding of ISO 6429 formatting codes.</p>
|
||
</section2>
|
||
<section2 topic="Combination With Other Real-Time Media" anchor="combination_with_other_realtime_media">
|
||
<p>In some cases, it may be beneficial in a real-time conversation situation to have simultaneous availability of multiple real-time media.</p>
|
||
<p>In the XMPP session environment, the Jingle protocol (&xep0166;) is available for negotiation and transport of the more time-critical, real-time audio and video media. For clients that already support audio and/or video, it is RECOMMENDED to continue providing real-time text according to this specification, regardless of whether audio and/or video is negotiated.</p>
|
||
<p>It is noted there is also another real-time text standard (RFC 4103, RFC 5194), used for SIP sessions with real-time text. In the situation where an implementor needs to decide which real-time text standard to use, it is generally recommended to use the real-time text specification of the specific session control standard in use for that particular session. This varies from implementation to implementation. For example, Google Talk network uses XMPP messaging for instant messages sent during audio/video conversations. Therefore, in this situation, it is recommended to use this XMPP extension document to add real-time text functionality. However, there are other situations where it is necessary to support multiple real-time-text standards, and to interoperate between the multiple real-time text standards. For more information, see the next section.</p>
|
||
<section3 topic="Total Conversation" anchor="total_conversation">
|
||
<p>According to <span class="ref"><strong><link url="http://www.itu.int/rec/T-REC-F.703">ITU-T F.703</link></strong></span> <note>ITU-T F.703: Multimedia conversational services. <<link url="http://www.itu.int/rec/T-REC-F.703">http://www.itu.int/rec/T-REC-F.703</link>>.</note>, "Total Conversation" defines the simultaneous use of audio, video, and real-time text. For convenience, some chat applications may be designed to have automatic negotiation of as many as possible of the three media preferred by the users.</p>
|
||
</section3>
|
||
</section2>
|
||
</section1>
|
||
<section1 topic="Internationalization Considerations" anchor="internationalization_considerations">
|
||
<p>There are special internationalization considerations involving real-time editing of international text, due to the character positioning and length values used by <link url="#action_elements">Action Elements</link>, in the form of <em><strong>p</strong></em> and <em><strong>n</strong></em> attributes. Different programming platforms use different internal Unicode encodings, which may be different from the transmission encoding (UTF-8) for XMPP. To achieve universally correct calculations for <em><strong>p</strong></em> and <em><strong>n</strong></em> attributes, consider these factors:</p>
|
||
<ul>
|
||
<li><p>Multiple Unicode code points may represent one displayable Unicode character (i.e. combining marks).<br />
|
||
<em>Action elements operate on Unicode code points</em><em>, not on displayable characters.</em></p></li>
|
||
<li><p>Characters U+10000 through U+1FFFF, which are single code points, but are represented as multiple surrogate code units in certain Unicode encodings (i.e. UTF-16).<br />
|
||
<em>Action elements operate on</em> <em>Unicode</em> <em>code points, not on individual surrogate code units.</em></p></li>
|
||
<li><p>Some Unicode encodings use a variable number of bytes per Unicode code point (i.e. UTF-8).<br /><em>Action elements operate on Unicode code points, not on individual bytes.</em></p></li>
|
||
</ul>
|
||
<p>Failure to correctly calculate <em><strong>p</strong></em> and <em><strong>n</strong></em> values by counting individual Unicode code points, will result in interoperability problems in the form of scrambled text during real-time editing. In some cases, this problem do not become visible until a chat session occurs in a different international language for the first time. It is critical to follow <link url="#rules_for_attribute_values">Rules for Attribute Values</link> in order to maintain world-wide interoperability of international text.</p>
|
||
</section1>
|
||
<section1 topic="Security Considerations" anchor="security_considerations">
|
||
<section2 topic="Privacy" anchor="privacy">
|
||
<p>It is important for implementors of real-time text to educate users about real-time text. Users of real-time text should be aware that their typing in the local input buffer is now visible to everyone in the current chat conversation. This may have security implications if users copy & paste private information into their chat entry buffer (i.e. a shopping invoice) before editing out the private parts of the pasted text (i.e. a credit card number) before they send the message. With real-time editing, recipients can watch all text changes that occur in the sender's text, before the sender sends the final message.</p>
|
||
</section2>
|
||
<section2 topic="Congestion Considerations" anchor="congestion_considerations">
|
||
<p>The nature of real-time text result in more frequent transmission of <message> elements than may otherwise happen in a non-real-time text conversation. This may lead to increased network and server loading of XMPP networks. Care SHOULD to be taken to use a reasonable <link url="#transmission_interval">Transmission Interval</link>, and avoid transmitting messages at an excessive rate, to avoid creating unnecessary congestion on public XMPP networks. Also, see &xep0205;.</p>
|
||
<p>Network monitoring mechanisms (i.e. &xep0184; and/or &xep0199;, etc.) MAY be used to monitor reliability and latency, in order to temporarily adjust the interval to prevent failure of real-time text transmissions during extreme network conditions.</p>
|
||
<p>That said, the load between participants using this specification in the recommended way, will cause a load that is only marginally higher than a user communicating without this specification. This is very low compared to many other activities possible on XMPP networks including VoIP and file transfers.</p>
|
||
</section2>
|
||
</section1>
|
||
<section1 topic="IANA Considerations" anchor="iana_considerations">
|
||
<p>This document requires no interaction with the Internet Assigned Numbers Authority (IANA).</p>
|
||
</section1>
|
||
<section1 topic="XMPP Registrar Considerations" anchor="xmpp_registrar_considerations">
|
||
<section2 topic="Protocol Namespaces" anchor="protocol_namespaces">
|
||
<p>The XMPP Registrar should include "urn:xmpp:rtt:0" in its registry of protocol namespaces (see <<link url="http://xmpp.org/registrar/namespaces.html">http://xmpp.org/registrar/namespaces.html</link>>).</p>
|
||
</section2>
|
||
<section2 topic="Namespace Versioning" anchor="namespace_versioning">
|
||
<p>If the protocol defined in this specification undergoes a revision that is not fully backwards-compatible with an older version, the XMPP Registrar shall increment the protocol version number found at the end of the XML namespaces defined herein, as described in Section 4 of XEP-0053.</p>
|
||
</section2>
|
||
</section1>
|
||
<section1 topic="XML Schema" anchor="xml_schema">
|
||
<p><code><![CDATA[<?xml version='1.0' encoding='UTF-8'?>
|
||
|
||
<xs:schema
|
||
xmlns:xs='http://www.w3.org/2001/XMLSchema'
|
||
targetNamespace='urn:xmpp:rtt:0'
|
||
xmlns='urn:xmpp:rtt:0'
|
||
elementFormDefault='qualified'>
|
||
|
||
<xs:annotation>
|
||
<xs:documentation>
|
||
The protocol documented by this schema is defined in
|
||
XEP-0xxx: http://www.xmpp.org/extensions/xep-0xxx.html
|
||
</xs:documentation>
|
||
</xs:annotation>
|
||
|
||
<xs:element name='rtt'>
|
||
<xs:complexType>
|
||
<xs:attribute name='seq' type='xs:unsignedInteger' use='required'/>
|
||
<xs:attribute name='event' type='xs:string' use='optional'/>
|
||
<xs:sequence>
|
||
<xs:element ref='t' minOccurs='0' maxOccurs='unbounded'/>
|
||
<xs:element ref='e' minOccurs='0' maxOccurs='unbounded'/>
|
||
<xs:element ref='d' minOccurs='0' maxOccurs='unbounded'/>
|
||
<xs:element ref='c' minOccurs='0' maxOccurs='unbounded'/>
|
||
<xs:element ref='w' minOccurs='0' maxOccurs='unbounded'/>
|
||
<xs:element ref='g' minOccurs='0' maxOccurs='unbounded'/>
|
||
</xs:sequence>
|
||
</xs:complexType>
|
||
</xs:element>
|
||
|
||
<xs:element name='t' type='xs:string'>
|
||
<xs:complexType>
|
||
<xs:attribute name='p' type='xs:unsignedInteger' use='optional'/>
|
||
</xs:complexType>
|
||
</xs:element>
|
||
|
||
<xs:element name='e' type='empty'>
|
||
<xs:complexType>
|
||
<xs:attribute name='p' type='xs:unsignedInteger' use='optional'/>
|
||
<xs:attribute name='n' type='xs:unsignedInteger' use='optional'/>
|
||
</xs:complexType>
|
||
</xs:element>
|
||
|
||
<xs:element name='d' type='empty'>
|
||
<xs:complexType>
|
||
<xs:attribute name='p' type='xs:unsignedInteger' use='required'/>
|
||
<xs:attribute name='n' type='xs:unsignedInteger' use='optional'/>
|
||
</xs:complexType>
|
||
</xs:element>
|
||
|
||
<xs:element name='c' type='empty'>
|
||
<xs:complexType>
|
||
<xs:attribute name='p' type='xs:unsignedInteger' use='required'/>
|
||
</xs:complexType>
|
||
</xs:element>
|
||
|
||
<xs:element name='w' type='empty'>
|
||
<xs:complexType>
|
||
<xs:attribute name='n' type='xs:unsignedInteger' use='required'/>
|
||
</xs:complexType>
|
||
</xs:element>
|
||
|
||
<xs:element name='g' type='empty'/>
|
||
|
||
<xs:simpleType name='empty'>
|
||
<xs:restriction base='xs:string'>
|
||
<xs:enumeration value=''/>
|
||
</xs:restriction>
|
||
</xs:simpleType>
|
||
|
||
</xs:schema>]]></code></p>
|
||
</section1>
|
||
<h1>Acknowledgements</h1>
|
||
<p>The author would like to thank Real-Time Text Taskforce (R3TF) at <link class="western" href="http://www.realtimetext.org/">www.realtimetext.org</link> for their contribution to the technology documented in this specification. Members of R3TF who have contributed to this document, including corrections and edits, include Gunnar Helstrom, Barry Dingle, Paul E. Jones, Anoud van Wijk, and Gregg Vanderheiden.</p>
|
||
<p>“Natural Typing”, the technique of preserving key press intervals, is acknowledged as an invention by Mark Rejhon, who is deaf. This technology is provided to XMPP.org as part of this specification in compliance of the XSF's Intellectual Property Rights Policy at <link class="western" href="http://xmpp.org/extensions/ipr-policy.shtml">http://xmpp.org/extensions/ipr-policy.shtml</link>. For more information, see Appendix C: Legal Notices.</p>
|
||
|
||
|
||
|
||
</xep>
|