XEP-xxxx: Pubsub Node Bookmark

Abstract
This specification defines a bookmark element pointing to a Pubsub node
Author
Timothée Jaussoin
Copyright
© 2025 – 2025 XMPP Standards Foundation. SEE LEGAL NOTICES.
Status

ProtoXEP

WARNING: This document has not yet been accepted for consideration or approved in any official manner by the XMPP Standards Foundation, and this document is not yet an XMPP Extension Protocol (XEP). If this document is accepted as a XEP by the XMPP Council, it will be published at <https://xmpp.org/extensions/> and announced on the <standards@xmpp.org> mailing list.
Type
Standards Track
Version
0.0.1 (2025-09-19)
Document Lifecycle
  1. Experimental
  2. Proposed
  3. Stable
  4. Final

1. Introduction

This document defines an extensible bookmark element pointing to a Pubsub node, compatible with the extensions defined in PEP Native Bookmarks (XEP-0402) [1].

This bookmarks elements are always listed as Pubsub items allowing an entity to discover and explore a list of bookmarks listed by another entity. For example in Server-side spaces (XEP-0503) [2] it allows a Space to list Pubsub nodes besides MUCs in a Space and in Pubsub Subscription (XEP-0330) [3] it allows an entity to share Pubsub nodes it subscribed to.

2. Protocol

Information about a Pubsub Node Bookmark is provided by the entity. The bookmark container is defined as a classic <pubsub-node/> element, qualified by with theses specific constraints:

Table 1: attributes
Name Type Description Support
jid attribute The node jid address REQUIRED
node attribute The node node REQUIRED
<extensions/> element XML Elements A set of child elements (of potentially any namespace). Clients MUST preserve these (particularly preserving unknown elements) when editing items. OPTIONAL

2.1 Item ID

The aim of this XEP is to allow an entity to handle a list of subscriptions. To simplify the managment of this list the ID of the Publish-Subscribe (XEP-0060) [4] items MUST be the Pubsub URI of the node as defined in Publish-Subscribe (XEP-0060) [4]#impl-uri without the 'xmpp:' part.

3. Requirements

The motivations for this document are to:

4. Use Cases

4.1 Discovering Pubsub Nodes Bookmarks

Example 1. Requests the list of bookmarks
<iq type='get'
    from='student@university.org'
    to='library.university.org'
    id='list-bookmarks'>
  <pubsub xmlns='http://jabber.org/protocol/pubsub'>
    <items node='bookmarks-lists'/>
  </pubsub>
</iq>
Example 2. Server return the list of bookmarks
<iq type='result'
    from='library.university.org'
    to='student@university.org/cool-client'
    id='list-bookmarks'>
  <pubsub xmlns='http://jabber.org/protocol/pubsub'>
    <items node='bookmarks-lists'>
      <item id='bookmarks.library.org?;node=books'>
        <pubsub-node xmlns="urn:xmpp:pubsub-node_bookmark:0"
                      jid="bookmarks.library.org"
                      node="books" />
      </item>
      <item id='bookmarks.library.org?;node=books'>
        <pubsub-node xmlns="urn:xmpp:pubsub-node_bookmark:0"
                      jid="bookmarks.library.org"
                      node="movies">
          <extensions>
            <pinned xmlns='urn:xmpp:bookmarks-pinning:0'/>
          </extensions>
        </pubsub-node>
      </item>
      <!-- other items -->
    </items>
  </pubsub>
</iq>

5. Security Considerations

Related to the XEPs using this document.

6. IANA Considerations

This document requires no interaction with the Internet Assigned Numbers Authority (IANA) [5].

7. XMPP Registrar Considerations

The XMPP Registrar [6] is requested to issue an initial namespace of "urn:xmpp:pubsub:subscription".

8. XML Schema

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

<xs:schema
    xmlns:xs='http://www.w3.org/2001/XMLSchema'
    targetNamespace='urn:xmpp:pubsub-node-bookmark:0'
    xmlns='urn:xmpp:pubsub-node-bookmark:0'
    elementFormDefault='qualified'>

  <xs:annotation>
    <xs:documentation>
      The protocol documented by this schema is defined in
      XEP-xxxx: http://www.xmpp.org/inbox/pubsub-node-bookmark.html
    </xs:documentation>
  </xs:annotation>

  <xs:element name='pubsub-node'>
    <xs:complexType>
      <xs:sequence>
        <xs:element ref='extensions' minOccurs='0' />
      </xs:sequence>
      <xs:attribute name='jid' type='xs:string' use='required'/>
      <xs:attribute name='node' type='xs:string' use='required'/>
    </xs:complexType>
  </xs:element>

  <xs:element name='extensions'>
    <xs:complexType>
      <xs:sequence>
        <xs:any namespace='##other'
                minOccurs='0'
                maxOccurs='unbounded'
                processContents='lax'/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
</xs:schema>

Appendices

Appendix A: Document Information

Series
XEP
Number
xxxx
Publisher
XMPP Standards Foundation
Status
ProtoXEP
Type
Standards Track
Version
0.0.1
Last Updated
2025-09-19
Approving Body
XMPP Council
Dependencies
XMPP Core, XEP-0001, XEP-0163, XEP-0060
Supersedes
None
Superseded By
None
Short Name
NOT_YET_ASSIGNED

This document in other formats: XML  PDF

Appendix B: Author Information

Timothée Jaussoin
Email
edhelas@movim.eu
JabberID
edhelas@movim.eu
URI
https://edhelas.movim.eu

Copyright

This XMPP Extension Protocol is copyright © 1999 – 2024 by the XMPP Standards Foundation (XSF).

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.

Disclaimer of 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. ##

Limitation of 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.

IPR 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 <https://xmpp.org/about/xsf/ipr-policy> or obtained by writing to XMPP Standards Foundation, P.O. Box 787, Parker, CO 80134 USA).

Visual Presentation

The HTML representation (you are looking at) is maintained by the XSF. It is based on the YAML CSS Framework, which is licensed under the terms of the CC-BY-SA 2.0 license.

Appendix D: Relation to XMPP

The Extensible Messaging and Presence Protocol (XMPP) is defined in the XMPP Core (RFC 6120) and XMPP IM (RFC 6121) specifications contributed by the XMPP Standards Foundation to the Internet Standards Process, which is managed by the Internet Engineering Task Force in accordance with RFC 2026. Any protocol defined in this document has been developed outside the Internet Standards Process and is to be understood as an extension to XMPP rather than as an evolution, development, or modification of XMPP itself.

Appendix E: Discussion Venue

The primary venue for discussion of XMPP Extension Protocols is the <standards@xmpp.org> discussion list.

Discussion on other xmpp.org discussion lists might also be appropriate; see <https://xmpp.org/community/> for a complete list.

Errata can be sent to <editor@xmpp.org>.

Appendix F: Requirements Conformance

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.

Appendix G: Notes

1. XEP-0402: PEP Native Bookmarks <https://xmpp.org/extensions/xep-0402.html>.

2. XEP-0503: Server-side spaces <https://xmpp.org/extensions/xep-0503.html>.

3. XEP-0330: Pubsub Subscription <https://xmpp.org/extensions/xep-0330.html>.

4. XEP-0060: Publish-Subscribe <https://xmpp.org/extensions/xep-0060.html>.

5. 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/>.

6. 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 <https://xmpp.org/registrar/>.

Appendix H: Revision History

Note: Older versions of this specification might be available at https://xmpp.org/extensions/attic/

  1. Version 0.0.1 (2025-09-19)

    First draft.

    psa

Appendix I: Bib(La)TeX Entry

@report{jaussoin2025xepxxxx,
  title = {Pubsub Node Bookmark},
  author = {Jaussoin, Timothée},
  type = {XEP},
  number = {xxxx},
  version = {0.0.1},
  institution = {XMPP Standards Foundation},
  url = {https://xmpp.org/extensions/xep-xxxx.html},
  date = {2025-09-19/2025-09-19},
}

END