hproduct-proposal: Difference between revisions

From Microformats Wiki
Jump to navigation Jump to search
m (→‎Out of Scope: Fixed broken link)
mNo edit summary
Line 66: Line 66:
'''msrp''':: This optional field is the manufacturer's suggested retail price for the item. It follows the proposed [[currency]] format.
'''msrp''':: This optional field is the manufacturer's suggested retail price for the item. It follows the proposed [[currency]] format.


=== Properties & Values ===
=== Properties
 
We understand the need for providing extensibility to this microformat and have built in a mechanism for doing that using properties and values (p-v). 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.
 
<ul>
<li>'''property''':: This required field denotes the property label.
 
<p>Anticipated 'property' types include</p>
 
* 'recurring' for intervals of time (associated with an 'msrp')
* 'artist'
* 'author'
* 'released' - [[hcal|hCal]] event for date of release
* 'upc'
* 'isbn' - international standard book number
* 'sku' - stock keeping unit
* 'sn' - serial number
* 'vin' - vehicle identification number
* 'batch'
 
</li>
 
<li>'''value''':: This required field denotes the property value. The value may be implied in certain shorthands.</li>
 
</ul>
 
===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 <code>LANG</code> attribute rules still apply as usual, for multilingual aggregators of hProduct.
 
The following field names have been reused from the [[hcard|hCard]] and [[hcalendar|hCalendar]] microformats: <code>version, description</code>.  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
 
<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>
 
 
 
==Changes==
 
mid Nov 2006: initial concepting.
 
== Discussions ==
 
* Feedback is encouraged on the [[hproduct-feedback|hProduct Feedback]] page.
* See also [http://www.technorati.com/cosmos/referer.html blogs discussing this page].
 
==See also==
*[[item]]
*[[currency]]
 
== Acknowledgements ==
 
Much of this document is based on the fine work of the folks behind [[hlisting|hListing]] and their proposal.

Revision as of 08:48, 7 June 2007

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

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.

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 hListing 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. text | hCard
    • uri. optional. URI to manufacturer product page.
    • msrp. optional. retail price.
    • p-v. optional. opens up possibilities for custom property-value pairs in more complex examples.
      • property. required.
      • value. required. (label may be implied)

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 17-Nov-2006 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'.

msrp:: This optional field is the manufacturer's suggested retail price for the item. It follows the proposed currency format.

=== Properties

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