Initial revision
[xmpp:xmpp.git] / extensions / xep-0125.xml
1 <?xml version='1.0' encoding='UTF-8'?>
2 <!DOCTYPE jep SYSTEM '../jep.dtd' [
3   <!ENTITY % ents SYSTEM '../jep.ent'>
4 %ents;
5 ]>
6 <?xml-stylesheet type='text/xsl' href='../jep.xsl'?>
7 <jep>
8 <header>
9   <title>vCard Infobits Mapping</title>
10   <abstract>NOTE: This proposal was retracted by the author on 2004-02-19.</abstract>
11   <!--
12   <abstract>A mapping of vCard data to the Jabber infobits protocol.</abstract>
13   -->
15   <number>0125</number>
16   <status>Retracted</status>
17   <type>Informational</type>
18   <jig>Standards JIG</jig>
19   <dependencies>JEP-0120</dependencies>
20   <supersedes>None</supersedes>
21   <supersededby>None</supersededby>
22   <shortname>N/A</shortname>
23   &stpeter;
24   <revision>
25     <version>0.1</version>
26     <date>2003-12-15</date>
27     <initials>psa</initials>
28     <remark>Initial version, split off from version 0.5 of JEP-0121 (with revisions to more clearly map vCard elements); further mapping and description required.</remark>
29   </revision>
30 </header>
31 <section1 topic='Introduction'>
32   <p>&jep0120; defines a protocol for capturing granular information (or "infobits") about users, servers, services, rooms, nodes, commands, files, and other phenomena on the Jabber/XMPP network; however, that document defines the protocol only, not the infobits themselves. This JEP specifies how to encapsulate one sort of metadata in infobits: the metadata elements about entities defined by &rfc2426; (supplemented by vCard-like metadata that is not defined in RFC 2426), thus enabling the Jabber community to supersede &jep0054;. Note well that this JEP is decidedly <em>not</em> meant to provide an exhaustive catalog of possible infobits. Future registrations, whether in Jabber Enhancement Proposals or direct submissions to the &REGISTRAR;, will specify additional infobits.</p>
33 </section1>
34 <section1 topic='vCard Mapping'>
35   <p>In order to supersede the vCard-XML protocol currently in use within the Jabber community, it is necessary to define infobits that correspond to the data elements defined by the vCard-XML DTD (more precisely, the vCard Profile Features specified in section 3 of RFC 2426). These are shown in the following table. (Note: this mapping uses the vCard entity names specified in &dawson3;, not those specified in JEP-0054.)</p>
36   <table caption='Mapping of vCard Fields'>
37     <tr>
38       <th>Infobit Key</th>
39       <th>vCard Element</th>
40       <th>Comments</th>
41     </tr>
42     <tr>
43       <td>birthdate</td>
44       <td>bday (partial)</td>
45       <td>Date of birth (DD); prepend with birthyear and birthmonth (with "-" separators) to create vCard bday content</td>
46     </tr>
47     <tr>
48       <td>birthmonth</td>
49       <td>bday (partial)</td>
50       <td>Month of birth (MM); prepend with birthyear and append with birthdate (with "-" separators) to create vCard bday content</td>
51     </tr>
52     <tr>
53       <td>birthyear</td>
54       <td>bday (partial)</td>
55       <td>Year of birth (YYYY); append with birthmonth and birthdate (with "-" separators) to create vCard bday content; the vCard "bday" element is separated into three infobits so that users can abstain from providing a birthyear</td>
56     </tr>
57     <tr>
58       <td>cellphone</td>
59       <td>tel + cell</td>
60       <td>A cellphone (mobile phone) number; if more than one cellphone number is specified, this infobit keyname should be appended with one of the following modifiers: home, work</td>
61     </tr>
62     <tr>
63       <td>city</td>
64       <td>city</td>
65       <td>If more than one address is specified (e.g., work and home), this infobit keyname may be appended with any of the following address modifiers: home, work, postal, parcel (e.g., city.home)</td>
66     </tr>
67     <tr>
68       <td>country</td>
69       <td>country</td>
70       <td>If more than one address is specified (e.g., work and home), this infobit keyname may be appended with any of the following address modifiers: home, work, postal, parcel (e.g., country.home)</td>
71     </tr>
72     <tr>
73       <td>email</td>
74       <td>email</td>
75       <td>If more than one email address is specified, this infobit name should be appended with one of the following address modifiers: home, work</td>
76     </tr>
77     <tr>
78       <td>extadd</td>
79       <td>extadd</td>
80       <td>Extended address; if more than one address is specified (e.g., work and home), this infobit keyname may be appended with any of the following address modifiers: home, work, postal, parcel (e.g., extadd.home)</td>
81     </tr>
82     <tr>
83       <td>family</td>
84       <td>family</td>
85       <td>A family name or surname; in some cultures, known as a "last name"</td>
86     </tr>
87     <tr>
88       <td>fax</td>
89       <td>tel + fax</td>
90       <td>A fax number; if more than one fax number is specified, this infobit keyname should be appended with one of the following modifiers: home, work</td>
91     </tr>
92     <tr>
93       <td>fn</td>
94       <td>fn</td>
95       <td>A full name</td>
96     </tr>
97     <tr>
98       <td>given</td>
99       <td>given</td>
100       <td>A given name; in some cultures, known as a "first name"</td>
101     </tr>
102     <tr>
103       <td>key</td>
104       <td>key</td>
105       <td>This SHOULD be a URL to or identifier for a public key, but MAY be the key information itself</td>
106     </tr>
107     <tr>
108       <td>lat</td>
109       <td>lat</td>
110       <td>Latitude in decimal degrees North</td>
111     </tr>
112     <tr>
113       <td>logo</td>
114       <td>logo</td>
115       <td>This MUST be a URL to a logo; recipients should be prepared to parse the URL in order to retrieve and then decode the binary information</td>
116     </tr>
117     <tr>
118       <td>lon</td>
119       <td>lon</td>
120       <td>Longitude in decimal degrees East</td>
121     </tr>
122     <tr>
123       <td>middle</td>
124       <td>middle</td>
125       <td>A person's middle name or initial</td>
126     </tr>
127     <tr>
128       <td>nickname</td>
129       <td>nickname</td>
130       <td>A person's preferred nickname or less formal name</td>
131     </tr>
132     <tr>
133       <td>orgnam</td>
134       <td>orgnam</td>
135       <td>A name for an organization</td>
136     </tr>
137     <tr>
138       <td>orgunit</td>
139       <td>orgunit</td>
140       <td>A name for an organizational unit</td>
141     </tr>
142     <tr>
143       <td>pager</td>
144       <td>tel + pager</td>
145       <td>A pager number; if more than one pager number is specified, this infobit keyname should be appended with one of the following modifiers: home, work</td>
146     </tr>
147     <tr>
148       <td>pcode</td>
149       <td>pcode</td>
150       <td>A postal code; if more than one address is specified (e.g., work and home), this infobit name may be appended with any of the following address modifiers: home, work, postal, parcel</td>
151     </tr>
152     <tr>
153       <td>phone</td>
154       <td>tel + voice</td>
155       <td>A voice phone number; if more than one voice phone number is specified, this infobit keyname should be appended with one of the following modifiers: home, work</td>
156     </tr>
157     <tr>
158       <td>photo</td>
159       <td>photo + extval</td>
160       <td>This MUST be a URL to a photo; recipients should be prepared to parse the URL in order to retrieve and then decode the binary information</td>
161     </tr>
162     <tr>
163       <td>prefix</td>
164       <td>prefix</td>
165       <td>A prefix to a name (e.g., "Dr.")</td>
166     </tr>
167     <tr>
168       <td>region</td>
169       <td>region</td>
170       <td>If more than one address is specified, this infobit keyname may be appended with any of the following address modifiers: home, work, postal, parcel (e.g., region.home)</td>
171     </tr>
172     <tr>
173       <td>role</td>
174       <td>role</td>
175       <td>A person's role within an organization</td>
176     </tr>
177     <tr>
178       <td>sound</td>
179       <td>sound + extval</td>
180       <td>This MUST be a URL to a sound file; recipients should be prepared to parse the URL in order to retrieve and then decode the binary information</td>
181     </tr>
182     <tr>
183       <td>street</td>
184       <td>street</td>
185       <td>Street number and name; if more than one address is specified, this infobit keyname may be appended with any of the following address modifiers: home, work, postal, parcel (e.g., street.home)</td>
186     </tr>
187     <tr>
188       <td>suffix</td>
189       <td>suffix</td>
190       <td>A suffix to a name (e.g., "Esq.")</td>
191     </tr>
192     <tr>
193       <td>title</td>
194       <td>title</td>
195       <td>This is a job title, and is not to be confused with the &DUBLINCORE; "title" metadata term</td>
196     </tr>
197     <tr>
198       <td>vmail</td>
199       <td>tel + msg</td>
200       <td>A voicemail (message) number; if more than one voicemail number is specified, this infobit keyname should be appended with one of the following modifiers: home, work</td>
201     </tr>
202     <tr>
203       <td>website</td>
204       <td>url</td>
205       <td>URL for any website</td>
206     </tr>
207   </table>
208 </section1>
209 <section1 topic='Supplementing vCard'>
210   <p>The vCard specification does not include the following infobits because either (1) it is not that granular or (2) they represent entities or properties that did not exist when the vCard format was defined.</p>
211   <table caption='Additional vCard-Like Infobits'>
212     <tr>
213       <th>Infobit</th>
214       <th>Comments</th>
215     </tr>
216     <tr>
217       <td>alt</td>
218       <td>Altitude in meters above sea level</td>
219     </tr>
220     <tr>
221       <td>area</td>
222       <td>An area within a locality; if more than one address is specified, this infobit keyname may be appended with any of the following address modifiers: home, work, postal, parcel (e.g., area.home)</td>
223     </tr>
224     <tr>
225       <td>building</td>
226       <td>The name of a specific building; if more than one address is specified, this infobit keyname may be appended with any of the following address modifiers: home, work, postal, parcel (e.g., building.home)</td>
227     </tr>
228     <tr>
229       <td>expertise</td>
230       <td>A self-defined area of expertise (no guarantees provided)</td>
231     </tr>
232     <tr>
233       <td>floor</td>
234       <td>The floor of a building; if more than one address is specified, this infobit keyname may be appended with any of the following address modifiers: home, work, postal, parcel (e.g., floor.home)</td>
235     </tr>
236     <tr>
237       <td>gender</td>
238       <td>The self-defined gender of a user (this is not limited to "male" and "female", although those are the expected values in most instances)</td>
239     </tr>
240     <tr>
241       <td>interest</td>
242       <td>A self-defined area of interest</td>
243     </tr>
244     <tr>
245       <td>jid</td>
246       <td>An entity's Jabber Identifier</td>
247     </tr>
248     <tr>
249       <td>orgurl</td>
250       <td>URL for organization's website</td>
251     </tr>
252     <tr>
253       <td>room</td>
254       <td>A specific room; if more than one address is specified, this infobit keyname may be appended with any of the following address modifiers: home, work, postal, parcel (e.g., room.home)</td>
255     </tr>
256     <tr>
257       <td>weblog</td>
258       <td>URL for weblog</td>
259     </tr>
260   </table>
261 </section1>
262 <section1 topic='Security Considerations'>
263   <p>This JEP introduces no security considerations above and beyond those already defined in JEP-0120.</p>
264 </section1>
265 <section1 topic='IANA Considerations'>
266   <p>This JEP requires no interaction with &IANA;.</p>
267 </section1>
268 <section1 topic='Jabber Registrar Considerations'>
269   <p>The following is a submission to the infobits registry called for by JEP-0120.</p>
270   <section2 topic='vCard Mapping Infobits'>
271     <p>To follow.</p>
272   </section2>
273   <section2 topic='vCard Supplement Infobits'>
274     <p>To follow.</p>
275   </section2>
276 </section1>
277 </jep>