<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type='text/xsl' href='xep.xsl'?>
<xep xmlns="">
<header>
  <title>Shared Notes</title>
  <abstract>A simplistic mechanism for shared notes, modeled after common stickie note applications.</abstract>
  
<legal>
<copyright>This XMPP Extension Protocol is copyright © 1999 – 2024 by the <link url="https://xmpp.org/">XMPP Standards Foundation</link> (XSF).</copyright>
<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.</permissions>
<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. ##</warranty>
<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.</liability>
<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 &lt;<link url="https://xmpp.org/about/xsf/ipr-policy">https://xmpp.org/about/xsf/ipr-policy</link>&gt; or obtained by writing to XMPP Standards Foundation, P.O. Box 787, Parker, CO 80134 USA).</conformance>
</legal>
  <number>0061</number>
  <status>Deferred</status>
  <type>Informational</type>
  <sig>Standards</sig>
  <dependencies><spec>XMPP Core</spec></dependencies>
  <supersedes/>
  <supersededby/>
  <shortname>Not yet assigned</shortname>
  <author>
    <firstname>Jeremie</firstname>
    <surname>Miller</surname>
    <email>jer@jabber.org</email>
    <jid>jer@jabber.org</jid>
  </author>
  <revision>
    <version>0.2</version>
    <date>2003-09-30</date>
    <initials>psa</initials>
    <remark>At the request of the author, changed the status of this document to Deferred pending development of an implementation; also changed the type to Informational.</remark>
  </revision>
  <revision>
    <version>0.1</version>
    <date>2002-12-06</date>
    <initials>jer</initials>
    <remark>Initial version.</remark>
  </revision>
</header>
<section1 topic="Introduction">
  <p>A very simple namespace contaning display hints for the content in a message.  Can be used for
person-person collaboration, or by a service managing notes.</p>
</section1>

<section1 topic="Message Extension">
<p>Normal messages are sent, with a sharednote namespace extending them hinting to any supporting client on
how to display the message as a note instead.  Any changes to the note within that client should then be sent
back to the sender, either automatically or when the user saves the note (depending on the update element, by
default on a save action by the user).</p>

    <example caption="An Example Shared Note Message"><![CDATA[
<message from="jer@jabber.org/foo" to="stpeter@jabber.org/bar">
  <thread>1X544O</thread>
  <subject>Council Votes</subject>
  <body>Need votes from bob, tom, and jane yet for XEP-0000</body>
  <note xmlns="http://www.jabber.org/protocol/sharednote">
    <color>#001122</color>
    <bgcolor>#221100</bgcolor>
    <font>font-name</font>
    <x>%left</x>
    <y>%top</y>
    <z>#</z>
    <width>%</width>
    <height>%</height>
    <update>auto|user</update>
  </note>
</message>
]]></example>

<p>Any element not specified in the note should use the last known setting or client defaults, so that when a
change is sent, only the changed elements are returned.</p>

</section1>

<section1 topic="Implementation Notes">

<p>Each thread is a different shared note. Auto updates should use an internal client timer and batch large
changes into chunks, when the user is typing every 5-10 seconds or so.  When the user has made changes that
haven't been sent and an update comes in on the same thread the client should prompt the user with the
changes offering to replace or save their changes.</p>

</section1>
</xep>
