- From: Robin Berjon via cvs-syncmail <cvsmail@w3.org>
- Date: Wed, 06 Apr 2011 13:54:30 +0000
- To: public-dap-commits@w3.org
Update of /sources/public/2009/dap/contacts
In directory hutz:/tmp/cvs-serv19752/contacts
Modified Files:
Overview.html
Log Message:
editorials, section Contact
Index: Overview.html
===================================================================
RCS file: /sources/public/2009/dap/contacts/Overview.html,v
retrieving revision 1.121
retrieving revision 1.122
diff -u -d -r1.121 -r1.122
--- Overview.html 6 Apr 2011 13:37:58 -0000 1.121
+++ Overview.html 6 Apr 2011 13:54:28 -0000 1.122
@@ -397,256 +397,187 @@
<section>
<h2><a>Contact</a> interface</h2>
-
- <p class="note">The attributes provided in this interface are under review and are likely to change as
- the recommendation progresses.
- </p>
-
<p>
- The <a href="#contact-interface"><code>Contact</code></a> interface captures the properties of a
- contact object.
+ The <a>Contact</a> interface captures the properties of a contact object.
</p>
-
<p>
- All <a href="#contact-interface"><code>Contact</code></a> objects MUST include all attributes
- supported by the implementation, regardless of whether these attributes have been assigned a
- non-<code>null</code> value or a <code>null</code> value. If a supported attribute has not been
- assigned a value by the user and/or implementation, then this attribute MUST still be present in the
- resulting <a href="#contact-interface"><code>Contact</code></a> object and MUST have a value of
- <code>null</code>.
+ All <a>Contact</a> objects MUST include all attributes supported by the implementation, regardless
+ of whether these attributes have been assigned a <code>null</code> value or not. If a supported attribute has not been
+ assigned a value by the user or the implementation, then this attribute MUST still be present in the
+ resulting <a>Contact</a> object and MUST have a value of <code>null</code>.
</p>
-
<p>
- Additional attributes MAY be included according to the provisions detailed in <a href=
- "#extended-contact-properties-and-parameters">Extended Contact Properties and Parameters</a>. If an
- extended attribute is supported by the current implementation and has not been assigned a value by the
- user and/or implementation, then this extended attribute MUST still be present in the resulting
- <a href="#contact-interface"><code>Contact</code></a> object and MUST have a value of
- <code>null</code>.
+ Additional attributes MAY be included according to the provisions detailed in
+ <a href="#extended-contact-properties-and-parameters">Extended Contact Properties and Parameters</a>. If an
+ extended attribute is supported by the current implementation and has not been assigned a value by the
+ user or the implementation, then this extended attribute MUST still be present in the resulting
+ <a>Contact</a> object and MUST have a value of <code>null</code>.
</p>
<dl title='[NoInterfaceObject] interface Contact' class='idl'>
<dt>readonly attribute DOMString id</dt>
-
<dd>
<p>
- A globally unique identifier for the given <code>Contact</code> object. Each
- <code>Contact</code> MUST include a non-empty <code>id</code> value.
+ A globally unique identifier for the given <a>Contact</a> object. Each <a>Contact</a> instance
+ MUST include a non-empty <code>id</code> value.
</p>
-
<p>
- An implementation MUST maintain this globally unique resource identifier when a Contact is added
- to, or present within, an Address Book.
+ An implementation MUST maintain this globally unique identifier when a <a>Contact</a> is added
+ to an address book.
</p>
</dd>
-
<dt>attribute DOMString displayName</dt>
-
<dd>
<p>
- This attribute contains the display name of this Contact which is suitable for display to the
- end-users.
+ This attribute contains the name of this <a>Contact</a> in a form that is suitable for display
+ to the user.
</p>
-
<p>
- Each Contact MUST include either a <code>displayName</code> or the <code>name</code>
- attribute.
+ Each <a>Contact</a> MUST include either a <code>displayName</code> or the <code>name</code>
+ attribute.
</p>
</dd>
-
<dt>attribute ContactName name</dt>
-
<dd>
<p>
- This attribute represents the full name of this <a href=
- "#contact-interface"><code>Contact</code></a> indicated by the name components associated with the
- <a href="#contactname-interface"><code>ContactName</code></a> object.
+ This attribute represents the full name of this <a>Contact</a> indicated by the name components
+ associated with the <a>ContactName</a> object.
</p>
</dd>
-
<dt>attribute DOMString nickname</dt>
-
<dd>
<p>
- This attribute contains the nickname (or a casual name) for this Contact.
+ This attribute contains the nickname (or a casual name) for this <a>Contact</a>.
</p>
</dd>
-
<dt>attribute ContactField[] phoneNumbers</dt>
-
<dd>
<p>
- This attribute represents one or more phone numbers associated with this Contact.
+ This attribute captures one or more phone numbers associated with this <a>Contact</a>.
</p>
</dd>
-
<dt>attribute ContactField[] emails</dt>
-
<dd>
<p>
- This attribute represents one or more email addresses associated with this Contact.
+ This attribute represents one or more email addresses associated with this <a>Contact</a>.
</p>
</dd>
-
<dt>attribute ContactAddress[] addresses</dt>
-
<dd>
<p>
- This attribute represents one or more physical addresses associated with this Contact.
+ This attribute represents one or more physical addresses associated with this <a>Contact</a>.
</p>
</dd>
-
<dt>attribute ContactField[] ims</dt>
-
<dd>
<p>
- This attribute represents one or more instant messaging identifiers associated with this
- Contact.
+ This attribute represents one or more instant messaging identifiers associated with this
+ <a>Contact</a>.
</p>
</dd>
-
<dt>attribute ContactOrganization[] organizations</dt>
-
<dd>
<p>
- This attribute represents one or more organizations associated with this Contact.
+ This attribute represents one or more organizations associated with this <a>Contact</a>.
</p>
</dd>
-
<dt>attribute Date revision</dt>
-
<dd>
<p>
- This atttribute contains the timestamp information associated with this Contact, which
- represents the last known modified time. If no modified time exists, then this object contains the
- timestamp of when the object was created.
+ This attribute contains the timestamp information associated with this <a>Contact</a>, which
+ represents the last known modification time. If no modification time exists, then this object contains the
+ timestamp of the object's creation time.
</p>
</dd>
-
<dt>attribute Date birthday</dt>
-
<dd>
<p>
- This attribute contains birthday of this Contact.
+ This attribute contains birthday of this <a>Contact</a>.
</p>
-
<p>
- The year value MAY be set to 0000 when the age of the Contact is private or the year is not
- available.
+ The year value MAY be set to 0000 when the age of the <a>Contact</a> is private or the year is not
+ available.
</p>
</dd>
-
<dt>attribute DOMString gender</dt>
-
<dd>
<p>
- This attribute contains the gender of this Contact. This attribute SHOULD have one of the
- following values:
+ This attribute contains the gender of this <a>Contact</a>. This attribute SHOULD have one of the
+ following values:
</p>
- <pre>
- male, female, undisclosed
- </pre>
-
+ <ul>
+ <li>male</li>
+ <li>female</li>
+ <li>undisclosed</li>
+ </ul>
<p>
- This attribute MAY return a different value if it is not covered by one of these values.
+ Note however that this attribute MAY contain a value not listed above.
</p>
</dd>
-
<dt>attribute DOMString note</dt>
-
<dd>
<p>
- This attribute contains the personal notes (free-text) for this Contact that is managed by the
- user of the Address Book.
- </p>
-
- <p>
- This field MAY contain newlines (<code>\n</code>).
+ This attribute contains the personal notes (free-text) for this <a>Contact</a> that is managed by the
+ user of the address book.
</p>
</dd>
-
<dt>attribute ContactField[] photos</dt>
-
<dd>
<p>
- This attribute represents one or more photos (that may be displayed) associated with this
- Contact.
- </p>
-
- <p>
- The photos MUST be specified in the <code>value</code> attribute of the
- <code>ContactField</code> object either by using a URL (representing an actual image file and not a
- web page pointing to that image file) or base64 encoded string representing the image data.
+ This attribute represents one or more photos associated with this <a>Contact</a>.
</p>
-
<p>
- Service Providers MAY return the same image at different sizes, though it is recognized that no
- standard for describing images of various sizes currently exists.
+ The photos MUST be specified in the <code>value</code> attribute of the <a>ContactField</a> object
+ either by using a URL to an image resource or base64 encoded string of the image data.
</p>
-
- <p class="note">This attribute SHOULD NOT be used to send down arbitrary photos taken by this user,
- but specifically profile photos of the contact suitable for display when describing the
- contact.
+ <p class="note">
+ This attribute SHOULD NOT be used to send down arbitrary photos taken by this user,
+ but specifically profile photos of the contact suitable for display when describing the
+ contact.
</p>
</dd>
-
<dt>attribute DOMString[] categories</dt>
-
<dd>
<p>
- This attribute contains one or more user-defined categories/tags/labels associated with this
- Contact. e.g. "family", "favorite".
+ This attribute contains one or more user-defined categories/tags/labels associated with this
+ <a>Contact</a>. e.g. "family", "favourite", "cryptozoologists".
</p>
</dd>
-
<dt>attribute ContactField[] urls</dt>
-
<dd>
<p>
- This attribute represents one or more web resources (i.e. URLs) associated with this Contact
- e.g. personal web page, blog.
- </p>
-
- <p>
- The web resources MUST be specified by the <code>value</code> attribute of the
- <code>ContactField</code> object using a URL.
+ This attribute represents one or more URLs associated with this <a>Contact</a> e.g. personal web page,
+ blog.
</p>
-
<p>
- In addition to the standard values for <code>type</code>, this field also defines the additional
- <code>type</code> values:
+ The web resources MUST be specified using the <code>value</code> attribute of the
+ <code>ContactField</code> object, and its <code>type</code> field may be set to "blog" or
+ "profile".
</p>
- <pre>
- blog, profile
- </pre>
</dd>
-
<dt>attribute DOMString timezone</dt>
-
<dd>
<p>
- This attribute represents the time zone of this Contact.
+ This attribute represents the time zone of this Contact.
</p>
-
<p>
- It is RECOMMENDED that names from the public-domain Olson database [[TZDB]] will be used as the
- value of this attribute, but this is not a restriction. For example, a value of
- <code>America/New_York</code> indicates the Contact is associated with the variable time zone of
- the New York region of the United States, including daylight saving time offsets experienced in
- that region.
+ It is RECOMMENDED that names from the public-domain Olson database [[TZDB]] will be used as the
+ value of this attribute, but this is not a restriction. For example, a value of
+ <code>America/New_York</code> indicates the <a>Contact</a> is associated with the variable time zone of
+ the New York region of the United States, including daylight saving time offsets experienced in
+ that region.
</p>
-
<p>
- It is also possible to use this attribute to express the timezone as a positive or negative
- difference from UTC, in the 24-hour clock, in units of hours and minutes (i.e.
- <code>+hh:mm</code>). For example, a value of <code>+05:30</code> indicates the Contact is
- associated with a fixed time zone of GMT+05:30.
+ It is also possible to use this attribute to express the timezone as a positive or negative
+ difference from UTC, in the 24-hour clock, in units of hours and minutes (i.e.
+ <code>+hh:mm</code>). For example, a value of <code>+05:30</code> indicates the Contact is
+ associated with a fixed time zone of GMT+05:30.
</p>
-
- <p class="note">Where possible UTC offset values SHOULD NOT be used. The UTC offset varies with
- time - not just because of the usual daylight saving time shifts that occur in may regions, but
- often entire regions will "re-base" their overall offset. The actual offset may be +/- 1 hour (or
- perhaps a little more) than any UTC offset given.
+ <p class="note">
+ Where possible UTC offset values SHOULD NOT be used. The UTC offset varies with
+ time - not just because of the usual daylight saving time shifts that occur in may regions, but
+ often entire regions will "re-base" their overall offset. The actual offset may be +/- 1 hour (or
+ perhaps a little more) than any UTC offset given.
</p>
</dd>
</dl>
Received on Wednesday, 6 April 2011 13:54:32 UTC