hproduct

2009-01-07T13:58:38Z

RocouTamon: relrelorace

getacoudr
<entry-title>hProduct</entry-title>
{{DraftSpecification}}
__TOC__
hProduct is a microformat suitable for publishing and embedding product data. hProduct is one of several open microformats standards suitable for embedding in HTML, XHTML, Atom, RSS, and arbitrary XML.

==hProduct Microformat Draft Specification==

; Editors/Authors
(alphabetical)
* [[User:PaulLee|Paul Lee]], Google Product Search
* [[User:JayMyers|Jay Myers]], [http://www.bestbuy.com/ Best Buy, Co., Inc.]

; Contributors
(alphabetical)
* Craig Cook, [http://focalcurve.com/ Focal Curve]
* Aaron Gustafson, [http://easy-designs.net/ Easy! Designs]

Microformats [http://microformats.org/wiki/hresume#Copyright copyright] and [http://microformats.org/wiki/hresume#Patents patents] statements apply.

== Status ==
Draft, version 0.1.

== Introduction ==
The web is a thriving consumer marketplace with a plethora of manufacturers and vendors scattered across the globe. Sifting through massive amounts of unstructured product data is a difficult task for both browsers and machines alike. The hProduct microformat gives structure to this metadata by providing constructs to identify universal product attributes, plus a mechanism to accomodate the wide variation in product attributes.

The hProduct microformat can assist consumers, manufacturers and retailers in a number of ways. If a browser or application understands that a specific web page contains the hProduct microformat, it can inform and help facilitate the best product choice by the consumer to fulfill their needs. An adpoted, open standard will ensure the correct product data is published between manufacturers and retailers, to the benefit of the consumer. Bringing order and structure to product data makes it easy for people and organizations to list the products and services they offer, and easy for web services to consume that product data for analysis and syndication.

=== Semantic XHTML Design Principles ===
{{SemanticXHTMLDesignPrinciples}}

=== Inspiration and Acknowledgment ===
Many thanks go out to the contributors who laid the foundation for the current hProduct draft spec.

=== Scope ===
Giving details about a particular product is sometimes very complex as parameters are different 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.

== Format ==
{{rfc-2119-intro}}

=== In General ===
The hProduct format is based on a set of fields common to numerous ecommerce sites and formats in use today on the web.

=== Schema ===
The hProduct schema consists of the following (see existing class names for reference):

*hproduct
** availability. optional. text. can be further refined by type (instore, online, preorder, backorder, specialorder).
** brand. optional. text. can also use [[hcard|hCard]] for manufacturer.
** buy. optional. text. purchase messaging and/or rel="purchase" indicating target url for purchasing item.
** category. optional. text. can also use [[rel-tag]]. re-used from [[hcard|hCard]].
** condition. optional. text. examples: 'new', 'used', 'refurbished'.
** description. optional. text. can also include valid HTML markup. re-used from [[hreview|hReview]].
** model. optional. text.
** '''n'''. required. text. product name or title. re-used from [[hcard|hCard]].
** photo. optional. image element or link. re-used from [[hcard|hCard]].
** price. optional. floating point number. can be further refined by type (msrp, regular, sale, clearance), can use [[currency]] format.
** quantity. optional. integer.
** shipping. optional. text. shipping messaging.
** url. optional. href. can contain [[rel-tag]] rel='product'. re-used from [[hcard|hCard]].
** version. optional. text. re-used from [[hreview|hReview]].
** identifier. optional.
***'''type'''. required. - examples:
****mpn
****upc
****isbn
****issn
****ean
****jan
****sn
****vin
****sku
***'''value'''. required. - label may be implied
** p-v. optional. property-value pair.
***'''property'''. required - examples:
****accessory for
****artist
****author
****color
****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
****size
***'''value'''. required. - label may be implied

=== Field details ===
Class names <code class="class-name">category</code>, <code class="class-name">n</code>, <code class="class-name">photo</code>, <code class="class-name">url</code> are reused from [[hcard|hCard]]. <code class="class-name">version</code> and <code class="class-name">description</code> are reused from [[hreview|hReview]].

The fields of the hProduct schema represent the following:

*'''<code class="class-name">hproduct::</code>''' Root class name
*'''<code class="class-name">availability::</code>''' the class name availability is used to determine availability of product. {{must}} be singular.
*'''<code class="class-name">brand::</code>''' the class name brand is used identify brand of the product. {{should}} use [[hcard|hCard]] for manufacturer name. {{must}} be singular.
*'''<code class="class-name">buy::</code>''' the class name buy contains messaging on how to buy product and/or relevant URLs to facilitate purchase. {{may}} be plural.
*'''<code class="class-name">category::</code>''' the class name category identifies product category. {{may}} use [[rel-tag]] microformat. {{may}} be plural to represent multiple categories.
*'''<code class="class-name">condition::</code>''' the class name condition identifies the product condition. {{may}} include text like "new", "used", "refurbished".{{must}} be singular.
*'''<code class="class-name">model::</code>''' the class name model identifies the manufacturer model name/ number associated with the item. {{must}} be singular.
*'''<code class="class-name">n::</code>''' product text name. {{must}} be singular.
*'''<code class="class-name">photo::</code>''' the class name photo {{may}} be applied to an <img> or <a> element. {{may}} be plural.
*'''<code class="class-name">price::</code>''' the class name price is used to identify a floating point number. {{may}} be refined by type, including msrp, regular, sale, or clearance. {{may}} use currency format. {{may}} be plural.
*'''<code class="class-name">quantity::</code>''' the class name quantity quantifies the number of available units of a product. {{must}} be singular.
*'''<code class="class-name">shipping::</code>''' the class name shipping {{may}} define the method, timeframe, and cost associated with shipping the product. {{must}} be singular.
*'''<code class="class-name">url::</code>''' the class name url {{should}} refer to the web page associated with product details. {{may}} use [[rel-tag]], rel='product'. {{must}} be singular.
*'''<code class="class-name">version::</code>''' the class name version {{should}} indicate the version of the hProduct format used for the item. by omitting this field, the publisher is stating that implementations {{may}} interpret the hProduct according to any version of the hProduct specification. {{must}} be singular.
*'''<code class="class-name">identifier::</code>''' the identifier structure is used to describe product identifiers like UPC or SKU, and is designed to accommodate new or as-yet-unidentified identifiers. {{should}} be singular.
**'''<code class="class-name">type::</code>''' the class name type identifies the identifier type.
**'''<code class="class-name">value::</code>''' label {{may}} be implied
*'''<code class="class-name">p-v::</code>''' the class p-v is the mechanism used to accomodate the wide variation in product attributes. {{may}} be plural.
**'''<code class="class-name">property::</code>''' the class name property is used to identify unique product attributes used in class p-v.
**'''<code class="class-name">value::</code>''' label {{may}} be implied.

=== Additional Details ===
''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.

=== XMDP Profile ===

<pre>
<dl class="profile">
<dt>class</dt>
<dd><p>
<a rel="help" href="http://www.w3.org/TR/html401/struct/global.html#adef-class">
HTML4 definition of the 'class' attribute.</a>
This meta data profile defines some 'class' attribute values (class names)
and their meanings as suggested by a
<a href="http://www.w3.org/TR/WD-htmllink-970328#profile">
draft of "Hypertext Links in HTML"</a>.</p>
<dl>
<dt>hproduct</dt>
<dd>Used to identify and describe metadata universally common to products.</dd>
<dt>availability</dt>
<dd>The details around the availability of the product.</dd>
<dt>brand</dt>
<dd>The brand name of the product.</dd>
<dt>buy</dt>
<dd>Details on how to buy the product</dd>
<dt>category</dt>
<dd>The product category/ categories the product belongs to.</dd>
<dt>condition</dt>
<dd>The condition of the product.</dd>
<dt>model</dt>
<dd>The model identifier of the product.</dd>
<dt>n</dt>
<dd>The common name of the product.</dd>
<dt>photo</dt>
<dd>Accompanying image of the product.</dd>
<dt>price</dt>
<dd>The price of the product.</dd>
<dt>quantity</dt>
<dd>The number of this type of product available.</dd>
<dt>shipping</dt>
<dd>Shipping information like method, timeframe or cost.</dd>
<dt>url</dt>
<dd>A link to the product details.</dd>
<dt>version</dt>
<dd>The version of the hProduct microformat being used in the example.</dd>
<dt>identifier</dt>
<dd>The product identifier like SKU, ISBN, or EAN associated with the product</dd>
<dt>p-v</dt>
<dd>Lists property-value pairs that identify unique product attributes.</dd>
</dl>
</dd>
</dl>

</pre>

=== Notes ===
This section is informative.
*...

=== Examples in Production ===
* Description of [http://jay.beweep.com/index.php/2008/10/14/reviving-shop-urls-with-hproduct BestBuy.com implementation]

=== Other examples ===

==== Simple Product ====

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

<pre><nowiki><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></nowiki></pre>

* more complicated examples can be found at [[hproduct-examples|hProduct examples]]

== Copyright ==
* [[User:JayMyers|JayMyers]]: I release all of my contributions to the public domain.

{{MicroFormatPublicDomainContributionStatement}}

== Patents ==
{{MicroFormatPatentStatement}}

== Related ==
* '''hproduct'''
* [[hproduct-issues]]
* [[hproduct-faq]]
* [[hproduct-examples]]

* [[product]]
* [[product-examples]]
* [[product-formats]]
* [[product-brainstorming]]

[[Category:Draft Specifications]]
[[Category:hProduct]]

Microformats Wiki - User contributions [en]

hproduct