%ents; ]>
Bookmark Storage This document defines an XML data format for storing bookmarks to XMPP conference rooms and HTTP URLs. &LEGALNOTICE; 0048 Proposed Standards Track Standards XMPP Core XEP-0049 XEP-0223 bookmarks http://www.xmpp.org/schemas/bookmarks.xsd Rachel Blackman rcb@ceruleanstudios.com sparks@jabber.org &pgmillard; &stpeter; 1.1pre1 in progress, last updated 2007-09-12 psa

Specified use of PEP as a storage mechanism in addition to existing jabber:iq:private method.

 1.0 2003-10-08 psa

Per a vote of the Jabber Council, changed status to Active; also added XML schema.

 0.3 2003-05-13 rcb

Re-focused to document only the existing protocol in use.

 0.2 2002-10-03 pgm

Typos, etc...

 0.1 2002-10-03 pgm

Initial version.

For ease-of-use in a Jabber client, it is desirable to have a way to store shortcuts to various services and resources (such as conference rooms and web pages) as 'bookmarks' that can be displayed in the user's client. Several Jabber clients have already agreed on and implemented a method to provide this service; that informal agreement is documented and expanded upon in this document. In particular, we introduce the 'storage' element (qualified by the 'storage:bookmarks' namespace) as a container for this sort of this data. While the <storage/> element can be stored using any XML storage mechanism, this document describes two such methods that are specific to XMPP.

A storage element marked by the storage:bookmarks namespace will contain a collection of child elements, each representing a 'bookmark' to be displayed in the client. At present, only two sub-elements are defined, 'conference' for conference rooms and 'url' for normal URLs.

All elements under storage MUST allow a 'name' tag, which is the friendly name by which they will be displayed in the client. If an element lacks a 'name' tag, the client SHOULD generate an appropriate substitution based on the other available data.

One of the most common uses of bookmarks will likely be to bookmark conference rooms on various Jabber servers. It is this aspect of the bookmark system which is used today by existing clients such as Exodus Exodus, see <http://exodus.jabberstudio.org/>. and Rival Messenger Rival Messenger, see <http://rival.chote.net/>.. In addition to the required 'jid' attribute, the conference element also possesses an 'autojoin' attribute, which determines whether or not the client should automatically join that conference room on login; this attribute is of type xs:boolean (see &w3xmlschema2;) and the default value is "false". &BOOLEANNOTE;

The conference element MAY also contain 'nick' and 'password' sub-elements; the XML character data from these elements should be used when joining the room from the bookmark. Password is, of course, important for joining potentially password-protected &xep0045; rooms.

Puck titania ]]>

This bookmark would be displayed as 'Council of Oberon' and, if activated, would attempt to join the conference room 'council@conference.underhill.org' with nickname 'Puck' and password 'titania'. A bookmark set may contain any number of conference rooms.

URLs are fairly simple, as they only need to store a URL and a title, and the client then can simply launch the appropriate browser.

A URL element therefore only needs a 'url' tag in addition to the required 'name'.

]]>

This bookmark would be displayed in the client as 'Complete Works of Shakespeare' and would take the user to http://the-tech.mit.edu/Shakespeare/ if activated. A bookmark set can contain any number of urls.

It is recommended to use either &xep0060; or &xep0049; in order to store the data format defined above; however, other methods could be used, such as HTTP.

A client may use Publish-Subscribe (XEP-0060) for data storage, specifically through the use of personal data nodes hosted at the user's virtual publish-subscribe service as described in &xep0223;.

JC Gl0b3 http://jabber.org/protocol/pubsub#publish-options true whitelist ]]> ]]>

The stored data is automatically pushed to all of the user's connected resources.

JC Gl0b3 Seems to be a good writer Oh my sweetest love ... ]]>

In order to retrieve stored data without receiving notifications (e.g., upon initial login), the user's client sends a retrieve-items request as specified in XEP-0060.

]]> JC Gl0b3 ]]>

A client may use Private Data Storage (XEP-0049) for data storage.

Puck titania ]]> ]]>

Note: The private XML storage protocol does not provide notifications to all connected resources, only an acknowledgement to the uploading resource.

 ]]> Puck titania ]]>

Security considerations related to object persistent via publish-subscribe are described in XEP-0060 and XEP-0223.

Security considerations related to private XML storage are described in XEP-0049.

This document requires no interaction with &IANA;.

No action by the ®ISTRAR; is required, since the 'storage:bookmarks' namespace is already included in the protocol namespaces registry (see &NAMESPACES;).

 The protocol documented by this schema is defined in XEP-0048: http://www.xmpp.org/extensions/xep-0048.html ]]>

Peter Millard, a co-author of this specification from version 0.1 through version 1.0, died on April 26, 2006.