hproduct-proposal

From Microformats Wiki
Revision as of 05:33, 16 September 2008 by PaulLee (talk | contribs) (→‎Out of Scope)
Jump to navigation Jump to search

draft hProduct Proposal

hProduct is a format suitable for embedding in (X)HTML, Atom, RSS, and arbitrary XML. hProduct would be related to several microformats (including hListing and hReview) and would be an open standard.

Authors

(in alphabetical order)

Introduction

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, Buy.com and AutoByTel.

hProduct would be compatible and combinable with hListing and hReview.

Scope

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

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

An hProduct schema should consist of the following:

  • hproduct
    • version. optional. text.
    • name. required.
    • image. optional. IMG element or rel='image'. could be further refined as image type ( thumb || full, photo || illo).
    • description. optional. could be denoted as 'summary' or 'extended'.
    • brand. optional. text | hCard
    • uri. optional. URI to product page, href could contain rel='product'.
    • price. optional. could be further refined as specific type (sale || regular || msrp || clearance). should follow currency format.
    • savings. optional. should follow currency format.
    • p-v. optional. opens up possibilities for custom property-value pairs in more complex examples.
      • property. required. property types could include:
        • artist
        • author
        • released - hcalendar event for date of release
        • upc
        • isbn
        • sku
        • sn
        • vin
        • batch
        • size
        • color
        • uid - unique id, item number
        • offer
        • others. possibly around product specs, features.
      • value. required. (label may be implied)
    • availability. optional. text containing availablity message.
    • shipping. optional. shipping messaging.
    • reviews. optional. text | hReview
    • buy. optional. text purchase messaging and/or rel="purchase" indicating target URI for purchasing item

Field Details

The fields of the hListing schema represent the following:

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 15-July-2008 is "0.0," since it has no official standing yet.

Content

name:: This required field contains the name of the item

image:: This optional field contains either an image (as an IMG element) or a link to an image (as an A with rel="image"). The image can be categorized by additional terms such as 'thumb' (for thumbnail), 'full' (for full size image), 'photo' (for a photograph), 'illo' (for an illustration).

description:: This optional field contains the full text representing the written description of the item. The field MAY include valid XHTML markup (e.g. paragraphs). User agents SHOULD preserve any markup. Description could be either a 'summary' or an 'extended' description.

brand:: This optional field can contain either plan text or an |hCard for the organization responsible for the item. Examples would include Sony, Friends of ED, O'Reilly, etc.

uri:: This optional field is a URI for the product at its brand website. It is not to be confused with the hListing 'permalink'.

price:: This optional field is the suggested price for the item. Price could be further refined to define a specific price type, such as 'sale' for sale price, 'regular' for regularly a priced item, 'msrp' for manufacturers retail price, or 'clearance' for a clearance product. It follows the proposed currency format.

savings:: This optional field will describe any savings scenarios in relation to the product price. It follows the proposed currency format.

availability:: Optional text field that describes product availability.

shipping:: Optional field that details shipping.

reviews:: Optional product reviews that can contain text or could follow current hReview format.

buy:: This optional field contains the buying messaging and/or rel="purchase" links pointing to the target URI for buying the product.


Properties & Values

A differentiator of hProduct versus some of the other, more mature formats is the properties and values (p-v) mechanism that is built in to the proposed format. With the wide variation in product attributes, the p-v mechanism provides extensibility to a large array of items without the need for subclassing. There will be several ways of accomplishing property-value associations which will be described below, with several possible shorthands.

p-v:: This optional field initiates a property-value group.

  • property:: This required field denotes the property label.

    Anticipated 'property' types include

    • 'artist'
    • 'author'
    • 'released' - hCal event for date of release
    • 'upc'
    • 'isbn' - international standard book number
    • 'sku' - stock keeping unit
    • 'sn' - serial number
    • 'vin' - vehicle identification number
    • 'batch'
    • 'size'
    • 'color'
    • 'uid' - unique id as provided by vendor/manufacturer/retailer
    • 'offer' - offers tied to the product, as provided by vendor/manufacturer/retailer
    • others - possibly around product specs, features
  • value:: This required field denotes the property value. The value may be implied in certain shorthands.

Cross-cutting issues

Internationalization: Though there are many English-language tokens, they are only used as invisible class-names; user-visible listing information can be completely localized. n.b. that (X)HTML LANG attribute rules still apply as usual, for multilingual aggregators of hProduct.

The following field names have been reused from the hCard and hCalendar microformats: version, description. In addition, brands described by hCards MAY contain any hCard field.

Examples (Preliminary)

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

<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>

Changes

mid Nov 2006: initial concepting.

15-July-2008: hProduct revival effort

research

Discussions

See also

Acknowledgements

Much of this document is based on the fine work of the folks behind hListing and their proposal.

Retrieved from "http://microformats.org/wiki/index.php?title=hproduct-proposal&oldid=29900"