moparisthebest/xeps
1
0
Fork 0
mirror of https://github.com/moparisthebest/xeps synced 2024-11-26 19:22:15 -05:00
Code Issues Releases Wiki Activity
ecba015bdd
xeps/xep-0154.xml
Matthew Wild 373b9de7b6 Multiple XEPs: Cross-document editorial adjustments for inclusive language. 
Further reading and some rationale for these changes can be found at:
https://tools.ietf.org/html/draft-knodel-terminology-04

All changes are intended to be editorial in nature, not break existing
wire protocols, and not alter the meanings of any text.
2021-03-04 17:59:37 +01:00

1968 lines
94 KiB
XML
Raw Blame History

<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE xep SYSTEM 'xep.dtd' [
<!ENTITY % ents SYSTEM 'xep.ent'>
%ents;
]>
<?xml-stylesheet type='text/xsl' href='xep.xsl'?>
<xep>
<header>
<title>User Profile</title>
<abstract>This document specifies how to represent and manage profile data about IM users and other XMPP entities using the XMPP Data Forms extension.</abstract>
&LEGALNOTICE;
<number>0154</number>
<status>Deferred</status>
<type>Standards Track</type>
<sig>Standards</sig>
<approver>Council</approver>
<dependencies>
<spec>XMPP Core</spec>
<spec>XEP-0004</spec>
<spec>XEP-0060</spec>
<spec>XEP-0068</spec>
<spec>XEP-0163</spec>
</dependencies>
<supersedes>
<spec>XEP-0054</spec>
</supersedes>
<supersededby/>
<shortname>TO-BE-ASSIGNED</shortname>
&stpeter;
<revision>
<version>0.6.1</version>
<date>2021-03-04</date>
<initials>mw</initials>
<remark><p>Cross-document editorial adjustments for inclusive language.</p></remark>
</revision>
<revision>
<version>0.6</version>
<date>2008-04-18</date>
<initials>psa</initials>
<remark><p>Updated to reflect stable PEP protocol; added OpenID field; specified XML schema; changed namespace to conform to XMPP Registrar procedures.</p></remark>
</revision>
<revision>
<version>0.5</version>
<date>2006-08-02</date>
<initials>psa</initials>
<remark><p>Updated to reflect changes to XEP-0163; added some mappings to the eduPerson object class.</p></remark>
</revision>
<revision>
<version>0.4</version>
<date>2006-01-16</date>
<initials>psa</initials>
<remark><p>Defined data management methods using IQ and the PEP subset of pubsub; added various data fields from LDAP; changed namespace from profiledata to profile.</p></remark>
</revision>
<revision>
<version>0.3</version>
<date>2005-11-11</date>
<initials>psa</initials>
<remark><p>Added postaladdress, fav_chatrooms, alt_contact, teams; added various security-related fields.</p></remark>
</revision>
<revision>
<version>0.2</version>
<date>2005-07-25</date>
<initials>psa</initials>
<remark><p>Added mappings to common LDAP schemas.</p></remark>
</revision>
<revision>
<version>0.1</version>
<date>2005-06-16</date>
<initials>psa</initials>
<remark><p>Initial version.</p></remark>
</revision>
<revision>
<version>0.0.5</version>
<date>2005-06-13</date>
<initials>psa</initials>
<remark><p>Defined how to handle vCard types such as home vs. work addresses.</p></remark>
</revision>
<revision>
<version>0.0.4</version>
<date>2005-04-07</date>
<initials>psa</initials>
<remark><p>Reworked field standardization; added support for telephony addresses, electronic addresses, and organizational data.</p></remark>
</revision>
<revision>
<version>0.0.3</version>
<date>2005-03-11</date>
<initials>psa</initials>
<remark><p>Added open issues.</p></remark>
</revision>
<revision>
<version>0.0.2</version>
<date>2005-01-06</date>
<initials>psa</initials>
<remark><p>Explained requirements and design decisions in more detail, especially with regard to extensibility; split photo into two elements (data and URL).</p></remark>
</revision>
<revision>
<version>0.0.1</version>
<date>2004-11-10</date>
<initials>psa</initials>
<remark><p>First draft.</p></remark>
</revision>
</header>
<section1 topic='Introduction' anchor='intro'>
<p>It is widely acknowledged within the Jabber/XMPP community that the &xep0054; specification (<cite>XEP-0054</cite>) has outlived its usefulness. There are several reasons for this conclusion:</p>
<ol>
<li><cite>XEP-0054</cite> is not fully consistent with the Internet-Draft on which it was based.</li>
<li>The Internet-Draft on which it was based was never approved by the IETF.</li>
<li>Because of confusion over aspects of the vcard-temp specification, there exist incompatible implementations.</li>
<li>vCard (&rfc2426;) captures only a limited set of information.</li>
<li>vCard (even in its XML representation <note>For links to the experimental XML representation of vCard, see <cite>XEP-0054</cite>.</note>) is not easily extensible, leading those who develop profiles for specialized communities to "roll their own" protocols, to the detriment of interoperability.</li>
<li>vCard data tends to be monolithic (the basic unit of information is the full vCard, not parts thereof).</li>
<li>The publication model for XEP-0054 is to set the full vCard, rather than only the parts that need to be modified.</li>
<li>The retrieval model for XEP-0054 is to get the full vCard, rather than only the parts that have been modified.</li>
</ol>
<p>Given the weaknesses of vCard, there is interest across the broader Internet community in replacing vCard with something more modern and extensible. Unfortunately, no other standards development organization has developed an alternative to vCard. Part of the challenge is that quite detailed ontologies have been developed that might replace parts of the vCard specification (e.g., the <cite>Extensible Name and Address Language</cite> <note>See &lt;<link url='http://xml.coverpages.org/xnal.html'>http://xml.coverpages.org/xnal.html</link>&gt;.</note> developed by &OASIS;) while less-formal ontologies are being used to represent other parts of the problem space (e.g., &foaf;). The relevant protocols are in flux and it is unclear when (or even if) stability will emerge.</p>
<p>Because of the unsettled landspace and the strong desire within the Jabber/XMPP community to move beyond XEP-0054, this document specifies methods for the representation of profile data in terms of the &xep0004; protocol (further qualified using the standardization concepts specified in &xep0068;) and for the management of profile data using standard IQ request-response semantics as well as, for more frequently-modified data, &xep0060; semantics (specifically the simplified subset of those semantics specified in &xep0163;). The rationale behind these design decisions is provided below.</p>
</section1>
<section1 topic='Requirements' anchor='reqs'>
<p>This document addresses the following requirements for data management:</p>
<ol>
<li>Enable an entity to publish profile data about itself.</li>
<li>Enable requesting entities to retrieve profile data about other entities.</li>
</ol>
<p>This document addresses the following requirements for data representation:</p>
<ol>
<li>Specify how to represent profile data in an XMPP-friendly manner for communication over the wire.</li>
<li>Ensure that the protocol is extensible (e.g., not limited to existing vCard fields).
<note>The extensibility requirement is critically important, because it would be best if the protocol specified herein could be used to represent data used within specialized communities. Examples of such communities include dating services, multiplayer gaming networks, IM services provided by portals and ISPs, and expert-location systems within large corporations. While such communities might use part or all of some common set of data fields (such as fields that map to familiar vCard elements), each community might also want to represent quite disparate kinds of information (dating criteria, favorite games, contact preferences, areas of expertise, and the like). Furthermore, data might be used to profile network actors that are not persons (e.g., bots, services, and other software agents). Therefore, the ideal proposal will provide an extensible framework for representing profile data and will not limit itself to representing the relatively small set of data fields covered by the vCard format.</note>
</li>
<li>Where possible, map profile data fields to existing vCard fields and other common formats.</li>
</ol>
</section1>
<section1 topic='Concepts and Approach' anchor='approach'>
<section2 topic='Data Management' anchor='approach-management'>
<p>There are several possible approaches to representing profile data for communication over XMPP networks, including the following:</p>
<ol>
<li>
<p><strong>IQ (request-and-response) semantics.</strong></p>
<p>In the simplest case, an entity may store its own profile data and provide only the complete profile and only on request, using the request-response semantics of the XMPP &IQ; stanza type. This model is most appropriate for stable entities that are always online and whose profile data does not change frequently, such as servers and server-side components (entities that are not always online or that frequently modify their profile data, such as IM users, may prefer to publish their information to entities that are always online, such as an IM user's server). While it may seem desirable to embed profile data in the responses an entity provides to service discovery information requests using &xep0128;, it is likely that profile data will be quite extensive; therefore, we define a standalone "wrapper" element for profile data, qualified by the 'urn:xmpp:tmp:profile' namespace &NSNOTE;.</p>
</li>
<li>
<p><strong>Pubsub (publish-and-subscribe) semantics.</strong></p>
<p>A more complex model is for an entity to publish its profile data to a publish-subscribe node or nodes and allow other entities to subscribe to that node or nodes, thus receiving notifications whenever the profiled entity updates its data. This model is more appropriate for entities that modify their profile data on a regular basis or when other entities wish to be informed when the profile data changes. Because this model will most likely be used most often by IM users and other intermittently-connected network endpoints, we use the simplified subset of the XMPP publish-subscribe extension defined in <cite>XEP-0163</cite> to implement this model.</p>
</li>
</ol>
</section2>
<section2 topic='Data Representation' anchor='approach-representation'>
<p>As with data management, there are several possible approaches to representing profile data for communication over XMPP networks, including the following:</p>
<ul>
<li>
<p><strong>Structured data formats, such as &xep0080; and &xep0112;.</strong></p>
<p>Such data formats have the advantage of being human-readable. However:</p>
<ol>
<li>They are not easily extensible: developers of specialized community services would need to write their own structured data formats, even to add one new field.</li>
<li>They are not easy to map to backend data storage facilities (e.g., database administrators generally would prefer to have generic database schemas and re-usable code for parsing the XML wire protocol into the database fields).</li>
<li>They would require specialized interface handlers for each data structure, rather than a generic interface handler.</li>
</ol>
</li>
<li>
<p><strong>A format represented by means of &w3rdf;.</strong></p>
<p>An argument could be made that RDF is a reasonable approach for representing profile data for communication over the XMPP network; however, such an argument will not be made in the current proposal. The author has considered RDF and has concluded that there are several reasons why RDF is undesirable as an XMPP wire protocol:</p>
<ol>
<li>RDF exists in an XML representation but the semantics of RDF impose a more complex conceptual structure (data triples) than does XML; this is sub-optimal since unnecessary complexity is to be avoided (see &xep0134;).</li>
<li>RDF requires a specialized parser rather than the normal XML parser that comes standard with all XMPP implementations.</li>
<li>As long as it is possible to define a consistent mapping of profile data to RDF representations, it should be straightforward to convert the XMPP data formats into those RDF representations if desired (e.g., to output a FOAF file).</li>
</ol>
</li>
<li>
<p><strong>A format represented by means of Data Forms (XEP-0004).</strong></p>
<p>The Data Forms protocol defined in XEP-0004 has several advantages for use over XMPP:</p>
<ol>
<li>It can be parsed using an off-the-shelf XML parser.</li>
<li>It is already widely deployed in existing Jabber/XMPP clients, servers, and components.</li>
<li>The data forms protocol is easily extensible.</li>
<li>The Jabber/XMPP community possesses consistent methods for profiling and scoping data forms (as specified in <cite>XEP-0068</cite>).</li>
<li>Data forms have a generic schema that is easy to map to common data storage mechanisms (usually databases).</li>
<li>Data forms provide a consistent abstraction layer for XMPP applications, thus shielding them from changes in the profile data formats being defined by other Internet projects and standards development organizations.</li>
<li>The use of data forms as the medium of representation for communication over the wire does not prevent applications from storing backend profile data in some other underlying format (e.g., RDF or a database).</li>
</ol>
</li>
</ul>
<p>Therefore, this proposal specifies that profile data shall be represented in data forms scoped by a FORM_TYPE of 'urn:xmpp:tmp:profile' &NSNOTE;, in accordance with the field standardization methods defined in <cite>XEP-0068</cite>. For the sake of interoperability, profile data fields that will be in common use SHOULD be registered with the &REGISTRAR; (although they may or may not be defined in a XMPP Extension Protocol specification). Profile data fields that are intended to be used only within the context of a specialized application MAY remain unregistered, but unregistered fields MUST begin with the string "x-" in accordance with Section 3.4 of <cite>XEP-0068</cite>. <note>Alternatively, specialized applications MAY define separate FORM_TYPEs for their particular data elements.</note></p>
<p>The following is a simple and incomplete example of profile data represented via the Data Forms protocol, containing two registered data fields and one unregistered field:</p>
<example caption='A Basic Example'><![CDATA[
<profile xmlns='urn:xmpp:tmp:profile'>
<x xmlns='jabber:x:data' type='result'>
<field var='FORM_TYPE' type='hidden'>
<value>urn:xmpp:tmp:profile</value>
</field>
<field var='common_name'>
<value>Peter Saint-Andre</value>
</field>
<field var='nickname'>
<value>stpeter</value>
</field>
<field var='x-favorite_painters'>
<value>Joaquin Sorolla</value>
<value>Jan Vermeer</value>
</field>
</x>
</profile>
]]></example>
<p>By specifying that all fields are scoped by a FORM_TYPE of 'urn:xmpp:tmp:profile', this proposal does not mean to imply that all profile data will or should be gathered in one data form. In reality, most such data will probably be gathered at the time of registration either at a website or via a "wizard" interface that breaks the process into smaller bundles (such as "Basic Personal Data", "Physical Location", "Internet Addresses", "Hobbies and Interests", and "Favorite Things"). The use of one FORM_TYPE is simply meant to scope the data fields so that each field is unique within the context of profile data. Any form that uses these fields along with a FORM_TYPE of 'urn:xmpp:tmp:profile' is of the "profile type" (i.e., is a specific instance of that type), which does not limit the number of forms that can be of that type.</p>
<p>However, scoping all data fields with a single FORM_TYPE implies it is necessary to define separate data fields for similar kinds of information. For example, the vCard specification (<cite>RFC 2426</cite>) defines "types" for certains kinds of data, such as email addresses, telephone numbers, and physical addresses, making it possible to specify that a telephone number corresponds to a fax machine or mobile phone or that a physical address corresponds to one's home or work location. In the Data Forms representation, any desired piece of information (e.g., work phone) must be represented with a separate data field.</p>
<p>In order to address most (if not all) of the pieces of information described in existing profile specifications, this document defines a great number of data fields. Even so, the data fields specified herein are not exhaustive, and it is expected that additional fields will be registered in the future through the mechanisms specified in the <link url='#registrar'>XMPP Registrar Considerations</link> section of this document.</p>
</section2>
</section1>
<section1 topic='Producer Use Cases' anchor='producer'>
<section2 topic='Publishing a Full Profile' anchor='producer-full'>
<p>In order to publish a full profile, an entity sends an IQ-set to its server with a child element of &lt;profile/&gt; containing the full profile information.</p>
<example caption='Entity publishes full profile'><![CDATA[
<iq type='set' id='setfull'>
<profile xmlns='urn:xmpp:tmp:profile'>
<x xmlns='jabber:x:data' type='submit'>
<field var='FORM_TYPE' type='hidden'>
<value>urn:xmpp:tmp:profile</value>
</field>
<field var='nickname'>
<value>Hamlet</value>
</field>
<field var='country'>
<value>DK</value>
</field>
<field var='locality'>
<value>Elsinore</value>
</field>
<field var='email'>
<value>hamlet@denmark.lit</value>
</field>
</x>
</profile>
</iq>
]]></example>
<p>If the server can successfully process the request and host the full profile, it MUST return an IQ-result:</p>
<example caption='Server acknowledges success'><![CDATA[
<iq type='result' to='hamlet@denmark.lit/elsinore' id='setfull'/>
]]></example>
<p>Otherwise it MUST return an error. If the server does not support the profile data functionality, the error MUST be &unavailable;.</p>
</section2>
<section2 topic='Updating One or More Profile Fields' anchor='producer-pub'>
<p>In order to update selected fields in a public profile, an entity simply publishes the modified fields (not the entire profile) to a pubsub node of "urn:xmpp:tmp:profile" at its server using the PEP subset of the publish-subscribe extension, as specified in <cite>XEP-0163</cite>.</p>
<example caption='Account owner publishes profile field(s)'><![CDATA[
<iq type='set' id='pub1'>
<pubsub xmlns='http://jabber.org/protocol/pubsub'>
<publish node='urn:xmpp:tmp:profile'>
<item>
<profile xmlns='urn:xmpp:tmp:profile'>
<x xmlns='jabber:x:data' type='result'>
<field var='weblog'>
<value>http://www.denmark.lit/blogs/princely_musings</value>
</field>
</x>
</profile>
</item>
</publish>
</pubsub>
</iq>
]]></example>
<p>The PEP service then MUST send notifications containing the updated field(s) to the node subscribers:</p>
<example caption='Server generates notifications'><![CDATA[
<message to='francisco@denmark.lit' from='hamlet@denmark.lit/elsinore' type='headline' id='foo'>
<event xmlns='http://jabber.org/protocol/pubsub#event'>
<items node='urn:xmpp:tmp:profile'>
<item>
<profile xmlns='urn:xmpp:tmp:profile'>
<x xmlns='jabber:x:data' type='result'>
<field var='weblog'>
<value>http://www.denmark.lit/blogs/princely_musings</value>
</field>
</x>
</profile>
</item>
</items>
</event>
</message>
.
.
.
]]></example>
<p>If the field(s) published are "public", the publisher SHOULD then repost the full profile as described above in order to keep the full profile in sync.</p>
<p>Note: The account owner MAY decide to effectively maintain two profile subsets: public profile fields (posted via the "full profile" protocol) and restricted profile fields (published only via PEP). If so, the client MUST keep track of which fields are in the public profile subset and which fields are in the restricted profile subset, and MUST NOT update the full profile if the account owner has updated a field in the restricted profile set.</p>
</section2>
</section1>
<section1 topic='Consumer Use Cases' anchor='consumer'>
<section2 topic='Discovering Support' anchor='consumer-disco'>
<p>If an entity can provide profile data directly using the standalone 'urn:xmpp:tmp:profile' namespace, it SHOULD advertise that feature in response to &xep0030; information requests:</p>
<example caption='A request for service discovery information'><![CDATA[
<iq type='get'
from='bard@shakespeare.lit/globe'
to='hamlet@denmark.lit'
id='disco1'>
<query xmlns='http://jabber.org/protocol/disco#info'/>
</iq>
]]></example>
<example caption='A service discovery information response'><![CDATA[
<iq type='result'
from='hamlet@denmark.lit'
to='bard@shakespeare.lit/globe'
id='disco1'>
<query xmlns='http://jabber.org/protocol/disco#info'>
<identity category='account' type='registered'/>
<identity category='pubsub' type='pep'/>
...
<feature var='urn:xmpp:tmp:profile'/>
...
</query>
</iq>
]]></example>
<p>Note: Because the foregoing request was sent to the bare JID &lt;hamlet@denmark.lit&gt;, the response is provided by the &lt;denmark.lit&gt; server on behalf of the registered account. The answer indicates that the server can provide profile data on behalf of the registered account and that it supports the personal eventing profile of XMPP Publish-Subscribe.</p>
</section2>
<section2 topic='Requesting Full Profile' anchor='consumer-full'>
<p>In order to request the full profile, the requesting entity sends an IQ-get to the providing entity's JID, where the request contains an empty &lt;profile/&gt; element qualified by the 'urn:xmpp:tmp:profile' namespace. In this example, the request is sent to a server, not a user (any XMPP entity can have a profile, including servers, gateways, &xep0045; rooms, and the like):</p>
<example caption='A request for profile data'><![CDATA[
<iq type='get'
from='hamlet@denmark.lit/elsinore'
to='shakespeare.lit'
id='iq1'>
<profile xmlns='urn:xmpp:tmp:profile'/>
</iq>
]]></example>
<p>The server then replies:</p>
<example caption='A basic profile data response'><![CDATA[
<iq type='result'
from='shakespeare.lit'
to='hamlet@denmark.lit/elsinore'
id='iq1'>
<profile xmlns='urn:xmpp:tmp:profile'>
<x xmlns='jabber:x:data' type='result'>
<field var='FORM_TYPE' type='hidden'>
<value>urn:xmpp:tmp:profile</value>
</field>
<field var='common_name'>
<value>shakespeare.lit IM server</value>
</field>
<field var='country'>
<value>UK</value>
</field>
<field var='region'>
<value>England</value>
</field>
<field var='locality'>
<value>London</value>
</field>
<field var='area'>
<value>Bankside</value>
</field>
<field var='street'>
<value>21 New Globe Walk</value>
</field>
<field var='postalcode'>
<value>SE1 9DT</value>
</field>
<field var='lat'>
<value>51.5076</value>
</field>
<field var='lon'>
<value>-0.0953</value>
</field>
<field var='landline_phone'>
<value>+44 20 7902 1400</value>
</field>
<field var='fax'>
<value>+44 20 7902 1401</value>
</field>
<field var='building'>
<value>Globe Theatre</value>
</field>
<field var='email'>
<value>admin@shakespeare.lit</value>
</field>
</x>
</profile>
</iq>
]]></example>
<p>If a server supports stored profile data for user accounts that it hosts, a requesting entity can request the full profile for such an account:</p>
<example caption='A request for hosted profile data'><![CDATA[
<iq type='get'
from='bard@shakespeare.lit/globe'
to='hamlet@denmark.lit'
id='iq2'>
<profile xmlns='urn:xmpp:tmp:profile'/>
</iq>
]]></example>
<p>If the requesting entity is not allowed to retrieve hosted profiles (e.g., because it is not on a list of entities permitted to "spider" the server's users), the server SHOULD return a &unavailable; error:</p>
<example caption='Server returns service unavailable error'><![CDATA[
<iq type='error'
from='hamlet@denmark.lit'
to='bard@shakespeare.lit/globe'
id='iq2'>
<profile xmlns='urn:xmpp:tmp:profile'/>
<error code='503' type='cancel'>
<service-unavailable xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/>
</error>
</iq>
]]></example>
<p>If the requested account does not exist or has not published profile data, the server also SHOULD return a &unavailable; error.</p>
<p>Otherwise, the server SHOULD return the profile for the hosted account.</p>
<example caption='Server returns profile data'><![CDATA[
<iq type='result'
from='hamlet@denmark.lit'
to='bard@shakespeare.lit/globe'
id='iq2'>
<profile xmlns='urn:xmpp:tmp:profile'>
<x xmlns='jabber:x:data' type='result'>
<field var='FORM_TYPE' type='hidden'>
<value>urn:xmpp:tmp:profile</value>
</field>
<field var='nickname'>
<value>Hamlet</value>
</field>
<field var='country'>
<value>DK</value>
</field>
<field var='locality'>
<value>Elsinore</value>
</field>
<field var='email'>
<value>hamlet@denmark.lit</value>
</field>
<field var='weblog'>
<value>http://www.denmark.lit/blogs/princely_musings</value>
</field>
</x>
</profile>
</iq>
]]></example>
</section2>
<section2 topic='Receiving Profile Updates' anchor='consumer-sub'>
<p>In order to receive updated fields for a contact's profile, an entity shall encapsulate a feature of "urn:xmpp:tmp:profile+notify" in its &xep0115; data. If the contact's server supports the personal eventing profile of XMPP Publish-Subscribe as described in <cite>XEP-0163</cite>, the entity will receive notifications whenever the contact sends updated profile fields to the profile node:</p>
<example caption='Entity receives notification'><![CDATA[
<message to='francisco@denmark.lit' from='hamlet@denmark.lit/elsinore' type='headline' id='foo'>
<event xmlns='http://jabber.org/protocol/pubsub#event'>
<items node='urn:xmpp:tmp:profile'>
<item>
<profile xmlns='urn:xmpp:tmp:profile'>
<x xmlns='jabber:x:data' type='result'>
<field var='weblog'>
<value>http://www.denmark.lit/blogs/princely_musings</value>
</field>
</x>
</profile>
</item>
</items>
</event>
</message>
]]></example>
<p>It is the responsibility of the receiving entity to correctly process the notification and update the local representation of the contact's profile information.</p>
</section2>
</section1>
<section1 topic='Data Representation' anchor='fields'>
<p>The following subsections specify common fields for defining various aspects of a person, which shall form the initial submission to the XMPP Registrar; many of these fields map to elements specified in vCard, xNAL, FOAF, LDAP (see &rfc2252;, &rfc2256;, and &rfc2798;) <note>This specification does not require that profile data fields mapped to LDAP fields must adhere to the X.500 data types that are re-used by LDAP. However, implementations MAY enforce those data types if desired.</note>, and LDAP object classes such as Person, organizationalPerson, inetOrgPerson, and eduPerson.</p>
<section2 topic='Name Data Aspects' anchor='fields-name'>
<p>Mappings are provided to vCard, LDAP, xNAL, and FOAF.</p>
<section3 topic='Display Name' anchor='display_name'>
<p>A display name is a version of a person's name intended for display in a user interface. Sometimes also called a "full name" or "formatted name".</p>
<p>The Data Forms field that represents a display name is "display_name".</p>
<p>This field maps to:</p>
<ul>
<li>vCard FN</li>
<li>LDAP displayName</li>
<li>FOAF name</li>
</ul>
<example caption='Display Name'><![CDATA[
<field var='display_name'>
<value>Peter Saint-Andre</value>
</field>
]]></example>
</section3>
<section3 topic='Familiar Name' anchor='familiar_name'>
<p>A familiar name is a shortened or modified form of someone's given name that may be used in somewhat informal contexts or that is preferred by the person (e.g., "Chuck" instead of "Charles").</p>
<p>The Data Forms field that represents a familiar name is "familiar_name".</p>
<p>This field maps to:</p>
<ul>
<li>eduPersonNickname</li>
</ul>
<example caption='Familiar Name'><![CDATA[
<field var='familiar_name'>
<value>Pete</value>
</field>
]]></example>
</section3>
<section3 topic='Family Name' anchor='family_name'>
<p>A family name is that part of a person's name which signifies the person's primary family association. Sometimes also called a "last name" or "surname".</p>
<p>The Data Forms field that represents a family name is "family_name".</p>
<p>This field maps to:</p>
<ul>
<li>vCard FAMILY</li>
<li>LDAP sn</li>
<li>xNAL LastName</li>
<li>FOAF family_name</li>
<li>FOAF surname</li>
</ul>
<example caption='Family Name'><![CDATA[
<field var='family_name'>
<value>Saint-Andre</value>
</field>
]]></example>
</section3>
<section3 topic='Given Name' anchor='given_name'>
<p>A given name is that part of a person's name which signifies the person's primary individual identity. Sometimes also called a "first name" or (in some countries) a "Christian name".</p>
<p>The Data Forms field that represents a given name is "given_name".</p>
<p>This field maps to:</p>
<ul>
<li>vCard GIVEN</li>
<li>LDAP givenName</li>
<li>xNAL FirstName</li>
<li>FOAF first_name</li>
<li>FOAF givenname</li>
</ul>
<example caption='Given Name'><![CDATA[
<field var='given_name'>
<value>J.</value>
</field>
]]></example>
</section3>
<section3 topic='Middle Name' anchor='middle_name'>
<p>A middle name is that part of a person's name which signifies the person's secondary individual identity. Sometimes also called a "middle initial".</p>
<p>The Data Forms field that represents a middle name is "middle_name".</p>
<p>This field maps to:</p>
<ul>
<li>vCard MIDDLE</li>
<li>xNAL MiddleName</li>
</ul>
<example caption='Middle Name'><![CDATA[
<field var='middle_name'>
<value>Peter</value>
</field>
]]></example>
</section3>
<section3 topic='Name Prefix' anchor='name_prefix'>
<p>A name prefix is that part of a person's name which prepends the person's full name (e.g., Mr or Dr). Sometimes also called an "honorific" or "title".</p>
<p>The Data Forms field that represents a name prefix is "name_prefix".</p>
<p>This field maps to:</p>
<ul>
<li>vCard PREFIX</li>
<li>xNAL Title</li>
<li>FOAF title</li>
</ul>
<example caption='Name Prefix'><![CDATA[
<field var='name_prefix'>
<value>Mr</value>
</field>
]]></example>
</section3>
<section3 topic='Name Suffix' anchor='name_suffix'>
<p>A name suffix is that part of a person's name which is appended to the person's full name (e.g., Jr or Esq).</p>
<p>The Data Forms field that represents a name suffix is "name_suffix".</p>
<p>This field maps to:</p>
<ul>
<li>vCard SUFFIX</li>
<li>xNAL GeneralSuffix</li>
</ul>
<example caption='Name Suffix'><![CDATA[
<field var='name_suffix'>
<value>Esq</value>
</field>
]]></example>
</section3>
<section3 topic='Nickname' anchor='nickname'>
<p>A nickname is a global, memorable (but not unique) friendly or informal name chosen by the owner of a JID. The purpose of a nickname is to associate a distinctive mapping between the person's unique JID and non-unique nickname. A nickname is normally used in online contexts (e.g., in chatrooms) that are less formal than real life (where a person's <link url='#familiar_name'>Familiar Name</link> would be more appropriate). Sometimes also called an "alias". A person SHOULD specify only one nickname (i.e., not more than one).</p>
<p>The Data Forms field that represents a nickname is "nickname".</p>
<p>This field maps to:</p>
<ul>
<li>vCard NICKNAME</li>
<li>xNAL Alias</li>
<li>FOAF nick</li>
</ul>
<example caption='Nickname'><![CDATA[
<field var='nickname'>
<value>stpeter</value>
</field>
]]></example>
</section3>
<section3 topic='Patronymic' anchor='patronymic'>
<p>In some cultures, one's name includes a part that is derived from the given name of one's father; this part of one's name is called a "patronymic".</p>
<p>The Data Forms field that represents a patronymic is "patronymic".</p>
<example caption='A Patronymic'><![CDATA[
<field var='patronymic'>
<value>Ivanovich</value>
</field>
]]></example>
</section3>
</section2>
<section2 topic='Physical Address Data Aspects' anchor='fields-physicaladdress'>
<p>Mappings are provided to vCard, xNAL, and XEP-0112 (&xep0112;).</p>
<section3 topic='Country' anchor='country'>
<p>A country is the sovereign nation in which a person is located. Sometimes also called a "nation".</p>
<p>The Data Forms fields that represent a country are "country", "home_country", and "work_country" for generic addresses, home addresses, and work addresses respectively.</p>
<p>This field maps to:</p>
<ul>
<li>vCard COUNTRY (or XEP-0054 CTRY), optionally supplemented with the "HOME" or "WORK" type</li>
<li>LDAP c</li>
<li>xNAL CountryName</li>
<li>XEP-0112 country</li>
</ul>
<example caption='Country'><![CDATA[
<field var='country'>
<value>USA</value>
</field>
]]></example>
</section3>
<section3 topic='Region' anchor='region'>
<p>A region is a second-level administrative unit within the nation in which a person is located. Sometimes also called a "province", "state", or "administrative area".</p>
<p>The Data Forms field that represents a region is "region".</p>
<p>The Data Forms fields that represent a region are "home_region" and "work_region" for home addresses and work addresses respectively.</p>
<p>This field maps to:</p>
<ul>
<li>vCard REGION, optionally supplemented with the "HOME" or "WORK" type</li>
<li>LDAP st</li>
<li>xNAL AdministrativeAreaName</li>
<li>XEP-0112 region</li>
</ul>
<example caption='Region'><![CDATA[
<field var='region'>
<value>New York</value>
</field>
]]></example>
</section3>
<section3 topic='Locality' anchor='locality'>
<p>A locality is a defined place within the region in which a person is located. Sometimes also called a "city", "town", or "village".</p>
<p>The Data Forms fields that represent a locality are "locality", "home_locality", and "work_locality" for generic addresses, home addresses, and work addresses respectively.</p>
<p>This field maps to:</p>
<ul>
<li>vCard LOCALITY, optionally supplemented with the "HOME" or "WORK" type</li>
<li>LDAP l</li>
<li>xNAL LocalityName</li>
<li>XEP-0112 locality</li>
</ul>
<example caption='Locality'><![CDATA[
<field var='locality'>
<value>New York City</value>
</field>
]]></example>
</section3>
<section3 topic='Area' anchor='area'>
<p>An area is a sub-division within the locality in which a person is located. Sometimes also called a "neighborhood", "suburb", "district", or "section".</p>
<p>The Data Forms fields that represent a area are "area", "home_area", and "work_area" for generic addresses, home addresses, and work addresses respectively.</p>
<p>This field maps to:</p>
<ul>
<li>xNAL DependentLocalityName</li>
<li>XEP-0112 area</li>
</ul>
<example caption='Area'><![CDATA[
<field var='area'>
<value>Manhattan</value>
</field>
]]></example>
</section3>
<section3 topic='Street' anchor='street'>
<p>A street is the street address (number plus street name, or two street names at an intersection) at which a person is located, or a postal box number for physical mail delivery. Sometimes also called a "street address".</p>
<p>The Data Forms fields that represent a street are "street", "home_street", and "work_street" for generic addresses, home addresses, and work addresses respectively.</p>
<p>This field maps to:</p>
<ul>
<li>vCard STREET, optionally supplemented with the "HOME" or "WORK" type</li>
<li>LDAP street</li>
<li>xNAL ThoroughfareNumber + ThoroughfareName</li>
<li>XEP-0112 street</li>
</ul>
<example caption='Street'><![CDATA[
<field var='street'>
<value>Fifth Avenue and 34th Street</value>
</field>
]]></example>
</section3>
<section3 topic='Building' anchor='building'>
<p>A building is the name for a specific structure on a street or within an area.</p>
<p>The Data Forms fields that represent a building are "building", "home_building", and "work_building" for generic addresses, home addresses, and work addresses respectively.</p>
<p>This field maps to:</p>
<ul>
<li>vCard EXTADR, optionally supplemented with the "HOME" or "WORK" type</li>
<li>xNAL BuildingName</li>
<li>XEP-0112 building</li>
</ul>
<example caption='Building'><![CDATA[
<field var='building'>
<value>Empire State Building</value>
</field>
]]></example>
</section3>
<section3 topic='Floor' anchor='floor'>
<p>A floor is a named or numbered floor or level within a building. Sometimes also called a "level", "block", or "suite".</p>
<p>The Data Forms fields that represent a floor are "floor", "home_floor", and "work_floor" for generic addresses, home addresses, and work addresses respectively.</p>
<p>This field maps to:</p>
<ul>
<li>vCard EXTADR, optionally supplemented with the "HOME" or "WORK" type</li>
<li>xNAL SubPremiseNumber</li>
<li>XEP-0112 floor</li>
</ul>
<example caption='Floor'><![CDATA[
<field var='floor'>
<value>102</value>
</field>
]]></example>
</section3>
<section3 topic='Room' anchor='room'>
<p>A room is a named or numbered subdivision of a floor. Sometimes also called a "unit" or "apartment".</p>
<p>The Data Forms fields that represent a room are "room", "home_room", and "work_room" for generic addresses, home addresses, and work addresses respectively.</p>
<p>This field maps to:</p>
<ul>
<li>vCard EXTADR, optionally supplemented with the "HOME" or "WORK" type</li>
<li>LDAP roomNumber</li>
<li>xNAL SubPremiseNumber</li>
<li>XEP-0112 room</li>
</ul>
<example caption='Room'><![CDATA[
<field var='room'>
<value>Observatory</value>
</field>
]]></example>
</section3>
<section3 topic='Postal Box' anchor='postalbox'>
<p>A postal box is a set of numeric or alphanumeric characters used to identify a mailbox at a postal delivery center.</p>
<p>The Data Forms fields that represent a postal box are "postalbox", "home_postalbox", and "work_postalbox" for generic addresses, home addresses, and work addresses respectively.</p>
<p>This field maps to:</p>
<ul>
<li>vCard POBOX, optionally supplemented with the "HOME" or "WORK" type</li>
<li>LDAP postOfficeBox</li>
</ul>
<example caption='Postal Box'><![CDATA[
<field var='postalbox'>
<value>1641</value>
</field>
]]></example>
</section3>
<section3 topic='Postal Code' anchor='postalcode'>
<p>A postal code is a set of numeric or alphanumeric characters used to identify an area for postal delivery. Sometimes also called a "ZIP code" (in the U.S.).</p>
<p>The Data Forms fields that represent a postal code are "postalcode", "home_postalcode", and "work_postalcode" for generic addresses, home addresses, and work addresses respectively.</p>
<p>This field maps to:</p>
<ul>
<li>vCard PCODE, optionally supplemented with the "HOME" or "WORK" type</li>
<li>LDAP postalCode</li>
<li>xNAL PostalCodeNumber</li>
<li>XEP-0112 postalcode</li>
</ul>
<example caption='Postal Code'><![CDATA[
<field var='postalcode'>
<value>10002</value>
</field>
]]></example>
</section3>
<section3 topic='Postal Address' anchor='postaladdress'>
<p>A postal address is a free-form mailing address, which may be easier to enter (or, in some cultural contexts, more appropriate) than the atomic address parts such as street, floor, etc.</p>
<p>The Data Forms fields that represent a postal address are "postaladdress", "home_postaladdress", and "work_postaladdress" for generic addresses, home addresses, and work addresses respectively.</p>
<p>This field maps to:</p>
<ul>
<li>LDAP postalAddress, homePostalAddress</li>
</ul>
<example caption='Postal Address'><![CDATA[
<field var='work_postaladdress'>
<value>1899 Wynkoop Street</value>
<value>Suite 600</value>
<value>Denver, CO 80202</value>
<value>USA</value>
</field>
]]></example>
</section3>
</section2>
<section2 topic='Geolocation Data Aspects' anchor='fields-geoloc'>
<p>Mappings are provided to vCard and XEP-0080 (&xep0080;).</p>
<section3 topic='Altitude' anchor='alt'>
<p>Altitude is a person's height or depth in relationship to sea level, where positive altitude is meters above sea level and negative altitude is meters below sea level.</p>
<p>The Data Forms field that represents altitude is "alt".</p>
<p>This field maps to:</p>
<ul>
<li>XEP-0080 alt</li>
</ul>
<example caption='Altitude'><![CDATA[
<field var='alt'>
<value>1609</value>
</field>
]]></example>
</section3>
<section3 topic='Latitude' anchor='lat'>
<p>Latitude is a person's latitude in relation to the equator, where positive latitude is north of the equator and negative latitude is south of the equator.</p>
<p>The Data Forms field that represents latitude is "lat".</p>
<p>This field maps to:</p>
<ul>
<li>vCard LAT</li>
<li>XEP-0080 lat</li>
</ul>
<example caption='Latitude'><![CDATA[
<field var='lat'>
<value>39.75477</value>
</field>
]]></example>
</section3>
<section3 topic='Longitude' anchor='lon'>
<p>Longitude is a person's longitude in relation to the equator, where positive longitude is east of the meridian and negative longitude is west of the equator.</p>
<p>The Data Forms field that represents longitude is "lon".</p>
<p>This field maps to:</p>
<ul>
<li>vCard LON</li>
<li>XEP-0080 lon</li>
</ul>
<example caption='Latitude'><![CDATA[
<field var='lon'>
<value>-104.99768</value>
</field>
]]></example>
</section3>
</section2>
<section2 topic='Telephony Address Data Aspects' anchor='fields-tel'>
<section3 topic='Fax Number' anchor='fax'>
<p>A fax number is a number for a machine that handles fascimile transmissions.</p>
<p>The Data Forms fields that represent a fax number are "fax", "home_fax", and "work_fax" for generic addresses, home addresses, and work addresses respectively.</p>
<p>This field maps to:</p>
<ul>
<li>vCard TEL (+ "FAX" modifier), optionally supplemented with the "HOME" or "WORK" type</li>
<li>LDAP facsimileTelephoneNumber</li>
</ul>
<example caption='Fax Number'><![CDATA[
<field var='fax'>
<value>303-308-3215</value>
</field>
]]></example>
</section3>
<section3 topic='Landline Telephone Number' anchor='landline'>
<p>A landline telephone number is a number for a traditional "PSTN" or "POTS" telephone.</p>
<p>The Data Forms fields that represent a landline telephone number are "landline", "home_landline", and "work_landline" for generic addresses, home addresses, and work addresses respectively.</p>
<p>This field maps to:</p>
<ul>
<li>vCard TEL, optionally supplemented with the "HOME" or "WORK" type</li>
<li>LDAP telephoneNumber</li>
<li>FOAF phone</li>
</ul>
<example caption='Landline Telephone Number'><![CDATA[
<field var='landline_phone'>
<value>303-308-3282</value>
</field>
]]></example>
</section3>
<section3 topic='Mobile Telephone Number' anchor='mobile'>
<p>A mobile telephone number is a number for a mobile phone or cell phone on a wireless network.</p>
<p>The Data Forms fields that represent a mobile telephone number are "mobile", "home_mobile", and "work_mobile" for generic addresses, home addresses, and work addresses respectively.</p>
<p>This field maps to:</p>
<ul>
<li>vCard TEL (+ "CELL" modifier), optionally supplemented with the "HOME" or "WORK" type</li>
<li>LDAP mobile</li>
<li>FOAF phone</li>
</ul>
<example caption='Mobile Telephone Number'><![CDATA[
<field var='mobile_phone'>
<value>303-555-1212</value>
</field>
]]></example>
</section3>
<section3 topic='Pager Number' anchor='pager'>
<p>A pager number is a number for a dedicated alphanumeric paging device.</p>
<p>The Data Forms fields that represent a pager number are "pager", "home_pager", and "work_pager" for generic addresses, home addresses, and work addresses respectively.</p>
<p>This field maps to:</p>
<ul>
<li>vCard TEL (+ "PAGER" modifier), optionally supplemented with the "HOME" or "WORK" type</li>
<li>LDAP pager</li>
</ul>
<example caption='Pager Number'><![CDATA[
<field var='pager'>
<value>303-555-1212</value>
</field>
]]></example>
</section3>
<section3 topic='SIP Address' anchor='sip_address'>
<p>A SIP address is a sip: or sips: URI at which a person can be contacted for Voice over Internet Protocol (VoIP) communications.</p>
<p>The Data Forms field that represents a SIP address is "sip_address".</p>
<p>This field does not map to data in vCard or any other profile representation format.</p>
<example caption='SIP Address'><![CDATA[
<field var='sip_address'>
<value>sip:stpeter@sipspeare.lit</value>
</field>
]]></example>
</section3>
<section3 topic='Skype Address' anchor='skype_address'>
<p>A Skype address is an address on the popular Skype system for Voice over Internet Protocol (VoIP) communications.</p>
<p>The Data Forms field that represents a Skype address is "skype_address".</p>
<p>This field does not map to data in vCard or any other profile representation format.</p>
<example caption='Skype Address'><![CDATA[
<field var='skype_address'>
<value>SomeSkypeUser</value>
</field>
]]></example>
</section3>
<section3 topic='Videophone Address' anchor='video_phone'>
<p>A videophone address is an address used for for H.323 video conferencing systems.</p>
<p>The Data Forms field that represents a videophone address is "video_phone".</p>
<p>This field does not map to data in vCard or any other profile representation format.</p>
<example caption='Videophone Address'><![CDATA[
<field var='video_phone'>
<value>foo</value>
</field>
]]></example>
</section3>
</section2>
<section2 topic='Electronic Address Data Aspects' anchor='fields-net'>
<section3 topic='AIM Screen Name' anchor='aim_id'>
<p>An AIM screen name is an address at which a person or other entity can be contacted on the AOL Instant Messenger service.</p>
<p>The Data Forms field that represents an AIM screen name is "aim_id".</p>
<p>This field maps to:</p>
<ul>
<li>FOAF aimChatID</li>
</ul>
<example caption='AIM Screen Name'><![CDATA[
<field var='aim_id'>
<value>psaintandre</value>
</field>
]]></example>
</section3>
<section3 topic='Email Address' anchor='email'>
<p>An email address is the value of a mailto: URI at which a person or other entity can be contacted using standard electronic mail protocols.</p>
<p>The Data Forms field that represents longitude is "email".</p>
<p>This field maps to:</p>
<ul>
<li>vCard EMAIL</li>
<li>LDAP mail</li>
</ul>
<example caption='Email address'><![CDATA[
<field var='email'>
<value>stpeter@jabber.org</value>
<value>stpeter@gmail.com</value>
</field>
]]></example>
</section3>
<section3 topic='ICQ Number' anchor='icq_id'>
<p>An ICQ number is an address at which a person or other entity can be contacted on the ICQ instant messaging service.</p>
<p>The Data Forms field that represents an ICQ number is "icq_id".</p>
<p>This field maps to:</p>
<ul>
<li>FOAF icqChatID</li>
</ul>
<example caption='ICQ number'><![CDATA[
<field var='icq_id'>
<value>70902454</value>
</field>
]]></example>
</section3>
<section3 topic='Jabber ID' anchor='jid'>
<p>A Jabber ID is the value of an xmpp: URI at which a person or other entity can be contacted over a Jabber/XMPP network.</p>
<p>The Data Forms field that represents a Jabber ID is "jid".</p>
<p>This field maps to:</p>
<ul>
<li>FOAF jabberID</li>
</ul>
<example caption='Jabber ID'><![CDATA[
<field var='jid'>
<value>stpeter@jabber.org</value>
<value>peter@saint-andre.com</value>
</field>
]]></example>
</section3>
<section3 topic='MSN Address' anchor='msn_id'>
<p>An MSN address is address at which a person or other entity can be contacted on the MSN instant messaging service.</p>
<p>The Data Forms field that represents an MSN address is "msn_id".</p>
<p>This field maps to:</p>
<ul>
<li>FOAF msnChatID</li>
</ul>
<example caption='MSN Address'><![CDATA[
<field var='msn_id'>
<value>petersaintandre@hotmail.com</value>
</field>
]]></example>
</section3>
<section3 topic='Yahoo ID' anchor='yahoo_id'>
<p>A Yahoo ID is address at which a person or other entity can be contacted on the Yahoo! Instant Messenger service.</p>
<p>The Data Forms field that represents a Yahoo ID is "yahoo_id".</p>
<p>This field maps to:</p>
<ul>
<li>FOAF yahooChatID</li>
</ul>
<example caption='Yahoo ID'><![CDATA[
<field var='yahoo_id'>
<value>psaintandre</value>
</field>
]]></example>
</section3>
</section2>
<section2 topic='World Wide Web Resource Aspects' anchor='fields-www'>
<section3 topic='Avatar URL' anchor='avatar_url'>
<p>An avatar is an often fanciful representation of a user's desired self-image or persona (e.g., in the context of a game). An avatar is usually not intended to be an accurate picture of the user's actual physical appearance (that is handled by the photo_url and photo_data fields).</p>
<p>An avatar can come in two forms: the avatar data itself, or a URL for a avatar.</p>
<p>The Data Forms field that represents the URL for an avatar is "avatar_url".</p>
<p>This field does not map to data in vCard or any other profile representation format.</p>
<example caption='Avatar URL'><![CDATA[
<field var='avatar_url'>
<value>http://www.saint-andre.com/images/stpeter_small.jpg</value>
</field>
]]></example>
</section3>
<section3 topic='Biographical URL' anchor='bio'>
<p>A biographical URL is the value of an http: URI at which can be found biographical information about a person.</p>
<p>The Data Forms field that represents a biographical URL is "bio".</p>
<example caption='Biographical URL'><![CDATA[
<field var='bio'>
<value>http://www.xmpp.org/xsf/people/stpeter.shtml</value>
<value>http://www.saint-andre.com/me/</value>
</field>
]]></example>
</section3>
<section3 topic='FOAF URL' anchor='foaf_url'>
<p>A FOAF URL is the value of an http: URI at which can be found a "friend of a friend" (FOAF) file about a person or entity.</p>
<p>The Data Forms field that represents a FOAF URL is "foaf_url".</p>
<example caption='FOAF URL'><![CDATA[
<field var='foaf_url'>
<value>http://www.saint-andre.com/me/foaf.rdf</value>
</field>
]]></example>
</section3>
<section3 topic='Homepage URL' anchor='homepage'>
<p>A homepage URL is the value of an http: URI that is the default resource on the World Wide Web for a person or other entity.</p>
<p>The Data Forms field that represents a homepage URL is "homepage".</p>
<p>This field maps to:</p>
<ul>
<li>LDAP labelledURI</li>
<li>FOAF homepage</li>
</ul>
<example caption='Homepage URL'><![CDATA[
<field var='homepage'>
<value>http://www.saint-andre.com/</value>
</field>
]]></example>
</section3>
<section3 topic='OpenID' anchor='openid'>
<p>An OpenID is the value of a URI by which a person can sign onto multiple websites or other Internet services using a single identifier (see &lt;<link url='http://openid.net/'>http://openid.net/</link>&gt;).</p>
<p>The Data Forms field that represents an OpenID is "openid".</p>
<p>This field maps to:</p>
<ul>
<li>FOAF openid</li>
</ul>
<example caption='OpenID'><![CDATA[
<field var='openid'>
<value>https://stpeter.startssl.com/</value>
</field>
]]></example>
</section3>
<section3 topic='Photo URL' anchor='photo_url'>
<p>A photograph provides a pictorial representation of a person. Sometimes also called a "mugshot".</p>
<p>A photograph can come in two forms: the photo data itself (see below) or a URL for a photograph (e.g., the vCard PHOTO element can represent either, while the FOAF depiction and FOAF img can represent only a URL). The Data Forms field specified here identifies a URL for a photograph, not the data itself.</p>
<p>The Data Forms field that represents the URL for a photograph is "photo_url".</p>
<p>This field maps to:</p>
<ul>
<li>vCard PHOTO</li>
<li>FOAF depiction</li>
<li>FOAF img</li>
</ul>
<example caption='Photo URL'><![CDATA[
<field var='photo_url'>
<value>http://www.saint-andre.com/images/stpeter.jpg</value>
<value>http://www.saint-andre.com/images/stpeter_hell.jpg</value>
<value>http://www.saint-andre.com/images/stpeter_oscon.jpg</value>
</field>
]]></example>
</section3>
<section3 topic='Publications URL' anchor='publications'>
<p>A publications URL is the value of an http: URI at which can be found the list of a person's published writings.</p>
<p>The Data Forms field that represents a publications URL is "publications".</p>
<p>This field maps to:</p>
<ul>
<li>FOAF publications</li>
</ul>
<example caption='Publications URL'><![CDATA[
<field var='publications'>
<value>http://www.saint-andre.com/thoughts/publications.html</value>
</field>
]]></example>
</section3>
<section3 topic='Resume URL' anchor='resume'>
<p>A resume URL is the value of an http: URI at which can be found a person's resume or curriculum vitae.</p>
<p>The Data Forms field that represents a resume URL is "resume".</p>
<example caption='Resume URL'><![CDATA[
<field var='resume'>
<value>http://www.saint-andre.com/work/</value>
</field>
]]></example>
</section3>
<section3 topic='Status URL' anchor='status_url'>
<p>A status URL is the value of an http: URI that specifies the current status of a person or other entity (e.g., a person's online presence or a server's uptime).</p>
<p>The Data Forms field that represents a homepage URL is "status_url".</p>
<example caption='Status URL'><![CDATA[
<field var='status_url'>
<value>http://status.jabber.org/</value>
</field>
]]></example>
</section3>
<section3 topic='Organizational URL' anchor='org_url'>
<p>An organizational URL is the value of an http: URI that specifies the homepage for an organization or employer.</p>
<p>The Data Forms field that represents an organizational URL is "org_url".</p>
<p>This field maps to:</p>
<ul>
<li>FOAF workplaceHomepage</li>
</ul>
<example caption='Organizational URL'><![CDATA[
<field var='org_url'>
<value>http://www.jabber.org/</value>
</field>
]]></example>
</section3>
<section3 topic='Weblog URL' anchor='weblog'>
<p>A weblog URL is the value of an http: URI at which a person or other entity maintains a weblog.</p>
<p>The Data Forms field that represents a weblog URL is "weblog".</p>
<p>This field maps to:</p>
<ul>
<li>FOAF weblog</li>
</ul>
<example caption='Weblog URL'><![CDATA[
<field var='weblog'>
<value>http://www.saint-andre.com/blog/</value>
</field>
]]></example>
</section3>
</section2>
<section2 topic='Organizational Data Aspects' anchor='fields-org'>
<section3 topic='Alternative Contact' anchor='alt_contact'>
<p>It may be appropriate to list others who can be contacted if the individual is not available.</p>
<example caption='Alternative Contact'><![CDATA[
<field var='alt_contact'>
<value>xmpp:peter@jabber.org</value>
</field>
]]></example>
</section3>
<section3 topic='Affiliation' anchor='affiliation'>
<p>An affiliation is a person's relationship to an institution, such as student, faculty, intern, fellow. An affiliation is in general less rigid than an <link url='#employee_type'>Employee Type</link>, which may not be relevant in noncommercial organizations.</p>
<p>The Data Forms field that represents an organizational affiliation is "affiliation".</p>
<p>This field maps to:</p>
<ul>
<li>LDAP eduPersonAffiliation</li>
</ul>
<example caption='Affiliation'><![CDATA[
<field var='affiliation'>
<value>faculty</value>
</field>
]]></example>
</section3>
<section3 topic='Assistant' anchor='assistant'>
<p>In some organizations, a person may be assisted by another individual.</p>
<p>The Data Forms field that represents an assistant is "assistant".</p>
<p>This field maps to:</p>
<ul>
<li>LDAP secretary</li>
</ul>
<example caption='Assistant'><![CDATA[
<field var='assistant'>
<value>Peter Pan</value>
</field>
]]></example>
</section3>
<section3 topic='Business Category' anchor='business_category'>
<p>The kind of business performed by an organization.</p>
<p>The Data Forms field that represents a business category is "business_category".</p>
<p>This field maps to:</p>
<ul>
<li>LDAP business_category</li>
</ul>
<example caption='Business Category'><![CDATA[
<field var='business_category'>
<value>Automobile sales</value>
</field>
]]></example>
</section3>
<section3 topic='Department Name' anchor='department_name'>
<p>Some organizations have departments, which can be named or numbered.</p>
<p>The Data Forms field that represents a department name is "department_name".</p>
<example caption='Department Name'><![CDATA[
<field var='department_name'>
<value>Executive</value>
</field>
]]></example>
</section3>
<section3 topic='Department Number' anchor='department_number'>
<p>Some organizations have departments, which can be named or numbered.</p>
<p>The Data Forms field that represents a department number is "department_number".</p>
<p>This field maps to:</p>
<ul>
<li>LDAP departmentNumber</li>
</ul>
<example caption='Department Number'><![CDATA[
<field var='department_number'>
<value>5674</value>
</field>
]]></example>
</section3>
<section3 topic='Employee Number' anchor='employee_number'>
<p>Some organizations assign numbers to employees.</p>
<p>The Data Forms field that represents an employee number is "employee_number".</p>
<p>This field maps to:</p>
<ul>
<li>LDAP employeeNumber</li>
</ul>
<example caption='Employee Number'><![CDATA[
<field var='employee_number'>
<value>1</value>
</field>
]]></example>
</section3>
<section3 topic='Employee Type' anchor='employee_type'>
<p>Some organizations have different types of employees, such as "full-time", "part-time", "contractor", and "temp".</p>
<p>The Data Forms field that represents an employee type is "employee_type".</p>
<p>This field maps to:</p>
<ul>
<li>LDAP employeeType</li>
</ul>
<example caption='Employee Type'><![CDATA[
<field var='employee_type'>
<value>volunteer</value>
</field>
]]></example>
</section3>
<section3 topic='Job Title' anchor='job_title'>
<p>A job title is the official name of a person's position within an organization.</p>
<p>The Data Forms field that represents a job title is "job_title".</p>
<p>This field maps to:</p>
<ul>
<li>vCard TITLE</li>
<li>LDAP title</li>
<li>FOAF title</li>
</ul>
<example caption='Job Title'><![CDATA[
<field var='job_title'>
<value>Executive Director</value>
</field>
]]></example>
</section3>
<section3 topic='Manager' anchor='manager'>
<p>In most organizations, a person is managed by or reports to another individual (often not exposed outside the organization).</p>
<p>The Data Forms field that represents a manager is "manager".</p>
<p>This field maps to:</p>
<ul>
<li>LDAP manager</li>
</ul>
<example caption='Manager'><![CDATA[
<field var='manager'>
<value>William Shakespeare</value>
</field>
]]></example>
</section3>
<section3 topic='Organizational Name' anchor='org_name'>
<p>An organizational name is the official name of an organization (company, school, etc.) within which a person works.</p>
<p>The Data Forms field that represents the name of an organization is "org_name".</p>
<p>This field maps to:</p>
<ul>
<li>vCard ORGNAME</li>
<li>LDAP o</li>
</ul>
<example caption='Organizational Name'><![CDATA[
<field var='org_name'>
<value>XMPP Standards Foundation</value>
</field>
]]></example>
</section3>
<section3 topic='Organizational Role' anchor='org_role'>
<p>An organizational role describes a person's profession or how a person contributes within an organization.</p>
<p>The Data Forms field that represents an organizational role is "org_role".</p>
<p>This field maps to:</p>
<ul>
<li>vCard ROLE</li>
</ul>
<example caption='Organizational Role'><![CDATA[
<field var='org_role'>
<value>Patron Saint</value>
<value>Chief Evangelist</value>
<value>Glorified Tech Writer</value>
</field>
]]></example>
</section3>
<section3 topic='Organizational Unit' anchor='org_unit'>
<p>An organizational unit is the name of part (subsidiary, department, etc.) of an organization.</p>
<p>The Data Forms field that represents an organizational unit is "org_unit".</p>
<p>This field maps to:</p>
<ul>
<li>vCard ORGUNIT</li>
<li>LDAP ou</li>
</ul>
<example caption='Organizational Unit'><![CDATA[
<field var='org_unit'>
<value>Jabber Council</value>
</field>
]]></example>
</section3>
<section3 topic='Primary Affiliation' anchor='primary_affiliation'>
<p>An affiliation is a person's relationship to an institution, such as student, faculty, intern, fellow. (An affiliation is in general less rigid than an <link url='#employee_type'>Employee Type</link>, which may not be relevant in noncommercial organizations.) Since a person may be affiliated with multiple organizations (e.g., multiple research institutions), the primary affiliation is used to describe a person's affiliation to their primary organization.</p>
<p>The Data Forms field that represents a primary organizational affiliation is "primary_affiliation".</p>
<p>This field maps to:</p>
<ul>
<li>LDAP eduPersonPrimaryAffiliation</li>
</ul>
<example caption='Primary Affiliation'><![CDATA[
<field var='primary_affiliation'>
<value>fellow</value>
</field>
]]></example>
</section3>
<section3 topic='Primary Organizational Name' anchor='primary_org_name'>
<p>An organizational name is the official name of an organization (company, school, etc.) within which a person works. Since a person may be affiliated with multiple organizations (e.g., multiple research institutions), the primary organizational name is used to differentiate the main organization with which a person is affiliated.</p>
<p>The Data Forms field that represents the name of a primary organization is "primary_org_name".</p>
<p>This field maps to:</p>
<ul>
<li>vCard o</li>
</ul>
<example caption='Primary Organizational Name'><![CDATA[
<field var='primary_org_name'>
<value>Columbia University</value>
</field>
]]></example>
</section3>
<section3 topic='Primary Organizational Role' anchor='primary_org_role'>
<p>An organizational role describes a person's profession or how a person contributes within an organization. Since a person may be affiliated with multiple organizations (e.g., multiple research institutions), the primary organizational role is used to differentiate the person's role at their primary organization.</p>
<p>The Data Forms field that represents an organizational role is "primary_org_role".</p>
<p>This field maps to:</p>
<ul>
<li>vCard ROLE</li>
</ul>
<example caption='Primary Organizational Role'><![CDATA[
<field var='primary_org_role'>
<value>Professor Emeritus</value>
</field>
]]></example>
</section3>
<section3 topic='Primary Organizational Unit' anchor='primary_org_unit'>
<p>An organizational unit is the name of part (subsidiary, department, etc.) of an organization Since a person may be affiliated with multiple organizational units (e.g., multiple schools within a university), the primary organizational name is used to differentiate the main organization with which a person is affiliated.</p>
<p>The Data Forms field that represents an organizational unit is "primary_org_unit".</p>
<p>This field maps to:</p>
<ul>
<li>LDAP ou</li>
<li>LDAP eduPersonPrimaryOrgUnitDN</li>
</ul>
<example caption='Primary Organizational Unit'><![CDATA[
<field var='primary_org_unit'>
<value>Jabber Council</value>
</field>
]]></example>
</section3>
<section3 topic='System Username' anchor='system_username'>
<p>Usually a person has a system or network username within an organization (usually not exposed outside the organization).</p>
<p>The Data Forms field that represents such a username is "system_username".</p>
<p>This field maps to:</p>
<ul>
<li>LDAP uid</li>
<li>LDAP userid</li>
</ul>
<example caption='System Username'><![CDATA[
<field var='system_username'>
<value>psaintandre</value>
</field>
]]></example>
</section3>
<section3 topic='Teams' anchor='teams'>
<p>People often work in teams. Sometimes it can be helpful to list those teams.</p>
<p>The Data Forms field that represents a work team is "teams".</p>
<example caption='Teams'><![CDATA[
<field var='teams'>
<value>Infrastructure Team</value>
<value>Jabber Council</value>
</field>
]]></example>
</section3>
<section3 topic='Workstation Address' anchor='workstation'>
<p>Often a person has a dedicated workstation address or name within an organization (usually not exposed outside the organization).</p>
<p>The Data Forms field that represents such a username is "workstation".</p>
<example caption='Workstation Address'><![CDATA[
<field var='workstation'>
<value>squire</value>
</field>
]]></example>
</section3>
</section2>
<section2 topic='Basic Personal Data Aspects' anchor='fields-basic'>
<p>These data fields are not necessarily permanent, but do not tend to change very often if at all.</p>
<section3 topic='Birth Day-of-Month' anchor='birth_dayofmonth'>
<p>A birth day-of-month is the day of the month in which a person was born. (Note: This data field is <em>not</em> what in English is usually referred to as a person's "birthday", i.e. the year+month+day on which the person was born; the "birthday" is split into three data fields in order to protect personal privacy, since a given individual might want to disclose his or her birth year, birth month, birth day-of-month, or some combination thereof but not all three.)</p>
<p>The Data Forms field that represents a birth day-of-month is "birth_dayofmonth".</p>
<p>When combined with other birthday-related fields, this field maps to:</p>
<ul>
<li>vCard BDAY</li>
</ul>
<example caption='Birth Day-of-Month'><![CDATA[
<field var='birth_dayofmonth'>
<value>06</value>
</field>
]]></example>
</section3>
<section3 topic='Birth Month' anchor='birth_month'>
<p>A birth month is the month of the year in which a person was born.</p>
<p>The Data Forms field that represents a birth month is "birth_month".</p>
<p>When combined with other birthday-related fields, this field maps to:</p>
<ul>
<li>vCard BDAY</li>
</ul>
<example caption='Birth Month'><![CDATA[
<field var='birth_month'>
<value>08</value>
</field>
]]></example>
</section3>
<section3 topic='Birth Year' anchor='birth_year'>
<p>A birth year is the year in which a person was born.</p>
<p>The Data Forms field that represents a birth year is "birth_year".</p>
<p>When combined with other birthday-related fields, this field maps to:</p>
<ul>
<li>vCard BDAY</li>
</ul>
<example caption='Birth Year'><![CDATA[
<field var='birth_year'>
<value>1966</value>
</field>
]]></example>
</section3>
<section3 topic='Description' anchor='description'>
<p>It can be helpful to provide a natural-language description of a person.</p>
<p>The Data Forms field that represents a description of a person is "description".</p>
<p>This field maps to:</p>
<ul>
<li>LDAP description</li>
</ul>
<example caption='Description'><![CDATA[
<field var='description'>
<value>I'm a Jabber fanatic.</value>
</field>
]]></example>
</section3>
<section3 topic='Eye Color' anchor='eye_color'>
<p>Some people may want to know the color of a person's eyes. The allowable or recommended values for this field are not specified.</p>
<p>The Data Forms field that represents a person's eye color is "eye_color".</p>
<example caption='Eye Color'><![CDATA[
<field var='eye_color'>
<value>blue</value>
</field>
]]></example>
</section3>
<section3 topic='Gender' anchor='gender'>
<p>Gender is the self-defined gender of a person (this is not limited to "male" and "female", although those are the expected values in most instances). Sometimes also called "sex" or "gender identification".</p>
<p>The Data Forms field that represents a person's gender is "gender".</p>
<p>This field maps to:</p>
<ul>
<li>FOAF gender</li>
</ul>
<example caption='Gender'><![CDATA[
<field var='gender'>
<value>male</value>
</field>
]]></example>
</section3>
<section3 topic='Hair Color' anchor='hair_color'>
<p>Some people may want to know the color of a person's hair (if any). The allowable or recommended values for this field are not specified.</p>
<p>The Data Forms field that represents a person's hair color is "hair_color".</p>
<example caption='Hair Color'><![CDATA[
<field var='hair_color'>
<value>none</value>
</field>
]]></example>
</section3>
<section3 topic='Height' anchor='height'>
<p>Some people may want to know a person's height. This SHOULD be expressed in centimeters (which can be transformed into other units if necessary by a client).</p>
<p>The Data Forms field that represents a person's height is "height".</p>
<example caption='Height'><![CDATA[
<field var='height'>
<value>178</value>
</field>
]]></example>
</section3>
<section3 topic='Weight' anchor='weight'>
<p>Yes, it is a sensitive topic, but some people may want to know a person's weight. This SHOULD be expressed in kilograms (which can be transformed into other units if necessary by a client).</p>
<p>The Data Forms field that represents a person's weight is "weight".</p>
<example caption='Weight'><![CDATA[
<field var='weight'>
<value>75</value>
</field>
]]></example>
</section3>
</section2>
<section2 topic='Extended Personal Data Aspects' anchor='fields-extended'>
<section3 topic='Areas of Expertise' anchor='expertise'>
<p>An area of expertise is a subject in which a person has a great deal of knowledge.</p>
<p>The Data Forms field that represents an area of expertise is "expertise".</p>
<example caption='Areas of Expertise'><![CDATA[
<field var='expertise'>
<value>Jabber</value>
<value>XMPP</value>
</field>
]]></example>
</section3>
<section3 topic='Avatar Data' anchor='avatar_data'>
<p>An avatar is an often fanciful representation of a user's desired self-image or persona (e.g., in the context of a game). An avatar is usually not intended to be an accurate picture of the user's actual physical appearance (that is handled by the photo_url and photo_data fields).</p>
<p>An avatar can come in two forms: the avatar data itself, or a URL for a avatar.</p>
<p>The Data Forms field that represents avatar data is "avatar_data".</p>
<p>This field does not map to data in vCard or any other profile representation format.</p>
<example caption='Avatar Data'><![CDATA[
<field var='avatar_data'>
<value>base64-encoded-image-data</value>
</field>
]]></example>
</section3>
<section3 topic='Clubs' anchor='clubs'>
<p>Some people are members of clubs or other voluntary organizations.</p>
<p>The Data Forms field that represents club memberships is "clubs".</p>
<example caption='Club Memberships'><![CDATA[
<field var='clubs'>
<value>DENSA</value>
</field>
]]></example>
</section3>
<section3 topic='Dietary Preferences' anchor='dietary_preferences'>
<p>Some people have dietary preferences (vegan, vegetarian, kosher, peanut allergy, no shellfish, etc.).</p>
<p>The Data Forms field that represents dietary preferences is "dietary_preferences".</p>
<example caption='Dietary Preferences'><![CDATA[
<field var='dietary_preferences'>
<value>none</value>
</field>
]]></example>
</section3>
<section3 topic='Hobbies' anchor='hobby'>
<p>A hobby is a non-work activity that a person enjoys pursuing. Also called an "avocation".</p>
<p>The Data Forms field that represents a hobby is "hobby".</p>
<example caption='Some Hobbies'><![CDATA[
<field var='hobby'>
<value>guitar</value>
<value>songwriting</value>
<value>blogging</value>
<value>reading</value>
<value>hiking</value>
</field>
]]></example>
</section3>
<section3 topic='Interests' anchor='interest'>
<p>An interest a thing that a person cares about or is curious about. It is, generally, less active than a hobby.</p>
<p>The Data Forms field that represents an interest is "interest".</p>
<example caption='Some Interests'><![CDATA[
<field var='interest'>
<value>history</value>
<value>baseball</value>
<value>economics</value>
</field>
]]></example>
</section3>
<section3 topic='Languages Known Less Well' anchor='languages_lesswell'>
<p>Some people know more than one language, but less than well (e.g., the person may not be able to speak fluently). The definition of "less well" is left to the user.</p>
<p>The value of this field MUST be an abbreviation for a language as specified in &rfc4646;.</p>
<p>The Data Forms field that represents a language known less that well is "languages_lesswell".</p>
<example caption='Languages Known Less than Well'><![CDATA[
<field var='languages_lesswell'>
<value>cz</value>
<value>de</value>
<value>nl</value>
</field>
]]></example>
</section3>
<section3 topic='Languages Known Well' anchor='languages_well'>
<p>Everyone knows at least one language well (e.g., they are able to speak or write the language with a fair degree of fluency). Determination of whether someone knows a language "well" or "fluently" is left to the user.</p>
<p>The value of this field MUST be an abbreviation for a language as specified in <cite>RFC 4646</cite>.</p>
<p>The Data Forms field that represents a language known well is "languages_well".</p>
<p>This field maps to:</p>
<ul>
<li>LDAP preferredLanguage</li>
</ul>
<example caption='Languages Known Well'><![CDATA[
<field var='languages_well'>
<value>en</value>
</field>
]]></example>
</section3>
<section3 topic='License Plate Number' anchor='car_license_number'>
<p>Many people own automobiles, which usually have license or registration numbers.</p>
<p>The Data Forms field that represents a car license or registration number is "car_license_number".</p>
<p>This field maps to:</p>
<ul>
<li>LDAP carLicense</li>
</ul>
<example caption='License Plate Number'><![CDATA[
<field var='car_license_number'>
<value>JABBER</value>
</field>
]]></example>
</section3>
<section3 topic='Marital Status' anchor='marital_status'>
<p>Human beings often get married, sometimes get divorced, become widowed, etc.</p>
<p>The Data Forms field that represents whether a person's marital status is "marital_status".</p>
<example caption='Marital Status'><![CDATA[
<field var='marital_status'>
<value>married</value>
</field>
]]></example>
</section3>
<section3 topic='Myers-Briggs Type Indicator' anchor='mbti'>
<p>A Myers-Briggs type indicator is four-letter acronym that is a popular way to characterize different personality types.</p>
<p>The Data Forms field that represents a Myers-Briggs type indicator is "mbti".</p>
<p>This field maps to:</p>
<ul>
<li>FOAF myersBriggs</li>
</ul>
<example caption='Myers-Briggs Type Indicator'><![CDATA[
<field var='mbti'>
<value>INTP</value>
</field>
]]></example>
</section3>
<section3 topic='Photo Data' anchor='photo_data'>
<p>A photo provides a pictorial representation of a person. Sometimes also called a "mugshot".</p>
<p>A photo can come in two forms: the photo data itself, or a URL for a photo (e.g., the vCard PHOTO element can represent either, while the FOAF depiction and FOAF img can represent only a URL).</p>
<p>The Data Forms field that represents photo data is "photo_data".</p>
<p>This field maps to:</p>
<ul>
<li>vCard PHOTO</li>
<li>LDAP jpegPhoto</li>
</ul>
<example caption='Photo Data'><![CDATA[
<field var='photo_data'>
<value>base64-encoded-image-data</value>
</field>
]]></example>
</section3>
<section3 topic='Profession' anchor='profession'>
<p>A profession is what a person does for his or her primary employment. Also known as a "vocation". The allowable or recommended values for this field are not specified.</p>
<p>The Data Forms field that represents a profession is "profession".</p>
<example caption='A Profession'><![CDATA[
<field var='profession'>
<value>software engineer</value>
</field>
]]></example>
</section3>
<section3 topic='Religious Affiliation' anchor='religion'>
<p>Many people feel affiliated with a religious belief system.</p>
<p>The Data Forms field that represents a religious affiliation is "religion".</p>
<example caption='Religious Affiliation'><![CDATA[
<field var='religion'>
<value>none</value>
</field>
]]></example>
</section3>
<section3 topic='Sexual Orientation' anchor='sexual_orientation'>
<p>The allowable or recommended values for this field are not specified.</p>
<p>The Data Forms field that represents a person's sexual orientation is "sexual_orientation".</p>
<example caption='Sexual Orientation'><![CDATA[
<field var='sexual_orientation'>
<value>straight</value>
</field>
]]></example>
</section3>
<section3 topic='Smoker' anchor='smoker'>
<p>Some people smoke tobacco in various forms (cigarettes, cigars, pipes, etc.).</p>
<p>The Data Forms field that represents whether a person smokes is "smoker".</p>
<example caption='Smoker'><![CDATA[
<field var='smoker'>
<value>no</value>
</field>
]]></example>
</section3>
<section3 topic='Wishlist' anchor='wishlist'>
<p>A wishlist is a list of items that a person would like to receive as gifts.</p>
<p>The Data Forms field that represents a wishlist is "wishlist".</p>
<example caption='Wishlist'><![CDATA[
<field var='wishlist'>
<value>A Mini Cooper</value>
</field>
]]></example>
</section3>
<section3 topic='Zodiac Sign (Chinese)' anchor='zodiac_chinese'>
<p>A Chinese zodiac sign denotes the type of year in which a person was born according to the Chinese calendar (e.g., the year of the dragon).</p>
<p>The Data Forms field that represents a Chinese zodiac sign is "zodiac_chinese".</p>
<example caption='Zodiac Sign (Chinese)'><![CDATA[
<field var='zodiac_chinese'>
<value>horse</value>
</field>
]]></example>
</section3>
<section3 topic='Zodiac Sign (Western)' anchor='zodiac_western'>
<p>A Western zodiac sign is that part of the astrological belt under which a person was born; each sign is named after one of the constellations.</p>
<p>The Data Forms field that represents a Western zodiac sign is "zodiac_western".</p>
<example caption='Zodiac Sign (Western)'><![CDATA[
<field var='zodiac_western'>
<value>Leo</value>
</field>
]]></example>
</section3>
</section2>
<section2 topic='Security Data Aspects' anchor='fields-security'>
<p>Some people have PGP keys, X.509 certificates, and the like.</p>
<section3 topic='PGP Key' anchor='pgpkey'>
<p>The ASCII armored output of a PGP key.</p>
<p>The Data Forms field that represents a PGP key is "pgpkey".</p>
<p>This field maps to:</p>
<ul>
<li>vCard KEY with TYPE of PGP</li>
</ul>
<example caption='PGP Key'><![CDATA[
<field var='pgpkey'>
<value>
-----BEGIN PGP PUBLIC KEY BLOCK-----
Version: GnuPG v1.2.4 (Darwin)
mQGiBEGSeUQRBADTT8NqGpxDQ1GjmAJBDNET0blyb1LF6exYLxydX+hzcooE5WxP
Zdo5Xx0RrLYlKmmcKv0Z8cG/kei2pkS05h/oqluphGmzMBIeC/ox22z87PKpVDfj
OEYQOZqhqdFI+KRIa4M89CQOO1N5V2KlX9GaNjxRearKvLgsoeTzpPtybwCgl91i
SqQnry1YV+PFOjRcDT7cX+UD/2JxXU5d1Z1WZf7ttM3QjSaPc9CA4fS+axinRkn/
IbRJ/Lj8Tz+Vb4kBbBhmFG8JCoRtj2J8bsDdaFCh7nHqT2u4oXy0NJSCKrDRBcuL
bEQfasT/cuBXIM2A7nB1UtlUCYXnINxakYLIsW9BvvFN935FhZ81EJvLW34W2Mf7
Y+9ZA/0adScaI05UUE5RRcZSiXs8/p+R6SeaW2gjS5beL5Wv6ExRlDe92rGqrjtN
PmBRiDiVBSoYlqOepBZk+wM+/B4WMsmUFVeXsXWjWMlghyyni2rI1Z2v1UH8KBKm
259k7SlU/BbnEAHIzuHPSQHJNUX+YqWArz1v5tDcQn7L1Wo7PbRAUGV0ZXIgU2Fp
bnQtQW5kcmUgKHhtcHA6c3RwZXRlckBqYWJiZXIub3JnKSA8c3RwZXRlckBqYWJi
ZXIub3JnPoheBBMRAgAeBQJBknlEAhsDBgsJCAcDAgMVAgMDFgIBAh4BAheAAAoJ
EFmFiWTXBRKsfeQAoJdO0PvP1Mi/kJ9U1zVpa4GPpXYCAJ9oFjonfr+Z3ZTefjSb
tZpE2mny57kCDQRBknlzEAgAisWlkK6daVjrxouZK9KvX8tt3CKVse4CY52Lq7xi
dtEAhDcXX9SgTnlxgrcCnBipj/OMi/B2M0U88qv3TcsZ0dWZt7H4FnHJvU4xloK8
qRkJ7xa6gCEoPAc7ESdr//6J/eEvWMqixstOUyfRg2AQp/eSHX0Cl/TQImRVZbh6
HYCehrqpErAnz0VY8nvun3709LgvIMUvKrnV7lF9wOuuhWCK9IYdpmgoD4d/Gr4t
ZVuE1jYN4tBLyQXtJDAR/UvKHEiXUAhsfXOtfCUQV5MaxM6YQce63BGl05kS7oLH
Sx+KYOX1vEi3k1OFfH5CpqYaxmfhSzdyz7Hhdsl+IbkhzwAECwf/YQfpx4z9dnJn
3ePrZhz5SI4KjdbOCmqhLFd8aVoQ9BCriePH3kPjjoE9Qz+0NlFqzuG4/tkZkAok
BA0GqYE4XXgvpwGpK95mlUvxDOowu0fLVQA8NfpU3U7YItZkfAPZ2M+PnmayRILi
0yBmm1taVllCD2mc2vhsMRUoD1DUworSzQuTG9YlQ89Q2/1LsoQzYjBz9XIfYV4A
MPr/PKPkKy3D7BYHi/DOnkcP9hLXJSCjgV5TpuWuCVX9aYU2Yb7BfY1OFORBCUaV
B1YLAPtXqfqjz25pIQPDEUbpKzhEO7xNU4EPT8ZsSfqqOd3aMet8McieRfMd+VIe
4J1OUIg1oYhJBBgRAgAJBQJBknlzAhsMAAoJEFmFiWTXBRKs/GgAn0R63qTEQd/e
XhK8hFkPvXjudl7xAJ95+2fAHfmHheZJVaO8VaJiL54Tvw==
=ZRIc
-----END PGP PUBLIC KEY BLOCK-----
</value>
</field>
]]></example>
</section3>
<section3 topic='PGP Key Fingerprint' anchor='pgp_fingerprint'>
<p>The fingerprint (hashed value) of a PGP key.</p>
<p>The Data Forms field that represents a PGP fingerprint is "pgp_fingerprint".</p>
<example caption='PGP Fingerprint'><![CDATA[
<field var='pgp_fingerprint'>
<value>E5CA EAE7 C8D6 CFE2 6D7A 8653 5985 8964 D705 12AC</value>
</field>
]]></example>
</section3>
<section3 topic='PGP Key ID' anchor='pgpkey_id'>
<p>The ID of a PGP key.</p>
<p>The Data Forms field that represents a PGP key ID is "pgpkey_id".</p>
<example caption='PGP Key ID'><![CDATA[
<field var='pgpkey_id'>
<value>D70512AC</value>
</field>
]]></example>
</section3>
<section3 topic='X.509 Fingerprint (MD5)' anchor='x509_fingerprint_md5'>
<p>The fingerprint of an X.509 certificate, hashed using MD5.</p>
<p>The Data Forms field representing such a value is "x509_fingerprint_md5".</p>
<example caption='X.509 Fingerprint (MD5)'><![CDATA[
<field var='x509_fingerprint_md5'>
<value>5D 41 20 54 7C 90 49 A1 78 36 07 29 75 9B A7 D0</value>
</field>
]]></example>
</section3>
<section3 topic='X.509 Fingerprint (SHA-1)' anchor='x509_fingerprint_sha1'>
<p>The fingerprint of an X.509 certificate, hashed using SHA-1.</p>
<p>The Data Forms field representing such a value is "x509_fingerprint_sha1".</p>
<example caption='X.509 Fingerprint (SHA-1)'><![CDATA[
<field var='x509_fingerprint_sha1'>
<value>C3 88 33 27 F3 47 3B 8B 07 71 3E 96 44 A7 EE E2 E0 50 4A 5B</value>
</field>
]]></example>
</section3>
</section2>
<section2 topic='Personal Favorites' anchor='fields-favorites'>
<p>Most people have favorite movies, authors, TV shows, musical artists, foods, games, etc.</p>
<section3 topic='Favorite Authors' anchor='fav_authors'>
<p>The Data Forms field that represents favorite authors is "fav_authors".</p>
<p>This field does not map to data in vCard or any other profile representation format.</p>
<example caption='Favorite Authors'><![CDATA[
<field var='fav_authors'>
<value>Jacob Bronowski</value>
<value>Friedrich Nietzsche</value>
<value>Carroll Quigley</value>
<value>Yevgeny Zamyatin</value>
</field>
]]></example>
</section3>
<section3 topic='Favorite Athletes' anchor='fav_athletes'>
<p>The Data Forms field that represents favorite athletes is "fav_athletes".</p>
<p>This field does not map to data in vCard or any other profile representation format.</p>
<example caption='Favorite Athletes'><![CDATA[
<field var='fav_athletes'>
<value>Lance Armstrong</value>
<value>Andre Agassiz</value>
</field>
]]></example>
</section3>
<section3 topic='Favorite Beverages' anchor='favorite_beverages'>
<p>The Data Forms field that represents favorite beverages is "favorite_beverages".</p>
<p>This field maps to:</p>
<ul>
<li>LDAP drink</li>
<li>LDAP favoriteDrink</li>
</ul>
<example caption='Favorite Beverages'><![CDATA[
<field var='favorite_beverages'>
<value>Guinness</value>
</field>
]]></example>
</section3>
<section3 topic='Favorite Charities' anchor='fav_charities'>
<p>The Data Forms field that represents favorite charities is "fav_charities".</p>
<p>This field does not map to data in vCard or any other profile representation format.</p>
<example caption='Favorite Charities'><![CDATA[
<field var='fav_charities'>
<value>Institute for Justice</value>
<value>PERC</value>
</field>
]]></example>
</section3>
<section3 topic='Favorite Chatrooms' anchor='fav_chatrooms'>
<p>The Data Forms field that represents favorite chatrooms is "fav_chatrooms".</p>
<p>This field does not map to data in vCard or any other profile representation format.</p>
<example caption='Favorite Chatrooms'><![CDATA[
<field var='fav_chatrooms'>
<value>jabber@conference.jabber.org</value>
<value>jdev@conference.jabber.org</value>
</field>
]]></example>
</section3>
<section3 topic='Favorite Drinks' anchor='fav_drinks'>
<p>The Data Forms field that represents favorite drinks is "fav_drinks".</p>
<p>This field does not map to data in vCard or any other profile representation format.</p>
<example caption='Favorite Drinks'><![CDATA[
<field var='fav_drinks'>
<value>Guinness</value>
</field>
]]></example>
</section3>
<section3 topic='Favorite Foods' anchor='fav_foods'>
<p>The Data Forms field that represents favorite foods is "fav_foods".</p>
<p>This field does not map to data in vCard or any other profile representation format.</p>
<example caption='Favorite Foods'><![CDATA[
<field var='fav_foods'>
<value>Thai</value>
<value>Mexican</value>
<value>Italian</value>
</field>
]]></example>
</section3>
<section3 topic='Favorite Games' anchor='fav_games'>
<p>The Data Forms field that represents favorite games is "fav_games".</p>
<p>This field does not map to data in vCard or any other profile representation format.</p>
<example caption='Favorite Games'><![CDATA[
<field var='fav_games'>
<value>chess</value>
</field>
]]></example>
</section3>
<section3 topic='Favorite Movies' anchor='fav_movies'>
<p>The Data Forms field that represents favorite movies is "fav_movies".</p>
<p>This field does not map to data in vCard or any other profile representation format.</p>
<example caption='Favorite Movies'><![CDATA[
<field var='fav_movies'>
<value>In Search of Bobby Fischer</value>
<value>Strictly Ballroom</value>
<value>The Truth About Cats and Dogs</value>
<value>Ray</value>
</field>
]]></example>
</section3>
<section3 topic='Favorite Music' anchor='fav_music'>
<p>The Data Forms field that represents favorite music is "fav_music".</p>
<p>This field does not map to data in vCard or any other profile representation format.</p>
<example caption='Favorite Music'><![CDATA[
<field var='fav_music'>
<value>J.S. Bach</value>
<value>Duke Ellington</value>
<value>Mellow Candle</value>
<value>Yes</value>
</field>
]]></example>
</section3>
<section3 topic='Favorite Quotes' anchor='fav_quotes'>
<p>A quote is a phrase or saying that a person identifies with in some way. According to the 2004 Pew Internet survey on instant messaging, quotes represent the most popular item to include in online profiles on major consumer-oriented instant messaging services.</p>
<p>The Data Forms field that represents favorite quotes is "fav_quotes".</p>
<p>This field does not map to data in vCard or any other profile representation format.</p>
<example caption='Favorite Quotes'><![CDATA[
<field var='fav_quotes'>
<value>I am large, I contain multitudes.</value>
<value>&quot;Think like a man of action, act like a man of thought.&quot; --Henri Bergson</value>
<value>One crowded hour of glorious life is worth an age without a name.</value>
</field>
]]></example>
</section3>
<section3 topic='Favorite Sports Teams' anchor='fav_teams'>
<p>The Data Forms field that represents favorite sports teams is "fav_teams".</p>
<p>This field does not map to data in vCard or any other profile representation format.</p>
<example caption='Favorite Sports Teams'><![CDATA[
<field var='fav_teams'>
<value>New York Yankees</value>
<value>Colorado Rockies</value>
</field>
]]></example>
</section3>
<section3 topic='Favorite TV Shows' anchor='fav_tv'>
<p>The Data Forms field that represents favorite TV shows is "fav_tv".</p>
<p>This field does not map to data in vCard or any other profile representation format.</p>
<example caption='Favorite TV Shows'><![CDATA[
<field var='fav_tv'>
<value>Antiques Road Show</value>
</field>
]]></example>
</section3>
</section2>
<section2 topic='Personal History' anchor='fields-history'>
<section3 topic='Places Lived' anchor='places_lived'>
<p>Some people move around a lot.</p>
<p>The Data Forms field that represents places lived is "places_lived".</p>
<p>This field does not map to data in vCard or any other profile representation format.</p>
<example caption='Places Lived'><![CDATA[
<field var='places_lived'>
<value>Denver, Colorado, USA</value>
<value>New Hope, Pennsylvania, USA</value>
<value>Maplewood, New Jersey, USA</value>
<value>Atlanta, Georgia, USA</value>
<value>Fairfax, Virginia, USA</value>
<value>Ceske Budejovice, Czech Republic</value>
<value>New York City</value>
<value>Readfield, Maine, USA</value>
<value>Sea Cliff, NY, USA</value>
</field>
]]></example>
</section3>
<section3 topic='Schools Attended' anchor='schools'>
<p>The Data Forms field that represents schools attended is "schools".</p>
<p>This field does not map to data in vCard or any other profile representation format.</p>
<example caption='Schools Attended'><![CDATA[
<field var='schools'>
<value>Columbia University</value>
<value>American Renaissance School</value>
<value>Maranacook Community School</value>
</field>
]]></example>
</section3>
</section2>
</section1>
<section1 topic='Security Considerations' anchor='security'>
<p>Profile data can be personally significant and even security critical. Due care should be taken in determining who shall have access to such information. In particular, an entity SHOULD ensure that its public profile contains only information that it deems safe to be world-readable, SHOULD ensure that any pubsub node it may create for profile data has an access model of "presence" or "roster", and SHOULD NOT publish private or restricted data except to such a pubsub node.</p>
</section1>
<section1 topic='IANA Considerations' anchor='iana'>
<p>This document requires no interaction with &IANA;.</p>
</section1>
<section1 topic='XMPP Registrar Considerations' anchor='registrar'>
<section2 topic='Protocol Namespaces' anchor='ns'>
<p>Until this specification advances to a status of Draft, its associated namespace shall be "urn:xmpp:tmp:profile"; upon advancement of this specification, the &REGISTRAR; shall issue a permanent namespace in accordance with the process defined in Section 4 of &xep0053;.</p>
</section2>
<section2 topic='Field Standardization' anchor='registrar-formtype'>
<p>To follow.</p>
</section2>
</section1>
<section1 topic='XML Schema' anchor='schema'>
<code><![CDATA[
<?xml version='1.0' encoding='UTF-8'?>
<xs:schema
xmlns:xs='http://www.w3.org/2001/XMLSchema'
targetNamespace='urn:xmpp:tmp:profile'
xmlns='urn:xmpp:tmp:profile'
elementFormDefault='qualified'>
<xs:import
namespace='jabber:x:data'
schemaLocation='http://www.xmpp.org/schemas/x-data.xsd'/>
<xs:element name='profile'>
<xs:complexType>
<xs:sequence xmlns:data='jabber:x:data'>
<xs:element ref='data:x'/>
</xs:sequence>
</xs:complexType>
</xs:schema>
]]></code>
</section1>
</xep>
Reference in New Issue View Git Blame Copy Permalink