From e696a6d10eb2c597dcdf3ac9540055ae0f1ff90c Mon Sep 17 00:00:00 2001 From: Peter Saint-Andre Date: Tue, 22 May 2012 11:47:32 -0600 Subject: [PATCH] 0.6 --- xep-0277.xml | 382 +++++++++++++++++++++++---------------------------- 1 file changed, 175 insertions(+), 207 deletions(-) mode change 100644 => 100755 xep-0277.xml diff --git a/xep-0277.xml b/xep-0277.xml old mode 100644 new mode 100755 index 7d88240e..9ccb782c --- a/xep-0277.xml +++ b/xep-0277.xml @@ -34,6 +34,12 @@ vanaryon@jappix.com http://vanaryon.eu/ + + 0.6 + 2012-05-22 + snd +

Added node configuration suggestions; removed file attachments; added rich content examples; change atom:content to atom:title anywhere in the document; invented the "Aggregator" entity; changed nodes metainformation locations; added possibility to add own content to repost.

 + 0.5 2011-06-15 @@ -44,7 +50,7 @@ 0.4 2011-06-01 vs -

Added microblog informations feature, ID innacurracy fixed, urn:xmpp:inbox support added, new commenting namespaces, first comment marker, security considerations added.

 +

Added microblog metadata feature, ID innacurracy fixed, urn:xmpp:inbox support added, new commenting namespaces, first comment marker, security considerations added.

 0.3 @@ -81,7 +87,7 @@
  • People learn about your posts only if they have permission to view them.
  • Your microblogging feed is discovered based on your identity at a domain or with a service.
    • -

    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).

    +

    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 messaging transports).

    @@ -101,7 +107,7 @@ xmpp:romeo@montague.lit?;node=urn%3Axmpp%3Amicroblog%3A0

    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.

    -

    The post content itself can be either text ("content" element "type" attribute with "text" value) or XHTML ("content" element "type" attribute with "xhtml" value). If Romeo publishes XHTML content, his client MUST publish two "content" elements: a text one, and a XHTML one. For XHTML publishing, see &xep0060;.

    +

    The post content itself can be either text (content element without "type" attribute or with "type" attribute with "text" value) or XHTML ("content" element "type" attribute with "xhtml" value). If Romeo publishes XHTML content, his client MUST publish two "content" elements: a text one, and a XHTML one. For XHTML publishing, see &xep0060;.

    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).

    - - - Romeo Montague - xmpp:romeo@montague.lit - - - hanging out at the Café Napolitano - - + hanging out at the Café Napolitano tag:montague.lit,2008-05-08:posts-1cb57d9c-1c46-11dd-838c-001143d5d5db 2008-05-08T18:30:02Z 2008-05-08T18:30:02Z @@ -133,9 +128,36 @@ xmpp:romeo@montague.lit?;node=urn%3Axmpp%3Amicroblog%3A0 ]]> +

    Note: The "title" element is required to be included in an "atom:entry" element according to &rfc4287;. An implementation MAY provide also "atom:summary" and/or "atom:content" elements too if it needs.

    + +

    It's possible to insert some rich content in the post or comment. It can be some text formatting, images, etc. Only "xhtml" content type is supported for the moment by this document but possibly it will be extended later. Also, it is RECOMMENDED for the client to restrict XHTML content to the XHTML-IM subset (&xep0071;).

    + + + + + + + <div xmlns="http://www.w3.org/1999/xhtml"> + <p>hanging out at the <strong>Caf&#233; Napolitano</strong></p> + </div> + + tag:montague.lit,2008-05-08:posts-1cb57d9c-1c46-11dd-838c-001143d5d5db + 2008-05-08T18:30:02Z + 2008-05-08T18:30:02Z + + + + + + ]]> +     -

    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 Message Body).

    +

    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 Message Body).

    hanging out at the Caf&#233; Napolitano - + - - - Romeo Montague - xmpp:romeo@montague.lit - - - hanging out at the Caf&#233; Napolitano + hanging out at the Caf&#233; Napolitano @@ -166,10 +182,12 @@ xmpp:romeo@montague.lit?;node=urn%3Axmpp%3Amicroblog%3A0 ]]> +

    Note: these alternate links were not posted by client because client can't compute them itself. These things SHOULD be inserted at server side though.

    Anyone can publish a post in reply to Romeo's post. Here we assume that a reply comes from Benvolio.

    -

    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.

    +

    Note: Inclusion of the "thr: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.

    +

    Note: The post can be a reply to more than the only one another.

    - - - Benvolio Montague - xmpp:romeo@montague.lit - - - @romeo cappuccino this late in the day? + + Benvolio Montague + xmpp:romeo@montague.lit + + @romeo cappuccino this late in the day? @@ -213,8 +229,9 @@ xmpp:romeo@montague.lit?;node=urn%3Axmpp%3Amicroblog%3A0

    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.

     -

    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).

    -

    If a comments link is present (see the Post Comments section of this document), the client SHOULD repeat it to keep the same discussion about the post.

    +

    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 specific "atom:author" child node, "atom:name" and "atom:uri", containing, respectively, the name of the original post author, and his XMPP URI (JID).

    +

    If a comments link is present (see the Post Comments section of this document), the client SHOULD repeat it to keep the same discussion about the post. The client also MAY create a separate node to discuss and specify it or specify both.

    +

    The client SHOULD also put an "atom:link" element with "rel" attribute set to "via" and point it to the original post.

    - - - Romeo Montague - xmpp:romeo@montague.lit - - - hanging out at the Caf&#233; Napolitano + + Romeo Montague + xmpp:romeo@montague.lit + + hanging out at the Caf&#233; Napolitano + tag:montague.lit,2008-05-08:posts-1re57d3c-1q46-11dd-748r-024943d2d5rt 2008-05-08T18:30:02Z 2008-05-08T18:32:02Z @@ -246,64 +264,25 @@ xmpp:romeo@montague.lit?;node=urn%3Axmpp%3Amicroblog%3A0 ]]>

    Thus, a different author JID value lets the client know the microblog item has been repeated from another one.

    +

    It's also possible for Benvolio to add his own thougths to the repost. To do this he SHOULD wrap the original content in the "xhtml:blockquote" element and after it add his own content. Also, the client MAY post reply without quotation to the original thread to inform users about the repost.

     - -

    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.

    - - - - - - - - Romeo Montague - xmpp:romeo@montague.lit - - - Beautiful Eiffel Tower! - - - - - - - tag:montague.lit,2008-05-08:posts-1df87v1q-2d12-43se-761w-318790d3g1sq - 2008-05-08T18:35:02Z - 2008-05-08T18:35:02Z - - - - - + +

    It's often handy to specify categories (or tags) to a post to make it easier to find it or to structure a blog. It's possible by adding "atom:category" element to the entry (it can be blog or replies entry).

    + + ... + + + ... + ]]> -

    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.

         -

    Juliet and Benvolio may want to discuss about latest Romeo's post. Romeo's client MIGHT add a element to the PubSub item. The element MUST have "rel", "title" and "href" attributes, where "rel" MUST have the "replies" value; "title" MUST have the "comments" value; "href" MUST be an XMPP URI (see &rfc5122; and &rfc3986;).

    +

    Juliet and Benvolio may want to discuss about latest Romeo's post. To enable this, Romeo's client MAY add a "atom:link" element to the PubSub item. The element MUST have "rel", "title" and "href" attributes, where "rel" MUST have the "replies" value; "title" MUST have the "comments" value; "href" MUST be an XMPP URI (see &rfc5122; and &rfc3986;).

    -

    We assume Romeo's client first created a comments node (named "urn:xmpp:microblog:0:comments/ID", where "ID" is the microblog item ID, or the SHA-1 encoded attachement URI, as defined in &rfc3174;), with defaults "pubsub#access_model" and "pubsub#publish_model" privacy settings (see &xep0060; for node creation and configuration).

    +

    We assume Romeo's client first created a comments node (named "urn:xmpp:microblog:0:comments/ID", where "ID" is the microblog item ID, or the SHA-1 encoded attachment URI, as defined in &rfc3174;).

    - - - Romeo Montague - xmpp:romeo@montague.lit - - - hanging out at the Caf&#233; Napolitano - - + hanging out at the Caf&#233; Napolitano @@ -337,54 +305,9 @@ xmpp:romeo@montague.lit?;node=urn%3Axmpp%3Amicroblog%3A0 ]]> -

    If the comment to publish is the first item of the node, the client MAY add a "link" element, with the "rel=start" attribute. In this way, clients can determine which comment is the first one of a discussion.

     - -

    As we do for Post Comments, Romeo's client MAY create one comments PubSub node for each attachement of a post (see section of Attaching files to a Post of this document).

    -

    The element to create MUST be children of the parent "link" element of the attachement. Some attributes differ from the original commenting specification: "xmlns" attribute MUST be set to value "urn:xmpp:microblog:0"; "title" attribute MUST be set to value "comments_file".

    - - - - - - - - Romeo Montague - xmpp:romeo@montague.lit - - - I love cranberries! - - - - - - tag:montague.lit,2008-05-08:posts-1af87d4i-3f09-41gt-871e-098182g4b2az - 2008-05-08T18:54:02Z - 2008-05-08T18:54:02Z - - - - - - ]]> -     - -

    If Juliet wants to comment Romeo's latest post, her client MUST then send a new Atom entry to the defined PubSub node.

    + +

    If Juliet wants to comment Romeo's latest post, her client sends a new Atom entry to the defined PubSub node.

    Note: A comments node SHOULD be located at a generic publish-subscribe node that is not attached to a user's IM account, but MAY be located at a personal eventing (PEP) node.

    - - - Juliet Capulet - xmpp:juliet@capulet.lit - - - She is so pretty! + + Juliet Capulet + xmpp:juliet@capulet.lit + + She is so pretty! 2008-05-08T18:39:02Z @@ -413,8 +334,78 @@ xmpp:romeo@montague.lit?;node=urn%3Axmpp%3Amicroblog%3A0     + +

    We have described two pubsub nodes types here: the one is for the microblog itself and the other one is for comments to posts.

    +

    Usage specific requires the special parameters to these nodes to be specified. This section describes recommendation for them.

    + +

    Here are recommendations for a microblogging node (usually located at PEP and named by the "urn:xmpp:microblog:0" namespace) configuration:

    +
      +
    1. The "pubsub#notify_retract" MUST be set to true to provide clients the ability to track if some items were retracted and reflect such changes in the UI correctly.
      2. +
    2. The "pubsub#max_items" SHOULD be increased from the default value to some reasonable value.
      3. +
    3. The "pubsub#send_last_published_item" SHOULD be changed to "never".
      4. +
    +     + +

    Here are recommendations for a comments node configuration:

    +
      +
    1. The "pubsub#notify_retract" MUST be set to true to provide clients the ability to track if some items were retracted and reflect such changes in the UI correctly.
      2. +
    2. The "pubsub#max_items" SHOULD be increased from the default value to some reasonable value.
      3. +
    3. The "pubsub#access_model" SHOULD be set to "open" to allow any user to comment to a post. Other values are suitable too according to the user's settings.
      4. +
    +     +     + + +

    In order to provide users with some metadata (i.e. blog title or author information) about the microblog, the client MUST to add an item with such information. The client MUST set the ID of the item to "0".

    + + + + + + Romeo&apos;s Microblog + tag:montague.lit,2008:home + 2008-05-08T18:30:02Z + + Romeo Montague + xmpp:romeo@montague.lit + + + + + + + ]]> +

    It also necessary to link a comments node to the post which discussed in the node. We will do it by adding the "atom:link" element with "rel=start" attribute:

    + + + + + + + Comments to a post + tag:pubsub.montague.lit,2008:comments-2ze57d9c-1c46-21df-830c-002143d3d2qgf + 2008-05-08T18:30:02Z + + + + + + + ]]> +     + -

    Juliet may want to know which places are Romeo's notices related to. That's why Romeo's client MIGHT geotag microblog entries, using the &xep0080; protocol for storing geolocation informations.

    +

    Juliet may want to know which places are Romeo's notices related to. That's why Romeo's client MAY geotag microblog entries, using the &xep0080; protocol for storing geolocation information.

    Romeo's client MUST create a "geoloc" element, with the &xep0080; reference namespace: "http://jabber.org/protocol/geoloc".

    - - - Romeo Montague - xmpp:romeo@montague.lit - - - Is lost in the forest. Need help! - - + + Romeo Montague + xmpp:romeo@montague.lit + + Is lost in the forest. Need help! @@ -458,48 +442,32 @@ xmpp:romeo@montague.lit?;node=urn%3Axmpp%3Amicroblog%3A0 ]]>     - -

    Romeo may want to publish some informations about his microblog, such as its title, an alternate web-version URI or the last time it was updated.

    -

    Romeo's client MAY publish these informations once he defined them. If so, his client MUST send them to the "urn:xmpp:microblog:0:informations" node, containing one only item, with the ID set to "0".

    - - - - - - - Romeo&apos;s Microblog - - tag:montague.lit,2008:home - 2008-05-08T18:30:02Z - - Romeo Montague - xmpp:romeo@montague.lit - - - - - - - - ]]> -     - - -

    When replying to a comment, it is RECOMMENDED the user's client send a notification to the people who commented on the comments node, as defined in a forthcoming specification currently located at <http://xmpp.org/extensions/inbox/notification-inbox.html>.

    -

    When quoting an user's name (e.g., by using @user tag), it is also RECOMMENDED to send a similar notification.

    + +

    In order to provide some statistical information, to represent the blogs other ways than XMPP (i.e. in web or NNTP), we will need other entities called "Aggregators".

    +

    You can think of aggregators like about search engines in the web: they gather information from the whole web and then represent it suitable ways. The same is true here: Aggregators just subscibe to many entities and then they can build a database to make queries and show appropriate information according to these queries. Also they can be used to represent information in web or other networks.

    +

    Unlike web search engines, an XMPP aggregator does not need to gather information by downloading it frequently to check if something was changed. Instead, it can listen to pubsub events and make its database up-to-date based on this information.

    +

    Aggregators can be started by different people with different aims. It can be aggregator which devoted to the concrete blog service provider which will be subscribed only to its own users, or it can be a global search engine which tries to subscribe to most of users or to aggregate the feeds of other aggregators.

    +

    This section will describe most used aggregator usecases but the list is not exhaustive.

    + +

    There are two different things that carry a similar sense: the XMPP pubsub Item ID and the "atom:id" element. This section is devoted to make a separation between them.

    +

    The pubsub Item ID MUST be used when linking to an entry with an XMPP channel (i.e. by including it in the URI with the "xmpp" schema). the Atom entry ID MUST be built according to &rfc4287; and used in aggregators with the aim of revealing of post duplicates, reposts, mentions, syndications, etc.

    +

    Note that the rules of comparing, building and security notes for "atom:id" are listed in the &rfc4287;.

    +     + + +

    One of the possible aims of aggregator services is to provide web representaion of blogs.

    +

    TBD: insert alternate link to the post with the http address of the post.

    +     +     -

    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 <content/> child of the Atom <entry/>.

    +

    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 "atom:title" child of the "atom:entry".

     - -

    The client SHOULD check that the comment author informations (provided in the "author" element) are valid, by checking that the "publisher" item attribute value matches the "uri" element value. If there is a difference, the comment MIGHT be displayed, but it is RECOMMENDED to specify there is a security problem.

    + +

    The client SHOULD check that the comment author information (provided in the "author" element) is valid, by checking that the "publisher" item attribute value matches the "uri" element value. If there is a difference or the check can not be performed because there was not a "publisher" attribute included, the comment can be displayed, but it is RECOMMENDED to specify there is a security problem.