<remark><p>Initial version as accepted for publication by the XMPP Council.</p></remark>
</revision>
<revision>
<version>0.0.1</version>
<date>2008-05-07</date>
<initials>psa/jh</initials>
<remark><p>First draft.</p></remark>
</revision>
</header>
<section1topic='Introduction'anchor='intro'>
<p>Microblogging is an increasingly popular technology for lightweight interaction over the Internet. It differs from traditional blogging in that:</p>
<ul>
<li>Posts are short (typically less than 140 characters, which is the limit in SMS).</li>
<li>Posts are in plain text.</li>
<li>People can reply to your posts, but not directly comment on them.</li>
<li>People learn about your posts only if they have permission to view them.</li>
<li>Your microblogging feed is discovered based on your identity at a domain or with a service.</li>
</ul>
<p>These characteristics map well to instant messaging systems such as those built using Jabber/XMPP technologies (e.g., permissions can be based on existing presence subscriptions as reflected in the XMPP roster or "buddy list"). Furthermore, the push nature of XMPP (especially as formalized in the &xep0163; profile of &xep0060; overcomes the problems of polling for updates via HTTP, which has caused scaling issues in existing microblogging services. Therefore this specification defines a method for microblogging over XMPP, building on the existing method for transporting Atom syndication data &rfc4287; over XMPP as described in &atomsub;. These XMPP-based methods are complementary to HTTP-based methods, and can provide an XMPP interface to existing microblogging services (which may also be accessible via HTTP, Short Message Service (SMS), and other message transports).</p>
<p>A person's microblog SHOULD be located at a personal eventing (PEP) node whose name is "urn:xmpp:microblog:0" but MAY be located at a generic publish-subscribe node that is not attached to a user's IM account. For instance, if the Shakespearean character Romeo has a JabberID of <romeo@montague.lit> then his microblog would be located at that JID with a node of "urn:xmpp:microblog:0". Outside of native XMPP systems, this node can be referred to as the following XMPP URI (the ":" character from the namespace URN is percent-encoded in the query component; see &rfc5122; and &rfc3986;).</p>
<p>Naturally, this node can be discovered by contacting romeo@montague.lit directly using &xep0030;.</p>
</section2>
<section2topic='Subscribing to a Microblog'anchor='subscribe'>
<p>Let us imagine that Juliet wishes to receive the posts that Romeo publishes to his microblog. She has two options:</p>
<ol>
<li>Implicitly subscribe by advertising support for "urn:xmpp:microblog:0+notify" in her &xep0115; data. Romeo's PEP service then automatically sends posts to her when it receives presence from her, until and unless she sends presence of type unavailable or stops advertising an interest in microblog updates.</li>
<li>Explicitly subscribe by sending a formal subscription request to the "urn:xmpp:microblog:0" node at Romeo's JabberID. Romeo's PEP service may send her all posts even if she is offline at the time (depending on service policies regarding presence integration).</li>
</ol>
</section2>
<section2topic='Publishing a Post'anchor='publish'>
<p>Romeo can publish a post via any interface provided by his service, such as a website, the Atom Publishing Protocol (see &rfc5023;), SMS, an IM bot, or XMPP pubsub. Here we assume that the post is provided via XMPP pubsub.</p>
<p>Note: Publishing via HTTP, AtomPub, SMS, or IM bot is simpler for the client (e.g., because the client does not need to generate an Item ID).</p>
<section2topic='Receiving a Post'anchor='receive'>
<p>Because Juliet has sent presence to Romeo including Entity Capabilities data that encapsulates the "urn:xmpp:microblog:0+notify" feature, Romeo's XMPP server will send a PEP notification to Juliet. The notification can include an XMPP message body for backwards-compatibility with Jabber clients that are not pubsub-capable (see <ahref="#body">Message Body</a>).</p>
<examplecaption="Receiving a post"><![CDATA[
<messagefrom='romeo@montague.lit'
to='juliet@capulet.lit'
type='headline'>
<body>hanging out at the Caf&#233; Napolitano</body>
<section2topic='Replying to a Post'anchor='reply'>
<p>Anyone can publish a post in reply to Romeo's post. Here we assume that a reply comes from Benvolio.</p>
<p>Note: Inclusion of the <in-reply-to/> element defined in &rfc4685; indicates the post to which the user is replying. This reply includes two such elements (one pointing to the HTTP URL for the post and the other pointing to the XMPP URI for the post.</p>
<p>Assuming that Romeo has also shared presence with Benvolio and has advertised support for "urn:xmpp:microblog:0+notify", he will receive the reply that Benvolio sent.</p>
<p>When Benvolio wants to repeat a Romeo's post, his client publishes the same post under a different name. But to be able to track the repeated post original author, Benvolio's client MAY use two specific <author /> child nodes, <name /> and <uri />, containing, respectively, the name of the original post author, and his XMPP URI (JID).</p>
<p>If a comments link is present (see the <linkurl='#comments_node'>Comments node</link> section of this document), the client SHOULD repeat it to keep the same discussion about the post.</p>
<examplecaption="Repeating a Post"><![CDATA[
<iqfrom='benvolio@montague.lit/mobile'
id='pub2'
to='benvolio@montague.lit'
type='set'>
<pubsubxmlns='http://jabber.org/protocol/pubsub'>
<publishnode='urn:xmpp:microblog:0'>
<itemid='1re57d3c-1q46-11dd-748r-024943d2d5rt'>
<entryxmlns='http://www.w3.org/2005/Atom'>
<source>
<title>Benvolio&apos;s Microblog</title>
<linkhref='http://montague.lit/benvolio'/>
<id>tag:montague.lit,2008:home</id>
<updated>2008-05-08T18:30:02Z</updated>
<author>
<name>Romeo Montague</name>
<uri>xmpp:romeo@montague.lit</uri>
</author>
</source>
<title>hanging out at the Caf&#233; Napolitano</title>
<p>Thus, a different author JID value lets the client know the microblog item has been repeated from another one.</p>
</section2>
<section2topic='Attaching files to a Post'anchor='attach'>
<p>Romeo might want to attach some files, such as pictures of his last vacations, or documents he wants to share. For each file to publish, Romeo's client MUST add a <link /> element. The "href" and "rel" attributes MUST be added; the "title", "type" and "length" ones MIGHT be added.</p>
<examplecaption="Attaching some files to a Post"><![CDATA[
<p>If client can generate some thumbnails images of the attached file (for pictures, videos or documents), it MAY create one or more <link /> sub-elements to the parent file <link /> element. It MUST set "xmlns" attribute to "urn:xmpp:microblog:0"; "rel" attribute to "self"; "title" attribute to "thumb"; "href" to the path of the thumbnail image. It SHOULD also have a "type" attribute specifying the thumbnail file MIME type.</p>
</section2>
</section1>
<section1topic='Comments'anchor='comments'>
<p>Juliet and Benvolio may want to discuss about latest Romeo's post. Romeo's client MIGHT add a <link/> element to the PubSub item. The element MUST have "rel", "title" and "href" attributes, where "rel" MUST have the "related" value; "title" MUST have the "comments" value; "href" MUST be an XMPP URI (see &rfc5122; and &rfc3986;).</p>
<p>We assume Romeo's client first created a comments node (named "urn:xmpp:microblog:0:comments:hash", where "hash" is a client-side generated random hash), with defaults "pubsub#access_model" and "pubsub#publish_model" privacy settings (see &xep0060; for node creation and configuration).</p>
<examplecaption="Adding a comments link to a Post"><![CDATA[
<iqfrom='romeo@montague.lit/pda'
id='pub4'
to='romeo@montague.lit'
type='set'>
<pubsubxmlns='http://jabber.org/protocol/pubsub'>
<publishnode='urn:xmpp:microblog:0'>
<itemid='2ze57d9c-1c46-21df-830c-002143d3d2qgf'>
<entryxmlns='http://www.w3.org/2005/Atom'>
<source>
<title>Romeo&apos;s Microblog</title>
<linkhref='http://montague.lit/romeo'/>
<id>tag:montague.lit,2008:home</id>
<updated>2008-05-08T18:30:02Z</updated>
<author>
<name>Romeo Montague</name>
<uri>xmpp:romeo@montague.lit</uri>
</author>
</source>
<title>hanging out at the Caf&#233; Napolitano</title>
<p>If Benvolio wants to retrieve the comments node, his client will send a standard PubSub stanza to request all items (see &xep0060; for all items retrieving).</p>
<p>Depending on service policies and the value of the "pubsub#include_body" node configuration option, microblogging notifications SHOULD include a message <body/> element for backwards-compatibility with Jabber clients that are not pubsub-capable. It is RECOMMENDED for the XML character value of the <body/> element to be the same as that of the <title/> child of the Atom <entry/>.</p>
<p>This specification re-uses the schema for the Atom content format, i.e., the 'http://www.w3.org/2005/Atom' namespace (see <cite>RFC 4287</cite>).</p>