hcard-th: Difference between revisions

From Microformats Wiki
Jump to navigation Jump to search
Line 62: Line 62:


=== หมายเหตุเกี่ยวกับคุณสมบัติ ===
=== หมายเหตุเกี่ยวกับคุณสมบัติ ===
<span id="note1">[[#property-list-n|1. ^]]</span>: คุณสมบัติชื่อ 'n' เป็นคุณสมบัติที่ {{มีหรือไม่มีก็ได้}} ถ้า [[hcard#Implied_.22n.22_Optimization|implied 'n' optimization rules]] มีผลบังคับใช้<br />
<span id="note1">[[#property-list-n|1. ^]]</span>: คุณสมบัติชื่อ 'n' เป็นคุณสมบัติที่ {{optional-th}} ถ้า [[hcard#Implied_.22n.22_Optimization|implied 'n' optimization rules]] มีผลบังคับใช้<br />
<span id="note2">[[#property-list-tel|2. ^]]</span>: tel - สำหรับคุณสมบัติ tel ผู้ใช้ {{ได้รับอนุญาติ}} ให้ใช้รูปแบบเบอร์โทรศัพท์ตามมาตรฐาน [http://en.wikipedia.org/wiki/E.123 E.123] ได้  ตัวอักษรที่อยู่ในรูปแบบ (เช่น +1-555-FORMATS) {{จะต้อง}} ถูกแทนที่ด้วยตัวเลข  คุณสามารถใช้ <code>abbr</code> เพื่อแสดงตัวอักษรและให้ค่าตัวเลขไปพร้อมๆกัน  เช่น <code><nowiki><abbr title="+15553676287">+1-555-FORMATS</abbr></nowiki></code>.
<span id="note2">[[#property-list-tel|2. ^]]</span>: tel - สำหรับคุณสมบัติ tel ผู้ใช้ {{may-th}} ให้ใช้รูปแบบเบอร์โทรศัพท์ตามมาตรฐาน [http://en.wikipedia.org/wiki/E.123 E.123] ได้  ตัวอักษรที่อยู่ในรูปแบบ (เช่น +1-555-FORMATS) {{must-th}} ถูกแทนที่ด้วยตัวเลข  คุณสามารถใช้ <code>abbr</code> เพื่อแสดงตัวอักษรและให้ค่าตัวเลขไปพร้อมๆกัน  เช่น <code><nowiki><abbr title="+15553676287">+1-555-FORMATS</abbr></nowiki></code>.


=== Singular vs. Plural Properties ===
=== Singular vs. Plural Properties ===

Revision as of 15:44, 7 May 2008

hCard

hCard เป็นรูปแบบไมโครฟอร์แมตที่เรียบง่ายที่ใช้เป็นสัญลักษณ์ของผู้คน บริษัท องค์กร และสถานที่ hCardใช้คุณสมบัติต่างๆจากมาตรฐาน vCard (ใน RFC2426) และแทนค่าผ่าน semantic HTML หรือ XHTML

hCard เป็นหนึ่งในไม่กี่มาตรฐานเปิดใน ไมโครฟอร์แมต ที่เหมาะสำหรับการนำไป embed ใน HTML, XHTML, Atom, RSS, และ XML

อยากจะเริ่มเขียน hCard แล้วหรือยัง? ลองดูที่ เครื่องมือสร้าง hCard เพื่อสร้างที่อยู่ติดต่อ หรือจะลองอ่าน เกร็ดในการสร้าง hCard เพื่อ mark up หน้าเว็บติดต่อของคุณดูก็ได้

Specification

บรรณาธิการ
Tantek Çelik (แทนเทค เซลิค) (http://tantek.com/, และก่อนหน้านี้ที่ Technorati, Inc., และที่ Microsoft Corporation)
ผู้แต่ง
Tantek Çelik (รายชื่อผู้มีส่วนร่วมอยู่ด้านบน)
Brian Suda (ไบรอัน ซูดา) (http://suda.co.uk/)
Acknowledgments
ดู acknowledgments.

copyright และ patents มีผลบังคับใช้ตามที่ระบุ

แนะนำ

มาตรฐาน vCard (RFC2426) ได้ถูกนำมาใช้อย่างแพร่หลาย (เช่นในโปรแกรม "Address Book" ของบริษัทแอปเปิลที่พ่วงมากับระบบปฏิบัติการ MacOSX).

นอกจากนั้น เจ้าของบล๊อกหลายๆคนก็ระบุชื่อตัวเองเวลาบล๊อก และบางคนก็พูดถึงเพื่อนๆหรือครอบครัวตัวเอง ถ้าเราเพิ่มโคงสร้างอีกเล็กน้อยให้เนื้อหา เจ้าของบล๊อกก็สามารถพูดถึงบุคคลต่างๆเหล่านี้โดยที่ spider และ aggregator ต่างๆสามารถดึงเอาข้อมูลเกี่ยวกับบุคคลเหล่านี้ได้จากเนื้อหาหน้าเว็บและแปลงมันมาเป็น vCard เพื่อใช้ในแอพพลิเคชั่นต่างๆได้อย่างง่ายดาย

Specification นี้แนะนำฟอร์แมต hCard ซึ่งใช้คุณสมบัติและค่าต่างๆจากมาตรฐาน vCard ในเนื้อหา HTML ตามที่ได้กล่าวไว้ก่อนหน้านี้ เจ้าของบล๊อกสามารถฝัง hCard เข้าไปในหน้าเว็บได้เลย และตกแต่ง hCard ด้วย CSS ตามที่ต้องการ นอกจากนั้น แอพพลิเคชั่นต่างๆก็สามารถดึงข้อมูล hCard จากหน้าเว็บได้โดยตรงโดยที่ไม่ต้องใช้ไฟล์อื่นเพิ่มเติมแม้แต่น้อย

คุณสามารถใช้เครื่องมือ ตัวสร้าง hCard และก็คัดลอก HTML ที่เครื่องมือนี้สร้้างให้ไปใส่ในบล๊อกหรือหน้าเว็บคุณเพื่อเผยแพร่ข้อมูลติดต่อของคุณได้

คำพิเศษเหล่านี้ "จะต้อง ", "จะต้องไม่", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "ไม่ควรจะ", "RECOMMENDED", "สามารถ ", และ "มีหรือไม่มีก็ได้ " ให้ตีความหมายตามคำอธิบายใน RFC 2119.

รูปแบบ

โดยทั่วไป

มาตรฐาน vCard (RFC2426) เป็นพื้นฐานสำหรับ hCard

รูปแบบเบื้องต้นของ hCard คือการใช้ชื่อ object/property ของ vCard แบบตัวอักษรตัวเล็กหมดสำหรับแทนชื่อคลาส (class) และแทน vCard ที่ซ้อนๆกันด้วยอีลีเมนต์ HTML ที่ซ้อนๆกัน

ชื่อคลาสราก (Root Class Name)

ชื่อคลาสรากสำหรับ hCard คือ "vcard" อีลีเมนต์ที่มีคลาส "vcard" ก็เป็น hCard ด้วยเช่นกัน

คุณสมบัติและคุณสมบัติย่อย (Properties and Sub-properties)

The properties of an hCard are represented by elements inside the hCard. Elements with class names of the listed properties represent the values of those properties. Some properties have sub-properties, and those are represented by elements inside the elements for properties.

รายชื่อคุณสมบัติ

รายชื่อคุณสมบัติ (properties) ของ hCard (คุณสมบัติย่อยหรือ sub-properties จะอยู่ในเครื่องหมายวงเล็บแบบนี้)

เพื่อความกระชับ คำอธิบายภาษาไทยของแต่ละคุณสมบัติหรือคุณสมบัติย่อยจะต่อท้ายชื่อคุณสมบัติที่เป็นภาษาอังกฤษ เวลาใช้งานไมโครฟอร์แมตในเนื้อหาของคุณ กรุณาใช้ชื่อภาษาอังกฤษ

จะต้องมีใน hCard:

  • fn
  • n1 (family-name เพื่อระบุนามสุกล, given-name ชื่อ, additional-name ชื่ออื่นๆ เช่นชื่อกลางถ้ามี, honorific-prefix คำนำหน้าชื่อ, honorific-suffix คำต่อท้ายชื่อ)

มีหรือไม่มีก็ได้:

  • nickname ชื่อเล่น, sort-string
  • url, email (type, value สำหรับชนิดของอีเมล์), tel เบอร์โทรศัพท์2 (type, value ชนิดของเบอร์โทรศัพท์)
  • adr ที่อยู่ (post-office-box บ้านเลขที่, extended-address ที่อยู่เพิ่มเติม เช่นซอย หมู่บ้าน ฯลฯ, street-address ถนน , locality ตำบลและอำเภย, region จังหวัด, postal-code รหัสไปรษณีย์, country-name ประเทศ, type, value), label
  • geo พิกัดบนโลก (latitude เส้นรุ้ง, longitude เส้นแวง), tz โซนเวลา
  • photo รูปภาพ, logo โลโก้, sound, bday วันเกิด
  • title ชื่อตำแหน่ง, role อาชีพหรือหน้าที่การงาน, org องค์กร (organization-name ชื่อองค์กร, organization-unit หน่วยงาน)
  • category, note หมายเหตุ
  • class, key, mailer, uid, rev

หมายเหตุเกี่ยวกับคุณสมบัติ

1. ^: คุณสมบัติชื่อ 'n' เป็นคุณสมบัติที่ มีหรือไม่มีก็ได้ ถ้า implied 'n' optimization rules มีผลบังคับใช้
2. ^: tel - สำหรับคุณสมบัติ tel ผู้ใช้ สามารถ ให้ใช้รูปแบบเบอร์โทรศัพท์ตามมาตรฐาน E.123 ได้ ตัวอักษรที่อยู่ในรูปแบบ (เช่น +1-555-FORMATS) จะต้อง ถูกแทนที่ด้วยตัวเลข คุณสามารถใช้ abbr เพื่อแสดงตัวอักษรและให้ค่าตัวเลขไปพร้อมๆกัน เช่น <abbr title="+15553676287">+1-555-FORMATS</abbr>.

Singular vs. Plural Properties

Singular properties: 'fn', 'n', 'bday', 'tz', 'geo', 'sort-string', 'uid', 'class'. For properties which are singular, the first descendant element with that class SHOULD take effect, any others being ignored.

All other properties MAY be plural. Each class instance of such properties creates a new instance of that property.

Human vs. Machine readable

The human visible text contents of an element for a property represents the value of that property, with a few exceptions:

If an <abbr> element is used for a property, then the 'title' attribute (if present) of the <abbr> element is the value of the property, instead of the contents of the element, which instead provide a more human presentable version of the value.

If an <a> element is used for one or more properties, it MUST be treated as follows:

  1. For the 'photo' property and any other property that takes a URL as its value, the href="..." attribute provides the property value.
  2. For other properties, the element's content is the value of the property.

If an <img> element is used for one or more properties, it MUST be treated as follows:

  1. For the 'photo' property and any other property that takes a URL as its value, the src="..." attribute provides the property value.
  2. For other properties, the <img> element's 'alt' attribute is the value of the property.

If an <object> element is used for one or more properties, it MUST be treated as follows:

  1. For the 'photo' property and any other property that takes a URL as its value, the data="..." attribute provides the property value.
  2. For other properties, the element's content is the value of the property.

Value excerpting

Sometimes only part of an element which is the equivalent for a property is used for the value of the property. This typically occurs when a property has a subtype, like 'tel'. For this purpose, the special class name "value" is used to excerpt out the subset of the element that is the value of the property. E.g. here is an hCard fragment for marking up a home phone number:

vCard: 

TEL;TYPE=HOME:+1.415.555.1212

hCard: 

<span class="tel">
 <span class="type">home</span>:
 <span class="value">+1.415.555.1212</span>
</span>

This hCard fragment could be displayed as:

home: +1.415.555.1212


Property Exceptions

vCard has several properties which either do not make sense on, or are already implied within the context of a web page. This section explains what to (not) do with them.

  1. vCard's NAME, PROFILE, SOURCE, PRODID, VERSION properties are defined in Sections 2.1.2, 2.1.3, 2.1.4, 3.6.3, 3.6.9 of RFC2426. Content publishers MUST NOT use these properties in their hCards, and as such, hCard consumers/parsers MUST IGNORE these properties if they are found within an hCard. Instead. hCard to vCard converters SHOULD use the title of the page where the hCard is found (e.g. the <title> element in HTML documents) to construct the NAME property, MAY output a PROFILE value of "VCARD" per RFC2426, SHOULD use the URL of the page where the hCard is found to construct the SOURCE property (e.g. perhaps as a parameter to a URL/service that converts hCards to vCards), for an output vCard stream (e.g. a .vcf file). Only services/applications that output actual vCards should write the PRODID property, with the product identifier for said service/application. Similarly, only such services/applications should write the VERSION property, with the value "3.0" (without quotes) per RFC2426 Section 3.6.9.

Organization Contact Info

If the "FN" and "ORG" properties have the exact same value (typically because they are set on the same element, e.g. class="fn org"), then the hCard represents contact information for a company, organization or place and SHOULD be treated as such. In this case the author also MUST NOT set the "N" property, or set it (and any sub-properties) explicitly to the empty string "". Thus parsers SHOULD handle the missing "N" property, in this case by implying empty values for all the "N" sub-properties.

Implied "n" Optimization

Although vCard requires that the "N" property be present, the authors of the vCard specification (RFC2426) themselves do not include "N" properties in their vCards near the end of the spec (p.38). This apparent contradiction can be resolved by simply allowing the "FN" property to imply "N" property values in typical cases provided in the spec. We do so explicitly in hCard.

If "FN" and "ORG" are not the same (see previous section), and the value of the "FN" property is exactly two words (separated by whitespace), and there is no explicit "N" property, then the "N" property is inferred from the "FN" property. For "FN"s with either one word see below, and for three or more, the author MUST explicitly markup the "N", except for the organization contact info case, see above for that.

  1. The content of "FN" is broken into two "words" separated by whitespace.
  2. The first word of the "FN" is interpreted as the "given-name" for the "N" property.
  3. The second/last word of the "FN" is interpreted as the "family-name" for the "N" property.
  4. Exception: If the first word ends in a "," comma OR if the second word is a single character (optionally followed by a period "."), then the first word (minus the comma at the end if any) is interpreted as the "family-name" and the second word is interpreted as the "given-name".

This allows simplification in the typical case of people stating:

  • given-name (space) family-name
  • family-name (comma) given-name
  • family-name (comma) given-name-first-initial
  • family-name (space) given-name-first-initial (optional period)

Implied "nickname" Optimization

Due to the prevalence of the use of nicknames/handles/usernames in actual content published on the Web (e.g. authors of reviews), hCard also has an implied "nickname" optimization to handle this.

Similar to the implied "n" optimization, if "FN" and "ORG" are not the same, and the value of the "FN" property is exactly one word, and there is no explicit "N" property, then:

  1. The content of the "FN" MUST be treated as a "nickname" property value.
  2. Parsers SHOULD handle the missing "N" property by implying empty values for all the "N" sub-properties.

Though parsers MUST follow the implied nickname optimization, publishers SHOULD explicitly indicate the "nickname" even in this case, e.g.: 

<span class="vcard">
 <span class="fn nickname">daveman692</span>
</span>

The hCard MAY have additional explicit "nickname" property values in addition to the implied nickname.

Implied "organization-name" Optimization

The "ORG" property has two subproperties, organization-name and organization-unit. Very often authors only publish the organization-name. Thus if an "ORG" property has no "organization-name" inside it, then its entire contents MUST be treated as the "organization-name".

Tags as Categories

Categories in hCard MAY be represented by tags with rel-tag. When a category property is a rel-tag, the tag (as defined by rel-tag) is used for that category.

type subproperty values

The 'type' subproperty in particular takes different values depending on which property it is a subproperty of. These 'type' subproperty values are case-INSENSITIVE, meaning "Home" is the same as "home", as well as multivalued, e.g. a tel can be home and preferred:

vCard: 

TEL;TYPE=HOME,PREF:+1.415.555.1212

hCard: 

<span class="tel"><span class="type">Home</span> (<span class="type">pref</span>erred):
 <span class="value">+1.415.555.1212</span>
</span>

This could be displayed as:

Home (preferred): +1.415.555.1212

type with unspecified value

When the type of a property is specified, and there is no explicit value specified, then everything in the property except for the type is considered the value of the property. E.g. 

<span class="tel"><span class="type">Home</span> +1.415.555.1212</span>

is equivalent to: 

<span class="tel"><span class="type">Home</span><span class="value"> +1.415.555.1212</span></span>

And thus the type is "home" and the value is "+1.415.555.1212".

adr tel email types

The following lists are informative. See RFC2426 sections 3.2.1 ADR, 3.3.1 TEL, and 3.3.2 EMAIL respectively for normative type values. They are repeated here for convenience. Default type subproperty value(s) is(are) first in each list and indicated in ALL CAPS. types may be multivalued.

  • adr type: INTL, POSTAL, PARCEL, WORK, dom, home, pref
  • tel type: VOICE, home, msg, work, pref, fax, cell, video, pager, bbs, modem, car, isdn, pcs
  • email type: INTERNET, x400, pref, "other IANA registered address types"

XMDP Profile

See hcard-profile for the XMDP profile of hCard which contains the above complete list of properties, with references to their RFC2426 definitions.

Parsing Details

See hCard parsing.

Examples

This section is informative.

Sample vCard

Here is a sample vCard: 

BEGIN:VCARD
VERSION:3.0
N:Çelik;Tantek
FN:Tantek Çelik
URL:http://tantek.com/
END:VCARD

and an equivalent in hCard with various elements optimized appropriately. See hCard Example 1 for the derivation. 

<div class="vcard">
 <a class="url fn" href="http://tantek.com/">Tantek Çelik</a>
</div>

This hCard might be displayed as:

Tantek Çelik

Note: The version information is unnecessary in hCard markup directly since the version will be defined by the profile of hCard that is used/referred to in the 'profile' attribute of the <head> element.

Live example

Here is Commercenet's contact details, as a live hCard which will be detected, on this page, by microformat parsing tools:

CommerceNet
http://www.commerce.net/
Work:
169 University Avenue

Palo Alto, CA  94301

USA
Work +1-650-289-4040
Fax +1-650-289-4041
Email

The mark-up, emboldening omitted for clarity, with the following semantic improvements:

  • abbr to expand abbreviations
  • hyperlinking the org name with the url
<div class="vcard">
  <a class="fn org url" href="http://www.commerce.net/">CommerceNet</a>
  <div class="adr">
    <span class="type">Work</span>:
    <div class="street-address">169 University Avenue</div>
    <span class="locality">Palo Alto</span>,  
    <abbr class="region" title="California">CA</abbr>  
    <span class="postal-code">94301</span>
    <div class="country-name">USA</div>
  </div>
  <div class="tel">
   <span class="type">Work</span> +1-650-289-4040
  </div>
  <div class="tel">
    <span class="type">Fax</span> +1-650-289-4041
  </div>
  <div>Email: 
   <span class="email">info@commerce.net</span>
  </div>
</div>

More Examples

See hCard examples for more examples, including all examples from vCard RFC2426 converted into hCard.

Buttons

You can use these buttons on pages with hCards. See buttons#hCard for any recent additions.

Examples in the wild

This section is informative. The number of hCard examples in the wild has expanded far beyond the capacity of being kept inline in this specification. They have been moved to a separate page.

See hCard Examples in the wild.

Implementations

This section is informative. The number of hCard implementations has also expanded beyond the capacity of keeping them inline. They have been moved to a separate page.

See hCard Implementations.

Copyright

Per the public domain release on the authors' user pages (Tantek Çelik, Brian Suda) this specification is released into the public domain.

Public Domain Contribution Requirement. Since the author(s) released this work into the public domain, in order to maintain this work's public domain status, all contributors to this page agree to release their contributions to this page to the public domain as well. Contributors may indicate their agreement by adding the public domain release template to their user page per the Voluntary Public Domain Declarations instructions. Unreleased contributions may be reverted/removed.

Patents

This specification is subject to a royalty free patent policy, e.g. per the W3C Patent Policy, and IETF RFC3667 & RFC3668.

References

Normative References

Informative References

Specifications That Use hCard

Similar Work

Inspiration and Acknowledgments

Thanks to: my good friend Vadim who introduced me to vCard many years ago, and if I'd only paid more attention then, perhaps I could have helped a lot of people avoid wasting a lot of time reinventing various standards wheels.

Notes on derivation from vCard

This section is informative.

More Semantic Equivalents

For some properties there are HTML elements which better match and convey their semantics. The following properties SHOULD be encoded with the following HTML:

  • URL in vCard becomes <a class="url" href="...">...</a> inside the element with class="vcard" in hCard.
  • Similarly, EMAIL in vCard becomes <a class="email" href="mailto:...">...</a>
  • PHOTO in vCard becomes <img class="photo" src="..." alt="Photo of ..." /> or <object class="photo" data="..." type="...">Photo of ...</object>
  • UID in vCard simply becomes another semantic applied to a specific URL (or EMAIL) for an hCard.

Singular and Plural derivations

The lists of singular and plural properties have been derived by analyzing the semantics of the individual properties in vCard RFC2426 and determining logically that they MUST be singular per their semantics. See hcard-singular-properties for explanations.

Plural Properties Singularized

Since plural property names become their singular equivalents, even if the original plural property permitted only a single value with multiple components, those multiple components are represented each with their own singularly named property and the the property is effectively multivalued and subject to the above treatment of multivalued properties.

Further Reading

Related Pages

The hCard specification is a work in progress. As additional aspects are discussed, understood, and written, they will be added. These thoughts, issues, and questions are kept in separate pages.

Retrieved from "http://microformats.org/wiki/index.php?title=hcard-th&oldid=26961"