Management Information Base for the Internet Protocol (IP)
RFC 4293

Network Working Group                                    H. Schulzrinne
Request for Comments: 4482                                  Columbia U.
Category: Standards Track                                      July 2006

  CIPID: Contact Information for the Presence Information Data Format

Status of This Memo

  This document specifies an Internet standards track protocol for the
  Internet community, and requests discussion and suggestions for
  improvements.  Please refer to the current edition of the "Internet
  Official Protocol Standards" (STD 1) for the standardization state
  and status of this protocol.  Distribution of this memo is unlimited.

Copyright Notice

  Copyright (C) The Internet Society (2006).

Abstract

  The Presence Information Data Format (PIDF) defines a basic XML
  format for presenting presence information for a presentity.  The
  Contact Information for the Presence Information Data format (CIPID)
  is an extension that adds elements to PIDF that provide additional
  contact information about a presentity and its contacts, including
  references to address book entries and icons.

Schulzrinne                Standards Track                    [Page 1]
RFC 4482                        CIPID                        July 2006

Table of Contents

  1. Introduction ....................................................2
  2. Terminology and Conventions .....................................3
  3. CIPID Elements ..................................................3
      3.1. Card Element ...............................................3
      3.2. Display-Name Element .......................................3
      3.3. Homepage Element ...........................................3
      3.4. Icon Element ...............................................4
      3.5. Map Element ................................................4
      3.6. Sound Element ..............................................4
  4. Example .........................................................4
  5. The XML Schema Definition .......................................6
  6. IANA Considerations .............................................7
      6.1. URN Sub-Namespace Registration for .........................7
          'urn:ietf:params:xml:ns:pidf:cipid'
      6.2. Schema Registration for Schema
          'urn:ietf:params:xml:ns:pidf:cipid' ........................7
  7. Internationalization Considerations .............................8
  8. Security Considerations .........................................8
  9. References ......................................................9
      9.1. Normative References .......................................9
      9.2. Informative References ....................................10

1.  Introduction

  Presence information facilitates communication; its usefulness can be
  enhanced by providing basic information about a presentity or
  contact.  This specification describes a basic set of information
  elements that allow a watcher to retrieve additional information
  about a presentity or contact.

  This specification defines extensions to the PIDF [9] Extensible
  Markup Language [7][8][10] (XML) document format.

  We describe elements for providing a "business card", references to
  the homepage, map, representative sound, display name, and an icon.
  This additional presence information can be used in PIDF [9]
  documents, together with Rich Presence Information Data format [11]
  (RPID), future-status [12], and other PIDF extensions.

  All elements extend the <person> or, less commonly, <tuple> element
  in the presence data model [13].  The <tuple> element is only
  extended with Contact Information for the Presence Information Data
  format (CIPID) elements if the information describes a service
  referring to another person that is marked by an RPID <relationship>
  element with a value other than 'self'.  All elements described in
  this document are optional.

Schulzrinne                Standards Track                    [Page 2]
RFC 4482                        CIPID                        July 2006

  RPID and CIPID both provide "rich" presence that goes beyond the
  basic 'open' and 'closed' status information in PIDF.  The presence
  information described in these two documents can be supplied
  independently, although in practice, both will often appear in the
  same PIDF document.  CIPID elements describe the more static aspects
  of somebody's presence information, while RPID focuses on elements
  that will likely change throughout the day.  Thus, CIPID information
  can often be statically configured by the user through the graphical
  user interface of a presence client; this is less likely to be
  sufficient for RPID.

  The namespace URI for these elements defined by this specification is
  a URN [2], using the namespace identifier 'ietf' defined by [4] and
  extended by [6]:

      urn:ietf:params:xml:ns:pidf:cipid

2.  Terminology and Conventions

  The key words MUST, MUST NOT, REQUIRED, SHOULD, SHOULD NOT,
  RECOMMENDED, MAY, and OPTIONAL in this document are to be interpreted
  as described in BCP 14, RFC 2119 [1].

3.  CIPID Elements

  Unless otherwise noted below, each element may only appear at most
  once.

3.1.  Card Element

  The <card> element includes a URI pointing to a business card, e.g.,
  in LDAP Data Interchange Format [15] (LDIF) or vCard [14] format.

3.2.  Display-Name Element

  The <display-name> element includes the name identifying the tuple or
  person that the presentity suggests should be shown by the watcher
  user interface.  It is left to the watcher user interface design to
  choose whether to heed this suggestion or to use some other suitable
  string.  The CIPID information MAY contain multiple display names,
  but only if they are labeled with different 'xml:lang' attributes.
  This allows a Korean-speaking presentity to convey its display name
  in different languages, Latin and Hangul, for example.

3.3.  Homepage Element

  The <homepage> element provides a URI pointing to general information
  about the tuple or person, typically a web home page.

Schulzrinne                Standards Track                    [Page 3]
RFC 4482                        CIPID                        July 2006

3.4.  Icon Element

  The <icon> element provides a URI pointing to an image (icon)
  representing the tuple or person.  The watcher can use this
  information to represent the tuple or person in a graphical user
  interface.  Presentities SHOULD provide images of sizes and aspect
  ratios that are appropriate for rendering as an icon.  Support for
  JPEG, PNG, and GIF formats is REQUIRED.

3.5.  Map Element

  The <map> element provides a URI pointing to a map related to the
  tuple or person.  The watcher can use this information to represent
  the tuple or person in a graphical user interface.  The map may be
  either an image, an HTML client-side image map, or a geographical
  information system (GIS) document, e.g., encoded as GML.  Support for
  images formatted as PNG and GIF is REQUIRED.

3.6.  Sound Element

  The <sound> element provides a URI pointing to a sound related to the
  tuple or person.  The watcher MAY use the sound object, such as a
  MIDI or MP3 file, referenced by the URL to inform the watcher that
  the presentity has assumed the status OPEN.  Implementors are advised
  to create user interfaces that provide the watcher with the
  opportunity to choose whether to play such sounds.  Support for
  sounds coded as MPEG-2 Layer 3 (MP3) is RECOMMENDED.  The sound
  object might also be used to indicate how to pronounce the
  presentity's name.

4.  Example

  An example using CIPID only is shown below:

  <?xml version="1.0" encoding="UTF-8"?>
  <presence xmlns="urn:ietf:params:xml:ns:pidf"
        xmlns:dm="urn:ietf:params:xml:ns:pidf:data-model"
        xmlns:c="urn:ietf:params:xml:ns:pidf:cipid"
        entity="pres:someone@example.com">

    <tuple id="bs35r9">
      <status>
        <basic>open</basic>
      </status>
      <contact priority="0.8">im:alice@example.net</contact>
      <timestamp>2005-11-21T16:14:29Z</timestamp>
    </tuple>

Schulzrinne                Standards Track                    [Page 4]
RFC 4482                        CIPID                        July 2006

    <dm:person id="p1">
      <c:card>http://example.com/~alice/card.vcd</c:card>
      <c:display-name>Alice Lewis</c:card>
      <c:homepage>http://example.com/~alice</c:homepage>
      <c:icon>http://example.com/~alice/me.png</c:icon>
      <c:map>http://example.com/~alice/gml-map.xml</c:map>
      <c:sound>http://example.com/~alice/hello.wav</c:sound>
      <dm:timestamp>2005-11-21T09:00:00+05:00</dm:timestamp>
    </dm:person>
  </presence>

  An example combining RPID and CIPID is shown below:

  <?xml version="1.0" encoding="UTF-8"?>
  <presence xmlns="urn:ietf:params:xml:ns:pidf"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:dm="urn:ietf:params:xml:ns:pidf:data-model"
  xmlns:c="urn:ietf:params:xml:ns:pidf:cipid"
  xmlns:r="urn:ietf:params:xml:ns:pidf:rpid"
  xsi:schemaLocation=&Amy Vezza