XEP-0048: Bookmark Storage

Rachel Blackman

Email: rcb@ceruleanstudios.com
JabberID: sparks@jabber.org

Peter Millard

See Author Note

1. Introduction
2. The storage:bookmarks Namespace
    2.1. The url element
    2.2. The conference element
3. Security Considerations
4. IANA Considerations
5. XMPP Registrar Considerations
6. XML Schema
7. Author Note
Notes
Revision History

2.1 The url element

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', like so:

Example 1. An example of the URL element

<iq type='result' id='1'>
  <query xmlns='jabber:iq:private'>
    <storage xmlns='storage:bookmarks'>
      <url name='Complete Works of Shakespeare'
           url='http://the-tech.mit.edu/Shakespeare/'/>
    </storage>
  </query>
</iq>
    
  

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.

2.2 The conference element

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 [2] and Rival Messenger [3]. 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 XML Schema Part 2 [4]) and the default value is "false". [5]

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 Multi-User Chat [6] rooms.

Example 2. An example of the conference element

<iq type='result' id='2'>
  <query xmlns='jabber:iq:private'>
    <storage xmlns='storage:bookmarks'>
      <conference name='Council of Oberon' 
                  autojoin='true'
                  jid='council@conference.underhill.org'>
        <nick>Puck</nick>
        <password>titania</password>
      </conference>
    </storage>
  </query>
</iq>   

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.

<?xml version='1.0' encoding='UTF-8'?>

<xs:schema
    xmlns:xs='http://www.w3.org/2001/XMLSchema'
    targetNamespace='storage:bookmarks'
    xmlns='storage:bookmarks'
    elementFormDefault='qualified'>

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

  <xs:element name='storage'>
    <xs:complexType>
      <xs:choice>
        <xs:element ref='url'/>
        <xs:element ref='conference'/>
      </xs:choice>
    </xs:complexType>
  </xs:element>

  <xs:element name='url'>
    <xs:complexType>
      <xs:simpleContent>
        <xs:extension base='empty'>
          <xs:attribute name='name' type='xs:string' use='required'/>
          <xs:attribute name='url' type='xs:string' use='required'/>
        </xs:extension>
      </xs:simpleContent>
    </xs:complexType>
  </xs:element>

  <xs:element name='conference'>
    <xs:complexType>
      <xs:sequence>
        <xs:element name='nick' type='xs:string' minOccurs='0'/>
        <xs:element name='password' type='xs:string' minOccurs='0'/>
      </xs:sequence>
      <xs:attribute name='autojoin' type='xs:boolean' use='optional' default='false'/>
      <xs:attribute name='jid' type='xs:string' use='required'/>
      <xs:attribute name='name' type='xs:string' use='required'/>
    </xs:complexType>
  </xs:element>

  <xs:simpleType name='empty'>
    <xs:restriction base='xs:string'>
      <xs:enumeration value=''/>
    </xs:restriction>
  </xs:simpleType>

</xs:schema>
  

1. XEP-0049: Private XML Storage <http://www.xmpp.org/extensions/xep-0049.html>.

2. Exodus, see <http://exodus.jabberstudio.org/>.

3. Rival Messenger, see <http://rival.chote.net/>.

4. XML Schema Part 2: Datatypes <http://www.w3.org/TR/xmlschema-2/>.

5. In accordance with Section 3.2.2.1 of XML Schema Part 2: Datatypes, the allowable lexical representations for the xs:boolean datatype are the strings "0" and "false" for the concept 'false' and the strings "1" and "true" for the concept 'true'; implementations MUST support both styles of lexical representation.

6. XEP-0045: Multi-User Chat <http://www.xmpp.org/extensions/xep-0045.html>.

7. The Internet Assigned Numbers Authority (IANA) is the central coordinator for the assignment of unique parameter values for Internet protocols, such as port numbers and URI schemes. For further information, see <http://www.iana.org/>.

8. The XMPP Registrar maintains a list of reserved protocol namespaces as well as registries of parameters used in the context of XMPP extension protocols approved by the XMPP Standards Foundation. For further information, see <http://www.xmpp.org/registrar/>.

Version 1.0 (2003-10-08)

Version 0.3 (2003-05-13)

Version 0.2 (2002-10-03)

Version 0.1 (2002-10-03)