draft hProduct Proposal
hProduct is a format suitable for embedding in (X)HTML, Atom, RSS, and arbitrary XML. hProduct is be related to several microformats (including hListing and hReview) and is an open standard.
(in alphabetical order)
- Craig Cook, Focal Curve
- Aaron Gustafson, Easy! Designs
- Paul Lee, Google Product Search
- Jay Myers, BestBuy Co, Inc.
The web is a thriving marketplace with a plethora of vendors scattered across the globe. Sifting through this mass of information is difficult when it is unstructured. The hProduct microformat will bring order and structure to the chaos, making it easy for people to list the products they offer and easy for Web Services to consume that product information for analysis and syndication. This proposal follows the common practices of ecommerce sites such as Amazon, BestBuy.com, Buy.com, and AutoByTel.
hProduct is compatible and combinable with hListing and hReview.
Giving details about a particular product is sometimes very complex as parameters are differnt for books and CDs than they are for iPods or cars. It should be very easy to mark up an item using hProduct and the syntax should be simple yet flexible enough for more advanced applications.
Out of Scope
This microformat does not intend to replicate any of the content proposed within hListing and would defer all money/transactional matters to that microformat. This microformat also does not attempt to specify a product ontology, or category-specific attributes; instead, it aims to create a framework to allow for flexible expression of both.
The hProduct format is based on a set of fields common to numerous ecommerce sites and formats in use today on the web.
The hProduct schema consists of the following (see existing class names for reference):
|availability||optional||singular||Text. Can be further refined by type (instore, online, preorder, backorder, specialorder).|
|brand||optional||singular||Text. Can also use hCard for manufacturer.|
|buy||optional||plural||Text. Purchase messaging and/or rel="purchase" indicating target url for purchasing item.|
|category||optional||plural||Text. hCard. Can also use rel="tag".|
|condition||optional||singular||Text. Examples: 'new', 'used', 'refurbished'.|
|description||optional||singular||Text. hReview. Can also include valid HTML markup.|
|n||required||singular||Text. hCard. Product name or title.|
|photo||optional||plural||Image element or link. hCard. Photo or image of the object used in <img>.|
|price||optional||plural||Floating point number. Can be further refined by type (msrp, regular, sale, clearance), can use currency format.|
|shipping||optional||singular||Text. Messaging. Example: 'Ships within 24-48 hours.'|
|url||optional||singular||href. hCard. Can contain rel='product'.|
The identifier structure is used to describe product identifiers like UPC or SKU, and is designed to accommodate new or as-yet-unidentified identifiers.
- identifier (optional)
In addition to the above fields, hProduct includes a properties and values (p-v) mechanism to accommodate the wide variation in product attributes.
- p-v (optional)
- property (required) - examples:
- accessory for
- compatible with
- quantity in lot
- rating - can be further denoted into rating types (product || merchant || mpaa || esrb || others)
- released - hcalendar event for date of release
- value (required) - label may be implied
- property (required) - examples:
Finally, hReview is used to describe product reviews.
version: This optional field permits hProduct publishers to specify a particular version of hProduct that their content uses. By omitting this field, the publisher is stating that implementations may interpret the hListings according to any version of the hProduct specification. The value for this proposal as of 28-Oct-2008 is "0.0," since it has no official standing yet.
Internationalization: Though there are many English-language tokens, they are only used as invisible class-names; user-visible listing information can be completely localized. Note that (X)HTML
LANG attribute rules still apply as usual, for multilingual aggregators of hProduct.
Certain field names have been reused from the hCard and hCalendar microformats, e.g.,
version, description. In addition, brands described by hProduct may contain hCard fields.
The Pick of Destiny by Tenacious D The Pick of Destiny is the highly anticipated soundtrack to the upcoming New Line Cinema comedy, Tenacious D in the Pick of Destiny. An epic musical adventure, the film follows Tenacious D (Jack Black and Kyle Gass) on their quest to obtain the Pick and become The Greatest Band on Earth. Released: November 14, 2006 Label: Sony UPC: 82796948912
<div class="hproduct"> <h4 class="name">The Pick of Destiny</h4> <h5 class="p-v">by <span class="property artist">Tenacious D</span></h5> <p class="description summary">The Pick of Destiny is the highly anticipated soundtrack to the upcoming New Line Cinema comedy, Tenacious D in the Pick of Destiny. An epic musical adventure, the film follows Tenacious D (Jack Black and Kyle Gass) on their quest to obtain the Pick and become The Greatest Band on Earth.</p> <ul> <li class="p-v"><span class="property">Released</span>: <span class="value"><abbr title="2006-11-14T12:00:01-05:00">November 14, 2006</abbr></span></li> <li>Label: <span class="brand">Sony</span></li> <li class="p-v"><span class="property">UPC</span>: <span class="value">82796948912</span></li> </ul> </div>
Examples in Production
- Description of BestBuy.com implementation
mid Nov 2006: initial concepting.
15-July-2008: hProduct revival effort
28-Oct-2008: Agreement on initial hProduct draft
- Feedback is encouraged on the product-brainstorming page.
- See also blogs discussing this page.
Much of this document is based on the fine work of the folks behind hListing and their proposal.