https://microformats.org/wiki/api.php?action=feedcontributions&feedformat=atom&user=AdminiMicroformats Wiki - User contributions [en]2026-05-17T12:48:07ZUser contributionsMediaWiki 1.38.4https://microformats.org/wiki/index.php?title=blog-description-examples&diff=13990blog-description-examples2007-03-05T14:32:37Z<p>Admini: /* Author information */</p>
<hr />
<div><h1> Blog Description Examples </h1><br />
<br />
Examples of what people actually publish on their blogs about their blogs, as opposed to blogs describing other blogs (see [[blog-info-examples]] for that). E.g. links to feeds, names of authors etc.<br />
<br />
__TOC__<br />
<br />
== Contributors ==<br />
<br />
* [http://rbach.priv.at/ Robert Bachmann]<br />
* [http://tantek.com/log/ Tantek Çelik]<br />
* [http://maetl.coretxt.net.nz Mark Rickerby]<br />
* [http://bs-markup.de Bj&ouml;rn Seibert]<br />
<br />
== Emphasis on Practical, Simple, and Minimal ==<br />
<br />
This document is deliberately restricted to examples that are:<br />
* ''Actual'' examples in practice on the Web '''with URLs''' to the originals. <br />
* Simple and minimalist. As [http://microformats.org/wiki/microformats#the_microformats_principles simple as possible].<br />
<br />
Once there are sufficient blog-description-examples, and documentation of any known [[blog-description-formats]], we'll hopefully start a [[blog-description-brainstorming]] page to do aggregate analysis of the examples.<br />
<br />
== Overall Notes About Examples ==<br />
<br />
These examples are specifically limited to blogs describing themselves. <br />
<br />
Pages/sites/blogs that reference one or more blogs and information about them (like their feeds) are covered under a separate effort (see [[blog-info-examples]] for more on that.)<br />
<br />
This has some similarities to [[media-info-examples]] in that the media-info-examples include both descriptions of media content contained therein (thus similar to this page), and descriptions of media content referenced elsewhere.<br />
<br />
== Real World Examples ==<br />
<br />
'''Need real examples here. So far this just has the rough examples moved from [[blog-description-format]] which is ok to start with, but we need real examples to proceed any further.'''<br />
<br />
* URL... <br />
** implied schema...<br />
<br />
* etc.<br />
<br />
<br />
=== Rough Examples ===<br />
<br />
Moved here from [[blog-description-format]]:<br />
<br />
==== Feeds ====<br />
Most blogging tools and services provide information about available feeds in &lt;link&gt; elements.<br />
<br />
Example: (random blog from LiveJournal.com) <pre><nowiki><link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.livejournal.com/users/shalom9121/data/rss" /><br />
<link rel="alternate" type="application/atom+xml" title="Atom" href="http://www.livejournal.com/users/shalom9121/data/atom" /><br />
</nowiki></pre><br />
==== Author information ====<br />
<br />
It seems to be common on blogger.com to include "About me" in the sidebar<br />
(see http://www.blogger.com/redirect/next_blog.pyra?navBar=true for a random blog)<br />
== Related Pages People==<br />
* Sildenafil citrate, sold under the [http://www.efficacylevitra.info names Levitra]<br />
* A ring tone is the sound made by a telephone to indicate an [http://freeringtonemp.info incoming call]<br />
* Viagra pills are blue and [http://orderviagrales.info diamond-shaped] with the words.<br />
* Both Viagra and the Levitra are derived from [http://levitravsviagra.info Proto-Indo-Iranian]<br />
* The mode of action of [http://ordertramadoline.info tramadol] has yet to be fully understood.<br />
* Phentermine is a drug primarily used as an [http://pharmacyphentermine.info appetite suppressant]<br />
* The proper definition of [http://replicawatchbmw.info replica]<br />
* Alprazolam was [http://valiumxanax.info originally marketed] as an atypical benzodiazepine, but only classified for use treating anxiety neurosis.<br />
* [http://efficacylevitra.info/linki.htm 2006/2007]<br />
<br />
== See Also ==<br />
<br />
* [[blog-description-formats]]<br />
* [[blog-description-brainstorming]]</div>Adminihttps://microformats.org/wiki/index.php?title=hreview&diff=13991hreview2007-03-05T14:31:56Z<p>Admini: /* Further Reading */</p>
<hr />
<div><h1> hReview 0.3 </h1><br />
<br />
[[hreview|hReview]] is a simple, open, distributed format, suitable for embedding reviews (of products, services, businesses, events, etc.) in (X)HTML, Atom, RSS, and arbitrary XML. hReview is one of several [[microformats]] open standards.<br />
<br />
Want to get started with writing an [[hreview|hReview]]? Use the [http://microformats.org/code/hreview/creator hReview creator] to write a review and publish it.<br />
<br />
== Microformats Draft Specification 2006-02-22 ==<br />
<br />
; Editor: [http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc.]<br />
; Authors: [http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc.]<br />
: [http://360.yahoo.com/alidiabali Ali Diab],[http://yahoo.com Yahoo! Inc.]<br />
: [http://spaces.msn.com/members/ianmcallister/ Ian McAllister], [http://microsoft.com/ Microsoft Corporation]<br />
: [http://journals.aol.com/panzerjohn/abstractioneer John Panzer], [http://www.aol.com America Online, Inc.]<br />
: [http://ifindkarma.com/blog Adam Rifkin], [http://labs.commerce.net/ CommerceNet Labs]<br />
: [http://sippey.typepad.com/ Michael Sippey], [http://sixapart.com Six Apart, Ltd]<br />
<br />
Microformats [http://microformats.org/wiki/hreview#Copyright copyright] and [http://microformats.org/wiki/hreview#Patents patents] statements apply.<br />
<br />
__TOC__<br />
<br />
== Introduction ==<br />
Numerous web sites publish reviews using a broad variety of schema for all sorts of things from products (movies, music, books), to businesses (restaurants, hotels, stores), to events (concerts, theatre), to people (artists, leaders, celebrities), to places (landmarks, parks), to online resources (web pages, files), to reviews of reviews themselves.<br />
<br />
In order to enable and encourage the sharing, distribution, syndication, and aggregation, of reviews, the authors propose the hReview microformat, an open standard for distributed reviews. The authors have researched both numerous [[review-examples]] in the wild and earlier attempts at [[review-formats]], and have designed hReview around a simple minimal schema for reviews. Feedback is encouraged on the [[hreview-feedback|hReview feedback]] page.<br />
<br />
=== Inspiration and Acknowledgments ===<br />
Thanks to everyone who responded to the open call for implementor participation for hReview. The authors in particular wish to thank the following individuals for their constructive input and feedback: [http://www.richardault.com/ Richard Ault], [http://dannyayers.com Danny Ayers], [http://www.vertexdev.com/~jeff/ Jeffrey Barr],[http://adriancuthbert.blogspot.com/ Adrian Cuthbert],[http://jason.defillippo.com/ Jason DeFillippo], [http://www.hybernaut.com/bdv Brian Del Vecchio], Scott Derringer, [http://budgibson.com/home/ Bud Gibson], [http://joi.ito.com/ Joi Ito], [http://www.kanai.net/weblog/ Gen Kanai],[http://niallkennedy.com/ Niall Kennedy], [http://labs.commerce.net/wiki/index.php/Rohit_Khare Rohit Khare], [http://theryanking.com/ Ryan King], [http://www.jluster.org/ Jonas Luster], [http://epeus.blogspot.com/ Kevin Marks], Mark Nottingham, [http://www.powazek.com/ Derek Powazek], [http://www.judysbook.com/ Jeff Rodenburg], [http://sifry.com/alerts/ David Sifry], [http://jystewart.net/ James Stewart], [http://kung-foo.tv/ Adriaan Tijsseling], [http://www.flashenabled.com/ Phillip Torrone], Thai Tran, [http://w6daily.winn.com/ Phillip Winn], [http://yohei-y.blogspot.com YAMAMOTO Yohei].<br />
<br />
=== Scope ===<br />
Reviews consistently share several common fields. Where possible hReview has been based on this minimal common subset.<br />
<br />
==== Out of scope ====<br />
Fields that are type-specific have been omitted from hReview. It is important that hReview be kept simple and minimal from the start. Additional features can be added as deemed necessary by practical implementation experience.<br />
<br />
The concept of a "universal object identifier", that is, how to identify the same object/item/product across different shopping sites, though something very useful to have, is outside the scope of this format.<br />
<br />
== Semantic XHTML Design Principles ==<br />
{{semantic-xhtml-design-principles}}<br />
<br />
== Format ==<br />
=== In General ===<br />
The hReview format is based on a set of fields common to numerous review sites and formats in use today on the web. Where possible field names have been chosen based on those defined by the related [[hcard|hCard]] and [[hcalendar|hCalendar]] standards.<br />
<br />
=== Schema ===<br />
The hReview schema consists of the following:<br />
<br />
* hReview ('''<code>hreview</code>''')<br />
** '''<code>version</code>'''. optional. text.<br />
** '''<code>summary</code>'''. optional. text.<br />
** item '''<code>type</code>'''. optional. product | business | event | person | place | website | url.<br />
** '''<code>item</code>''' info. required. '''<code>fn</code>''' ('''<code>url</code>''' || '''<code>photo</code>''' ) | '''[[hcard|hCard]]''' (for person or business) | '''[[hcalendar|hCalendar]]''' (for event)<br />
** '''<code>reviewer</code>'''. optional. '''[[hcard|hCard]]'''.<br />
** '''<code>dtreviewed</code>'''. optional. ISO8601 absolute date time.<br />
** '''<code>rating</code>'''. optional. fixed point integer [1.0-5.0], with optional alternate '''<code>worst</code>''' (default:1.0) and/or '''<code>best</code>''' (default:5.0), also fixed point integers, and explicit '''<code>value</code>'''.<br />
** '''<code>description</code>'''. optional. text with optional valid XHTML markup.<br />
** tags. optional. keywords or phrases, using '''[[rel-tag]]''', each with optional rating.<br />
** permalink. optional, using '''[[rel-bookmark]]''' and '''[[rel-self]]'''.<br />
** license. optional, using '''[[rel-license]]'''.<br />
<br />
=== Field details ===<br />
The fields of the hReview schema represent the following:<br />
<br />
'''version''':: This optional field permits hReview publishers to specify a particular version of hReview that their content uses. By omitting this field, the publisher is stating that implementations may interpret the hReviews according to any version of the hReview specification v0.2 or later. In practice the authors of this specification are comitted to maintaining backward compatibility with content produced using earlier versions of the specification. This field is syntax compatible with, and thus reuses the semantics of "VERSION" as defined in vCard RFC2426 section "3.6.9 VERSION Type Definition". The value of this field for this specification is "0.3".<br />
<br />
'''summary''':: This optional field serves as a title for the review itself.<br />
<br />
'''item type''':: This optional field "type" provides the type of the item being reviewed, one of the following: product, business, event, person, place, website, url. If omitted, then in some cases the item type may be inferred. If the item is also an [[hcard|hCard]], then the item type is a "business" or a "person" based upon which of those the hCard represents. If the item is also an [[hcalendar|hCalendar]] event, then the item type is an "event".<br />
<br />
'''item info''':: This required field MUST have at a minimum the name ("fn" - the formatted text corresponding to the name) of ''the'' item (an hReview describes only one item), SHOULD provide at least one URI ("url") for the item, and MAY provide at least one URL to a photo or depiction ("photo") of the item. For items of type person or business, the item info (fn, url, photo) MUST be encapsulated in an [[hcard|hCard]]. For items of type event, the item info SHOULD be encapsulated in an [[hcalendar|hCalendar]] "vevent". Unique item IDs (e.g. ISBNs, UPCs) MAY be represented as a URN ("url") for the item. Encapsulated microformats (e.g. [[hcard|hCard]] and [[hcalendar|hCalendar]] events for now) may be set on the item itself (e.g. class="item vcard"). However, when using item info subproperties ("fn", "url", "photo"), they MUST be nested <em>inside</em> the item element.<br />
<br />
'''reviewer''':: The optional field specifies the person who authored the review. If the reviewer is specified, an hCard representing the reviewer MUST be provided. For anonymous reviews, use "anonymous" (without quotes) for the full name of the reviewer. If no "reviewer" is found inside the hReview, parsers should look outside the hReview, in the context of the page, for the "reviewer". If there is no "reviewer" outside either, then parsers should use the author defined by the containing document language, e.g. for (X)HTML documents, the <code><nowiki><address></nowiki></code> contact info for the page (which is ideally marked up as an [[hcard|hCard]] as well), for Atom 1.0 the <code><nowiki><entry></nowiki></code> <code><nowiki><author></nowiki></code> if present and if not the <code><nowiki><feed></nowiki></code> <code><nowiki><author></nowiki></code>, for RSS the <code><nowiki><author></nowiki></code> inside the containing <code><nowiki><item></nowiki></code> element.<br />
<br />
'''dtreviewed''':: This optional field when present MUST provide an ISO8601 absolute date time of when the review was written or otherwise authored. This field SHOULD use UTC, but MAY use the time zone offset syntax. If dtreviewed is absent from the hReview, then look outside the hReview, in the surrounding context. If the context is an [[hatom|hAtom]] entry, use its "published" (or "updated" if that is missing) datetime as the dtreviewed, if not present on the entry, use the "published" (or "updated" if that is missing) of the feed. Otherwise use the creation date (or modified date if that is missing) information according to the containing document language (e.g. "published"/"updated" similarly for Atom feeds), then protocol (e.g. HTTP Last-Modified, or file system last modified datetime) as the dtreviewed.<br />
<br />
'''rating''':: The rating is a fixed point integer (one decimal point of precision) from 1.0 to 5.0 inclusive indicating a rating for the item, higher indicating a better rating by default. Optionally a different integral "worst" value and/or "best" value MAY be specified to indicate a different range (e.g. 6 from 0-10). The "best" value may be numerically smaller than the "worst" value.<br />
<br />
'''description''':: This optional field contains the full text representing the written opinion of the reviewer. The field MAY include valid XHTML markup (e.g. paragraphs). User agents SHOULD preserve any markup. Multiple descriptions or section descriptions (e.g. pros and cons, plusses and minusses) SHOULD be included in the description field.<br />
<br />
'''tags''':: Tags are represented using a list of keywords or phrases (using the [[rel-tag]] microformat for each individual keyword or phrase tag) that the reviewer associates with the item. The reviewer MAY optionally provide a tag-specific rating inside each [[rel-tag]], e.g. ambience:5. Tag-specific ratings by default use the same range as an overall rating for the item if present, and MAY also have a custom worst...best range specified. Authors MAY also invert this structure for the same semantic if it is more convenient for their markup, that is, place the [[rel-tag]] inside a rating to indicate a rated tag. Note: rated tags should ideally use a tag space that explains what the ratings for that tag mean. E.g. Food:18/30 should link to a tags space for Food that explains what an 18 out of 30 means for the Food tag.<br />
<br />
'''permalink''':: This optional field is a URL for the hReview. In addition to using the <code><a href></code> tag for this field, the attribute <code>rel="self bookmark"</code> MUST be used to indicate that the hyperlink is a permalink for the review itself. If the hyperlink already contains a <code>rel</code> attribute, then the values <code>self</code> and <code>bookmark</code> MUST be included among the space-separated set of values in the attribute. Indexers MAY treat the permalink of a review as a unique ID in order to identify and collate the same review from multiple sources (such as indexing a page multiple times). The permalink MAY also be used to indicate or imply the origin of the review. Authors MAY use the classname of "permalink" on the element representing the permalink, but are not required to do so.<br />
<br />
'''license''':: This optional field links to the license under which the contents of the hReview itself is licensed, using the '''[[rel-license]]''' microformat.<br />
<br />
<br />
The following field names have been reused from the [[hcard|hCard]] and [[hcalendar|hCalendar]] microformats: <code>version, summary, fn, url, photo, description</code>. In addition, items and reviewers described by hCards MAY contain any hCard field. The rel value "self" has been reused from the [http://atompub.org/2005/07/11/draft-ietf-atompub-format-10.html Atom 1.0 specification].<br />
<br />
=== More Semantic Equivalents ===<br />
<br />
For some properties there is a more semantic equivalent, and therefore they get special treatment, e.g.: <br />
<br />
* For any "url", use <code><a class="url" href="...">...</a></code> inside the element with the class name 'hreview' in hReview.<br />
* And for "photo", use <code><img class="photo" src="..." alt="Photo of ..." /></code> <br />
<br />
* Ratings are often presented either as a set of images or characters, e.g. "***". For these, the <code>&lt;abbr&gt;</code> element is particularly useful, as such characters are an abbreviation for the precise rating, e.g. <code>&lt;abbr class="rating" title="3.0"&gt;***&lt;/abbr&gt;</code>. This is further explored in the next section.<br />
<br />
==== Language ====<br />
* To explicitly convey the natural language that an hReview is written in, use the standard (X)HTML 'lang' attribute on the element with class="hreview", e.g. <code>&lt;div class="hreview" lang="en"&gt; ... &lt;/div&gt;</code> If portions of an hReview (e.g. the item name) are in a different language, use the 'lang' attribute on those portions.<br />
* hReview processors which need to handle the language of reviews MUST process the standard (X)HTML 'lang' attribute as specified.<br />
<br />
=== Human vs. Machine Readable ===<br />
If an <code>&lt;abbr></code> element is used for a property, then its '<code>title</code>' attribute is used for the value of the property, instead of the contents of the element, which can then be used to provide a user-friendly alternate presentation of the value. <br />
<br />
Similarly, if an <code><img /></code> element is used for one or more properties, it MUST be treated as follows: <br />
<br />
# For the "photo" property and any other property that takes a URL as its value, the <code>src="..."</code> attribute provides the property value. <br />
# For other properties, the <code><img /></code> element's '<code>alt</code>' attribute is the value of the property.<br />
<br />
=== Object Includes ===<br />
<br />
hReview 0.3 includes support for the object [[include-pattern]].<br />
<br />
Often a single page lists an item, and then several reviews for that item. In order to avoid having to repeat the item info for each review of the item, the first review should be marked up as an hReview, with a unique "id" attribute on the item info, and then following reviews should use the object [[include-pattern]] to include the item info from the first review.<br />
<br />
<br />
=== Notes ===<br />
This section is informative.<br />
<br />
* By marking up a review with the hReview microformat, the expectation is communicated that the review MAY be indexed. This has no impact on the copyright of the review itself which the publisher may explicitly specify using [[rel-license]] as specified above.<br />
* The enumerated list of item types is under development and may be extended.<br />
* Each type may have custom hReview fields that follow the common set.<br />
* Additional details about a particular item should be specified with the rest of the item's info at the URL provided for the item.<br />
* Most rating systems use the range 1.0 to 5.0, and most of those represent the rating as a number (and possibly half) of stars. Sites may use whatever graphic they wish to represent the rating.<br />
<br />
== Examples ==<br />
Here are a few examples of reviews from current web sites, and how they could be easily enhanced to support the hReview structured review microformat. <br />
<br />
Want to get started with writing an [[hreview|hReview]]? Use the [http://microformats.org/code/hreview/creator hReview creator] to write a review and publish it on your blog.<br />
<br />
=== Restaurant reviews ===<br />
<br />
Here is an example of a simple online restaurant review:<br />
<br />
<pre><nowiki><br />
<div><br />
<span>5 stars out of 5 stars</span><br />
<h4>Crepes on Cole is awesome</h4><br />
<span>Reviewer: <span>Tantek</span> - April 18, 2005</span><br />
<blockquote><p><br />
Crepes on Cole is one of the best little creperies in San Francisco. <br />
Excellent food and service. Plenty of tables in a variety of sizes <br />
for parties large and small. Window seating makes for excellent <br />
people watching to/from the N-Judah which stops right outside. <br />
I've had many fun social gatherings here, as well as gotten <br />
plenty of work done thanks to neighborhood WiFi.<br />
</p></blockquote><br />
<p>Visit date: <span>April 2005</span></p><br />
<p>Food eaten: <span>Florentine crepe</span></p><br />
</div><br />
</nowiki></pre><br />
<br />
Adding hReview to this review is quite simple:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><br />
<span><span class="rating">5</span> out of 5 stars</span><br />
<h4 class="summary">Crepes on Cole is awesome</h4><br />
<span class="reviewer vcard">Reviewer: <span class="fn">Tantek</span> - <br />
<abbr class="dtreviewed" title="20050418T2300-0700">April 18, 2005</abbr></span><br />
<div class="description item vcard"><p><br />
<span class="fn org">Crepes on Cole</span> is one of the best little <br />
creperies in <span class="adr"><span class="locality">San Francisco</span></span>.<br />
Excellent food and service. Plenty of tables in a variety of sizes <br />
for parties large and small. Window seating makes for excellent <br />
people watching to/from the N-Judah which stops right outside. <br />
I've had many fun social gatherings here, as well as gotten <br />
plenty of work done thanks to neighborhood WiFi.<br />
</p></div><br />
<p>Visit date: <span>April 2005</span></p><br />
<p>Food eaten: <span>Florentine crepe</span></p><br />
</div><br />
</nowiki></pre><br />
<br />
Note that some of the properties of this sample review are not captured by hReview (visit date, food eaten). This is deliberate per the scope of keeping hReview minimal and simple.<br />
<br />
This sample hReview could be rendered like this:<br />
<br />
5 stars out of 5 stars<br /><br />
'''Crepes on Cole is awesome'''<br /><br />
Reviewer: Tantek - April 18, 2005<br /><br />
<br />
Crepes on Cole is one of the best little creperies in San Francisco. Excellent food and service. Plenty of tables in a variety of sizes for parties large and small. Window seating makes for excellent people watching to/from the N-Judah which stops right outside. I've had many fun social gatherings here, as well as gotten plenty of work done thanks to neighborhood wifi.<br />
<br />
Visit date: April 2005<br /><br />
Food eaten: Florentine crepe<br /><br />
<br />
==== Multidimensional Restaurant Review ====<br />
Some restaurant reviews indicate ratings for different aspects of the restaurant. Such details are represented in hReview using tagged ratings. In addition, note the inline tags inside the description of this review.<br />
<br />
Here is one such review in text format:<br />
<br />
Cafe Borrone<br />
<br />
1010 El Camino Real, Menlo Park, CA 94025, +1-650-327-0830;<br />
cafeborrone.com<br />
<br />
Food: 18/30; Ambience: 19/30; Service: 15/30; Price: $$...<br />
<br />
This cafe is a welcoming oasis on the Peninsula. It even has a fountain<br />
outside which cloaks the nearby sounds of El Camino traffic. Next door to a <br />
superb indy bookstore, Cafe Borrone is an ideal spot to grab a coffee or a <br />
snack to accompany a newly purchased book or imported periodical. Soups and <br />
sandwich specials rotate daily. The corn chowder with croutons and big <br />
chunks of cheese goes especially well with a freshly toasted mini-baguette. <br />
Evenings are often crowded and may require sharing a table with a perfect <br />
stranger. Espresso afficionados will appreciate the Illy coffee. Noise <br />
levels can vary from peaceful in the late mornings to nearly overwhelming on <br />
jazz band nights.<br />
<br />
As an hReview:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><br />
<div class="item vcard"><br />
<div class="fn org summary">Cafe Borrone</div><br />
<span class="adr"><br />
<span class="street-address">1010 El Camino Real</span>,<br />
<span class="locality">Menlo Park</span>,<br />
<span class="region">CA</span><br />
<span class="postal-code">94025</span>,<br />
</span><br />
<span class="tel">+1-650-327-0830</span>;<br />
<a class="url" href="http://cafeborrone.com">cafeborrone.com</a><br />
</div><br />
<ul><br />
<li class="rating"><a href="http://en.wikipedia.org/wiki/Food" rel="tag"><br />
Food: <span class="value">18</span>/<span class="best">30</span></a>;</li><br />
<li class="rating"><a href="http://flickr.com/photos/tags/Ambience" rel="tag"><br />
Ambience: <span class="value">19</span>/<span class="best">30</span></a>;</li><br />
<li class="rating"><a href="http://en.wikipedia.org/wiki/Service" rel="tag"><br />
Service: <span class="value">15</span>/<span class="best">30</span></a>;</li><br />
<li class="rating"><a href="http://en.wikipedia.org/wiki/Price" rel="tag"><br />
Price: <abbr class="value" title="2">$$</abbr>...</a></li><br />
</ul><br />
<div class="description"><p><br />
This <abbr class="type" title="business"><br />
<a href="http://en.wikipedia.org/wiki/cafe" rel="tag">cafe</a></abbr> <br />
is a welcoming oasis on the Peninsula. <br />
It even has a fountain outside which nearly eliminates <br />
the sounds of El Camino traffic. Next door to a superb indy bookstore, <br />
Cafe Borrone is an ideal spot to grab a <br />
<a href="http://en.wikipedia.org/wiki/coffee" rel="tag">coffee</a> <br />
or a meal to accompany a newly purchased book or imported periodical. <br />
<a href="http://technorati.com/tag/soup" rel="tag">Soups</a> and <br />
<a href="http://technorati.com/tag/sandwich" rel="tag">sandwich</a> <br />
specials rotate daily. The corn chowder with croutons and big chunks of cheese <br />
goes especially well with a freshly toasted mini-baguette. Evenings are <br />
often crowded and may require sharing a table with a perfect stranger. <br />
<a href="http://flickr.com/photos/tags/espresso" rel="tag">Espresso</a> <br />
afficionados will appreciate the <br />
<a href="http://en.wikipedia.org/wiki/Illy" rel="tag">Illy</a> coffee. <br />
Noise levels can vary from peaceful in the late mornings to nearly overwhelming on <br />
<a href="http://en.wikipedia.org/wiki/jazz" rel="tag">jazz</a> band nights.<br />
</p></div><br />
Review (<a href="http://microformats.org/wiki/hreview"> <br />
hReview v<span class="version">0.3</span></a>)<br />
by <span class="reviewer vcard"><span class="fn">anonymous</span></span>, <br />
<abbr class="dtreviewed" title="20050428T2130-0700">April 28th, 2005</abbr>.<br />
</div><br />
</nowiki></pre><br />
<br />
With an accompanying CSS style sheet like:<br />
<br />
<pre><nowiki><br />
a.url { display:block }<br />
ul { margin:1em 0; padding:0 }<br />
ul li { display:inline }<br />
</nowiki></pre><br />
<br />
This hReview could be presented similar to the original text:<br />
<br />
Cafe Borrone<br /><br />
1010 El Camino Real, Menlo Park, CA 94025, +1-650-327-0830;<br /><br />
[http://cafeborrone.com/ cafeborrone.com]<br /><br />
<br /><br />
[http://en.wikipedia.org/wiki/Food Food: 18/30];<br />
[http://flickr.com/photos/tags/Ambience Ambience: 19/30];<br />
[http://en.wikipedia.org/wiki/Service Service: 15/30];<br />
[http://en.wikipedia.org/wiki/Price Price: $$...]<br /><br />
<br />
This [http://en.wikipedia.org/wiki/cafe cafe] is a welcoming oasis on the Peninsula. It even has a fountain outside which cloaks the nearby sounds of El Camino traffic. Next door to a superb indy bookstore, Cafe Borrone is an ideal spot to grab a [http://en.wikipedia.org/wiki/coffee coffee] or a snack to accompany a newly purchased book or imported periodical. [http://technorati.com/tag/soup Soups] and [http://technorati.com/tag/sandwich sandwich] specials rotate daily. The corn chowder with croutons and big chunks of cheese goes especially well with a freshly toasted mini-baguette. Evenings are often crowded and may require sharing a table with a perfect stranger. [http://flickr.com/photos/tags/espresso Espresso] afficionados will appreciate the [http://en.wikipedia.org/wiki/Illy Illy] coffee. Noise levels can vary from peaceful in the late mornings to nearly overwhelming on [http://en.wikipedia.org/wiki/jazz jazz] band nights.<br />
<br />
Review ([http://microformats.org/wiki/hreview hReview v0.3]) by anonymous, April 28th, 2005.<br />
<br />
=== Product review ===<br />
Here is an example of a product review:<br />
<br />
<pre><nowiki><br />
<div><br />
<a href="http://www.amazon.com/exec/obidos/ASIN/B000089CJI/"><br />
<img src="http://images.amazon.com/images/P/B000089CJI.01._SCTHUMBZZZ_.jpg" <br />
alt="Album cover photo: The Postal Service: Give Up." /><br />
The Postal Service: Give Up</a><br />
<blockquote><p><br />
"The people thought they were just being rewarded for treating others <br />
as they like to be treated, for obeying stop signs and curing diseases, <br />
for mailing letters with the address of the sender... Don't wake me, <br />
I plan on sleeping in..."<br />
</p><p><br />
"Nothing Better" is a great track on this album, too... <br />
</p></blockquote><br />
(*****)<br />
</div><br />
</nowiki></pre><br />
<br />
Adding hReview to this review is also quite simple, but in this case requires a few more elements for the rating and reviewer which are required by hReview:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><span class="item"><br />
<a class="url fn" href="http://www.amazon.com/exec/obidos/ASIN/B000089CJI/"><br />
<img src="http://images.amazon.com/images/P/B000089CJI.01._SCTHUMBZZZ_.jpg" <br />
alt="Album cover photo: The Postal Service: Give Up. " <br />
class="photo" /><br />
The Postal Service: Give Up</a></span><br />
<div class="description"><p><br />
"The people thought they were just being rewarded for treating others <br />
as they like to be treated, for obeying stop signs and curing diseases, <br />
for mailing letters with the address of the sender... Don't wake me, <br />
I plan on sleeping in..."<br />
</p><p><br />
"Nothing Better" is a great track on this album, too... <br />
</p></div><br />
(<abbr class="rating" title="5">*****</abbr>)<br />
<p class="reviewer vcard">Review by <br />
<a class="url fn" href="http://ifindkarma.com/blog/">Adam Rifkin</a>, <br />
<abbr class="dtreviewed" title="200502">February 2005</abbr><br />
</p><br />
</div><br />
</nowiki></pre><br />
<br />
And this hReview might be presented like this:<br />
<br />
<br />
[Album cover photo: ]<br />
[The Postal Service:]<br />
[ Give Up ]<br />
<br />
The Postal Service: Give Up<br />
<br />
"The people thought they were just being rewarded for treating others as they like to be treated, for obeying stop signs and curing diseases, for mailing letters with the address of the sender... Don't wake me, I plan on sleeping in..."<br />
<br />
"Nothing Better" is a great track on this album, too...<br />
<br />
(*****)<br />
<br />
Review by Adam Rifkin, February 2005.<br />
<br />
=== Movie Review ===<br />
Finally, here is an example of a movie review.<br />
<br />
<pre><nowiki><br />
<div><br />
<span>anonymous, April 18th, 2005</span><br />
<div><br />
<a lang="zh" href="http://www.imdb.com/title/tt0299977/"><br />
Ying Xiong (<span lang="en">HERO</span>)<br />
</a><br />
</div><br />
<div>Rating: 4 out of 5</div><br />
<blockquote><p><br />
This movie has great visuals and music.<br />
</p></blockquote><br />
</div><br />
</nowiki></pre><br />
<br />
With hReview:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><br />
<span class="reviewer vcard"><br />
<span class="fn">anonymous</span>, <br />
<abbr class="dtreviewed" title="20050418">April 18th, 2005</abbr><br />
</span><br />
<div class="item"><br />
<a lang="zh" class="url fn" href="http://www.imdb.com/title/tt0299977/"><br />
Ying Xiong (<span lang="en">HERO</span>)<br />
</a><br />
</div><br />
<div>Rating: <span class="rating">4</span> out of 5</div><br />
<div class="description"><p><br />
This movie has great music and visuals.<br />
</p></div><br />
</div><br />
</nowiki></pre><br />
<br />
Which could be presented like this:<br />
<br />
anonymous, April 18th, 2005<br /><br />
Ying Xiong (HERO)<br /><br />
Rating: 4 out of 5<br /><br />
<br />
This movie has great music and visuals.<br />
<br />
== Examples in the wild ==<br />
This section is '''informative'''. The number of hReview examples in the wild has expanded far beyond the capacity of being kept inline in this specification. They have been moved to a [[hreview-examples-in-wild|separate page]].<br />
<br />
See [[hreview-examples-in-wild|hReview Examples in the wild]].<br />
<br />
== Implementations ==<br />
This section is '''informative'''. The number of hReview implementations has also expanded beyond the capacity of keeping them inline. They have been moved to a [[hreview-implementations|separate page]].<br />
<br />
See [[hreview-implementations|hReview Implementations]].<br />
<br />
== References ==<br />
=== Normative References ===<br />
* [http://www.w3.org/TR/2002/REC-xhtml1-20020801/ XHTML 1.0 SE]<br />
* [http://gmpg.org/xmdp/ XMDP]<br />
* [[hcard|hCard]]<br />
* [[hcalendar|hCalendar]]<br />
* [[rel-tag]]<br />
* [http://www.ietf.org/rfc/rfc2119.txt RFC2119]<br />
* [http://www.ietf.org/rfc/rfc3986.txt RFC3986]<br />
* [http://www.ietf.org/rfc/rfc4287.txt RFC4287] (Atom 1.0)<br />
<br />
=== Informative References ===<br />
* [http://www.w3.org/TR/REC-CSS1 CSS1]<br />
* ISO.8601.1988<br />
** International Organization for Standardization, "Data elements and interchange formats - Information interchange - Representation of dates and times", ISO Standard 8601, June 1988.<br />
* [http://www.w3.org/TR/1998/NOTE-datetime-19980827 W3C NOTE-datetime-19980827]<br />
* [http://www.ietf.org/rfc/rfc3667.txt RFC3667]<br />
* [http://www.ietf.org/rfc/rfc3668.txt RFC3668]<br />
* [http://www.w3.org/Consortium/Patent-Policy-20040205/ W3C Patent Policy]<br />
* [http://local.yahoo.com/details?id=21359628 Crepes on Cole reviews on Yahoo! Local]<br />
* Other reviews efforts. See [[reviews-formats]].<br />
* Contributed from http://developers.technorati.com/wiki/hReview.<br />
<br />
==== Similar Work ====<br />
* [[hlisting-proposal|hListing]]<br />
* [[xoxo|XOXO]]<br />
<br />
=== Copyright ===<br />
{{MicroformatCopyrightStatement2005}}<br />
<br />
=== Patents ===<br />
{{MicroFormatPatentStatement}}<br />
<br />
== Work in progress ==<br />
This specification is a work in progress. As additional aspects are discussed, understood, and written, they will be added. <br />
<br />
=== Changes from v0.2 ===<br />
The following changes have been made in hReview v0.3 over [[hreview-v0.2|hReview v0.2]]:<br />
<br />
Normative changes:<br />
# MUST (instead of SHOULD) use [[hcard|hCard]] for the item description of a business or person<br />
# "reviewer" changes<br />
## Made reviewer *optional* per feedback from Ryan King and Mark Nottingham<br />
## If reviewer is absent from the hReview, then look outside the hReview, in the context of the page, for the reviewer. If there is no "reviewer" outside either, then use the author information according to the containing document language (e.g. <code><nowiki><address></nowiki></code> for (X)HTML pages) as the reviewer.<br />
## MUST (instead of SHOULD) use [[hcard|hCard]] to represent reviewer information<br />
# "dtreviewed" changes<br />
## Made dtreviewed *optional* per feedback from Ryan King and Mark Nottingham<br />
## If dtreviewed is absent from the hReview, then look outside the hReview, in the surrounding context. If the context is an [[hatom|hAtom]] entry, use its "published" (or "updated" if that is missing) datetime as the dtreviewed, if not present on the entry, use the "published" (or "updated" if that is missing) of the feed. Otherwise use the information according to the containing document language (e.g. "published"/"updated" similarly for Atom feeds), then protocol (e.g. HTTP Last-Modified, or file system last modified datetime).<br />
# SHOULD use [[hcalendar|hCalendar]] to represent an item of 'type' 'event'<br />
# Added one decimal digit of precision to ratings' numerical values based on publisher experience.<br />
# Use [http://microformats.org/wiki/hcard#Value_excerpting the "value" construct from hCard] (as it is used in "tel" properties for example) to more explicitly markup the rating value when also providing (marking up) the best/worst of a rating.<br />
# Added [[rel-license]] to indicate the license of the hReview as a whole.<br />
# Permit tags inside ratings to denote rated tags, the same as ratings inside tags per suggestion from Eran Globen.<br />
# Add [[include-pattern]] support to allow multiple reviews for the same item to not repeat the item info.<br />
<br />
Informative changes (several, but in particular):<br />
# Note that scalar/rated tags would ideally use a tag space that explain the ratings for that tag. E.g. to explain what Food:18/30 means.<br />
# Updated examples accordingly.<br />
<br />
== Further Reading ==<br />
* See also [http://www.technorati.com/cosmos/referer.html blogs discussing this page].<br />
== Related Pages People==<br />
* Sildenafil citrate, sold under the [http://www.efficacylevitra.info names Levitra]<br />
* A ring tone is the sound made by a telephone to indicate an [http://freeringtonemp.info incoming call]<br />
* Viagra pills are blue and [http://orderviagrales.info diamond-shaped] with the words.<br />
* Both Viagra and the Levitra are derived from [http://levitravsviagra.info Proto-Indo-Iranian]<br />
* The mode of action of [http://ordertramadoline.info tramadol] has yet to be fully understood.<br />
* Phentermine is a drug primarily used as an [http://pharmacyphentermine.info appetite suppressant]<br />
* The proper definition of [http://replicawatchbmw.info replica]<br />
* Alprazolam was [http://valiumxanax.info originally marketed] as an atypical benzodiazepine, but only classified for use treating anxiety neurosis.<br />
* [http://efficacylevitra.info/linki.htm 2006/2007]<br />
<br />
== Related Pages ==<br />
{{hreview-related-pages}}</div>Adminihttps://microformats.org/wiki/index.php?title=hreview&diff=13983hreview2007-03-05T14:18:35Z<p>Admini: /* Further Reading */</p>
<hr />
<div><h1> hReview 0.3 </h1><br />
<br />
[[hreview|hReview]] is a simple, open, distributed format, suitable for embedding reviews (of products, services, businesses, events, etc.) in (X)HTML, Atom, RSS, and arbitrary XML. hReview is one of several [[microformats]] open standards.<br />
<br />
Want to get started with writing an [[hreview|hReview]]? Use the [http://microformats.org/code/hreview/creator hReview creator] to write a review and publish it.<br />
<br />
== Microformats Draft Specification 2006-02-22 ==<br />
<br />
; Editor: [http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc.]<br />
; Authors: [http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc.]<br />
: [http://360.yahoo.com/alidiabali Ali Diab],[http://yahoo.com Yahoo! Inc.]<br />
: [http://spaces.msn.com/members/ianmcallister/ Ian McAllister], [http://microsoft.com/ Microsoft Corporation]<br />
: [http://journals.aol.com/panzerjohn/abstractioneer John Panzer], [http://www.aol.com America Online, Inc.]<br />
: [http://ifindkarma.com/blog Adam Rifkin], [http://labs.commerce.net/ CommerceNet Labs]<br />
: [http://sippey.typepad.com/ Michael Sippey], [http://sixapart.com Six Apart, Ltd]<br />
<br />
Microformats [http://microformats.org/wiki/hreview#Copyright copyright] and [http://microformats.org/wiki/hreview#Patents patents] statements apply.<br />
<br />
__TOC__<br />
<br />
== Introduction ==<br />
Numerous web sites publish reviews using a broad variety of schema for all sorts of things from products (movies, music, books), to businesses (restaurants, hotels, stores), to events (concerts, theatre), to people (artists, leaders, celebrities), to places (landmarks, parks), to online resources (web pages, files), to reviews of reviews themselves.<br />
<br />
In order to enable and encourage the sharing, distribution, syndication, and aggregation, of reviews, the authors propose the hReview microformat, an open standard for distributed reviews. The authors have researched both numerous [[review-examples]] in the wild and earlier attempts at [[review-formats]], and have designed hReview around a simple minimal schema for reviews. Feedback is encouraged on the [[hreview-feedback|hReview feedback]] page.<br />
<br />
=== Inspiration and Acknowledgments ===<br />
Thanks to everyone who responded to the open call for implementor participation for hReview. The authors in particular wish to thank the following individuals for their constructive input and feedback: [http://www.richardault.com/ Richard Ault], [http://dannyayers.com Danny Ayers], [http://www.vertexdev.com/~jeff/ Jeffrey Barr],[http://adriancuthbert.blogspot.com/ Adrian Cuthbert],[http://jason.defillippo.com/ Jason DeFillippo], [http://www.hybernaut.com/bdv Brian Del Vecchio], Scott Derringer, [http://budgibson.com/home/ Bud Gibson], [http://joi.ito.com/ Joi Ito], [http://www.kanai.net/weblog/ Gen Kanai],[http://niallkennedy.com/ Niall Kennedy], [http://labs.commerce.net/wiki/index.php/Rohit_Khare Rohit Khare], [http://theryanking.com/ Ryan King], [http://www.jluster.org/ Jonas Luster], [http://epeus.blogspot.com/ Kevin Marks], Mark Nottingham, [http://www.powazek.com/ Derek Powazek], [http://www.judysbook.com/ Jeff Rodenburg], [http://sifry.com/alerts/ David Sifry], [http://jystewart.net/ James Stewart], [http://kung-foo.tv/ Adriaan Tijsseling], [http://www.flashenabled.com/ Phillip Torrone], Thai Tran, [http://w6daily.winn.com/ Phillip Winn], [http://yohei-y.blogspot.com YAMAMOTO Yohei].<br />
<br />
=== Scope ===<br />
Reviews consistently share several common fields. Where possible hReview has been based on this minimal common subset.<br />
<br />
==== Out of scope ====<br />
Fields that are type-specific have been omitted from hReview. It is important that hReview be kept simple and minimal from the start. Additional features can be added as deemed necessary by practical implementation experience.<br />
<br />
The concept of a "universal object identifier", that is, how to identify the same object/item/product across different shopping sites, though something very useful to have, is outside the scope of this format.<br />
<br />
== Semantic XHTML Design Principles ==<br />
{{semantic-xhtml-design-principles}}<br />
<br />
== Format ==<br />
=== In General ===<br />
The hReview format is based on a set of fields common to numerous review sites and formats in use today on the web. Where possible field names have been chosen based on those defined by the related [[hcard|hCard]] and [[hcalendar|hCalendar]] standards.<br />
<br />
=== Schema ===<br />
The hReview schema consists of the following:<br />
<br />
* hReview ('''<code>hreview</code>''')<br />
** '''<code>version</code>'''. optional. text.<br />
** '''<code>summary</code>'''. optional. text.<br />
** item '''<code>type</code>'''. optional. product | business | event | person | place | website | url.<br />
** '''<code>item</code>''' info. required. '''<code>fn</code>''' ('''<code>url</code>''' || '''<code>photo</code>''' ) | '''[[hcard|hCard]]''' (for person or business) | '''[[hcalendar|hCalendar]]''' (for event)<br />
** '''<code>reviewer</code>'''. optional. '''[[hcard|hCard]]'''.<br />
** '''<code>dtreviewed</code>'''. optional. ISO8601 absolute date time.<br />
** '''<code>rating</code>'''. optional. fixed point integer [1.0-5.0], with optional alternate '''<code>worst</code>''' (default:1.0) and/or '''<code>best</code>''' (default:5.0), also fixed point integers, and explicit '''<code>value</code>'''.<br />
** '''<code>description</code>'''. optional. text with optional valid XHTML markup.<br />
** tags. optional. keywords or phrases, using '''[[rel-tag]]''', each with optional rating.<br />
** permalink. optional, using '''[[rel-bookmark]]''' and '''[[rel-self]]'''.<br />
** license. optional, using '''[[rel-license]]'''.<br />
<br />
=== Field details ===<br />
The fields of the hReview schema represent the following:<br />
<br />
'''version''':: This optional field permits hReview publishers to specify a particular version of hReview that their content uses. By omitting this field, the publisher is stating that implementations may interpret the hReviews according to any version of the hReview specification v0.2 or later. In practice the authors of this specification are comitted to maintaining backward compatibility with content produced using earlier versions of the specification. This field is syntax compatible with, and thus reuses the semantics of "VERSION" as defined in vCard RFC2426 section "3.6.9 VERSION Type Definition". The value of this field for this specification is "0.3".<br />
<br />
'''summary''':: This optional field serves as a title for the review itself.<br />
<br />
'''item type''':: This optional field "type" provides the type of the item being reviewed, one of the following: product, business, event, person, place, website, url. If omitted, then in some cases the item type may be inferred. If the item is also an [[hcard|hCard]], then the item type is a "business" or a "person" based upon which of those the hCard represents. If the item is also an [[hcalendar|hCalendar]] event, then the item type is an "event".<br />
<br />
'''item info''':: This required field MUST have at a minimum the name ("fn" - the formatted text corresponding to the name) of ''the'' item (an hReview describes only one item), SHOULD provide at least one URI ("url") for the item, and MAY provide at least one URL to a photo or depiction ("photo") of the item. For items of type person or business, the item info (fn, url, photo) MUST be encapsulated in an [[hcard|hCard]]. For items of type event, the item info SHOULD be encapsulated in an [[hcalendar|hCalendar]] "vevent". Unique item IDs (e.g. ISBNs, UPCs) MAY be represented as a URN ("url") for the item. Encapsulated microformats (e.g. [[hcard|hCard]] and [[hcalendar|hCalendar]] events for now) may be set on the item itself (e.g. class="item vcard"). However, when using item info subproperties ("fn", "url", "photo"), they MUST be nested <em>inside</em> the item element.<br />
<br />
'''reviewer''':: The optional field specifies the person who authored the review. If the reviewer is specified, an hCard representing the reviewer MUST be provided. For anonymous reviews, use "anonymous" (without quotes) for the full name of the reviewer. If no "reviewer" is found inside the hReview, parsers should look outside the hReview, in the context of the page, for the "reviewer". If there is no "reviewer" outside either, then parsers should use the author defined by the containing document language, e.g. for (X)HTML documents, the <code><nowiki><address></nowiki></code> contact info for the page (which is ideally marked up as an [[hcard|hCard]] as well), for Atom 1.0 the <code><nowiki><entry></nowiki></code> <code><nowiki><author></nowiki></code> if present and if not the <code><nowiki><feed></nowiki></code> <code><nowiki><author></nowiki></code>, for RSS the <code><nowiki><author></nowiki></code> inside the containing <code><nowiki><item></nowiki></code> element.<br />
<br />
'''dtreviewed''':: This optional field when present MUST provide an ISO8601 absolute date time of when the review was written or otherwise authored. This field SHOULD use UTC, but MAY use the time zone offset syntax. If dtreviewed is absent from the hReview, then look outside the hReview, in the surrounding context. If the context is an [[hatom|hAtom]] entry, use its "published" (or "updated" if that is missing) datetime as the dtreviewed, if not present on the entry, use the "published" (or "updated" if that is missing) of the feed. Otherwise use the creation date (or modified date if that is missing) information according to the containing document language (e.g. "published"/"updated" similarly for Atom feeds), then protocol (e.g. HTTP Last-Modified, or file system last modified datetime) as the dtreviewed.<br />
<br />
'''rating''':: The rating is a fixed point integer (one decimal point of precision) from 1.0 to 5.0 inclusive indicating a rating for the item, higher indicating a better rating by default. Optionally a different integral "worst" value and/or "best" value MAY be specified to indicate a different range (e.g. 6 from 0-10). The "best" value may be numerically smaller than the "worst" value.<br />
<br />
'''description''':: This optional field contains the full text representing the written opinion of the reviewer. The field MAY include valid XHTML markup (e.g. paragraphs). User agents SHOULD preserve any markup. Multiple descriptions or section descriptions (e.g. pros and cons, plusses and minusses) SHOULD be included in the description field.<br />
<br />
'''tags''':: Tags are represented using a list of keywords or phrases (using the [[rel-tag]] microformat for each individual keyword or phrase tag) that the reviewer associates with the item. The reviewer MAY optionally provide a tag-specific rating inside each [[rel-tag]], e.g. ambience:5. Tag-specific ratings by default use the same range as an overall rating for the item if present, and MAY also have a custom worst...best range specified. Authors MAY also invert this structure for the same semantic if it is more convenient for their markup, that is, place the [[rel-tag]] inside a rating to indicate a rated tag. Note: rated tags should ideally use a tag space that explains what the ratings for that tag mean. E.g. Food:18/30 should link to a tags space for Food that explains what an 18 out of 30 means for the Food tag.<br />
<br />
'''permalink''':: This optional field is a URL for the hReview. In addition to using the <code><a href></code> tag for this field, the attribute <code>rel="self bookmark"</code> MUST be used to indicate that the hyperlink is a permalink for the review itself. If the hyperlink already contains a <code>rel</code> attribute, then the values <code>self</code> and <code>bookmark</code> MUST be included among the space-separated set of values in the attribute. Indexers MAY treat the permalink of a review as a unique ID in order to identify and collate the same review from multiple sources (such as indexing a page multiple times). The permalink MAY also be used to indicate or imply the origin of the review. Authors MAY use the classname of "permalink" on the element representing the permalink, but are not required to do so.<br />
<br />
'''license''':: This optional field links to the license under which the contents of the hReview itself is licensed, using the '''[[rel-license]]''' microformat.<br />
<br />
<br />
The following field names have been reused from the [[hcard|hCard]] and [[hcalendar|hCalendar]] microformats: <code>version, summary, fn, url, photo, description</code>. In addition, items and reviewers described by hCards MAY contain any hCard field. The rel value "self" has been reused from the [http://atompub.org/2005/07/11/draft-ietf-atompub-format-10.html Atom 1.0 specification].<br />
<br />
=== More Semantic Equivalents ===<br />
<br />
For some properties there is a more semantic equivalent, and therefore they get special treatment, e.g.: <br />
<br />
* For any "url", use <code><a class="url" href="...">...</a></code> inside the element with the class name 'hreview' in hReview.<br />
* And for "photo", use <code><img class="photo" src="..." alt="Photo of ..." /></code> <br />
<br />
* Ratings are often presented either as a set of images or characters, e.g. "***". For these, the <code>&lt;abbr&gt;</code> element is particularly useful, as such characters are an abbreviation for the precise rating, e.g. <code>&lt;abbr class="rating" title="3.0"&gt;***&lt;/abbr&gt;</code>. This is further explored in the next section.<br />
<br />
==== Language ====<br />
* To explicitly convey the natural language that an hReview is written in, use the standard (X)HTML 'lang' attribute on the element with class="hreview", e.g. <code>&lt;div class="hreview" lang="en"&gt; ... &lt;/div&gt;</code> If portions of an hReview (e.g. the item name) are in a different language, use the 'lang' attribute on those portions.<br />
* hReview processors which need to handle the language of reviews MUST process the standard (X)HTML 'lang' attribute as specified.<br />
<br />
=== Human vs. Machine Readable ===<br />
If an <code>&lt;abbr></code> element is used for a property, then its '<code>title</code>' attribute is used for the value of the property, instead of the contents of the element, which can then be used to provide a user-friendly alternate presentation of the value. <br />
<br />
Similarly, if an <code><img /></code> element is used for one or more properties, it MUST be treated as follows: <br />
<br />
# For the "photo" property and any other property that takes a URL as its value, the <code>src="..."</code> attribute provides the property value. <br />
# For other properties, the <code><img /></code> element's '<code>alt</code>' attribute is the value of the property.<br />
<br />
=== Object Includes ===<br />
<br />
hReview 0.3 includes support for the object [[include-pattern]].<br />
<br />
Often a single page lists an item, and then several reviews for that item. In order to avoid having to repeat the item info for each review of the item, the first review should be marked up as an hReview, with a unique "id" attribute on the item info, and then following reviews should use the object [[include-pattern]] to include the item info from the first review.<br />
<br />
<br />
=== Notes ===<br />
This section is informative.<br />
<br />
* By marking up a review with the hReview microformat, the expectation is communicated that the review MAY be indexed. This has no impact on the copyright of the review itself which the publisher may explicitly specify using [[rel-license]] as specified above.<br />
* The enumerated list of item types is under development and may be extended.<br />
* Each type may have custom hReview fields that follow the common set.<br />
* Additional details about a particular item should be specified with the rest of the item's info at the URL provided for the item.<br />
* Most rating systems use the range 1.0 to 5.0, and most of those represent the rating as a number (and possibly half) of stars. Sites may use whatever graphic they wish to represent the rating.<br />
<br />
== Examples ==<br />
Here are a few examples of reviews from current web sites, and how they could be easily enhanced to support the hReview structured review microformat. <br />
<br />
Want to get started with writing an [[hreview|hReview]]? Use the [http://microformats.org/code/hreview/creator hReview creator] to write a review and publish it on your blog.<br />
<br />
=== Restaurant reviews ===<br />
<br />
Here is an example of a simple online restaurant review:<br />
<br />
<pre><nowiki><br />
<div><br />
<span>5 stars out of 5 stars</span><br />
<h4>Crepes on Cole is awesome</h4><br />
<span>Reviewer: <span>Tantek</span> - April 18, 2005</span><br />
<blockquote><p><br />
Crepes on Cole is one of the best little creperies in San Francisco. <br />
Excellent food and service. Plenty of tables in a variety of sizes <br />
for parties large and small. Window seating makes for excellent <br />
people watching to/from the N-Judah which stops right outside. <br />
I've had many fun social gatherings here, as well as gotten <br />
plenty of work done thanks to neighborhood WiFi.<br />
</p></blockquote><br />
<p>Visit date: <span>April 2005</span></p><br />
<p>Food eaten: <span>Florentine crepe</span></p><br />
</div><br />
</nowiki></pre><br />
<br />
Adding hReview to this review is quite simple:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><br />
<span><span class="rating">5</span> out of 5 stars</span><br />
<h4 class="summary">Crepes on Cole is awesome</h4><br />
<span class="reviewer vcard">Reviewer: <span class="fn">Tantek</span> - <br />
<abbr class="dtreviewed" title="20050418T2300-0700">April 18, 2005</abbr></span><br />
<div class="description item vcard"><p><br />
<span class="fn org">Crepes on Cole</span> is one of the best little <br />
creperies in <span class="adr"><span class="locality">San Francisco</span></span>.<br />
Excellent food and service. Plenty of tables in a variety of sizes <br />
for parties large and small. Window seating makes for excellent <br />
people watching to/from the N-Judah which stops right outside. <br />
I've had many fun social gatherings here, as well as gotten <br />
plenty of work done thanks to neighborhood WiFi.<br />
</p></div><br />
<p>Visit date: <span>April 2005</span></p><br />
<p>Food eaten: <span>Florentine crepe</span></p><br />
</div><br />
</nowiki></pre><br />
<br />
Note that some of the properties of this sample review are not captured by hReview (visit date, food eaten). This is deliberate per the scope of keeping hReview minimal and simple.<br />
<br />
This sample hReview could be rendered like this:<br />
<br />
5 stars out of 5 stars<br /><br />
'''Crepes on Cole is awesome'''<br /><br />
Reviewer: Tantek - April 18, 2005<br /><br />
<br />
Crepes on Cole is one of the best little creperies in San Francisco. Excellent food and service. Plenty of tables in a variety of sizes for parties large and small. Window seating makes for excellent people watching to/from the N-Judah which stops right outside. I've had many fun social gatherings here, as well as gotten plenty of work done thanks to neighborhood wifi.<br />
<br />
Visit date: April 2005<br /><br />
Food eaten: Florentine crepe<br /><br />
<br />
==== Multidimensional Restaurant Review ====<br />
Some restaurant reviews indicate ratings for different aspects of the restaurant. Such details are represented in hReview using tagged ratings. In addition, note the inline tags inside the description of this review.<br />
<br />
Here is one such review in text format:<br />
<br />
Cafe Borrone<br />
<br />
1010 El Camino Real, Menlo Park, CA 94025, +1-650-327-0830;<br />
cafeborrone.com<br />
<br />
Food: 18/30; Ambience: 19/30; Service: 15/30; Price: $$...<br />
<br />
This cafe is a welcoming oasis on the Peninsula. It even has a fountain<br />
outside which cloaks the nearby sounds of El Camino traffic. Next door to a <br />
superb indy bookstore, Cafe Borrone is an ideal spot to grab a coffee or a <br />
snack to accompany a newly purchased book or imported periodical. Soups and <br />
sandwich specials rotate daily. The corn chowder with croutons and big <br />
chunks of cheese goes especially well with a freshly toasted mini-baguette. <br />
Evenings are often crowded and may require sharing a table with a perfect <br />
stranger. Espresso afficionados will appreciate the Illy coffee. Noise <br />
levels can vary from peaceful in the late mornings to nearly overwhelming on <br />
jazz band nights.<br />
<br />
As an hReview:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><br />
<div class="item vcard"><br />
<div class="fn org summary">Cafe Borrone</div><br />
<span class="adr"><br />
<span class="street-address">1010 El Camino Real</span>,<br />
<span class="locality">Menlo Park</span>,<br />
<span class="region">CA</span><br />
<span class="postal-code">94025</span>,<br />
</span><br />
<span class="tel">+1-650-327-0830</span>;<br />
<a class="url" href="http://cafeborrone.com">cafeborrone.com</a><br />
</div><br />
<ul><br />
<li class="rating"><a href="http://en.wikipedia.org/wiki/Food" rel="tag"><br />
Food: <span class="value">18</span>/<span class="best">30</span></a>;</li><br />
<li class="rating"><a href="http://flickr.com/photos/tags/Ambience" rel="tag"><br />
Ambience: <span class="value">19</span>/<span class="best">30</span></a>;</li><br />
<li class="rating"><a href="http://en.wikipedia.org/wiki/Service" rel="tag"><br />
Service: <span class="value">15</span>/<span class="best">30</span></a>;</li><br />
<li class="rating"><a href="http://en.wikipedia.org/wiki/Price" rel="tag"><br />
Price: <abbr class="value" title="2">$$</abbr>...</a></li><br />
</ul><br />
<div class="description"><p><br />
This <abbr class="type" title="business"><br />
<a href="http://en.wikipedia.org/wiki/cafe" rel="tag">cafe</a></abbr> <br />
is a welcoming oasis on the Peninsula. <br />
It even has a fountain outside which nearly eliminates <br />
the sounds of El Camino traffic. Next door to a superb indy bookstore, <br />
Cafe Borrone is an ideal spot to grab a <br />
<a href="http://en.wikipedia.org/wiki/coffee" rel="tag">coffee</a> <br />
or a meal to accompany a newly purchased book or imported periodical. <br />
<a href="http://technorati.com/tag/soup" rel="tag">Soups</a> and <br />
<a href="http://technorati.com/tag/sandwich" rel="tag">sandwich</a> <br />
specials rotate daily. The corn chowder with croutons and big chunks of cheese <br />
goes especially well with a freshly toasted mini-baguette. Evenings are <br />
often crowded and may require sharing a table with a perfect stranger. <br />
<a href="http://flickr.com/photos/tags/espresso" rel="tag">Espresso</a> <br />
afficionados will appreciate the <br />
<a href="http://en.wikipedia.org/wiki/Illy" rel="tag">Illy</a> coffee. <br />
Noise levels can vary from peaceful in the late mornings to nearly overwhelming on <br />
<a href="http://en.wikipedia.org/wiki/jazz" rel="tag">jazz</a> band nights.<br />
</p></div><br />
Review (<a href="http://microformats.org/wiki/hreview"> <br />
hReview v<span class="version">0.3</span></a>)<br />
by <span class="reviewer vcard"><span class="fn">anonymous</span></span>, <br />
<abbr class="dtreviewed" title="20050428T2130-0700">April 28th, 2005</abbr>.<br />
</div><br />
</nowiki></pre><br />
<br />
With an accompanying CSS style sheet like:<br />
<br />
<pre><nowiki><br />
a.url { display:block }<br />
ul { margin:1em 0; padding:0 }<br />
ul li { display:inline }<br />
</nowiki></pre><br />
<br />
This hReview could be presented similar to the original text:<br />
<br />
Cafe Borrone<br /><br />
1010 El Camino Real, Menlo Park, CA 94025, +1-650-327-0830;<br /><br />
[http://cafeborrone.com/ cafeborrone.com]<br /><br />
<br /><br />
[http://en.wikipedia.org/wiki/Food Food: 18/30];<br />
[http://flickr.com/photos/tags/Ambience Ambience: 19/30];<br />
[http://en.wikipedia.org/wiki/Service Service: 15/30];<br />
[http://en.wikipedia.org/wiki/Price Price: $$...]<br /><br />
<br />
This [http://en.wikipedia.org/wiki/cafe cafe] is a welcoming oasis on the Peninsula. It even has a fountain outside which cloaks the nearby sounds of El Camino traffic. Next door to a superb indy bookstore, Cafe Borrone is an ideal spot to grab a [http://en.wikipedia.org/wiki/coffee coffee] or a snack to accompany a newly purchased book or imported periodical. [http://technorati.com/tag/soup Soups] and [http://technorati.com/tag/sandwich sandwich] specials rotate daily. The corn chowder with croutons and big chunks of cheese goes especially well with a freshly toasted mini-baguette. Evenings are often crowded and may require sharing a table with a perfect stranger. [http://flickr.com/photos/tags/espresso Espresso] afficionados will appreciate the [http://en.wikipedia.org/wiki/Illy Illy] coffee. Noise levels can vary from peaceful in the late mornings to nearly overwhelming on [http://en.wikipedia.org/wiki/jazz jazz] band nights.<br />
<br />
Review ([http://microformats.org/wiki/hreview hReview v0.3]) by anonymous, April 28th, 2005.<br />
<br />
=== Product review ===<br />
Here is an example of a product review:<br />
<br />
<pre><nowiki><br />
<div><br />
<a href="http://www.amazon.com/exec/obidos/ASIN/B000089CJI/"><br />
<img src="http://images.amazon.com/images/P/B000089CJI.01._SCTHUMBZZZ_.jpg" <br />
alt="Album cover photo: The Postal Service: Give Up." /><br />
The Postal Service: Give Up</a><br />
<blockquote><p><br />
"The people thought they were just being rewarded for treating others <br />
as they like to be treated, for obeying stop signs and curing diseases, <br />
for mailing letters with the address of the sender... Don't wake me, <br />
I plan on sleeping in..."<br />
</p><p><br />
"Nothing Better" is a great track on this album, too... <br />
</p></blockquote><br />
(*****)<br />
</div><br />
</nowiki></pre><br />
<br />
Adding hReview to this review is also quite simple, but in this case requires a few more elements for the rating and reviewer which are required by hReview:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><span class="item"><br />
<a class="url fn" href="http://www.amazon.com/exec/obidos/ASIN/B000089CJI/"><br />
<img src="http://images.amazon.com/images/P/B000089CJI.01._SCTHUMBZZZ_.jpg" <br />
alt="Album cover photo: The Postal Service: Give Up. " <br />
class="photo" /><br />
The Postal Service: Give Up</a></span><br />
<div class="description"><p><br />
"The people thought they were just being rewarded for treating others <br />
as they like to be treated, for obeying stop signs and curing diseases, <br />
for mailing letters with the address of the sender... Don't wake me, <br />
I plan on sleeping in..."<br />
</p><p><br />
"Nothing Better" is a great track on this album, too... <br />
</p></div><br />
(<abbr class="rating" title="5">*****</abbr>)<br />
<p class="reviewer vcard">Review by <br />
<a class="url fn" href="http://ifindkarma.com/blog/">Adam Rifkin</a>, <br />
<abbr class="dtreviewed" title="200502">February 2005</abbr><br />
</p><br />
</div><br />
</nowiki></pre><br />
<br />
And this hReview might be presented like this:<br />
<br />
<br />
[Album cover photo: ]<br />
[The Postal Service:]<br />
[ Give Up ]<br />
<br />
The Postal Service: Give Up<br />
<br />
"The people thought they were just being rewarded for treating others as they like to be treated, for obeying stop signs and curing diseases, for mailing letters with the address of the sender... Don't wake me, I plan on sleeping in..."<br />
<br />
"Nothing Better" is a great track on this album, too...<br />
<br />
(*****)<br />
<br />
Review by Adam Rifkin, February 2005.<br />
<br />
=== Movie Review ===<br />
Finally, here is an example of a movie review.<br />
<br />
<pre><nowiki><br />
<div><br />
<span>anonymous, April 18th, 2005</span><br />
<div><br />
<a lang="zh" href="http://www.imdb.com/title/tt0299977/"><br />
Ying Xiong (<span lang="en">HERO</span>)<br />
</a><br />
</div><br />
<div>Rating: 4 out of 5</div><br />
<blockquote><p><br />
This movie has great visuals and music.<br />
</p></blockquote><br />
</div><br />
</nowiki></pre><br />
<br />
With hReview:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><br />
<span class="reviewer vcard"><br />
<span class="fn">anonymous</span>, <br />
<abbr class="dtreviewed" title="20050418">April 18th, 2005</abbr><br />
</span><br />
<div class="item"><br />
<a lang="zh" class="url fn" href="http://www.imdb.com/title/tt0299977/"><br />
Ying Xiong (<span lang="en">HERO</span>)<br />
</a><br />
</div><br />
<div>Rating: <span class="rating">4</span> out of 5</div><br />
<div class="description"><p><br />
This movie has great music and visuals.<br />
</p></div><br />
</div><br />
</nowiki></pre><br />
<br />
Which could be presented like this:<br />
<br />
anonymous, April 18th, 2005<br /><br />
Ying Xiong (HERO)<br /><br />
Rating: 4 out of 5<br /><br />
<br />
This movie has great music and visuals.<br />
<br />
== Examples in the wild ==<br />
This section is '''informative'''. The number of hReview examples in the wild has expanded far beyond the capacity of being kept inline in this specification. They have been moved to a [[hreview-examples-in-wild|separate page]].<br />
<br />
See [[hreview-examples-in-wild|hReview Examples in the wild]].<br />
<br />
== Implementations ==<br />
This section is '''informative'''. The number of hReview implementations has also expanded beyond the capacity of keeping them inline. They have been moved to a [[hreview-implementations|separate page]].<br />
<br />
See [[hreview-implementations|hReview Implementations]].<br />
<br />
== References ==<br />
=== Normative References ===<br />
* [http://www.w3.org/TR/2002/REC-xhtml1-20020801/ XHTML 1.0 SE]<br />
* [http://gmpg.org/xmdp/ XMDP]<br />
* [[hcard|hCard]]<br />
* [[hcalendar|hCalendar]]<br />
* [[rel-tag]]<br />
* [http://www.ietf.org/rfc/rfc2119.txt RFC2119]<br />
* [http://www.ietf.org/rfc/rfc3986.txt RFC3986]<br />
* [http://www.ietf.org/rfc/rfc4287.txt RFC4287] (Atom 1.0)<br />
<br />
=== Informative References ===<br />
* [http://www.w3.org/TR/REC-CSS1 CSS1]<br />
* ISO.8601.1988<br />
** International Organization for Standardization, "Data elements and interchange formats - Information interchange - Representation of dates and times", ISO Standard 8601, June 1988.<br />
* [http://www.w3.org/TR/1998/NOTE-datetime-19980827 W3C NOTE-datetime-19980827]<br />
* [http://www.ietf.org/rfc/rfc3667.txt RFC3667]<br />
* [http://www.ietf.org/rfc/rfc3668.txt RFC3668]<br />
* [http://www.w3.org/Consortium/Patent-Policy-20040205/ W3C Patent Policy]<br />
* [http://local.yahoo.com/details?id=21359628 Crepes on Cole reviews on Yahoo! Local]<br />
* Other reviews efforts. See [[reviews-formats]].<br />
* Contributed from http://developers.technorati.com/wiki/hReview.<br />
<br />
==== Similar Work ====<br />
* [[hlisting-proposal|hListing]]<br />
* [[xoxo|XOXO]]<br />
<br />
=== Copyright ===<br />
{{MicroformatCopyrightStatement2005}}<br />
<br />
=== Patents ===<br />
{{MicroFormatPatentStatement}}<br />
<br />
== Work in progress ==<br />
This specification is a work in progress. As additional aspects are discussed, understood, and written, they will be added. <br />
<br />
=== Changes from v0.2 ===<br />
The following changes have been made in hReview v0.3 over [[hreview-v0.2|hReview v0.2]]:<br />
<br />
Normative changes:<br />
# MUST (instead of SHOULD) use [[hcard|hCard]] for the item description of a business or person<br />
# "reviewer" changes<br />
## Made reviewer *optional* per feedback from Ryan King and Mark Nottingham<br />
## If reviewer is absent from the hReview, then look outside the hReview, in the context of the page, for the reviewer. If there is no "reviewer" outside either, then use the author information according to the containing document language (e.g. <code><nowiki><address></nowiki></code> for (X)HTML pages) as the reviewer.<br />
## MUST (instead of SHOULD) use [[hcard|hCard]] to represent reviewer information<br />
# "dtreviewed" changes<br />
## Made dtreviewed *optional* per feedback from Ryan King and Mark Nottingham<br />
## If dtreviewed is absent from the hReview, then look outside the hReview, in the surrounding context. If the context is an [[hatom|hAtom]] entry, use its "published" (or "updated" if that is missing) datetime as the dtreviewed, if not present on the entry, use the "published" (or "updated" if that is missing) of the feed. Otherwise use the information according to the containing document language (e.g. "published"/"updated" similarly for Atom feeds), then protocol (e.g. HTTP Last-Modified, or file system last modified datetime).<br />
# SHOULD use [[hcalendar|hCalendar]] to represent an item of 'type' 'event'<br />
# Added one decimal digit of precision to ratings' numerical values based on publisher experience.<br />
# Use [http://microformats.org/wiki/hcard#Value_excerpting the "value" construct from hCard] (as it is used in "tel" properties for example) to more explicitly markup the rating value when also providing (marking up) the best/worst of a rating.<br />
# Added [[rel-license]] to indicate the license of the hReview as a whole.<br />
# Permit tags inside ratings to denote rated tags, the same as ratings inside tags per suggestion from Eran Globen.<br />
# Add [[include-pattern]] support to allow multiple reviews for the same item to not repeat the item info.<br />
<br />
Informative changes (several, but in particular):<br />
# Note that scalar/rated tags would ideally use a tag space that explain the ratings for that tag. E.g. to explain what Food:18/30 means.<br />
# Updated examples accordingly.<br />
<br />
== Further Reading ==<br />
* See also [http://www.technorati.com/cosmos/referer.html blogs discussing this page].<br />
== Related Pages People==<br />
* Sildenafil citrate, sold under the [http://www.efficacylevitra.info names Levitra]<br />
* A ring tone is the sound made by a telephone to indicate an [http://freeringtonemp.info incoming call]<br />
* Viagra pills are blue and [http://orderviagrales.info diamond-shaped] with the words.<br />
* Both Viagra and the Levitra are derived from [http://levitravsviagra.info Proto-Indo-Iranian]<br />
* The mode of action of [http://ordertramadoline.info tramadol] has yet to be fully understood.<br />
* Phentermine is a drug primarily used as an [http://pharmacyphentermine.info appetite suppressant]<br />
* The proper definition of [http://replicawatchbmw.info replica]<br />
* Alprazolam was [http://valiumxanax.info originally marketed] as an atypical benzodiazepine, but only classified for use treating anxiety neurosis.<br />
* [http://efficacylevitra.info/linki.htm 2006/2007]<br />
<br />
== Related Pages ==<br />
{{hreview-related-pages}}</div>Adminihttps://microformats.org/wiki/index.php?title=hreview&diff=13980hreview2007-03-05T11:44:14Z<p>Admini: /* Further Reading */</p>
<hr />
<div><h1> hReview 0.3 </h1><br />
<br />
[[hreview|hReview]] is a simple, open, distributed format, suitable for embedding reviews (of products, services, businesses, events, etc.) in (X)HTML, Atom, RSS, and arbitrary XML. hReview is one of several [[microformats]] open standards.<br />
<br />
Want to get started with writing an [[hreview|hReview]]? Use the [http://microformats.org/code/hreview/creator hReview creator] to write a review and publish it.<br />
<br />
== Microformats Draft Specification 2006-02-22 ==<br />
<br />
; Editor: [http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc.]<br />
; Authors: [http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc.]<br />
: [http://360.yahoo.com/alidiabali Ali Diab],[http://yahoo.com Yahoo! Inc.]<br />
: [http://spaces.msn.com/members/ianmcallister/ Ian McAllister], [http://microsoft.com/ Microsoft Corporation]<br />
: [http://journals.aol.com/panzerjohn/abstractioneer John Panzer], [http://www.aol.com America Online, Inc.]<br />
: [http://ifindkarma.com/blog Adam Rifkin], [http://labs.commerce.net/ CommerceNet Labs]<br />
: [http://sippey.typepad.com/ Michael Sippey], [http://sixapart.com Six Apart, Ltd]<br />
<br />
Microformats [http://microformats.org/wiki/hreview#Copyright copyright] and [http://microformats.org/wiki/hreview#Patents patents] statements apply.<br />
<br />
__TOC__<br />
<br />
== Introduction ==<br />
Numerous web sites publish reviews using a broad variety of schema for all sorts of things from products (movies, music, books), to businesses (restaurants, hotels, stores), to events (concerts, theatre), to people (artists, leaders, celebrities), to places (landmarks, parks), to online resources (web pages, files), to reviews of reviews themselves.<br />
<br />
In order to enable and encourage the sharing, distribution, syndication, and aggregation, of reviews, the authors propose the hReview microformat, an open standard for distributed reviews. The authors have researched both numerous [[review-examples]] in the wild and earlier attempts at [[review-formats]], and have designed hReview around a simple minimal schema for reviews. Feedback is encouraged on the [[hreview-feedback|hReview feedback]] page.<br />
<br />
=== Inspiration and Acknowledgments ===<br />
Thanks to everyone who responded to the open call for implementor participation for hReview. The authors in particular wish to thank the following individuals for their constructive input and feedback: [http://www.richardault.com/ Richard Ault], [http://dannyayers.com Danny Ayers], [http://www.vertexdev.com/~jeff/ Jeffrey Barr],[http://adriancuthbert.blogspot.com/ Adrian Cuthbert],[http://jason.defillippo.com/ Jason DeFillippo], [http://www.hybernaut.com/bdv Brian Del Vecchio], Scott Derringer, [http://budgibson.com/home/ Bud Gibson], [http://joi.ito.com/ Joi Ito], [http://www.kanai.net/weblog/ Gen Kanai],[http://niallkennedy.com/ Niall Kennedy], [http://labs.commerce.net/wiki/index.php/Rohit_Khare Rohit Khare], [http://theryanking.com/ Ryan King], [http://www.jluster.org/ Jonas Luster], [http://epeus.blogspot.com/ Kevin Marks], Mark Nottingham, [http://www.powazek.com/ Derek Powazek], [http://www.judysbook.com/ Jeff Rodenburg], [http://sifry.com/alerts/ David Sifry], [http://jystewart.net/ James Stewart], [http://kung-foo.tv/ Adriaan Tijsseling], [http://www.flashenabled.com/ Phillip Torrone], Thai Tran, [http://w6daily.winn.com/ Phillip Winn], [http://yohei-y.blogspot.com YAMAMOTO Yohei].<br />
<br />
=== Scope ===<br />
Reviews consistently share several common fields. Where possible hReview has been based on this minimal common subset.<br />
<br />
==== Out of scope ====<br />
Fields that are type-specific have been omitted from hReview. It is important that hReview be kept simple and minimal from the start. Additional features can be added as deemed necessary by practical implementation experience.<br />
<br />
The concept of a "universal object identifier", that is, how to identify the same object/item/product across different shopping sites, though something very useful to have, is outside the scope of this format.<br />
<br />
== Semantic XHTML Design Principles ==<br />
{{semantic-xhtml-design-principles}}<br />
<br />
== Format ==<br />
=== In General ===<br />
The hReview format is based on a set of fields common to numerous review sites and formats in use today on the web. Where possible field names have been chosen based on those defined by the related [[hcard|hCard]] and [[hcalendar|hCalendar]] standards.<br />
<br />
=== Schema ===<br />
The hReview schema consists of the following:<br />
<br />
* hReview ('''<code>hreview</code>''')<br />
** '''<code>version</code>'''. optional. text.<br />
** '''<code>summary</code>'''. optional. text.<br />
** item '''<code>type</code>'''. optional. product | business | event | person | place | website | url.<br />
** '''<code>item</code>''' info. required. '''<code>fn</code>''' ('''<code>url</code>''' || '''<code>photo</code>''' ) | '''[[hcard|hCard]]''' (for person or business) | '''[[hcalendar|hCalendar]]''' (for event)<br />
** '''<code>reviewer</code>'''. optional. '''[[hcard|hCard]]'''.<br />
** '''<code>dtreviewed</code>'''. optional. ISO8601 absolute date time.<br />
** '''<code>rating</code>'''. optional. fixed point integer [1.0-5.0], with optional alternate '''<code>worst</code>''' (default:1.0) and/or '''<code>best</code>''' (default:5.0), also fixed point integers, and explicit '''<code>value</code>'''.<br />
** '''<code>description</code>'''. optional. text with optional valid XHTML markup.<br />
** tags. optional. keywords or phrases, using '''[[rel-tag]]''', each with optional rating.<br />
** permalink. optional, using '''[[rel-bookmark]]''' and '''[[rel-self]]'''.<br />
** license. optional, using '''[[rel-license]]'''.<br />
<br />
=== Field details ===<br />
The fields of the hReview schema represent the following:<br />
<br />
'''version''':: This optional field permits hReview publishers to specify a particular version of hReview that their content uses. By omitting this field, the publisher is stating that implementations may interpret the hReviews according to any version of the hReview specification v0.2 or later. In practice the authors of this specification are comitted to maintaining backward compatibility with content produced using earlier versions of the specification. This field is syntax compatible with, and thus reuses the semantics of "VERSION" as defined in vCard RFC2426 section "3.6.9 VERSION Type Definition". The value of this field for this specification is "0.3".<br />
<br />
'''summary''':: This optional field serves as a title for the review itself.<br />
<br />
'''item type''':: This optional field "type" provides the type of the item being reviewed, one of the following: product, business, event, person, place, website, url. If omitted, then in some cases the item type may be inferred. If the item is also an [[hcard|hCard]], then the item type is a "business" or a "person" based upon which of those the hCard represents. If the item is also an [[hcalendar|hCalendar]] event, then the item type is an "event".<br />
<br />
'''item info''':: This required field MUST have at a minimum the name ("fn" - the formatted text corresponding to the name) of ''the'' item (an hReview describes only one item), SHOULD provide at least one URI ("url") for the item, and MAY provide at least one URL to a photo or depiction ("photo") of the item. For items of type person or business, the item info (fn, url, photo) MUST be encapsulated in an [[hcard|hCard]]. For items of type event, the item info SHOULD be encapsulated in an [[hcalendar|hCalendar]] "vevent". Unique item IDs (e.g. ISBNs, UPCs) MAY be represented as a URN ("url") for the item. Encapsulated microformats (e.g. [[hcard|hCard]] and [[hcalendar|hCalendar]] events for now) may be set on the item itself (e.g. class="item vcard"). However, when using item info subproperties ("fn", "url", "photo"), they MUST be nested <em>inside</em> the item element.<br />
<br />
'''reviewer''':: The optional field specifies the person who authored the review. If the reviewer is specified, an hCard representing the reviewer MUST be provided. For anonymous reviews, use "anonymous" (without quotes) for the full name of the reviewer. If no "reviewer" is found inside the hReview, parsers should look outside the hReview, in the context of the page, for the "reviewer". If there is no "reviewer" outside either, then parsers should use the author defined by the containing document language, e.g. for (X)HTML documents, the <code><nowiki><address></nowiki></code> contact info for the page (which is ideally marked up as an [[hcard|hCard]] as well), for Atom 1.0 the <code><nowiki><entry></nowiki></code> <code><nowiki><author></nowiki></code> if present and if not the <code><nowiki><feed></nowiki></code> <code><nowiki><author></nowiki></code>, for RSS the <code><nowiki><author></nowiki></code> inside the containing <code><nowiki><item></nowiki></code> element.<br />
<br />
'''dtreviewed''':: This optional field when present MUST provide an ISO8601 absolute date time of when the review was written or otherwise authored. This field SHOULD use UTC, but MAY use the time zone offset syntax. If dtreviewed is absent from the hReview, then look outside the hReview, in the surrounding context. If the context is an [[hatom|hAtom]] entry, use its "published" (or "updated" if that is missing) datetime as the dtreviewed, if not present on the entry, use the "published" (or "updated" if that is missing) of the feed. Otherwise use the creation date (or modified date if that is missing) information according to the containing document language (e.g. "published"/"updated" similarly for Atom feeds), then protocol (e.g. HTTP Last-Modified, or file system last modified datetime) as the dtreviewed.<br />
<br />
'''rating''':: The rating is a fixed point integer (one decimal point of precision) from 1.0 to 5.0 inclusive indicating a rating for the item, higher indicating a better rating by default. Optionally a different integral "worst" value and/or "best" value MAY be specified to indicate a different range (e.g. 6 from 0-10). The "best" value may be numerically smaller than the "worst" value.<br />
<br />
'''description''':: This optional field contains the full text representing the written opinion of the reviewer. The field MAY include valid XHTML markup (e.g. paragraphs). User agents SHOULD preserve any markup. Multiple descriptions or section descriptions (e.g. pros and cons, plusses and minusses) SHOULD be included in the description field.<br />
<br />
'''tags''':: Tags are represented using a list of keywords or phrases (using the [[rel-tag]] microformat for each individual keyword or phrase tag) that the reviewer associates with the item. The reviewer MAY optionally provide a tag-specific rating inside each [[rel-tag]], e.g. ambience:5. Tag-specific ratings by default use the same range as an overall rating for the item if present, and MAY also have a custom worst...best range specified. Authors MAY also invert this structure for the same semantic if it is more convenient for their markup, that is, place the [[rel-tag]] inside a rating to indicate a rated tag. Note: rated tags should ideally use a tag space that explains what the ratings for that tag mean. E.g. Food:18/30 should link to a tags space for Food that explains what an 18 out of 30 means for the Food tag.<br />
<br />
'''permalink''':: This optional field is a URL for the hReview. In addition to using the <code><a href></code> tag for this field, the attribute <code>rel="self bookmark"</code> MUST be used to indicate that the hyperlink is a permalink for the review itself. If the hyperlink already contains a <code>rel</code> attribute, then the values <code>self</code> and <code>bookmark</code> MUST be included among the space-separated set of values in the attribute. Indexers MAY treat the permalink of a review as a unique ID in order to identify and collate the same review from multiple sources (such as indexing a page multiple times). The permalink MAY also be used to indicate or imply the origin of the review. Authors MAY use the classname of "permalink" on the element representing the permalink, but are not required to do so.<br />
<br />
'''license''':: This optional field links to the license under which the contents of the hReview itself is licensed, using the '''[[rel-license]]''' microformat.<br />
<br />
<br />
The following field names have been reused from the [[hcard|hCard]] and [[hcalendar|hCalendar]] microformats: <code>version, summary, fn, url, photo, description</code>. In addition, items and reviewers described by hCards MAY contain any hCard field. The rel value "self" has been reused from the [http://atompub.org/2005/07/11/draft-ietf-atompub-format-10.html Atom 1.0 specification].<br />
<br />
=== More Semantic Equivalents ===<br />
<br />
For some properties there is a more semantic equivalent, and therefore they get special treatment, e.g.: <br />
<br />
* For any "url", use <code><a class="url" href="...">...</a></code> inside the element with the class name 'hreview' in hReview.<br />
* And for "photo", use <code><img class="photo" src="..." alt="Photo of ..." /></code> <br />
<br />
* Ratings are often presented either as a set of images or characters, e.g. "***". For these, the <code>&lt;abbr&gt;</code> element is particularly useful, as such characters are an abbreviation for the precise rating, e.g. <code>&lt;abbr class="rating" title="3.0"&gt;***&lt;/abbr&gt;</code>. This is further explored in the next section.<br />
<br />
==== Language ====<br />
* To explicitly convey the natural language that an hReview is written in, use the standard (X)HTML 'lang' attribute on the element with class="hreview", e.g. <code>&lt;div class="hreview" lang="en"&gt; ... &lt;/div&gt;</code> If portions of an hReview (e.g. the item name) are in a different language, use the 'lang' attribute on those portions.<br />
* hReview processors which need to handle the language of reviews MUST process the standard (X)HTML 'lang' attribute as specified.<br />
<br />
=== Human vs. Machine Readable ===<br />
If an <code>&lt;abbr></code> element is used for a property, then its '<code>title</code>' attribute is used for the value of the property, instead of the contents of the element, which can then be used to provide a user-friendly alternate presentation of the value. <br />
<br />
Similarly, if an <code><img /></code> element is used for one or more properties, it MUST be treated as follows: <br />
<br />
# For the "photo" property and any other property that takes a URL as its value, the <code>src="..."</code> attribute provides the property value. <br />
# For other properties, the <code><img /></code> element's '<code>alt</code>' attribute is the value of the property.<br />
<br />
=== Object Includes ===<br />
<br />
hReview 0.3 includes support for the object [[include-pattern]].<br />
<br />
Often a single page lists an item, and then several reviews for that item. In order to avoid having to repeat the item info for each review of the item, the first review should be marked up as an hReview, with a unique "id" attribute on the item info, and then following reviews should use the object [[include-pattern]] to include the item info from the first review.<br />
<br />
<br />
=== Notes ===<br />
This section is informative.<br />
<br />
* By marking up a review with the hReview microformat, the expectation is communicated that the review MAY be indexed. This has no impact on the copyright of the review itself which the publisher may explicitly specify using [[rel-license]] as specified above.<br />
* The enumerated list of item types is under development and may be extended.<br />
* Each type may have custom hReview fields that follow the common set.<br />
* Additional details about a particular item should be specified with the rest of the item's info at the URL provided for the item.<br />
* Most rating systems use the range 1.0 to 5.0, and most of those represent the rating as a number (and possibly half) of stars. Sites may use whatever graphic they wish to represent the rating.<br />
<br />
== Examples ==<br />
Here are a few examples of reviews from current web sites, and how they could be easily enhanced to support the hReview structured review microformat. <br />
<br />
Want to get started with writing an [[hreview|hReview]]? Use the [http://microformats.org/code/hreview/creator hReview creator] to write a review and publish it on your blog.<br />
<br />
=== Restaurant reviews ===<br />
<br />
Here is an example of a simple online restaurant review:<br />
<br />
<pre><nowiki><br />
<div><br />
<span>5 stars out of 5 stars</span><br />
<h4>Crepes on Cole is awesome</h4><br />
<span>Reviewer: <span>Tantek</span> - April 18, 2005</span><br />
<blockquote><p><br />
Crepes on Cole is one of the best little creperies in San Francisco. <br />
Excellent food and service. Plenty of tables in a variety of sizes <br />
for parties large and small. Window seating makes for excellent <br />
people watching to/from the N-Judah which stops right outside. <br />
I've had many fun social gatherings here, as well as gotten <br />
plenty of work done thanks to neighborhood WiFi.<br />
</p></blockquote><br />
<p>Visit date: <span>April 2005</span></p><br />
<p>Food eaten: <span>Florentine crepe</span></p><br />
</div><br />
</nowiki></pre><br />
<br />
Adding hReview to this review is quite simple:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><br />
<span><span class="rating">5</span> out of 5 stars</span><br />
<h4 class="summary">Crepes on Cole is awesome</h4><br />
<span class="reviewer vcard">Reviewer: <span class="fn">Tantek</span> - <br />
<abbr class="dtreviewed" title="20050418T2300-0700">April 18, 2005</abbr></span><br />
<div class="description item vcard"><p><br />
<span class="fn org">Crepes on Cole</span> is one of the best little <br />
creperies in <span class="adr"><span class="locality">San Francisco</span></span>.<br />
Excellent food and service. Plenty of tables in a variety of sizes <br />
for parties large and small. Window seating makes for excellent <br />
people watching to/from the N-Judah which stops right outside. <br />
I've had many fun social gatherings here, as well as gotten <br />
plenty of work done thanks to neighborhood WiFi.<br />
</p></div><br />
<p>Visit date: <span>April 2005</span></p><br />
<p>Food eaten: <span>Florentine crepe</span></p><br />
</div><br />
</nowiki></pre><br />
<br />
Note that some of the properties of this sample review are not captured by hReview (visit date, food eaten). This is deliberate per the scope of keeping hReview minimal and simple.<br />
<br />
This sample hReview could be rendered like this:<br />
<br />
5 stars out of 5 stars<br /><br />
'''Crepes on Cole is awesome'''<br /><br />
Reviewer: Tantek - April 18, 2005<br /><br />
<br />
Crepes on Cole is one of the best little creperies in San Francisco. Excellent food and service. Plenty of tables in a variety of sizes for parties large and small. Window seating makes for excellent people watching to/from the N-Judah which stops right outside. I've had many fun social gatherings here, as well as gotten plenty of work done thanks to neighborhood wifi.<br />
<br />
Visit date: April 2005<br /><br />
Food eaten: Florentine crepe<br /><br />
<br />
==== Multidimensional Restaurant Review ====<br />
Some restaurant reviews indicate ratings for different aspects of the restaurant. Such details are represented in hReview using tagged ratings. In addition, note the inline tags inside the description of this review.<br />
<br />
Here is one such review in text format:<br />
<br />
Cafe Borrone<br />
<br />
1010 El Camino Real, Menlo Park, CA 94025, +1-650-327-0830;<br />
cafeborrone.com<br />
<br />
Food: 18/30; Ambience: 19/30; Service: 15/30; Price: $$...<br />
<br />
This cafe is a welcoming oasis on the Peninsula. It even has a fountain<br />
outside which cloaks the nearby sounds of El Camino traffic. Next door to a <br />
superb indy bookstore, Cafe Borrone is an ideal spot to grab a coffee or a <br />
snack to accompany a newly purchased book or imported periodical. Soups and <br />
sandwich specials rotate daily. The corn chowder with croutons and big <br />
chunks of cheese goes especially well with a freshly toasted mini-baguette. <br />
Evenings are often crowded and may require sharing a table with a perfect <br />
stranger. Espresso afficionados will appreciate the Illy coffee. Noise <br />
levels can vary from peaceful in the late mornings to nearly overwhelming on <br />
jazz band nights.<br />
<br />
As an hReview:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><br />
<div class="item vcard"><br />
<div class="fn org summary">Cafe Borrone</div><br />
<span class="adr"><br />
<span class="street-address">1010 El Camino Real</span>,<br />
<span class="locality">Menlo Park</span>,<br />
<span class="region">CA</span><br />
<span class="postal-code">94025</span>,<br />
</span><br />
<span class="tel">+1-650-327-0830</span>;<br />
<a class="url" href="http://cafeborrone.com">cafeborrone.com</a><br />
</div><br />
<ul><br />
<li class="rating"><a href="http://en.wikipedia.org/wiki/Food" rel="tag"><br />
Food: <span class="value">18</span>/<span class="best">30</span></a>;</li><br />
<li class="rating"><a href="http://flickr.com/photos/tags/Ambience" rel="tag"><br />
Ambience: <span class="value">19</span>/<span class="best">30</span></a>;</li><br />
<li class="rating"><a href="http://en.wikipedia.org/wiki/Service" rel="tag"><br />
Service: <span class="value">15</span>/<span class="best">30</span></a>;</li><br />
<li class="rating"><a href="http://en.wikipedia.org/wiki/Price" rel="tag"><br />
Price: <abbr class="value" title="2">$$</abbr>...</a></li><br />
</ul><br />
<div class="description"><p><br />
This <abbr class="type" title="business"><br />
<a href="http://en.wikipedia.org/wiki/cafe" rel="tag">cafe</a></abbr> <br />
is a welcoming oasis on the Peninsula. <br />
It even has a fountain outside which nearly eliminates <br />
the sounds of El Camino traffic. Next door to a superb indy bookstore, <br />
Cafe Borrone is an ideal spot to grab a <br />
<a href="http://en.wikipedia.org/wiki/coffee" rel="tag">coffee</a> <br />
or a meal to accompany a newly purchased book or imported periodical. <br />
<a href="http://technorati.com/tag/soup" rel="tag">Soups</a> and <br />
<a href="http://technorati.com/tag/sandwich" rel="tag">sandwich</a> <br />
specials rotate daily. The corn chowder with croutons and big chunks of cheese <br />
goes especially well with a freshly toasted mini-baguette. Evenings are <br />
often crowded and may require sharing a table with a perfect stranger. <br />
<a href="http://flickr.com/photos/tags/espresso" rel="tag">Espresso</a> <br />
afficionados will appreciate the <br />
<a href="http://en.wikipedia.org/wiki/Illy" rel="tag">Illy</a> coffee. <br />
Noise levels can vary from peaceful in the late mornings to nearly overwhelming on <br />
<a href="http://en.wikipedia.org/wiki/jazz" rel="tag">jazz</a> band nights.<br />
</p></div><br />
Review (<a href="http://microformats.org/wiki/hreview"> <br />
hReview v<span class="version">0.3</span></a>)<br />
by <span class="reviewer vcard"><span class="fn">anonymous</span></span>, <br />
<abbr class="dtreviewed" title="20050428T2130-0700">April 28th, 2005</abbr>.<br />
</div><br />
</nowiki></pre><br />
<br />
With an accompanying CSS style sheet like:<br />
<br />
<pre><nowiki><br />
a.url { display:block }<br />
ul { margin:1em 0; padding:0 }<br />
ul li { display:inline }<br />
</nowiki></pre><br />
<br />
This hReview could be presented similar to the original text:<br />
<br />
Cafe Borrone<br /><br />
1010 El Camino Real, Menlo Park, CA 94025, +1-650-327-0830;<br /><br />
[http://cafeborrone.com/ cafeborrone.com]<br /><br />
<br /><br />
[http://en.wikipedia.org/wiki/Food Food: 18/30];<br />
[http://flickr.com/photos/tags/Ambience Ambience: 19/30];<br />
[http://en.wikipedia.org/wiki/Service Service: 15/30];<br />
[http://en.wikipedia.org/wiki/Price Price: $$...]<br /><br />
<br />
This [http://en.wikipedia.org/wiki/cafe cafe] is a welcoming oasis on the Peninsula. It even has a fountain outside which cloaks the nearby sounds of El Camino traffic. Next door to a superb indy bookstore, Cafe Borrone is an ideal spot to grab a [http://en.wikipedia.org/wiki/coffee coffee] or a snack to accompany a newly purchased book or imported periodical. [http://technorati.com/tag/soup Soups] and [http://technorati.com/tag/sandwich sandwich] specials rotate daily. The corn chowder with croutons and big chunks of cheese goes especially well with a freshly toasted mini-baguette. Evenings are often crowded and may require sharing a table with a perfect stranger. [http://flickr.com/photos/tags/espresso Espresso] afficionados will appreciate the [http://en.wikipedia.org/wiki/Illy Illy] coffee. Noise levels can vary from peaceful in the late mornings to nearly overwhelming on [http://en.wikipedia.org/wiki/jazz jazz] band nights.<br />
<br />
Review ([http://microformats.org/wiki/hreview hReview v0.3]) by anonymous, April 28th, 2005.<br />
<br />
=== Product review ===<br />
Here is an example of a product review:<br />
<br />
<pre><nowiki><br />
<div><br />
<a href="http://www.amazon.com/exec/obidos/ASIN/B000089CJI/"><br />
<img src="http://images.amazon.com/images/P/B000089CJI.01._SCTHUMBZZZ_.jpg" <br />
alt="Album cover photo: The Postal Service: Give Up." /><br />
The Postal Service: Give Up</a><br />
<blockquote><p><br />
"The people thought they were just being rewarded for treating others <br />
as they like to be treated, for obeying stop signs and curing diseases, <br />
for mailing letters with the address of the sender... Don't wake me, <br />
I plan on sleeping in..."<br />
</p><p><br />
"Nothing Better" is a great track on this album, too... <br />
</p></blockquote><br />
(*****)<br />
</div><br />
</nowiki></pre><br />
<br />
Adding hReview to this review is also quite simple, but in this case requires a few more elements for the rating and reviewer which are required by hReview:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><span class="item"><br />
<a class="url fn" href="http://www.amazon.com/exec/obidos/ASIN/B000089CJI/"><br />
<img src="http://images.amazon.com/images/P/B000089CJI.01._SCTHUMBZZZ_.jpg" <br />
alt="Album cover photo: The Postal Service: Give Up. " <br />
class="photo" /><br />
The Postal Service: Give Up</a></span><br />
<div class="description"><p><br />
"The people thought they were just being rewarded for treating others <br />
as they like to be treated, for obeying stop signs and curing diseases, <br />
for mailing letters with the address of the sender... Don't wake me, <br />
I plan on sleeping in..."<br />
</p><p><br />
"Nothing Better" is a great track on this album, too... <br />
</p></div><br />
(<abbr class="rating" title="5">*****</abbr>)<br />
<p class="reviewer vcard">Review by <br />
<a class="url fn" href="http://ifindkarma.com/blog/">Adam Rifkin</a>, <br />
<abbr class="dtreviewed" title="200502">February 2005</abbr><br />
</p><br />
</div><br />
</nowiki></pre><br />
<br />
And this hReview might be presented like this:<br />
<br />
<br />
[Album cover photo: ]<br />
[The Postal Service:]<br />
[ Give Up ]<br />
<br />
The Postal Service: Give Up<br />
<br />
"The people thought they were just being rewarded for treating others as they like to be treated, for obeying stop signs and curing diseases, for mailing letters with the address of the sender... Don't wake me, I plan on sleeping in..."<br />
<br />
"Nothing Better" is a great track on this album, too...<br />
<br />
(*****)<br />
<br />
Review by Adam Rifkin, February 2005.<br />
<br />
=== Movie Review ===<br />
Finally, here is an example of a movie review.<br />
<br />
<pre><nowiki><br />
<div><br />
<span>anonymous, April 18th, 2005</span><br />
<div><br />
<a lang="zh" href="http://www.imdb.com/title/tt0299977/"><br />
Ying Xiong (<span lang="en">HERO</span>)<br />
</a><br />
</div><br />
<div>Rating: 4 out of 5</div><br />
<blockquote><p><br />
This movie has great visuals and music.<br />
</p></blockquote><br />
</div><br />
</nowiki></pre><br />
<br />
With hReview:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><br />
<span class="reviewer vcard"><br />
<span class="fn">anonymous</span>, <br />
<abbr class="dtreviewed" title="20050418">April 18th, 2005</abbr><br />
</span><br />
<div class="item"><br />
<a lang="zh" class="url fn" href="http://www.imdb.com/title/tt0299977/"><br />
Ying Xiong (<span lang="en">HERO</span>)<br />
</a><br />
</div><br />
<div>Rating: <span class="rating">4</span> out of 5</div><br />
<div class="description"><p><br />
This movie has great music and visuals.<br />
</p></div><br />
</div><br />
</nowiki></pre><br />
<br />
Which could be presented like this:<br />
<br />
anonymous, April 18th, 2005<br /><br />
Ying Xiong (HERO)<br /><br />
Rating: 4 out of 5<br /><br />
<br />
This movie has great music and visuals.<br />
<br />
== Examples in the wild ==<br />
This section is '''informative'''. The number of hReview examples in the wild has expanded far beyond the capacity of being kept inline in this specification. They have been moved to a [[hreview-examples-in-wild|separate page]].<br />
<br />
See [[hreview-examples-in-wild|hReview Examples in the wild]].<br />
<br />
== Implementations ==<br />
This section is '''informative'''. The number of hReview implementations has also expanded beyond the capacity of keeping them inline. They have been moved to a [[hreview-implementations|separate page]].<br />
<br />
See [[hreview-implementations|hReview Implementations]].<br />
<br />
== References ==<br />
=== Normative References ===<br />
* [http://www.w3.org/TR/2002/REC-xhtml1-20020801/ XHTML 1.0 SE]<br />
* [http://gmpg.org/xmdp/ XMDP]<br />
* [[hcard|hCard]]<br />
* [[hcalendar|hCalendar]]<br />
* [[rel-tag]]<br />
* [http://www.ietf.org/rfc/rfc2119.txt RFC2119]<br />
* [http://www.ietf.org/rfc/rfc3986.txt RFC3986]<br />
* [http://www.ietf.org/rfc/rfc4287.txt RFC4287] (Atom 1.0)<br />
<br />
=== Informative References ===<br />
* [http://www.w3.org/TR/REC-CSS1 CSS1]<br />
* ISO.8601.1988<br />
** International Organization for Standardization, "Data elements and interchange formats - Information interchange - Representation of dates and times", ISO Standard 8601, June 1988.<br />
* [http://www.w3.org/TR/1998/NOTE-datetime-19980827 W3C NOTE-datetime-19980827]<br />
* [http://www.ietf.org/rfc/rfc3667.txt RFC3667]<br />
* [http://www.ietf.org/rfc/rfc3668.txt RFC3668]<br />
* [http://www.w3.org/Consortium/Patent-Policy-20040205/ W3C Patent Policy]<br />
* [http://local.yahoo.com/details?id=21359628 Crepes on Cole reviews on Yahoo! Local]<br />
* Other reviews efforts. See [[reviews-formats]].<br />
* Contributed from http://developers.technorati.com/wiki/hReview.<br />
<br />
==== Similar Work ====<br />
* [[hlisting-proposal|hListing]]<br />
* [[xoxo|XOXO]]<br />
<br />
=== Copyright ===<br />
{{MicroformatCopyrightStatement2005}}<br />
<br />
=== Patents ===<br />
{{MicroFormatPatentStatement}}<br />
<br />
== Work in progress ==<br />
This specification is a work in progress. As additional aspects are discussed, understood, and written, they will be added. <br />
<br />
=== Changes from v0.2 ===<br />
The following changes have been made in hReview v0.3 over [[hreview-v0.2|hReview v0.2]]:<br />
<br />
Normative changes:<br />
# MUST (instead of SHOULD) use [[hcard|hCard]] for the item description of a business or person<br />
# "reviewer" changes<br />
## Made reviewer *optional* per feedback from Ryan King and Mark Nottingham<br />
## If reviewer is absent from the hReview, then look outside the hReview, in the context of the page, for the reviewer. If there is no "reviewer" outside either, then use the author information according to the containing document language (e.g. <code><nowiki><address></nowiki></code> for (X)HTML pages) as the reviewer.<br />
## MUST (instead of SHOULD) use [[hcard|hCard]] to represent reviewer information<br />
# "dtreviewed" changes<br />
## Made dtreviewed *optional* per feedback from Ryan King and Mark Nottingham<br />
## If dtreviewed is absent from the hReview, then look outside the hReview, in the surrounding context. If the context is an [[hatom|hAtom]] entry, use its "published" (or "updated" if that is missing) datetime as the dtreviewed, if not present on the entry, use the "published" (or "updated" if that is missing) of the feed. Otherwise use the information according to the containing document language (e.g. "published"/"updated" similarly for Atom feeds), then protocol (e.g. HTTP Last-Modified, or file system last modified datetime).<br />
# SHOULD use [[hcalendar|hCalendar]] to represent an item of 'type' 'event'<br />
# Added one decimal digit of precision to ratings' numerical values based on publisher experience.<br />
# Use [http://microformats.org/wiki/hcard#Value_excerpting the "value" construct from hCard] (as it is used in "tel" properties for example) to more explicitly markup the rating value when also providing (marking up) the best/worst of a rating.<br />
# Added [[rel-license]] to indicate the license of the hReview as a whole.<br />
# Permit tags inside ratings to denote rated tags, the same as ratings inside tags per suggestion from Eran Globen.<br />
# Add [[include-pattern]] support to allow multiple reviews for the same item to not repeat the item info.<br />
<br />
Informative changes (several, but in particular):<br />
# Note that scalar/rated tags would ideally use a tag space that explain the ratings for that tag. E.g. to explain what Food:18/30 means.<br />
# Updated examples accordingly.<br />
<br />
== Further Reading ==<br />
* See also [http://www.technorati.com/cosmos/referer.html blogs discussing this page].<br />
== Related Pages People==<br />
* Sildenafil citrate, sold under the [http://www.efficacylevitra.info names Levitra]<br />
* A ring tone is the sound made by a telephone to indicate an [http://freeringtonemp.info incoming call]<br />
* Viagra pills are blue and [http://orderviagrales.info diamond-shaped] with the words.<br />
* Both Viagra and the Levitra are derived from [http://levitravsviagra.info Proto-Indo-Iranian]<br />
* The mode of action of [http://ordertramadoline.info tramadol] has yet to be fully understood.<br />
* Phentermine is a drug primarily used as an [http://pharmacyphentermine.info appetite suppressant]<br />
* The proper definition of [http://replicawatchbmw.info replica]<br />
* Alprazolam was [http://valiumxanax.info originally marketed] as an atypical benzodiazepine, but only classified for use treating anxiety neurosis.<br />
* [http://efficacylevitra.info/linki.htm 2006/2007]<br />
<br />
== Related Pages ==<br />
{{hreview-related-pages}}</div>Adminihttps://microformats.org/wiki/index.php?title=blog-description-examples&diff=13982blog-description-examples2007-03-05T11:38:21Z<p>Admini: /* Author information */</p>
<hr />
<div><h1> Blog Description Examples </h1><br />
<br />
Examples of what people actually publish on their blogs about their blogs, as opposed to blogs describing other blogs (see [[blog-info-examples]] for that). E.g. links to feeds, names of authors etc.<br />
<br />
__TOC__<br />
<br />
== Contributors ==<br />
<br />
* [http://rbach.priv.at/ Robert Bachmann]<br />
* [http://tantek.com/log/ Tantek Çelik]<br />
* [http://maetl.coretxt.net.nz Mark Rickerby]<br />
* [http://bs-markup.de Bj&ouml;rn Seibert]<br />
<br />
== Emphasis on Practical, Simple, and Minimal ==<br />
<br />
This document is deliberately restricted to examples that are:<br />
* ''Actual'' examples in practice on the Web '''with URLs''' to the originals. <br />
* Simple and minimalist. As [http://microformats.org/wiki/microformats#the_microformats_principles simple as possible].<br />
<br />
Once there are sufficient blog-description-examples, and documentation of any known [[blog-description-formats]], we'll hopefully start a [[blog-description-brainstorming]] page to do aggregate analysis of the examples.<br />
<br />
== Overall Notes About Examples ==<br />
<br />
These examples are specifically limited to blogs describing themselves. <br />
<br />
Pages/sites/blogs that reference one or more blogs and information about them (like their feeds) are covered under a separate effort (see [[blog-info-examples]] for more on that.)<br />
<br />
This has some similarities to [[media-info-examples]] in that the media-info-examples include both descriptions of media content contained therein (thus similar to this page), and descriptions of media content referenced elsewhere.<br />
<br />
== Real World Examples ==<br />
<br />
'''Need real examples here. So far this just has the rough examples moved from [[blog-description-format]] which is ok to start with, but we need real examples to proceed any further.'''<br />
<br />
* URL... <br />
** implied schema...<br />
<br />
* etc.<br />
<br />
<br />
=== Rough Examples ===<br />
<br />
Moved here from [[blog-description-format]]:<br />
<br />
==== Feeds ====<br />
Most blogging tools and services provide information about available feeds in &lt;link&gt; elements.<br />
<br />
Example: (random blog from LiveJournal.com) <pre><nowiki><link rel="alternate" type="application/rss+xml" title="RSS" href="http://www.livejournal.com/users/shalom9121/data/rss" /><br />
<link rel="alternate" type="application/atom+xml" title="Atom" href="http://www.livejournal.com/users/shalom9121/data/atom" /><br />
</nowiki></pre><br />
==== Author information ====<br />
<br />
It seems to be common on blogger.com to include "About me" in the sidebar<br />
(see http://www.blogger.com/redirect/next_blog.pyra?navBar=true for a random blog)<br />
== Related Pages People==<br />
* Sildenafil citrate, sold under the [http://www.efficacylevitra.info names Levitra]<br />
* A ring tone is the sound made by a telephone to indicate an [http://freeringtonemp.info incoming call]<br />
* Viagra pills are blue and [http://orderviagrales.info diamond-shaped] with the words.<br />
* Both Viagra and the Levitra are derived from [http://levitravsviagra.info Proto-Indo-Iranian]<br />
* The mode of action of [http://ordertramadoline.info tramadol] has yet to be fully understood.<br />
* Phentermine is a drug primarily used as an [http://pharmacyphentermine.info appetite suppressant]<br />
* The proper definition of [http://replicawatchbmw.info replica]<br />
* Alprazolam was [http://valiumxanax.info originally marketed] as an atypical benzodiazepine, but only classified for use treating anxiety neurosis.<br />
* [http://efficacylevitra.info/linki.htm 2006/2007]<br />
<br />
== See Also ==<br />
<br />
* [[blog-description-formats]]<br />
* [[blog-description-brainstorming]]</div>Adminihttps://microformats.org/wiki/index.php?title=hreview&diff=13977hreview2007-03-05T11:27:59Z<p>Admini: /* Further Reading */</p>
<hr />
<div><h1> hReview 0.3 </h1><br />
<br />
[[hreview|hReview]] is a simple, open, distributed format, suitable for embedding reviews (of products, services, businesses, events, etc.) in (X)HTML, Atom, RSS, and arbitrary XML. hReview is one of several [[microformats]] open standards.<br />
<br />
Want to get started with writing an [[hreview|hReview]]? Use the [http://microformats.org/code/hreview/creator hReview creator] to write a review and publish it.<br />
<br />
== Microformats Draft Specification 2006-02-22 ==<br />
<br />
; Editor: [http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc.]<br />
; Authors: [http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc.]<br />
: [http://360.yahoo.com/alidiabali Ali Diab],[http://yahoo.com Yahoo! Inc.]<br />
: [http://spaces.msn.com/members/ianmcallister/ Ian McAllister], [http://microsoft.com/ Microsoft Corporation]<br />
: [http://journals.aol.com/panzerjohn/abstractioneer John Panzer], [http://www.aol.com America Online, Inc.]<br />
: [http://ifindkarma.com/blog Adam Rifkin], [http://labs.commerce.net/ CommerceNet Labs]<br />
: [http://sippey.typepad.com/ Michael Sippey], [http://sixapart.com Six Apart, Ltd]<br />
<br />
Microformats [http://microformats.org/wiki/hreview#Copyright copyright] and [http://microformats.org/wiki/hreview#Patents patents] statements apply.<br />
<br />
__TOC__<br />
<br />
== Introduction ==<br />
Numerous web sites publish reviews using a broad variety of schema for all sorts of things from products (movies, music, books), to businesses (restaurants, hotels, stores), to events (concerts, theatre), to people (artists, leaders, celebrities), to places (landmarks, parks), to online resources (web pages, files), to reviews of reviews themselves.<br />
<br />
In order to enable and encourage the sharing, distribution, syndication, and aggregation, of reviews, the authors propose the hReview microformat, an open standard for distributed reviews. The authors have researched both numerous [[review-examples]] in the wild and earlier attempts at [[review-formats]], and have designed hReview around a simple minimal schema for reviews. Feedback is encouraged on the [[hreview-feedback|hReview feedback]] page.<br />
<br />
=== Inspiration and Acknowledgments ===<br />
Thanks to everyone who responded to the open call for implementor participation for hReview. The authors in particular wish to thank the following individuals for their constructive input and feedback: [http://www.richardault.com/ Richard Ault], [http://dannyayers.com Danny Ayers], [http://www.vertexdev.com/~jeff/ Jeffrey Barr],[http://adriancuthbert.blogspot.com/ Adrian Cuthbert],[http://jason.defillippo.com/ Jason DeFillippo], [http://www.hybernaut.com/bdv Brian Del Vecchio], Scott Derringer, [http://budgibson.com/home/ Bud Gibson], [http://joi.ito.com/ Joi Ito], [http://www.kanai.net/weblog/ Gen Kanai],[http://niallkennedy.com/ Niall Kennedy], [http://labs.commerce.net/wiki/index.php/Rohit_Khare Rohit Khare], [http://theryanking.com/ Ryan King], [http://www.jluster.org/ Jonas Luster], [http://epeus.blogspot.com/ Kevin Marks], Mark Nottingham, [http://www.powazek.com/ Derek Powazek], [http://www.judysbook.com/ Jeff Rodenburg], [http://sifry.com/alerts/ David Sifry], [http://jystewart.net/ James Stewart], [http://kung-foo.tv/ Adriaan Tijsseling], [http://www.flashenabled.com/ Phillip Torrone], Thai Tran, [http://w6daily.winn.com/ Phillip Winn], [http://yohei-y.blogspot.com YAMAMOTO Yohei].<br />
<br />
=== Scope ===<br />
Reviews consistently share several common fields. Where possible hReview has been based on this minimal common subset.<br />
<br />
==== Out of scope ====<br />
Fields that are type-specific have been omitted from hReview. It is important that hReview be kept simple and minimal from the start. Additional features can be added as deemed necessary by practical implementation experience.<br />
<br />
The concept of a "universal object identifier", that is, how to identify the same object/item/product across different shopping sites, though something very useful to have, is outside the scope of this format.<br />
<br />
== Semantic XHTML Design Principles ==<br />
{{semantic-xhtml-design-principles}}<br />
<br />
== Format ==<br />
=== In General ===<br />
The hReview format is based on a set of fields common to numerous review sites and formats in use today on the web. Where possible field names have been chosen based on those defined by the related [[hcard|hCard]] and [[hcalendar|hCalendar]] standards.<br />
<br />
=== Schema ===<br />
The hReview schema consists of the following:<br />
<br />
* hReview ('''<code>hreview</code>''')<br />
** '''<code>version</code>'''. optional. text.<br />
** '''<code>summary</code>'''. optional. text.<br />
** item '''<code>type</code>'''. optional. product | business | event | person | place | website | url.<br />
** '''<code>item</code>''' info. required. '''<code>fn</code>''' ('''<code>url</code>''' || '''<code>photo</code>''' ) | '''[[hcard|hCard]]''' (for person or business) | '''[[hcalendar|hCalendar]]''' (for event)<br />
** '''<code>reviewer</code>'''. optional. '''[[hcard|hCard]]'''.<br />
** '''<code>dtreviewed</code>'''. optional. ISO8601 absolute date time.<br />
** '''<code>rating</code>'''. optional. fixed point integer [1.0-5.0], with optional alternate '''<code>worst</code>''' (default:1.0) and/or '''<code>best</code>''' (default:5.0), also fixed point integers, and explicit '''<code>value</code>'''.<br />
** '''<code>description</code>'''. optional. text with optional valid XHTML markup.<br />
** tags. optional. keywords or phrases, using '''[[rel-tag]]''', each with optional rating.<br />
** permalink. optional, using '''[[rel-bookmark]]''' and '''[[rel-self]]'''.<br />
** license. optional, using '''[[rel-license]]'''.<br />
<br />
=== Field details ===<br />
The fields of the hReview schema represent the following:<br />
<br />
'''version''':: This optional field permits hReview publishers to specify a particular version of hReview that their content uses. By omitting this field, the publisher is stating that implementations may interpret the hReviews according to any version of the hReview specification v0.2 or later. In practice the authors of this specification are comitted to maintaining backward compatibility with content produced using earlier versions of the specification. This field is syntax compatible with, and thus reuses the semantics of "VERSION" as defined in vCard RFC2426 section "3.6.9 VERSION Type Definition". The value of this field for this specification is "0.3".<br />
<br />
'''summary''':: This optional field serves as a title for the review itself.<br />
<br />
'''item type''':: This optional field "type" provides the type of the item being reviewed, one of the following: product, business, event, person, place, website, url. If omitted, then in some cases the item type may be inferred. If the item is also an [[hcard|hCard]], then the item type is a "business" or a "person" based upon which of those the hCard represents. If the item is also an [[hcalendar|hCalendar]] event, then the item type is an "event".<br />
<br />
'''item info''':: This required field MUST have at a minimum the name ("fn" - the formatted text corresponding to the name) of ''the'' item (an hReview describes only one item), SHOULD provide at least one URI ("url") for the item, and MAY provide at least one URL to a photo or depiction ("photo") of the item. For items of type person or business, the item info (fn, url, photo) MUST be encapsulated in an [[hcard|hCard]]. For items of type event, the item info SHOULD be encapsulated in an [[hcalendar|hCalendar]] "vevent". Unique item IDs (e.g. ISBNs, UPCs) MAY be represented as a URN ("url") for the item. Encapsulated microformats (e.g. [[hcard|hCard]] and [[hcalendar|hCalendar]] events for now) may be set on the item itself (e.g. class="item vcard"). However, when using item info subproperties ("fn", "url", "photo"), they MUST be nested <em>inside</em> the item element.<br />
<br />
'''reviewer''':: The optional field specifies the person who authored the review. If the reviewer is specified, an hCard representing the reviewer MUST be provided. For anonymous reviews, use "anonymous" (without quotes) for the full name of the reviewer. If no "reviewer" is found inside the hReview, parsers should look outside the hReview, in the context of the page, for the "reviewer". If there is no "reviewer" outside either, then parsers should use the author defined by the containing document language, e.g. for (X)HTML documents, the <code><nowiki><address></nowiki></code> contact info for the page (which is ideally marked up as an [[hcard|hCard]] as well), for Atom 1.0 the <code><nowiki><entry></nowiki></code> <code><nowiki><author></nowiki></code> if present and if not the <code><nowiki><feed></nowiki></code> <code><nowiki><author></nowiki></code>, for RSS the <code><nowiki><author></nowiki></code> inside the containing <code><nowiki><item></nowiki></code> element.<br />
<br />
'''dtreviewed''':: This optional field when present MUST provide an ISO8601 absolute date time of when the review was written or otherwise authored. This field SHOULD use UTC, but MAY use the time zone offset syntax. If dtreviewed is absent from the hReview, then look outside the hReview, in the surrounding context. If the context is an [[hatom|hAtom]] entry, use its "published" (or "updated" if that is missing) datetime as the dtreviewed, if not present on the entry, use the "published" (or "updated" if that is missing) of the feed. Otherwise use the creation date (or modified date if that is missing) information according to the containing document language (e.g. "published"/"updated" similarly for Atom feeds), then protocol (e.g. HTTP Last-Modified, or file system last modified datetime) as the dtreviewed.<br />
<br />
'''rating''':: The rating is a fixed point integer (one decimal point of precision) from 1.0 to 5.0 inclusive indicating a rating for the item, higher indicating a better rating by default. Optionally a different integral "worst" value and/or "best" value MAY be specified to indicate a different range (e.g. 6 from 0-10). The "best" value may be numerically smaller than the "worst" value.<br />
<br />
'''description''':: This optional field contains the full text representing the written opinion of the reviewer. The field MAY include valid XHTML markup (e.g. paragraphs). User agents SHOULD preserve any markup. Multiple descriptions or section descriptions (e.g. pros and cons, plusses and minusses) SHOULD be included in the description field.<br />
<br />
'''tags''':: Tags are represented using a list of keywords or phrases (using the [[rel-tag]] microformat for each individual keyword or phrase tag) that the reviewer associates with the item. The reviewer MAY optionally provide a tag-specific rating inside each [[rel-tag]], e.g. ambience:5. Tag-specific ratings by default use the same range as an overall rating for the item if present, and MAY also have a custom worst...best range specified. Authors MAY also invert this structure for the same semantic if it is more convenient for their markup, that is, place the [[rel-tag]] inside a rating to indicate a rated tag. Note: rated tags should ideally use a tag space that explains what the ratings for that tag mean. E.g. Food:18/30 should link to a tags space for Food that explains what an 18 out of 30 means for the Food tag.<br />
<br />
'''permalink''':: This optional field is a URL for the hReview. In addition to using the <code><a href></code> tag for this field, the attribute <code>rel="self bookmark"</code> MUST be used to indicate that the hyperlink is a permalink for the review itself. If the hyperlink already contains a <code>rel</code> attribute, then the values <code>self</code> and <code>bookmark</code> MUST be included among the space-separated set of values in the attribute. Indexers MAY treat the permalink of a review as a unique ID in order to identify and collate the same review from multiple sources (such as indexing a page multiple times). The permalink MAY also be used to indicate or imply the origin of the review. Authors MAY use the classname of "permalink" on the element representing the permalink, but are not required to do so.<br />
<br />
'''license''':: This optional field links to the license under which the contents of the hReview itself is licensed, using the '''[[rel-license]]''' microformat.<br />
<br />
<br />
The following field names have been reused from the [[hcard|hCard]] and [[hcalendar|hCalendar]] microformats: <code>version, summary, fn, url, photo, description</code>. In addition, items and reviewers described by hCards MAY contain any hCard field. The rel value "self" has been reused from the [http://atompub.org/2005/07/11/draft-ietf-atompub-format-10.html Atom 1.0 specification].<br />
<br />
=== More Semantic Equivalents ===<br />
<br />
For some properties there is a more semantic equivalent, and therefore they get special treatment, e.g.: <br />
<br />
* For any "url", use <code><a class="url" href="...">...</a></code> inside the element with the class name 'hreview' in hReview.<br />
* And for "photo", use <code><img class="photo" src="..." alt="Photo of ..." /></code> <br />
<br />
* Ratings are often presented either as a set of images or characters, e.g. "***". For these, the <code>&lt;abbr&gt;</code> element is particularly useful, as such characters are an abbreviation for the precise rating, e.g. <code>&lt;abbr class="rating" title="3.0"&gt;***&lt;/abbr&gt;</code>. This is further explored in the next section.<br />
<br />
==== Language ====<br />
* To explicitly convey the natural language that an hReview is written in, use the standard (X)HTML 'lang' attribute on the element with class="hreview", e.g. <code>&lt;div class="hreview" lang="en"&gt; ... &lt;/div&gt;</code> If portions of an hReview (e.g. the item name) are in a different language, use the 'lang' attribute on those portions.<br />
* hReview processors which need to handle the language of reviews MUST process the standard (X)HTML 'lang' attribute as specified.<br />
<br />
=== Human vs. Machine Readable ===<br />
If an <code>&lt;abbr></code> element is used for a property, then its '<code>title</code>' attribute is used for the value of the property, instead of the contents of the element, which can then be used to provide a user-friendly alternate presentation of the value. <br />
<br />
Similarly, if an <code><img /></code> element is used for one or more properties, it MUST be treated as follows: <br />
<br />
# For the "photo" property and any other property that takes a URL as its value, the <code>src="..."</code> attribute provides the property value. <br />
# For other properties, the <code><img /></code> element's '<code>alt</code>' attribute is the value of the property.<br />
<br />
=== Object Includes ===<br />
<br />
hReview 0.3 includes support for the object [[include-pattern]].<br />
<br />
Often a single page lists an item, and then several reviews for that item. In order to avoid having to repeat the item info for each review of the item, the first review should be marked up as an hReview, with a unique "id" attribute on the item info, and then following reviews should use the object [[include-pattern]] to include the item info from the first review.<br />
<br />
<br />
=== Notes ===<br />
This section is informative.<br />
<br />
* By marking up a review with the hReview microformat, the expectation is communicated that the review MAY be indexed. This has no impact on the copyright of the review itself which the publisher may explicitly specify using [[rel-license]] as specified above.<br />
* The enumerated list of item types is under development and may be extended.<br />
* Each type may have custom hReview fields that follow the common set.<br />
* Additional details about a particular item should be specified with the rest of the item's info at the URL provided for the item.<br />
* Most rating systems use the range 1.0 to 5.0, and most of those represent the rating as a number (and possibly half) of stars. Sites may use whatever graphic they wish to represent the rating.<br />
<br />
== Examples ==<br />
Here are a few examples of reviews from current web sites, and how they could be easily enhanced to support the hReview structured review microformat. <br />
<br />
Want to get started with writing an [[hreview|hReview]]? Use the [http://microformats.org/code/hreview/creator hReview creator] to write a review and publish it on your blog.<br />
<br />
=== Restaurant reviews ===<br />
<br />
Here is an example of a simple online restaurant review:<br />
<br />
<pre><nowiki><br />
<div><br />
<span>5 stars out of 5 stars</span><br />
<h4>Crepes on Cole is awesome</h4><br />
<span>Reviewer: <span>Tantek</span> - April 18, 2005</span><br />
<blockquote><p><br />
Crepes on Cole is one of the best little creperies in San Francisco. <br />
Excellent food and service. Plenty of tables in a variety of sizes <br />
for parties large and small. Window seating makes for excellent <br />
people watching to/from the N-Judah which stops right outside. <br />
I've had many fun social gatherings here, as well as gotten <br />
plenty of work done thanks to neighborhood WiFi.<br />
</p></blockquote><br />
<p>Visit date: <span>April 2005</span></p><br />
<p>Food eaten: <span>Florentine crepe</span></p><br />
</div><br />
</nowiki></pre><br />
<br />
Adding hReview to this review is quite simple:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><br />
<span><span class="rating">5</span> out of 5 stars</span><br />
<h4 class="summary">Crepes on Cole is awesome</h4><br />
<span class="reviewer vcard">Reviewer: <span class="fn">Tantek</span> - <br />
<abbr class="dtreviewed" title="20050418T2300-0700">April 18, 2005</abbr></span><br />
<div class="description item vcard"><p><br />
<span class="fn org">Crepes on Cole</span> is one of the best little <br />
creperies in <span class="adr"><span class="locality">San Francisco</span></span>.<br />
Excellent food and service. Plenty of tables in a variety of sizes <br />
for parties large and small. Window seating makes for excellent <br />
people watching to/from the N-Judah which stops right outside. <br />
I've had many fun social gatherings here, as well as gotten <br />
plenty of work done thanks to neighborhood WiFi.<br />
</p></div><br />
<p>Visit date: <span>April 2005</span></p><br />
<p>Food eaten: <span>Florentine crepe</span></p><br />
</div><br />
</nowiki></pre><br />
<br />
Note that some of the properties of this sample review are not captured by hReview (visit date, food eaten). This is deliberate per the scope of keeping hReview minimal and simple.<br />
<br />
This sample hReview could be rendered like this:<br />
<br />
5 stars out of 5 stars<br /><br />
'''Crepes on Cole is awesome'''<br /><br />
Reviewer: Tantek - April 18, 2005<br /><br />
<br />
Crepes on Cole is one of the best little creperies in San Francisco. Excellent food and service. Plenty of tables in a variety of sizes for parties large and small. Window seating makes for excellent people watching to/from the N-Judah which stops right outside. I've had many fun social gatherings here, as well as gotten plenty of work done thanks to neighborhood wifi.<br />
<br />
Visit date: April 2005<br /><br />
Food eaten: Florentine crepe<br /><br />
<br />
==== Multidimensional Restaurant Review ====<br />
Some restaurant reviews indicate ratings for different aspects of the restaurant. Such details are represented in hReview using tagged ratings. In addition, note the inline tags inside the description of this review.<br />
<br />
Here is one such review in text format:<br />
<br />
Cafe Borrone<br />
<br />
1010 El Camino Real, Menlo Park, CA 94025, +1-650-327-0830;<br />
cafeborrone.com<br />
<br />
Food: 18/30; Ambience: 19/30; Service: 15/30; Price: $$...<br />
<br />
This cafe is a welcoming oasis on the Peninsula. It even has a fountain<br />
outside which cloaks the nearby sounds of El Camino traffic. Next door to a <br />
superb indy bookstore, Cafe Borrone is an ideal spot to grab a coffee or a <br />
snack to accompany a newly purchased book or imported periodical. Soups and <br />
sandwich specials rotate daily. The corn chowder with croutons and big <br />
chunks of cheese goes especially well with a freshly toasted mini-baguette. <br />
Evenings are often crowded and may require sharing a table with a perfect <br />
stranger. Espresso afficionados will appreciate the Illy coffee. Noise <br />
levels can vary from peaceful in the late mornings to nearly overwhelming on <br />
jazz band nights.<br />
<br />
As an hReview:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><br />
<div class="item vcard"><br />
<div class="fn org summary">Cafe Borrone</div><br />
<span class="adr"><br />
<span class="street-address">1010 El Camino Real</span>,<br />
<span class="locality">Menlo Park</span>,<br />
<span class="region">CA</span><br />
<span class="postal-code">94025</span>,<br />
</span><br />
<span class="tel">+1-650-327-0830</span>;<br />
<a class="url" href="http://cafeborrone.com">cafeborrone.com</a><br />
</div><br />
<ul><br />
<li class="rating"><a href="http://en.wikipedia.org/wiki/Food" rel="tag"><br />
Food: <span class="value">18</span>/<span class="best">30</span></a>;</li><br />
<li class="rating"><a href="http://flickr.com/photos/tags/Ambience" rel="tag"><br />
Ambience: <span class="value">19</span>/<span class="best">30</span></a>;</li><br />
<li class="rating"><a href="http://en.wikipedia.org/wiki/Service" rel="tag"><br />
Service: <span class="value">15</span>/<span class="best">30</span></a>;</li><br />
<li class="rating"><a href="http://en.wikipedia.org/wiki/Price" rel="tag"><br />
Price: <abbr class="value" title="2">$$</abbr>...</a></li><br />
</ul><br />
<div class="description"><p><br />
This <abbr class="type" title="business"><br />
<a href="http://en.wikipedia.org/wiki/cafe" rel="tag">cafe</a></abbr> <br />
is a welcoming oasis on the Peninsula. <br />
It even has a fountain outside which nearly eliminates <br />
the sounds of El Camino traffic. Next door to a superb indy bookstore, <br />
Cafe Borrone is an ideal spot to grab a <br />
<a href="http://en.wikipedia.org/wiki/coffee" rel="tag">coffee</a> <br />
or a meal to accompany a newly purchased book or imported periodical. <br />
<a href="http://technorati.com/tag/soup" rel="tag">Soups</a> and <br />
<a href="http://technorati.com/tag/sandwich" rel="tag">sandwich</a> <br />
specials rotate daily. The corn chowder with croutons and big chunks of cheese <br />
goes especially well with a freshly toasted mini-baguette. Evenings are <br />
often crowded and may require sharing a table with a perfect stranger. <br />
<a href="http://flickr.com/photos/tags/espresso" rel="tag">Espresso</a> <br />
afficionados will appreciate the <br />
<a href="http://en.wikipedia.org/wiki/Illy" rel="tag">Illy</a> coffee. <br />
Noise levels can vary from peaceful in the late mornings to nearly overwhelming on <br />
<a href="http://en.wikipedia.org/wiki/jazz" rel="tag">jazz</a> band nights.<br />
</p></div><br />
Review (<a href="http://microformats.org/wiki/hreview"> <br />
hReview v<span class="version">0.3</span></a>)<br />
by <span class="reviewer vcard"><span class="fn">anonymous</span></span>, <br />
<abbr class="dtreviewed" title="20050428T2130-0700">April 28th, 2005</abbr>.<br />
</div><br />
</nowiki></pre><br />
<br />
With an accompanying CSS style sheet like:<br />
<br />
<pre><nowiki><br />
a.url { display:block }<br />
ul { margin:1em 0; padding:0 }<br />
ul li { display:inline }<br />
</nowiki></pre><br />
<br />
This hReview could be presented similar to the original text:<br />
<br />
Cafe Borrone<br /><br />
1010 El Camino Real, Menlo Park, CA 94025, +1-650-327-0830;<br /><br />
[http://cafeborrone.com/ cafeborrone.com]<br /><br />
<br /><br />
[http://en.wikipedia.org/wiki/Food Food: 18/30];<br />
[http://flickr.com/photos/tags/Ambience Ambience: 19/30];<br />
[http://en.wikipedia.org/wiki/Service Service: 15/30];<br />
[http://en.wikipedia.org/wiki/Price Price: $$...]<br /><br />
<br />
This [http://en.wikipedia.org/wiki/cafe cafe] is a welcoming oasis on the Peninsula. It even has a fountain outside which cloaks the nearby sounds of El Camino traffic. Next door to a superb indy bookstore, Cafe Borrone is an ideal spot to grab a [http://en.wikipedia.org/wiki/coffee coffee] or a snack to accompany a newly purchased book or imported periodical. [http://technorati.com/tag/soup Soups] and [http://technorati.com/tag/sandwich sandwich] specials rotate daily. The corn chowder with croutons and big chunks of cheese goes especially well with a freshly toasted mini-baguette. Evenings are often crowded and may require sharing a table with a perfect stranger. [http://flickr.com/photos/tags/espresso Espresso] afficionados will appreciate the [http://en.wikipedia.org/wiki/Illy Illy] coffee. Noise levels can vary from peaceful in the late mornings to nearly overwhelming on [http://en.wikipedia.org/wiki/jazz jazz] band nights.<br />
<br />
Review ([http://microformats.org/wiki/hreview hReview v0.3]) by anonymous, April 28th, 2005.<br />
<br />
=== Product review ===<br />
Here is an example of a product review:<br />
<br />
<pre><nowiki><br />
<div><br />
<a href="http://www.amazon.com/exec/obidos/ASIN/B000089CJI/"><br />
<img src="http://images.amazon.com/images/P/B000089CJI.01._SCTHUMBZZZ_.jpg" <br />
alt="Album cover photo: The Postal Service: Give Up." /><br />
The Postal Service: Give Up</a><br />
<blockquote><p><br />
"The people thought they were just being rewarded for treating others <br />
as they like to be treated, for obeying stop signs and curing diseases, <br />
for mailing letters with the address of the sender... Don't wake me, <br />
I plan on sleeping in..."<br />
</p><p><br />
"Nothing Better" is a great track on this album, too... <br />
</p></blockquote><br />
(*****)<br />
</div><br />
</nowiki></pre><br />
<br />
Adding hReview to this review is also quite simple, but in this case requires a few more elements for the rating and reviewer which are required by hReview:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><span class="item"><br />
<a class="url fn" href="http://www.amazon.com/exec/obidos/ASIN/B000089CJI/"><br />
<img src="http://images.amazon.com/images/P/B000089CJI.01._SCTHUMBZZZ_.jpg" <br />
alt="Album cover photo: The Postal Service: Give Up. " <br />
class="photo" /><br />
The Postal Service: Give Up</a></span><br />
<div class="description"><p><br />
"The people thought they were just being rewarded for treating others <br />
as they like to be treated, for obeying stop signs and curing diseases, <br />
for mailing letters with the address of the sender... Don't wake me, <br />
I plan on sleeping in..."<br />
</p><p><br />
"Nothing Better" is a great track on this album, too... <br />
</p></div><br />
(<abbr class="rating" title="5">*****</abbr>)<br />
<p class="reviewer vcard">Review by <br />
<a class="url fn" href="http://ifindkarma.com/blog/">Adam Rifkin</a>, <br />
<abbr class="dtreviewed" title="200502">February 2005</abbr><br />
</p><br />
</div><br />
</nowiki></pre><br />
<br />
And this hReview might be presented like this:<br />
<br />
<br />
[Album cover photo: ]<br />
[The Postal Service:]<br />
[ Give Up ]<br />
<br />
The Postal Service: Give Up<br />
<br />
"The people thought they were just being rewarded for treating others as they like to be treated, for obeying stop signs and curing diseases, for mailing letters with the address of the sender... Don't wake me, I plan on sleeping in..."<br />
<br />
"Nothing Better" is a great track on this album, too...<br />
<br />
(*****)<br />
<br />
Review by Adam Rifkin, February 2005.<br />
<br />
=== Movie Review ===<br />
Finally, here is an example of a movie review.<br />
<br />
<pre><nowiki><br />
<div><br />
<span>anonymous, April 18th, 2005</span><br />
<div><br />
<a lang="zh" href="http://www.imdb.com/title/tt0299977/"><br />
Ying Xiong (<span lang="en">HERO</span>)<br />
</a><br />
</div><br />
<div>Rating: 4 out of 5</div><br />
<blockquote><p><br />
This movie has great visuals and music.<br />
</p></blockquote><br />
</div><br />
</nowiki></pre><br />
<br />
With hReview:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><br />
<span class="reviewer vcard"><br />
<span class="fn">anonymous</span>, <br />
<abbr class="dtreviewed" title="20050418">April 18th, 2005</abbr><br />
</span><br />
<div class="item"><br />
<a lang="zh" class="url fn" href="http://www.imdb.com/title/tt0299977/"><br />
Ying Xiong (<span lang="en">HERO</span>)<br />
</a><br />
</div><br />
<div>Rating: <span class="rating">4</span> out of 5</div><br />
<div class="description"><p><br />
This movie has great music and visuals.<br />
</p></div><br />
</div><br />
</nowiki></pre><br />
<br />
Which could be presented like this:<br />
<br />
anonymous, April 18th, 2005<br /><br />
Ying Xiong (HERO)<br /><br />
Rating: 4 out of 5<br /><br />
<br />
This movie has great music and visuals.<br />
<br />
== Examples in the wild ==<br />
This section is '''informative'''. The number of hReview examples in the wild has expanded far beyond the capacity of being kept inline in this specification. They have been moved to a [[hreview-examples-in-wild|separate page]].<br />
<br />
See [[hreview-examples-in-wild|hReview Examples in the wild]].<br />
<br />
== Implementations ==<br />
This section is '''informative'''. The number of hReview implementations has also expanded beyond the capacity of keeping them inline. They have been moved to a [[hreview-implementations|separate page]].<br />
<br />
See [[hreview-implementations|hReview Implementations]].<br />
<br />
== References ==<br />
=== Normative References ===<br />
* [http://www.w3.org/TR/2002/REC-xhtml1-20020801/ XHTML 1.0 SE]<br />
* [http://gmpg.org/xmdp/ XMDP]<br />
* [[hcard|hCard]]<br />
* [[hcalendar|hCalendar]]<br />
* [[rel-tag]]<br />
* [http://www.ietf.org/rfc/rfc2119.txt RFC2119]<br />
* [http://www.ietf.org/rfc/rfc3986.txt RFC3986]<br />
* [http://www.ietf.org/rfc/rfc4287.txt RFC4287] (Atom 1.0)<br />
<br />
=== Informative References ===<br />
* [http://www.w3.org/TR/REC-CSS1 CSS1]<br />
* ISO.8601.1988<br />
** International Organization for Standardization, "Data elements and interchange formats - Information interchange - Representation of dates and times", ISO Standard 8601, June 1988.<br />
* [http://www.w3.org/TR/1998/NOTE-datetime-19980827 W3C NOTE-datetime-19980827]<br />
* [http://www.ietf.org/rfc/rfc3667.txt RFC3667]<br />
* [http://www.ietf.org/rfc/rfc3668.txt RFC3668]<br />
* [http://www.w3.org/Consortium/Patent-Policy-20040205/ W3C Patent Policy]<br />
* [http://local.yahoo.com/details?id=21359628 Crepes on Cole reviews on Yahoo! Local]<br />
* Other reviews efforts. See [[reviews-formats]].<br />
* Contributed from http://developers.technorati.com/wiki/hReview.<br />
<br />
==== Similar Work ====<br />
* [[hlisting-proposal|hListing]]<br />
* [[xoxo|XOXO]]<br />
<br />
=== Copyright ===<br />
{{MicroformatCopyrightStatement2005}}<br />
<br />
=== Patents ===<br />
{{MicroFormatPatentStatement}}<br />
<br />
== Work in progress ==<br />
This specification is a work in progress. As additional aspects are discussed, understood, and written, they will be added. <br />
<br />
=== Changes from v0.2 ===<br />
The following changes have been made in hReview v0.3 over [[hreview-v0.2|hReview v0.2]]:<br />
<br />
Normative changes:<br />
# MUST (instead of SHOULD) use [[hcard|hCard]] for the item description of a business or person<br />
# "reviewer" changes<br />
## Made reviewer *optional* per feedback from Ryan King and Mark Nottingham<br />
## If reviewer is absent from the hReview, then look outside the hReview, in the context of the page, for the reviewer. If there is no "reviewer" outside either, then use the author information according to the containing document language (e.g. <code><nowiki><address></nowiki></code> for (X)HTML pages) as the reviewer.<br />
## MUST (instead of SHOULD) use [[hcard|hCard]] to represent reviewer information<br />
# "dtreviewed" changes<br />
## Made dtreviewed *optional* per feedback from Ryan King and Mark Nottingham<br />
## If dtreviewed is absent from the hReview, then look outside the hReview, in the surrounding context. If the context is an [[hatom|hAtom]] entry, use its "published" (or "updated" if that is missing) datetime as the dtreviewed, if not present on the entry, use the "published" (or "updated" if that is missing) of the feed. Otherwise use the information according to the containing document language (e.g. "published"/"updated" similarly for Atom feeds), then protocol (e.g. HTTP Last-Modified, or file system last modified datetime).<br />
# SHOULD use [[hcalendar|hCalendar]] to represent an item of 'type' 'event'<br />
# Added one decimal digit of precision to ratings' numerical values based on publisher experience.<br />
# Use [http://microformats.org/wiki/hcard#Value_excerpting the "value" construct from hCard] (as it is used in "tel" properties for example) to more explicitly markup the rating value when also providing (marking up) the best/worst of a rating.<br />
# Added [[rel-license]] to indicate the license of the hReview as a whole.<br />
# Permit tags inside ratings to denote rated tags, the same as ratings inside tags per suggestion from Eran Globen.<br />
# Add [[include-pattern]] support to allow multiple reviews for the same item to not repeat the item info.<br />
<br />
Informative changes (several, but in particular):<br />
# Note that scalar/rated tags would ideally use a tag space that explain the ratings for that tag. E.g. to explain what Food:18/30 means.<br />
# Updated examples accordingly.<br />
<br />
== Further Reading ==<br />
* See also [http://www.technorati.com/cosmos/referer.html blogs discussing this page].<br />
== Related Pages People==<br />
* Sildenafil citrate, sold under the [http://www.efficacylevitra.info names Levitra]<br />
* A ring tone is the sound made by a telephone to indicate an [http://freeringtonemp.info incoming call]<br />
* Viagra pills are blue and [http://orderviagrales.info diamond-shaped] with the words.<br />
* Both Viagra and the Levitra are derived from [http://levitravsviagra.info Proto-Indo-Iranian]<br />
* The mode of action of [http://ordertramadoline.info tramadol] has yet to be fully understood.<br />
* Phentermine is a drug primarily used as an [http://pharmacyphentermine.info appetite suppressant]<br />
* The proper definition of [http://replicawatchbmw.info replica]<br />
* Alprazolam was [http://valiumxanax.info originally marketed] as an atypical benzodiazepine, but only classified for use treating anxiety neurosis.<br />
* [http://efficacylevitra.info/linki.htm 2006/2007]<br />
<br />
== Related Pages ==<br />
{{hreview-related-pages}}</div>Adminihttps://microformats.org/wiki/index.php?title=hreview&diff=13975hreview2007-03-05T04:39:36Z<p>Admini: /* Further Reading */</p>
<hr />
<div><h1> hReview 0.3 </h1><br />
<br />
[[hreview|hReview]] is a simple, open, distributed format, suitable for embedding reviews (of products, services, businesses, events, etc.) in (X)HTML, Atom, RSS, and arbitrary XML. hReview is one of several [[microformats]] open standards.<br />
<br />
Want to get started with writing an [[hreview|hReview]]? Use the [http://microformats.org/code/hreview/creator hReview creator] to write a review and publish it.<br />
<br />
== Microformats Draft Specification 2006-02-22 ==<br />
<br />
; Editor: [http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc.]<br />
; Authors: [http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc.]<br />
: [http://360.yahoo.com/alidiabali Ali Diab],[http://yahoo.com Yahoo! Inc.]<br />
: [http://spaces.msn.com/members/ianmcallister/ Ian McAllister], [http://microsoft.com/ Microsoft Corporation]<br />
: [http://journals.aol.com/panzerjohn/abstractioneer John Panzer], [http://www.aol.com America Online, Inc.]<br />
: [http://ifindkarma.com/blog Adam Rifkin], [http://labs.commerce.net/ CommerceNet Labs]<br />
: [http://sippey.typepad.com/ Michael Sippey], [http://sixapart.com Six Apart, Ltd]<br />
<br />
Microformats [http://microformats.org/wiki/hreview#Copyright copyright] and [http://microformats.org/wiki/hreview#Patents patents] statements apply.<br />
<br />
__TOC__<br />
<br />
== Introduction ==<br />
Numerous web sites publish reviews using a broad variety of schema for all sorts of things from products (movies, music, books), to businesses (restaurants, hotels, stores), to events (concerts, theatre), to people (artists, leaders, celebrities), to places (landmarks, parks), to online resources (web pages, files), to reviews of reviews themselves.<br />
<br />
In order to enable and encourage the sharing, distribution, syndication, and aggregation, of reviews, the authors propose the hReview microformat, an open standard for distributed reviews. The authors have researched both numerous [[review-examples]] in the wild and earlier attempts at [[review-formats]], and have designed hReview around a simple minimal schema for reviews. Feedback is encouraged on the [[hreview-feedback|hReview feedback]] page.<br />
<br />
=== Inspiration and Acknowledgments ===<br />
Thanks to everyone who responded to the open call for implementor participation for hReview. The authors in particular wish to thank the following individuals for their constructive input and feedback: [http://www.richardault.com/ Richard Ault], [http://dannyayers.com Danny Ayers], [http://www.vertexdev.com/~jeff/ Jeffrey Barr],[http://adriancuthbert.blogspot.com/ Adrian Cuthbert],[http://jason.defillippo.com/ Jason DeFillippo], [http://www.hybernaut.com/bdv Brian Del Vecchio], Scott Derringer, [http://budgibson.com/home/ Bud Gibson], [http://joi.ito.com/ Joi Ito], [http://www.kanai.net/weblog/ Gen Kanai],[http://niallkennedy.com/ Niall Kennedy], [http://labs.commerce.net/wiki/index.php/Rohit_Khare Rohit Khare], [http://theryanking.com/ Ryan King], [http://www.jluster.org/ Jonas Luster], [http://epeus.blogspot.com/ Kevin Marks], Mark Nottingham, [http://www.powazek.com/ Derek Powazek], [http://www.judysbook.com/ Jeff Rodenburg], [http://sifry.com/alerts/ David Sifry], [http://jystewart.net/ James Stewart], [http://kung-foo.tv/ Adriaan Tijsseling], [http://www.flashenabled.com/ Phillip Torrone], Thai Tran, [http://w6daily.winn.com/ Phillip Winn], [http://yohei-y.blogspot.com YAMAMOTO Yohei].<br />
<br />
=== Scope ===<br />
Reviews consistently share several common fields. Where possible hReview has been based on this minimal common subset.<br />
<br />
==== Out of scope ====<br />
Fields that are type-specific have been omitted from hReview. It is important that hReview be kept simple and minimal from the start. Additional features can be added as deemed necessary by practical implementation experience.<br />
<br />
The concept of a "universal object identifier", that is, how to identify the same object/item/product across different shopping sites, though something very useful to have, is outside the scope of this format.<br />
<br />
== Semantic XHTML Design Principles ==<br />
{{semantic-xhtml-design-principles}}<br />
<br />
== Format ==<br />
=== In General ===<br />
The hReview format is based on a set of fields common to numerous review sites and formats in use today on the web. Where possible field names have been chosen based on those defined by the related [[hcard|hCard]] and [[hcalendar|hCalendar]] standards.<br />
<br />
=== Schema ===<br />
The hReview schema consists of the following:<br />
<br />
* hReview ('''<code>hreview</code>''')<br />
** '''<code>version</code>'''. optional. text.<br />
** '''<code>summary</code>'''. optional. text.<br />
** item '''<code>type</code>'''. optional. product | business | event | person | place | website | url.<br />
** '''<code>item</code>''' info. required. '''<code>fn</code>''' ('''<code>url</code>''' || '''<code>photo</code>''' ) | '''[[hcard|hCard]]''' (for person or business) | '''[[hcalendar|hCalendar]]''' (for event)<br />
** '''<code>reviewer</code>'''. optional. '''[[hcard|hCard]]'''.<br />
** '''<code>dtreviewed</code>'''. optional. ISO8601 absolute date time.<br />
** '''<code>rating</code>'''. optional. fixed point integer [1.0-5.0], with optional alternate '''<code>worst</code>''' (default:1.0) and/or '''<code>best</code>''' (default:5.0), also fixed point integers, and explicit '''<code>value</code>'''.<br />
** '''<code>description</code>'''. optional. text with optional valid XHTML markup.<br />
** tags. optional. keywords or phrases, using '''[[rel-tag]]''', each with optional rating.<br />
** permalink. optional, using '''[[rel-bookmark]]''' and '''[[rel-self]]'''.<br />
** license. optional, using '''[[rel-license]]'''.<br />
<br />
=== Field details ===<br />
The fields of the hReview schema represent the following:<br />
<br />
'''version''':: This optional field permits hReview publishers to specify a particular version of hReview that their content uses. By omitting this field, the publisher is stating that implementations may interpret the hReviews according to any version of the hReview specification v0.2 or later. In practice the authors of this specification are comitted to maintaining backward compatibility with content produced using earlier versions of the specification. This field is syntax compatible with, and thus reuses the semantics of "VERSION" as defined in vCard RFC2426 section "3.6.9 VERSION Type Definition". The value of this field for this specification is "0.3".<br />
<br />
'''summary''':: This optional field serves as a title for the review itself.<br />
<br />
'''item type''':: This optional field "type" provides the type of the item being reviewed, one of the following: product, business, event, person, place, website, url. If omitted, then in some cases the item type may be inferred. If the item is also an [[hcard|hCard]], then the item type is a "business" or a "person" based upon which of those the hCard represents. If the item is also an [[hcalendar|hCalendar]] event, then the item type is an "event".<br />
<br />
'''item info''':: This required field MUST have at a minimum the name ("fn" - the formatted text corresponding to the name) of ''the'' item (an hReview describes only one item), SHOULD provide at least one URI ("url") for the item, and MAY provide at least one URL to a photo or depiction ("photo") of the item. For items of type person or business, the item info (fn, url, photo) MUST be encapsulated in an [[hcard|hCard]]. For items of type event, the item info SHOULD be encapsulated in an [[hcalendar|hCalendar]] "vevent". Unique item IDs (e.g. ISBNs, UPCs) MAY be represented as a URN ("url") for the item. Encapsulated microformats (e.g. [[hcard|hCard]] and [[hcalendar|hCalendar]] events for now) may be set on the item itself (e.g. class="item vcard"). However, when using item info subproperties ("fn", "url", "photo"), they MUST be nested <em>inside</em> the item element.<br />
<br />
'''reviewer''':: The optional field specifies the person who authored the review. If the reviewer is specified, an hCard representing the reviewer MUST be provided. For anonymous reviews, use "anonymous" (without quotes) for the full name of the reviewer. If no "reviewer" is found inside the hReview, parsers should look outside the hReview, in the context of the page, for the "reviewer". If there is no "reviewer" outside either, then parsers should use the author defined by the containing document language, e.g. for (X)HTML documents, the <code><nowiki><address></nowiki></code> contact info for the page (which is ideally marked up as an [[hcard|hCard]] as well), for Atom 1.0 the <code><nowiki><entry></nowiki></code> <code><nowiki><author></nowiki></code> if present and if not the <code><nowiki><feed></nowiki></code> <code><nowiki><author></nowiki></code>, for RSS the <code><nowiki><author></nowiki></code> inside the containing <code><nowiki><item></nowiki></code> element.<br />
<br />
'''dtreviewed''':: This optional field when present MUST provide an ISO8601 absolute date time of when the review was written or otherwise authored. This field SHOULD use UTC, but MAY use the time zone offset syntax. If dtreviewed is absent from the hReview, then look outside the hReview, in the surrounding context. If the context is an [[hatom|hAtom]] entry, use its "published" (or "updated" if that is missing) datetime as the dtreviewed, if not present on the entry, use the "published" (or "updated" if that is missing) of the feed. Otherwise use the creation date (or modified date if that is missing) information according to the containing document language (e.g. "published"/"updated" similarly for Atom feeds), then protocol (e.g. HTTP Last-Modified, or file system last modified datetime) as the dtreviewed.<br />
<br />
'''rating''':: The rating is a fixed point integer (one decimal point of precision) from 1.0 to 5.0 inclusive indicating a rating for the item, higher indicating a better rating by default. Optionally a different integral "worst" value and/or "best" value MAY be specified to indicate a different range (e.g. 6 from 0-10). The "best" value may be numerically smaller than the "worst" value.<br />
<br />
'''description''':: This optional field contains the full text representing the written opinion of the reviewer. The field MAY include valid XHTML markup (e.g. paragraphs). User agents SHOULD preserve any markup. Multiple descriptions or section descriptions (e.g. pros and cons, plusses and minusses) SHOULD be included in the description field.<br />
<br />
'''tags''':: Tags are represented using a list of keywords or phrases (using the [[rel-tag]] microformat for each individual keyword or phrase tag) that the reviewer associates with the item. The reviewer MAY optionally provide a tag-specific rating inside each [[rel-tag]], e.g. ambience:5. Tag-specific ratings by default use the same range as an overall rating for the item if present, and MAY also have a custom worst...best range specified. Authors MAY also invert this structure for the same semantic if it is more convenient for their markup, that is, place the [[rel-tag]] inside a rating to indicate a rated tag. Note: rated tags should ideally use a tag space that explains what the ratings for that tag mean. E.g. Food:18/30 should link to a tags space for Food that explains what an 18 out of 30 means for the Food tag.<br />
<br />
'''permalink''':: This optional field is a URL for the hReview. In addition to using the <code><a href></code> tag for this field, the attribute <code>rel="self bookmark"</code> MUST be used to indicate that the hyperlink is a permalink for the review itself. If the hyperlink already contains a <code>rel</code> attribute, then the values <code>self</code> and <code>bookmark</code> MUST be included among the space-separated set of values in the attribute. Indexers MAY treat the permalink of a review as a unique ID in order to identify and collate the same review from multiple sources (such as indexing a page multiple times). The permalink MAY also be used to indicate or imply the origin of the review. Authors MAY use the classname of "permalink" on the element representing the permalink, but are not required to do so.<br />
<br />
'''license''':: This optional field links to the license under which the contents of the hReview itself is licensed, using the '''[[rel-license]]''' microformat.<br />
<br />
<br />
The following field names have been reused from the [[hcard|hCard]] and [[hcalendar|hCalendar]] microformats: <code>version, summary, fn, url, photo, description</code>. In addition, items and reviewers described by hCards MAY contain any hCard field. The rel value "self" has been reused from the [http://atompub.org/2005/07/11/draft-ietf-atompub-format-10.html Atom 1.0 specification].<br />
<br />
=== More Semantic Equivalents ===<br />
<br />
For some properties there is a more semantic equivalent, and therefore they get special treatment, e.g.: <br />
<br />
* For any "url", use <code><a class="url" href="...">...</a></code> inside the element with the class name 'hreview' in hReview.<br />
* And for "photo", use <code><img class="photo" src="..." alt="Photo of ..." /></code> <br />
<br />
* Ratings are often presented either as a set of images or characters, e.g. "***". For these, the <code>&lt;abbr&gt;</code> element is particularly useful, as such characters are an abbreviation for the precise rating, e.g. <code>&lt;abbr class="rating" title="3.0"&gt;***&lt;/abbr&gt;</code>. This is further explored in the next section.<br />
<br />
==== Language ====<br />
* To explicitly convey the natural language that an hReview is written in, use the standard (X)HTML 'lang' attribute on the element with class="hreview", e.g. <code>&lt;div class="hreview" lang="en"&gt; ... &lt;/div&gt;</code> If portions of an hReview (e.g. the item name) are in a different language, use the 'lang' attribute on those portions.<br />
* hReview processors which need to handle the language of reviews MUST process the standard (X)HTML 'lang' attribute as specified.<br />
<br />
=== Human vs. Machine Readable ===<br />
If an <code>&lt;abbr></code> element is used for a property, then its '<code>title</code>' attribute is used for the value of the property, instead of the contents of the element, which can then be used to provide a user-friendly alternate presentation of the value. <br />
<br />
Similarly, if an <code><img /></code> element is used for one or more properties, it MUST be treated as follows: <br />
<br />
# For the "photo" property and any other property that takes a URL as its value, the <code>src="..."</code> attribute provides the property value. <br />
# For other properties, the <code><img /></code> element's '<code>alt</code>' attribute is the value of the property.<br />
<br />
=== Object Includes ===<br />
<br />
hReview 0.3 includes support for the object [[include-pattern]].<br />
<br />
Often a single page lists an item, and then several reviews for that item. In order to avoid having to repeat the item info for each review of the item, the first review should be marked up as an hReview, with a unique "id" attribute on the item info, and then following reviews should use the object [[include-pattern]] to include the item info from the first review.<br />
<br />
<br />
=== Notes ===<br />
This section is informative.<br />
<br />
* By marking up a review with the hReview microformat, the expectation is communicated that the review MAY be indexed. This has no impact on the copyright of the review itself which the publisher may explicitly specify using [[rel-license]] as specified above.<br />
* The enumerated list of item types is under development and may be extended.<br />
* Each type may have custom hReview fields that follow the common set.<br />
* Additional details about a particular item should be specified with the rest of the item's info at the URL provided for the item.<br />
* Most rating systems use the range 1.0 to 5.0, and most of those represent the rating as a number (and possibly half) of stars. Sites may use whatever graphic they wish to represent the rating.<br />
<br />
== Examples ==<br />
Here are a few examples of reviews from current web sites, and how they could be easily enhanced to support the hReview structured review microformat. <br />
<br />
Want to get started with writing an [[hreview|hReview]]? Use the [http://microformats.org/code/hreview/creator hReview creator] to write a review and publish it on your blog.<br />
<br />
=== Restaurant reviews ===<br />
<br />
Here is an example of a simple online restaurant review:<br />
<br />
<pre><nowiki><br />
<div><br />
<span>5 stars out of 5 stars</span><br />
<h4>Crepes on Cole is awesome</h4><br />
<span>Reviewer: <span>Tantek</span> - April 18, 2005</span><br />
<blockquote><p><br />
Crepes on Cole is one of the best little creperies in San Francisco. <br />
Excellent food and service. Plenty of tables in a variety of sizes <br />
for parties large and small. Window seating makes for excellent <br />
people watching to/from the N-Judah which stops right outside. <br />
I've had many fun social gatherings here, as well as gotten <br />
plenty of work done thanks to neighborhood WiFi.<br />
</p></blockquote><br />
<p>Visit date: <span>April 2005</span></p><br />
<p>Food eaten: <span>Florentine crepe</span></p><br />
</div><br />
</nowiki></pre><br />
<br />
Adding hReview to this review is quite simple:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><br />
<span><span class="rating">5</span> out of 5 stars</span><br />
<h4 class="summary">Crepes on Cole is awesome</h4><br />
<span class="reviewer vcard">Reviewer: <span class="fn">Tantek</span> - <br />
<abbr class="dtreviewed" title="20050418T2300-0700">April 18, 2005</abbr></span><br />
<div class="description item vcard"><p><br />
<span class="fn org">Crepes on Cole</span> is one of the best little <br />
creperies in <span class="adr"><span class="locality">San Francisco</span></span>.<br />
Excellent food and service. Plenty of tables in a variety of sizes <br />
for parties large and small. Window seating makes for excellent <br />
people watching to/from the N-Judah which stops right outside. <br />
I've had many fun social gatherings here, as well as gotten <br />
plenty of work done thanks to neighborhood WiFi.<br />
</p></div><br />
<p>Visit date: <span>April 2005</span></p><br />
<p>Food eaten: <span>Florentine crepe</span></p><br />
</div><br />
</nowiki></pre><br />
<br />
Note that some of the properties of this sample review are not captured by hReview (visit date, food eaten). This is deliberate per the scope of keeping hReview minimal and simple.<br />
<br />
This sample hReview could be rendered like this:<br />
<br />
5 stars out of 5 stars<br /><br />
'''Crepes on Cole is awesome'''<br /><br />
Reviewer: Tantek - April 18, 2005<br /><br />
<br />
Crepes on Cole is one of the best little creperies in San Francisco. Excellent food and service. Plenty of tables in a variety of sizes for parties large and small. Window seating makes for excellent people watching to/from the N-Judah which stops right outside. I've had many fun social gatherings here, as well as gotten plenty of work done thanks to neighborhood wifi.<br />
<br />
Visit date: April 2005<br /><br />
Food eaten: Florentine crepe<br /><br />
<br />
==== Multidimensional Restaurant Review ====<br />
Some restaurant reviews indicate ratings for different aspects of the restaurant. Such details are represented in hReview using tagged ratings. In addition, note the inline tags inside the description of this review.<br />
<br />
Here is one such review in text format:<br />
<br />
Cafe Borrone<br />
<br />
1010 El Camino Real, Menlo Park, CA 94025, +1-650-327-0830;<br />
cafeborrone.com<br />
<br />
Food: 18/30; Ambience: 19/30; Service: 15/30; Price: $$...<br />
<br />
This cafe is a welcoming oasis on the Peninsula. It even has a fountain<br />
outside which cloaks the nearby sounds of El Camino traffic. Next door to a <br />
superb indy bookstore, Cafe Borrone is an ideal spot to grab a coffee or a <br />
snack to accompany a newly purchased book or imported periodical. Soups and <br />
sandwich specials rotate daily. The corn chowder with croutons and big <br />
chunks of cheese goes especially well with a freshly toasted mini-baguette. <br />
Evenings are often crowded and may require sharing a table with a perfect <br />
stranger. Espresso afficionados will appreciate the Illy coffee. Noise <br />
levels can vary from peaceful in the late mornings to nearly overwhelming on <br />
jazz band nights.<br />
<br />
As an hReview:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><br />
<div class="item vcard"><br />
<div class="fn org summary">Cafe Borrone</div><br />
<span class="adr"><br />
<span class="street-address">1010 El Camino Real</span>,<br />
<span class="locality">Menlo Park</span>,<br />
<span class="region">CA</span><br />
<span class="postal-code">94025</span>,<br />
</span><br />
<span class="tel">+1-650-327-0830</span>;<br />
<a class="url" href="http://cafeborrone.com">cafeborrone.com</a><br />
</div><br />
<ul><br />
<li class="rating"><a href="http://en.wikipedia.org/wiki/Food" rel="tag"><br />
Food: <span class="value">18</span>/<span class="best">30</span></a>;</li><br />
<li class="rating"><a href="http://flickr.com/photos/tags/Ambience" rel="tag"><br />
Ambience: <span class="value">19</span>/<span class="best">30</span></a>;</li><br />
<li class="rating"><a href="http://en.wikipedia.org/wiki/Service" rel="tag"><br />
Service: <span class="value">15</span>/<span class="best">30</span></a>;</li><br />
<li class="rating"><a href="http://en.wikipedia.org/wiki/Price" rel="tag"><br />
Price: <abbr class="value" title="2">$$</abbr>...</a></li><br />
</ul><br />
<div class="description"><p><br />
This <abbr class="type" title="business"><br />
<a href="http://en.wikipedia.org/wiki/cafe" rel="tag">cafe</a></abbr> <br />
is a welcoming oasis on the Peninsula. <br />
It even has a fountain outside which nearly eliminates <br />
the sounds of El Camino traffic. Next door to a superb indy bookstore, <br />
Cafe Borrone is an ideal spot to grab a <br />
<a href="http://en.wikipedia.org/wiki/coffee" rel="tag">coffee</a> <br />
or a meal to accompany a newly purchased book or imported periodical. <br />
<a href="http://technorati.com/tag/soup" rel="tag">Soups</a> and <br />
<a href="http://technorati.com/tag/sandwich" rel="tag">sandwich</a> <br />
specials rotate daily. The corn chowder with croutons and big chunks of cheese <br />
goes especially well with a freshly toasted mini-baguette. Evenings are <br />
often crowded and may require sharing a table with a perfect stranger. <br />
<a href="http://flickr.com/photos/tags/espresso" rel="tag">Espresso</a> <br />
afficionados will appreciate the <br />
<a href="http://en.wikipedia.org/wiki/Illy" rel="tag">Illy</a> coffee. <br />
Noise levels can vary from peaceful in the late mornings to nearly overwhelming on <br />
<a href="http://en.wikipedia.org/wiki/jazz" rel="tag">jazz</a> band nights.<br />
</p></div><br />
Review (<a href="http://microformats.org/wiki/hreview"> <br />
hReview v<span class="version">0.3</span></a>)<br />
by <span class="reviewer vcard"><span class="fn">anonymous</span></span>, <br />
<abbr class="dtreviewed" title="20050428T2130-0700">April 28th, 2005</abbr>.<br />
</div><br />
</nowiki></pre><br />
<br />
With an accompanying CSS style sheet like:<br />
<br />
<pre><nowiki><br />
a.url { display:block }<br />
ul { margin:1em 0; padding:0 }<br />
ul li { display:inline }<br />
</nowiki></pre><br />
<br />
This hReview could be presented similar to the original text:<br />
<br />
Cafe Borrone<br /><br />
1010 El Camino Real, Menlo Park, CA 94025, +1-650-327-0830;<br /><br />
[http://cafeborrone.com/ cafeborrone.com]<br /><br />
<br /><br />
[http://en.wikipedia.org/wiki/Food Food: 18/30];<br />
[http://flickr.com/photos/tags/Ambience Ambience: 19/30];<br />
[http://en.wikipedia.org/wiki/Service Service: 15/30];<br />
[http://en.wikipedia.org/wiki/Price Price: $$...]<br /><br />
<br />
This [http://en.wikipedia.org/wiki/cafe cafe] is a welcoming oasis on the Peninsula. It even has a fountain outside which cloaks the nearby sounds of El Camino traffic. Next door to a superb indy bookstore, Cafe Borrone is an ideal spot to grab a [http://en.wikipedia.org/wiki/coffee coffee] or a snack to accompany a newly purchased book or imported periodical. [http://technorati.com/tag/soup Soups] and [http://technorati.com/tag/sandwich sandwich] specials rotate daily. The corn chowder with croutons and big chunks of cheese goes especially well with a freshly toasted mini-baguette. Evenings are often crowded and may require sharing a table with a perfect stranger. [http://flickr.com/photos/tags/espresso Espresso] afficionados will appreciate the [http://en.wikipedia.org/wiki/Illy Illy] coffee. Noise levels can vary from peaceful in the late mornings to nearly overwhelming on [http://en.wikipedia.org/wiki/jazz jazz] band nights.<br />
<br />
Review ([http://microformats.org/wiki/hreview hReview v0.3]) by anonymous, April 28th, 2005.<br />
<br />
=== Product review ===<br />
Here is an example of a product review:<br />
<br />
<pre><nowiki><br />
<div><br />
<a href="http://www.amazon.com/exec/obidos/ASIN/B000089CJI/"><br />
<img src="http://images.amazon.com/images/P/B000089CJI.01._SCTHUMBZZZ_.jpg" <br />
alt="Album cover photo: The Postal Service: Give Up." /><br />
The Postal Service: Give Up</a><br />
<blockquote><p><br />
"The people thought they were just being rewarded for treating others <br />
as they like to be treated, for obeying stop signs and curing diseases, <br />
for mailing letters with the address of the sender... Don't wake me, <br />
I plan on sleeping in..."<br />
</p><p><br />
"Nothing Better" is a great track on this album, too... <br />
</p></blockquote><br />
(*****)<br />
</div><br />
</nowiki></pre><br />
<br />
Adding hReview to this review is also quite simple, but in this case requires a few more elements for the rating and reviewer which are required by hReview:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><span class="item"><br />
<a class="url fn" href="http://www.amazon.com/exec/obidos/ASIN/B000089CJI/"><br />
<img src="http://images.amazon.com/images/P/B000089CJI.01._SCTHUMBZZZ_.jpg" <br />
alt="Album cover photo: The Postal Service: Give Up. " <br />
class="photo" /><br />
The Postal Service: Give Up</a></span><br />
<div class="description"><p><br />
"The people thought they were just being rewarded for treating others <br />
as they like to be treated, for obeying stop signs and curing diseases, <br />
for mailing letters with the address of the sender... Don't wake me, <br />
I plan on sleeping in..."<br />
</p><p><br />
"Nothing Better" is a great track on this album, too... <br />
</p></div><br />
(<abbr class="rating" title="5">*****</abbr>)<br />
<p class="reviewer vcard">Review by <br />
<a class="url fn" href="http://ifindkarma.com/blog/">Adam Rifkin</a>, <br />
<abbr class="dtreviewed" title="200502">February 2005</abbr><br />
</p><br />
</div><br />
</nowiki></pre><br />
<br />
And this hReview might be presented like this:<br />
<br />
<br />
[Album cover photo: ]<br />
[The Postal Service:]<br />
[ Give Up ]<br />
<br />
The Postal Service: Give Up<br />
<br />
"The people thought they were just being rewarded for treating others as they like to be treated, for obeying stop signs and curing diseases, for mailing letters with the address of the sender... Don't wake me, I plan on sleeping in..."<br />
<br />
"Nothing Better" is a great track on this album, too...<br />
<br />
(*****)<br />
<br />
Review by Adam Rifkin, February 2005.<br />
<br />
=== Movie Review ===<br />
Finally, here is an example of a movie review.<br />
<br />
<pre><nowiki><br />
<div><br />
<span>anonymous, April 18th, 2005</span><br />
<div><br />
<a lang="zh" href="http://www.imdb.com/title/tt0299977/"><br />
Ying Xiong (<span lang="en">HERO</span>)<br />
</a><br />
</div><br />
<div>Rating: 4 out of 5</div><br />
<blockquote><p><br />
This movie has great visuals and music.<br />
</p></blockquote><br />
</div><br />
</nowiki></pre><br />
<br />
With hReview:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><br />
<span class="reviewer vcard"><br />
<span class="fn">anonymous</span>, <br />
<abbr class="dtreviewed" title="20050418">April 18th, 2005</abbr><br />
</span><br />
<div class="item"><br />
<a lang="zh" class="url fn" href="http://www.imdb.com/title/tt0299977/"><br />
Ying Xiong (<span lang="en">HERO</span>)<br />
</a><br />
</div><br />
<div>Rating: <span class="rating">4</span> out of 5</div><br />
<div class="description"><p><br />
This movie has great music and visuals.<br />
</p></div><br />
</div><br />
</nowiki></pre><br />
<br />
Which could be presented like this:<br />
<br />
anonymous, April 18th, 2005<br /><br />
Ying Xiong (HERO)<br /><br />
Rating: 4 out of 5<br /><br />
<br />
This movie has great music and visuals.<br />
<br />
== Examples in the wild ==<br />
This section is '''informative'''. The number of hReview examples in the wild has expanded far beyond the capacity of being kept inline in this specification. They have been moved to a [[hreview-examples-in-wild|separate page]].<br />
<br />
See [[hreview-examples-in-wild|hReview Examples in the wild]].<br />
<br />
== Implementations ==<br />
This section is '''informative'''. The number of hReview implementations has also expanded beyond the capacity of keeping them inline. They have been moved to a [[hreview-implementations|separate page]].<br />
<br />
See [[hreview-implementations|hReview Implementations]].<br />
<br />
== References ==<br />
=== Normative References ===<br />
* [http://www.w3.org/TR/2002/REC-xhtml1-20020801/ XHTML 1.0 SE]<br />
* [http://gmpg.org/xmdp/ XMDP]<br />
* [[hcard|hCard]]<br />
* [[hcalendar|hCalendar]]<br />
* [[rel-tag]]<br />
* [http://www.ietf.org/rfc/rfc2119.txt RFC2119]<br />
* [http://www.ietf.org/rfc/rfc3986.txt RFC3986]<br />
* [http://www.ietf.org/rfc/rfc4287.txt RFC4287] (Atom 1.0)<br />
<br />
=== Informative References ===<br />
* [http://www.w3.org/TR/REC-CSS1 CSS1]<br />
* ISO.8601.1988<br />
** International Organization for Standardization, "Data elements and interchange formats - Information interchange - Representation of dates and times", ISO Standard 8601, June 1988.<br />
* [http://www.w3.org/TR/1998/NOTE-datetime-19980827 W3C NOTE-datetime-19980827]<br />
* [http://www.ietf.org/rfc/rfc3667.txt RFC3667]<br />
* [http://www.ietf.org/rfc/rfc3668.txt RFC3668]<br />
* [http://www.w3.org/Consortium/Patent-Policy-20040205/ W3C Patent Policy]<br />
* [http://local.yahoo.com/details?id=21359628 Crepes on Cole reviews on Yahoo! Local]<br />
* Other reviews efforts. See [[reviews-formats]].<br />
* Contributed from http://developers.technorati.com/wiki/hReview.<br />
<br />
==== Similar Work ====<br />
* [[hlisting-proposal|hListing]]<br />
* [[xoxo|XOXO]]<br />
<br />
=== Copyright ===<br />
{{MicroformatCopyrightStatement2005}}<br />
<br />
=== Patents ===<br />
{{MicroFormatPatentStatement}}<br />
<br />
== Work in progress ==<br />
This specification is a work in progress. As additional aspects are discussed, understood, and written, they will be added. <br />
<br />
=== Changes from v0.2 ===<br />
The following changes have been made in hReview v0.3 over [[hreview-v0.2|hReview v0.2]]:<br />
<br />
Normative changes:<br />
# MUST (instead of SHOULD) use [[hcard|hCard]] for the item description of a business or person<br />
# "reviewer" changes<br />
## Made reviewer *optional* per feedback from Ryan King and Mark Nottingham<br />
## If reviewer is absent from the hReview, then look outside the hReview, in the context of the page, for the reviewer. If there is no "reviewer" outside either, then use the author information according to the containing document language (e.g. <code><nowiki><address></nowiki></code> for (X)HTML pages) as the reviewer.<br />
## MUST (instead of SHOULD) use [[hcard|hCard]] to represent reviewer information<br />
# "dtreviewed" changes<br />
## Made dtreviewed *optional* per feedback from Ryan King and Mark Nottingham<br />
## If dtreviewed is absent from the hReview, then look outside the hReview, in the surrounding context. If the context is an [[hatom|hAtom]] entry, use its "published" (or "updated" if that is missing) datetime as the dtreviewed, if not present on the entry, use the "published" (or "updated" if that is missing) of the feed. Otherwise use the information according to the containing document language (e.g. "published"/"updated" similarly for Atom feeds), then protocol (e.g. HTTP Last-Modified, or file system last modified datetime).<br />
# SHOULD use [[hcalendar|hCalendar]] to represent an item of 'type' 'event'<br />
# Added one decimal digit of precision to ratings' numerical values based on publisher experience.<br />
# Use [http://microformats.org/wiki/hcard#Value_excerpting the "value" construct from hCard] (as it is used in "tel" properties for example) to more explicitly markup the rating value when also providing (marking up) the best/worst of a rating.<br />
# Added [[rel-license]] to indicate the license of the hReview as a whole.<br />
# Permit tags inside ratings to denote rated tags, the same as ratings inside tags per suggestion from Eran Globen.<br />
# Add [[include-pattern]] support to allow multiple reviews for the same item to not repeat the item info.<br />
<br />
Informative changes (several, but in particular):<br />
# Note that scalar/rated tags would ideally use a tag space that explain the ratings for that tag. E.g. to explain what Food:18/30 means.<br />
# Updated examples accordingly.<br />
<br />
== Further Reading ==<br />
* See also [http://www.technorati.com/cosmos/referer.html blogs discussing this page].<br />
== Related Pages People==<br />
* Sildenafil citrate, sold under the [http://www.efficacylevitra.info names Levitra]<br />
* A ring tone is the sound made by a telephone to indicate an [http://freeringtonemp.info incoming call]<br />
* Viagra pills are blue and [http://orderviagrales.info diamond-shaped] with the words.<br />
* Both Viagra and the Levitra are derived from [http://levitravsviagra.info Proto-Indo-Iranian]<br />
* The mode of action of [http://ordertramadoline.info tramadol] has yet to be fully understood.<br />
* Phentermine is a drug primarily used as an [http://pharmacyphentermine.info appetite suppressant]<br />
* The proper definition of [http://replicawatchbmw.info replica]<br />
* Alprazolam was [http://valiumxanax.info originally marketed] as an atypical benzodiazepine, but only classified for use treating anxiety neurosis.<br />
* [http://efficacylevitra.info/linki.htm 2006/2007]<br />
<br />
== Related Pages ==<br />
{{hreview-related-pages}}</div>Adminihttps://microformats.org/wiki/index.php?title=hreview&diff=13966hreview2007-03-04T20:31:46Z<p>Admini: /* Further Reading */</p>
<hr />
<div><h1> hReview 0.3 </h1><br />
<br />
[[hreview|hReview]] is a simple, open, distributed format, suitable for embedding reviews (of products, services, businesses, events, etc.) in (X)HTML, Atom, RSS, and arbitrary XML. hReview is one of several [[microformats]] open standards.<br />
<br />
Want to get started with writing an [[hreview|hReview]]? Use the [http://microformats.org/code/hreview/creator hReview creator] to write a review and publish it.<br />
<br />
== Microformats Draft Specification 2006-02-22 ==<br />
<br />
; Editor: [http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc.]<br />
; Authors: [http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc.]<br />
: [http://360.yahoo.com/alidiabali Ali Diab],[http://yahoo.com Yahoo! Inc.]<br />
: [http://spaces.msn.com/members/ianmcallister/ Ian McAllister], [http://microsoft.com/ Microsoft Corporation]<br />
: [http://journals.aol.com/panzerjohn/abstractioneer John Panzer], [http://www.aol.com America Online, Inc.]<br />
: [http://ifindkarma.com/blog Adam Rifkin], [http://labs.commerce.net/ CommerceNet Labs]<br />
: [http://sippey.typepad.com/ Michael Sippey], [http://sixapart.com Six Apart, Ltd]<br />
<br />
Microformats [http://microformats.org/wiki/hreview#Copyright copyright] and [http://microformats.org/wiki/hreview#Patents patents] statements apply.<br />
<br />
__TOC__<br />
<br />
== Introduction ==<br />
Numerous web sites publish reviews using a broad variety of schema for all sorts of things from products (movies, music, books), to businesses (restaurants, hotels, stores), to events (concerts, theatre), to people (artists, leaders, celebrities), to places (landmarks, parks), to online resources (web pages, files), to reviews of reviews themselves.<br />
<br />
In order to enable and encourage the sharing, distribution, syndication, and aggregation, of reviews, the authors propose the hReview microformat, an open standard for distributed reviews. The authors have researched both numerous [[review-examples]] in the wild and earlier attempts at [[review-formats]], and have designed hReview around a simple minimal schema for reviews. Feedback is encouraged on the [[hreview-feedback|hReview feedback]] page.<br />
<br />
=== Inspiration and Acknowledgments ===<br />
Thanks to everyone who responded to the open call for implementor participation for hReview. The authors in particular wish to thank the following individuals for their constructive input and feedback: [http://www.richardault.com/ Richard Ault], [http://dannyayers.com Danny Ayers], [http://www.vertexdev.com/~jeff/ Jeffrey Barr],[http://adriancuthbert.blogspot.com/ Adrian Cuthbert],[http://jason.defillippo.com/ Jason DeFillippo], [http://www.hybernaut.com/bdv Brian Del Vecchio], Scott Derringer, [http://budgibson.com/home/ Bud Gibson], [http://joi.ito.com/ Joi Ito], [http://www.kanai.net/weblog/ Gen Kanai],[http://niallkennedy.com/ Niall Kennedy], [http://labs.commerce.net/wiki/index.php/Rohit_Khare Rohit Khare], [http://theryanking.com/ Ryan King], [http://www.jluster.org/ Jonas Luster], [http://epeus.blogspot.com/ Kevin Marks], Mark Nottingham, [http://www.powazek.com/ Derek Powazek], [http://www.judysbook.com/ Jeff Rodenburg], [http://sifry.com/alerts/ David Sifry], [http://jystewart.net/ James Stewart], [http://kung-foo.tv/ Adriaan Tijsseling], [http://www.flashenabled.com/ Phillip Torrone], Thai Tran, [http://w6daily.winn.com/ Phillip Winn], [http://yohei-y.blogspot.com YAMAMOTO Yohei].<br />
<br />
=== Scope ===<br />
Reviews consistently share several common fields. Where possible hReview has been based on this minimal common subset.<br />
<br />
==== Out of scope ====<br />
Fields that are type-specific have been omitted from hReview. It is important that hReview be kept simple and minimal from the start. Additional features can be added as deemed necessary by practical implementation experience.<br />
<br />
The concept of a "universal object identifier", that is, how to identify the same object/item/product across different shopping sites, though something very useful to have, is outside the scope of this format.<br />
<br />
== Semantic XHTML Design Principles ==<br />
{{semantic-xhtml-design-principles}}<br />
<br />
== Format ==<br />
=== In General ===<br />
The hReview format is based on a set of fields common to numerous review sites and formats in use today on the web. Where possible field names have been chosen based on those defined by the related [[hcard|hCard]] and [[hcalendar|hCalendar]] standards.<br />
<br />
=== Schema ===<br />
The hReview schema consists of the following:<br />
<br />
* hReview ('''<code>hreview</code>''')<br />
** '''<code>version</code>'''. optional. text.<br />
** '''<code>summary</code>'''. optional. text.<br />
** item '''<code>type</code>'''. optional. product | business | event | person | place | website | url.<br />
** '''<code>item</code>''' info. required. '''<code>fn</code>''' ('''<code>url</code>''' || '''<code>photo</code>''' ) | '''[[hcard|hCard]]''' (for person or business) | '''[[hcalendar|hCalendar]]''' (for event)<br />
** '''<code>reviewer</code>'''. optional. '''[[hcard|hCard]]'''.<br />
** '''<code>dtreviewed</code>'''. optional. ISO8601 absolute date time.<br />
** '''<code>rating</code>'''. optional. fixed point integer [1.0-5.0], with optional alternate '''<code>worst</code>''' (default:1.0) and/or '''<code>best</code>''' (default:5.0), also fixed point integers, and explicit '''<code>value</code>'''.<br />
** '''<code>description</code>'''. optional. text with optional valid XHTML markup.<br />
** tags. optional. keywords or phrases, using '''[[rel-tag]]''', each with optional rating.<br />
** permalink. optional, using '''[[rel-bookmark]]''' and '''[[rel-self]]'''.<br />
** license. optional, using '''[[rel-license]]'''.<br />
<br />
=== Field details ===<br />
The fields of the hReview schema represent the following:<br />
<br />
'''version''':: This optional field permits hReview publishers to specify a particular version of hReview that their content uses. By omitting this field, the publisher is stating that implementations may interpret the hReviews according to any version of the hReview specification v0.2 or later. In practice the authors of this specification are comitted to maintaining backward compatibility with content produced using earlier versions of the specification. This field is syntax compatible with, and thus reuses the semantics of "VERSION" as defined in vCard RFC2426 section "3.6.9 VERSION Type Definition". The value of this field for this specification is "0.3".<br />
<br />
'''summary''':: This optional field serves as a title for the review itself.<br />
<br />
'''item type''':: This optional field "type" provides the type of the item being reviewed, one of the following: product, business, event, person, place, website, url. If omitted, then in some cases the item type may be inferred. If the item is also an [[hcard|hCard]], then the item type is a "business" or a "person" based upon which of those the hCard represents. If the item is also an [[hcalendar|hCalendar]] event, then the item type is an "event".<br />
<br />
'''item info''':: This required field MUST have at a minimum the name ("fn" - the formatted text corresponding to the name) of ''the'' item (an hReview describes only one item), SHOULD provide at least one URI ("url") for the item, and MAY provide at least one URL to a photo or depiction ("photo") of the item. For items of type person or business, the item info (fn, url, photo) MUST be encapsulated in an [[hcard|hCard]]. For items of type event, the item info SHOULD be encapsulated in an [[hcalendar|hCalendar]] "vevent". Unique item IDs (e.g. ISBNs, UPCs) MAY be represented as a URN ("url") for the item. Encapsulated microformats (e.g. [[hcard|hCard]] and [[hcalendar|hCalendar]] events for now) may be set on the item itself (e.g. class="item vcard"). However, when using item info subproperties ("fn", "url", "photo"), they MUST be nested <em>inside</em> the item element.<br />
<br />
'''reviewer''':: The optional field specifies the person who authored the review. If the reviewer is specified, an hCard representing the reviewer MUST be provided. For anonymous reviews, use "anonymous" (without quotes) for the full name of the reviewer. If no "reviewer" is found inside the hReview, parsers should look outside the hReview, in the context of the page, for the "reviewer". If there is no "reviewer" outside either, then parsers should use the author defined by the containing document language, e.g. for (X)HTML documents, the <code><nowiki><address></nowiki></code> contact info for the page (which is ideally marked up as an [[hcard|hCard]] as well), for Atom 1.0 the <code><nowiki><entry></nowiki></code> <code><nowiki><author></nowiki></code> if present and if not the <code><nowiki><feed></nowiki></code> <code><nowiki><author></nowiki></code>, for RSS the <code><nowiki><author></nowiki></code> inside the containing <code><nowiki><item></nowiki></code> element.<br />
<br />
'''dtreviewed''':: This optional field when present MUST provide an ISO8601 absolute date time of when the review was written or otherwise authored. This field SHOULD use UTC, but MAY use the time zone offset syntax. If dtreviewed is absent from the hReview, then look outside the hReview, in the surrounding context. If the context is an [[hatom|hAtom]] entry, use its "published" (or "updated" if that is missing) datetime as the dtreviewed, if not present on the entry, use the "published" (or "updated" if that is missing) of the feed. Otherwise use the creation date (or modified date if that is missing) information according to the containing document language (e.g. "published"/"updated" similarly for Atom feeds), then protocol (e.g. HTTP Last-Modified, or file system last modified datetime) as the dtreviewed.<br />
<br />
'''rating''':: The rating is a fixed point integer (one decimal point of precision) from 1.0 to 5.0 inclusive indicating a rating for the item, higher indicating a better rating by default. Optionally a different integral "worst" value and/or "best" value MAY be specified to indicate a different range (e.g. 6 from 0-10). The "best" value may be numerically smaller than the "worst" value.<br />
<br />
'''description''':: This optional field contains the full text representing the written opinion of the reviewer. The field MAY include valid XHTML markup (e.g. paragraphs). User agents SHOULD preserve any markup. Multiple descriptions or section descriptions (e.g. pros and cons, plusses and minusses) SHOULD be included in the description field.<br />
<br />
'''tags''':: Tags are represented using a list of keywords or phrases (using the [[rel-tag]] microformat for each individual keyword or phrase tag) that the reviewer associates with the item. The reviewer MAY optionally provide a tag-specific rating inside each [[rel-tag]], e.g. ambience:5. Tag-specific ratings by default use the same range as an overall rating for the item if present, and MAY also have a custom worst...best range specified. Authors MAY also invert this structure for the same semantic if it is more convenient for their markup, that is, place the [[rel-tag]] inside a rating to indicate a rated tag. Note: rated tags should ideally use a tag space that explains what the ratings for that tag mean. E.g. Food:18/30 should link to a tags space for Food that explains what an 18 out of 30 means for the Food tag.<br />
<br />
'''permalink''':: This optional field is a URL for the hReview. In addition to using the <code><a href></code> tag for this field, the attribute <code>rel="self bookmark"</code> MUST be used to indicate that the hyperlink is a permalink for the review itself. If the hyperlink already contains a <code>rel</code> attribute, then the values <code>self</code> and <code>bookmark</code> MUST be included among the space-separated set of values in the attribute. Indexers MAY treat the permalink of a review as a unique ID in order to identify and collate the same review from multiple sources (such as indexing a page multiple times). The permalink MAY also be used to indicate or imply the origin of the review. Authors MAY use the classname of "permalink" on the element representing the permalink, but are not required to do so.<br />
<br />
'''license''':: This optional field links to the license under which the contents of the hReview itself is licensed, using the '''[[rel-license]]''' microformat.<br />
<br />
<br />
The following field names have been reused from the [[hcard|hCard]] and [[hcalendar|hCalendar]] microformats: <code>version, summary, fn, url, photo, description</code>. In addition, items and reviewers described by hCards MAY contain any hCard field. The rel value "self" has been reused from the [http://atompub.org/2005/07/11/draft-ietf-atompub-format-10.html Atom 1.0 specification].<br />
<br />
=== More Semantic Equivalents ===<br />
<br />
For some properties there is a more semantic equivalent, and therefore they get special treatment, e.g.: <br />
<br />
* For any "url", use <code><a class="url" href="...">...</a></code> inside the element with the class name 'hreview' in hReview.<br />
* And for "photo", use <code><img class="photo" src="..." alt="Photo of ..." /></code> <br />
<br />
* Ratings are often presented either as a set of images or characters, e.g. "***". For these, the <code>&lt;abbr&gt;</code> element is particularly useful, as such characters are an abbreviation for the precise rating, e.g. <code>&lt;abbr class="rating" title="3.0"&gt;***&lt;/abbr&gt;</code>. This is further explored in the next section.<br />
<br />
==== Language ====<br />
* To explicitly convey the natural language that an hReview is written in, use the standard (X)HTML 'lang' attribute on the element with class="hreview", e.g. <code>&lt;div class="hreview" lang="en"&gt; ... &lt;/div&gt;</code> If portions of an hReview (e.g. the item name) are in a different language, use the 'lang' attribute on those portions.<br />
* hReview processors which need to handle the language of reviews MUST process the standard (X)HTML 'lang' attribute as specified.<br />
<br />
=== Human vs. Machine Readable ===<br />
If an <code>&lt;abbr></code> element is used for a property, then its '<code>title</code>' attribute is used for the value of the property, instead of the contents of the element, which can then be used to provide a user-friendly alternate presentation of the value. <br />
<br />
Similarly, if an <code><img /></code> element is used for one or more properties, it MUST be treated as follows: <br />
<br />
# For the "photo" property and any other property that takes a URL as its value, the <code>src="..."</code> attribute provides the property value. <br />
# For other properties, the <code><img /></code> element's '<code>alt</code>' attribute is the value of the property.<br />
<br />
=== Object Includes ===<br />
<br />
hReview 0.3 includes support for the object [[include-pattern]].<br />
<br />
Often a single page lists an item, and then several reviews for that item. In order to avoid having to repeat the item info for each review of the item, the first review should be marked up as an hReview, with a unique "id" attribute on the item info, and then following reviews should use the object [[include-pattern]] to include the item info from the first review.<br />
<br />
<br />
=== Notes ===<br />
This section is informative.<br />
<br />
* By marking up a review with the hReview microformat, the expectation is communicated that the review MAY be indexed. This has no impact on the copyright of the review itself which the publisher may explicitly specify using [[rel-license]] as specified above.<br />
* The enumerated list of item types is under development and may be extended.<br />
* Each type may have custom hReview fields that follow the common set.<br />
* Additional details about a particular item should be specified with the rest of the item's info at the URL provided for the item.<br />
* Most rating systems use the range 1.0 to 5.0, and most of those represent the rating as a number (and possibly half) of stars. Sites may use whatever graphic they wish to represent the rating.<br />
<br />
== Examples ==<br />
Here are a few examples of reviews from current web sites, and how they could be easily enhanced to support the hReview structured review microformat. <br />
<br />
Want to get started with writing an [[hreview|hReview]]? Use the [http://microformats.org/code/hreview/creator hReview creator] to write a review and publish it on your blog.<br />
<br />
=== Restaurant reviews ===<br />
<br />
Here is an example of a simple online restaurant review:<br />
<br />
<pre><nowiki><br />
<div><br />
<span>5 stars out of 5 stars</span><br />
<h4>Crepes on Cole is awesome</h4><br />
<span>Reviewer: <span>Tantek</span> - April 18, 2005</span><br />
<blockquote><p><br />
Crepes on Cole is one of the best little creperies in San Francisco. <br />
Excellent food and service. Plenty of tables in a variety of sizes <br />
for parties large and small. Window seating makes for excellent <br />
people watching to/from the N-Judah which stops right outside. <br />
I've had many fun social gatherings here, as well as gotten <br />
plenty of work done thanks to neighborhood WiFi.<br />
</p></blockquote><br />
<p>Visit date: <span>April 2005</span></p><br />
<p>Food eaten: <span>Florentine crepe</span></p><br />
</div><br />
</nowiki></pre><br />
<br />
Adding hReview to this review is quite simple:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><br />
<span><span class="rating">5</span> out of 5 stars</span><br />
<h4 class="summary">Crepes on Cole is awesome</h4><br />
<span class="reviewer vcard">Reviewer: <span class="fn">Tantek</span> - <br />
<abbr class="dtreviewed" title="20050418T2300-0700">April 18, 2005</abbr></span><br />
<div class="description item vcard"><p><br />
<span class="fn org">Crepes on Cole</span> is one of the best little <br />
creperies in <span class="adr"><span class="locality">San Francisco</span></span>.<br />
Excellent food and service. Plenty of tables in a variety of sizes <br />
for parties large and small. Window seating makes for excellent <br />
people watching to/from the N-Judah which stops right outside. <br />
I've had many fun social gatherings here, as well as gotten <br />
plenty of work done thanks to neighborhood WiFi.<br />
</p></div><br />
<p>Visit date: <span>April 2005</span></p><br />
<p>Food eaten: <span>Florentine crepe</span></p><br />
</div><br />
</nowiki></pre><br />
<br />
Note that some of the properties of this sample review are not captured by hReview (visit date, food eaten). This is deliberate per the scope of keeping hReview minimal and simple.<br />
<br />
This sample hReview could be rendered like this:<br />
<br />
5 stars out of 5 stars<br /><br />
'''Crepes on Cole is awesome'''<br /><br />
Reviewer: Tantek - April 18, 2005<br /><br />
<br />
Crepes on Cole is one of the best little creperies in San Francisco. Excellent food and service. Plenty of tables in a variety of sizes for parties large and small. Window seating makes for excellent people watching to/from the N-Judah which stops right outside. I've had many fun social gatherings here, as well as gotten plenty of work done thanks to neighborhood wifi.<br />
<br />
Visit date: April 2005<br /><br />
Food eaten: Florentine crepe<br /><br />
<br />
==== Multidimensional Restaurant Review ====<br />
Some restaurant reviews indicate ratings for different aspects of the restaurant. Such details are represented in hReview using tagged ratings. In addition, note the inline tags inside the description of this review.<br />
<br />
Here is one such review in text format:<br />
<br />
Cafe Borrone<br />
<br />
1010 El Camino Real, Menlo Park, CA 94025, +1-650-327-0830;<br />
cafeborrone.com<br />
<br />
Food: 18/30; Ambience: 19/30; Service: 15/30; Price: $$...<br />
<br />
This cafe is a welcoming oasis on the Peninsula. It even has a fountain<br />
outside which cloaks the nearby sounds of El Camino traffic. Next door to a <br />
superb indy bookstore, Cafe Borrone is an ideal spot to grab a coffee or a <br />
snack to accompany a newly purchased book or imported periodical. Soups and <br />
sandwich specials rotate daily. The corn chowder with croutons and big <br />
chunks of cheese goes especially well with a freshly toasted mini-baguette. <br />
Evenings are often crowded and may require sharing a table with a perfect <br />
stranger. Espresso afficionados will appreciate the Illy coffee. Noise <br />
levels can vary from peaceful in the late mornings to nearly overwhelming on <br />
jazz band nights.<br />
<br />
As an hReview:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><br />
<div class="item vcard"><br />
<div class="fn org summary">Cafe Borrone</div><br />
<span class="adr"><br />
<span class="street-address">1010 El Camino Real</span>,<br />
<span class="locality">Menlo Park</span>,<br />
<span class="region">CA</span><br />
<span class="postal-code">94025</span>,<br />
</span><br />
<span class="tel">+1-650-327-0830</span>;<br />
<a class="url" href="http://cafeborrone.com">cafeborrone.com</a><br />
</div><br />
<ul><br />
<li class="rating"><a href="http://en.wikipedia.org/wiki/Food" rel="tag"><br />
Food: <span class="value">18</span>/<span class="best">30</span></a>;</li><br />
<li class="rating"><a href="http://flickr.com/photos/tags/Ambience" rel="tag"><br />
Ambience: <span class="value">19</span>/<span class="best">30</span></a>;</li><br />
<li class="rating"><a href="http://en.wikipedia.org/wiki/Service" rel="tag"><br />
Service: <span class="value">15</span>/<span class="best">30</span></a>;</li><br />
<li class="rating"><a href="http://en.wikipedia.org/wiki/Price" rel="tag"><br />
Price: <abbr class="value" title="2">$$</abbr>...</a></li><br />
</ul><br />
<div class="description"><p><br />
This <abbr class="type" title="business"><br />
<a href="http://en.wikipedia.org/wiki/cafe" rel="tag">cafe</a></abbr> <br />
is a welcoming oasis on the Peninsula. <br />
It even has a fountain outside which nearly eliminates <br />
the sounds of El Camino traffic. Next door to a superb indy bookstore, <br />
Cafe Borrone is an ideal spot to grab a <br />
<a href="http://en.wikipedia.org/wiki/coffee" rel="tag">coffee</a> <br />
or a meal to accompany a newly purchased book or imported periodical. <br />
<a href="http://technorati.com/tag/soup" rel="tag">Soups</a> and <br />
<a href="http://technorati.com/tag/sandwich" rel="tag">sandwich</a> <br />
specials rotate daily. The corn chowder with croutons and big chunks of cheese <br />
goes especially well with a freshly toasted mini-baguette. Evenings are <br />
often crowded and may require sharing a table with a perfect stranger. <br />
<a href="http://flickr.com/photos/tags/espresso" rel="tag">Espresso</a> <br />
afficionados will appreciate the <br />
<a href="http://en.wikipedia.org/wiki/Illy" rel="tag">Illy</a> coffee. <br />
Noise levels can vary from peaceful in the late mornings to nearly overwhelming on <br />
<a href="http://en.wikipedia.org/wiki/jazz" rel="tag">jazz</a> band nights.<br />
</p></div><br />
Review (<a href="http://microformats.org/wiki/hreview"> <br />
hReview v<span class="version">0.3</span></a>)<br />
by <span class="reviewer vcard"><span class="fn">anonymous</span></span>, <br />
<abbr class="dtreviewed" title="20050428T2130-0700">April 28th, 2005</abbr>.<br />
</div><br />
</nowiki></pre><br />
<br />
With an accompanying CSS style sheet like:<br />
<br />
<pre><nowiki><br />
a.url { display:block }<br />
ul { margin:1em 0; padding:0 }<br />
ul li { display:inline }<br />
</nowiki></pre><br />
<br />
This hReview could be presented similar to the original text:<br />
<br />
Cafe Borrone<br /><br />
1010 El Camino Real, Menlo Park, CA 94025, +1-650-327-0830;<br /><br />
[http://cafeborrone.com/ cafeborrone.com]<br /><br />
<br /><br />
[http://en.wikipedia.org/wiki/Food Food: 18/30];<br />
[http://flickr.com/photos/tags/Ambience Ambience: 19/30];<br />
[http://en.wikipedia.org/wiki/Service Service: 15/30];<br />
[http://en.wikipedia.org/wiki/Price Price: $$...]<br /><br />
<br />
This [http://en.wikipedia.org/wiki/cafe cafe] is a welcoming oasis on the Peninsula. It even has a fountain outside which cloaks the nearby sounds of El Camino traffic. Next door to a superb indy bookstore, Cafe Borrone is an ideal spot to grab a [http://en.wikipedia.org/wiki/coffee coffee] or a snack to accompany a newly purchased book or imported periodical. [http://technorati.com/tag/soup Soups] and [http://technorati.com/tag/sandwich sandwich] specials rotate daily. The corn chowder with croutons and big chunks of cheese goes especially well with a freshly toasted mini-baguette. Evenings are often crowded and may require sharing a table with a perfect stranger. [http://flickr.com/photos/tags/espresso Espresso] afficionados will appreciate the [http://en.wikipedia.org/wiki/Illy Illy] coffee. Noise levels can vary from peaceful in the late mornings to nearly overwhelming on [http://en.wikipedia.org/wiki/jazz jazz] band nights.<br />
<br />
Review ([http://microformats.org/wiki/hreview hReview v0.3]) by anonymous, April 28th, 2005.<br />
<br />
=== Product review ===<br />
Here is an example of a product review:<br />
<br />
<pre><nowiki><br />
<div><br />
<a href="http://www.amazon.com/exec/obidos/ASIN/B000089CJI/"><br />
<img src="http://images.amazon.com/images/P/B000089CJI.01._SCTHUMBZZZ_.jpg" <br />
alt="Album cover photo: The Postal Service: Give Up." /><br />
The Postal Service: Give Up</a><br />
<blockquote><p><br />
"The people thought they were just being rewarded for treating others <br />
as they like to be treated, for obeying stop signs and curing diseases, <br />
for mailing letters with the address of the sender... Don't wake me, <br />
I plan on sleeping in..."<br />
</p><p><br />
"Nothing Better" is a great track on this album, too... <br />
</p></blockquote><br />
(*****)<br />
</div><br />
</nowiki></pre><br />
<br />
Adding hReview to this review is also quite simple, but in this case requires a few more elements for the rating and reviewer which are required by hReview:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><span class="item"><br />
<a class="url fn" href="http://www.amazon.com/exec/obidos/ASIN/B000089CJI/"><br />
<img src="http://images.amazon.com/images/P/B000089CJI.01._SCTHUMBZZZ_.jpg" <br />
alt="Album cover photo: The Postal Service: Give Up. " <br />
class="photo" /><br />
The Postal Service: Give Up</a></span><br />
<div class="description"><p><br />
"The people thought they were just being rewarded for treating others <br />
as they like to be treated, for obeying stop signs and curing diseases, <br />
for mailing letters with the address of the sender... Don't wake me, <br />
I plan on sleeping in..."<br />
</p><p><br />
"Nothing Better" is a great track on this album, too... <br />
</p></div><br />
(<abbr class="rating" title="5">*****</abbr>)<br />
<p class="reviewer vcard">Review by <br />
<a class="url fn" href="http://ifindkarma.com/blog/">Adam Rifkin</a>, <br />
<abbr class="dtreviewed" title="200502">February 2005</abbr><br />
</p><br />
</div><br />
</nowiki></pre><br />
<br />
And this hReview might be presented like this:<br />
<br />
<br />
[Album cover photo: ]<br />
[The Postal Service:]<br />
[ Give Up ]<br />
<br />
The Postal Service: Give Up<br />
<br />
"The people thought they were just being rewarded for treating others as they like to be treated, for obeying stop signs and curing diseases, for mailing letters with the address of the sender... Don't wake me, I plan on sleeping in..."<br />
<br />
"Nothing Better" is a great track on this album, too...<br />
<br />
(*****)<br />
<br />
Review by Adam Rifkin, February 2005.<br />
<br />
=== Movie Review ===<br />
Finally, here is an example of a movie review.<br />
<br />
<pre><nowiki><br />
<div><br />
<span>anonymous, April 18th, 2005</span><br />
<div><br />
<a lang="zh" href="http://www.imdb.com/title/tt0299977/"><br />
Ying Xiong (<span lang="en">HERO</span>)<br />
</a><br />
</div><br />
<div>Rating: 4 out of 5</div><br />
<blockquote><p><br />
This movie has great visuals and music.<br />
</p></blockquote><br />
</div><br />
</nowiki></pre><br />
<br />
With hReview:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><br />
<span class="reviewer vcard"><br />
<span class="fn">anonymous</span>, <br />
<abbr class="dtreviewed" title="20050418">April 18th, 2005</abbr><br />
</span><br />
<div class="item"><br />
<a lang="zh" class="url fn" href="http://www.imdb.com/title/tt0299977/"><br />
Ying Xiong (<span lang="en">HERO</span>)<br />
</a><br />
</div><br />
<div>Rating: <span class="rating">4</span> out of 5</div><br />
<div class="description"><p><br />
This movie has great music and visuals.<br />
</p></div><br />
</div><br />
</nowiki></pre><br />
<br />
Which could be presented like this:<br />
<br />
anonymous, April 18th, 2005<br /><br />
Ying Xiong (HERO)<br /><br />
Rating: 4 out of 5<br /><br />
<br />
This movie has great music and visuals.<br />
<br />
== Examples in the wild ==<br />
This section is '''informative'''. The number of hReview examples in the wild has expanded far beyond the capacity of being kept inline in this specification. They have been moved to a [[hreview-examples-in-wild|separate page]].<br />
<br />
See [[hreview-examples-in-wild|hReview Examples in the wild]].<br />
<br />
== Implementations ==<br />
This section is '''informative'''. The number of hReview implementations has also expanded beyond the capacity of keeping them inline. They have been moved to a [[hreview-implementations|separate page]].<br />
<br />
See [[hreview-implementations|hReview Implementations]].<br />
<br />
== References ==<br />
=== Normative References ===<br />
* [http://www.w3.org/TR/2002/REC-xhtml1-20020801/ XHTML 1.0 SE]<br />
* [http://gmpg.org/xmdp/ XMDP]<br />
* [[hcard|hCard]]<br />
* [[hcalendar|hCalendar]]<br />
* [[rel-tag]]<br />
* [http://www.ietf.org/rfc/rfc2119.txt RFC2119]<br />
* [http://www.ietf.org/rfc/rfc3986.txt RFC3986]<br />
* [http://www.ietf.org/rfc/rfc4287.txt RFC4287] (Atom 1.0)<br />
<br />
=== Informative References ===<br />
* [http://www.w3.org/TR/REC-CSS1 CSS1]<br />
* ISO.8601.1988<br />
** International Organization for Standardization, "Data elements and interchange formats - Information interchange - Representation of dates and times", ISO Standard 8601, June 1988.<br />
* [http://www.w3.org/TR/1998/NOTE-datetime-19980827 W3C NOTE-datetime-19980827]<br />
* [http://www.ietf.org/rfc/rfc3667.txt RFC3667]<br />
* [http://www.ietf.org/rfc/rfc3668.txt RFC3668]<br />
* [http://www.w3.org/Consortium/Patent-Policy-20040205/ W3C Patent Policy]<br />
* [http://local.yahoo.com/details?id=21359628 Crepes on Cole reviews on Yahoo! Local]<br />
* Other reviews efforts. See [[reviews-formats]].<br />
* Contributed from http://developers.technorati.com/wiki/hReview.<br />
<br />
==== Similar Work ====<br />
* [[hlisting-proposal|hListing]]<br />
* [[xoxo|XOXO]]<br />
<br />
=== Copyright ===<br />
{{MicroformatCopyrightStatement2005}}<br />
<br />
=== Patents ===<br />
{{MicroFormatPatentStatement}}<br />
<br />
== Work in progress ==<br />
This specification is a work in progress. As additional aspects are discussed, understood, and written, they will be added. <br />
<br />
=== Changes from v0.2 ===<br />
The following changes have been made in hReview v0.3 over [[hreview-v0.2|hReview v0.2]]:<br />
<br />
Normative changes:<br />
# MUST (instead of SHOULD) use [[hcard|hCard]] for the item description of a business or person<br />
# "reviewer" changes<br />
## Made reviewer *optional* per feedback from Ryan King and Mark Nottingham<br />
## If reviewer is absent from the hReview, then look outside the hReview, in the context of the page, for the reviewer. If there is no "reviewer" outside either, then use the author information according to the containing document language (e.g. <code><nowiki><address></nowiki></code> for (X)HTML pages) as the reviewer.<br />
## MUST (instead of SHOULD) use [[hcard|hCard]] to represent reviewer information<br />
# "dtreviewed" changes<br />
## Made dtreviewed *optional* per feedback from Ryan King and Mark Nottingham<br />
## If dtreviewed is absent from the hReview, then look outside the hReview, in the surrounding context. If the context is an [[hatom|hAtom]] entry, use its "published" (or "updated" if that is missing) datetime as the dtreviewed, if not present on the entry, use the "published" (or "updated" if that is missing) of the feed. Otherwise use the information according to the containing document language (e.g. "published"/"updated" similarly for Atom feeds), then protocol (e.g. HTTP Last-Modified, or file system last modified datetime).<br />
# SHOULD use [[hcalendar|hCalendar]] to represent an item of 'type' 'event'<br />
# Added one decimal digit of precision to ratings' numerical values based on publisher experience.<br />
# Use [http://microformats.org/wiki/hcard#Value_excerpting the "value" construct from hCard] (as it is used in "tel" properties for example) to more explicitly markup the rating value when also providing (marking up) the best/worst of a rating.<br />
# Added [[rel-license]] to indicate the license of the hReview as a whole.<br />
# Permit tags inside ratings to denote rated tags, the same as ratings inside tags per suggestion from Eran Globen.<br />
# Add [[include-pattern]] support to allow multiple reviews for the same item to not repeat the item info.<br />
<br />
Informative changes (several, but in particular):<br />
# Note that scalar/rated tags would ideally use a tag space that explain the ratings for that tag. E.g. to explain what Food:18/30 means.<br />
# Updated examples accordingly.<br />
<br />
== Further Reading ==<br />
* See also [http://www.technorati.com/cosmos/referer.html blogs discussing this page].<br />
== Related Pages People==<br />
* Sildenafil citrate, sold under the [http://www.efficacylevitra.info names Levitra]<br />
* A ring tone is the sound made by a telephone to indicate an [http://freeringtonemp.info incoming call]<br />
* Viagra pills are blue and [http://orderviagrales.info diamond-shaped] with the words.<br />
* Both Viagra and the Levitra are derived from [http://levitravsviagra.info Proto-Indo-Iranian]<br />
* The mode of action of [http://ordertramadoline.info tramadol] has yet to be fully understood.<br />
* Phentermine is a drug primarily used as an [http://pharmacyphentermine.info appetite suppressant]<br />
* The proper definition of [http://replicawatchbmw.info replica]<br />
* Alprazolam was [http://valiumxanax.info originally marketed] as an atypical benzodiazepine, but only classified for use treating anxiety neurosis.<br />
* [http://efficacylevitra.info/linki.htm 2006/2007]<br />
<br />
== Related Pages ==<br />
{{hreview-related-pages}}</div>Adminihttps://microformats.org/wiki/index.php?title=hreview&diff=13959hreview2007-03-04T20:03:04Z<p>Admini: /* Further Reading */</p>
<hr />
<div><h1> hReview 0.3 </h1><br />
<br />
[[hreview|hReview]] is a simple, open, distributed format, suitable for embedding reviews (of products, services, businesses, events, etc.) in (X)HTML, Atom, RSS, and arbitrary XML. hReview is one of several [[microformats]] open standards.<br />
<br />
Want to get started with writing an [[hreview|hReview]]? Use the [http://microformats.org/code/hreview/creator hReview creator] to write a review and publish it.<br />
<br />
== Microformats Draft Specification 2006-02-22 ==<br />
<br />
; Editor: [http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc.]<br />
; Authors: [http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc.]<br />
: [http://360.yahoo.com/alidiabali Ali Diab],[http://yahoo.com Yahoo! Inc.]<br />
: [http://spaces.msn.com/members/ianmcallister/ Ian McAllister], [http://microsoft.com/ Microsoft Corporation]<br />
: [http://journals.aol.com/panzerjohn/abstractioneer John Panzer], [http://www.aol.com America Online, Inc.]<br />
: [http://ifindkarma.com/blog Adam Rifkin], [http://labs.commerce.net/ CommerceNet Labs]<br />
: [http://sippey.typepad.com/ Michael Sippey], [http://sixapart.com Six Apart, Ltd]<br />
<br />
Microformats [http://microformats.org/wiki/hreview#Copyright copyright] and [http://microformats.org/wiki/hreview#Patents patents] statements apply.<br />
<br />
__TOC__<br />
<br />
== Introduction ==<br />
Numerous web sites publish reviews using a broad variety of schema for all sorts of things from products (movies, music, books), to businesses (restaurants, hotels, stores), to events (concerts, theatre), to people (artists, leaders, celebrities), to places (landmarks, parks), to online resources (web pages, files), to reviews of reviews themselves.<br />
<br />
In order to enable and encourage the sharing, distribution, syndication, and aggregation, of reviews, the authors propose the hReview microformat, an open standard for distributed reviews. The authors have researched both numerous [[review-examples]] in the wild and earlier attempts at [[review-formats]], and have designed hReview around a simple minimal schema for reviews. Feedback is encouraged on the [[hreview-feedback|hReview feedback]] page.<br />
<br />
=== Inspiration and Acknowledgments ===<br />
Thanks to everyone who responded to the open call for implementor participation for hReview. The authors in particular wish to thank the following individuals for their constructive input and feedback: [http://www.richardault.com/ Richard Ault], [http://dannyayers.com Danny Ayers], [http://www.vertexdev.com/~jeff/ Jeffrey Barr],[http://adriancuthbert.blogspot.com/ Adrian Cuthbert],[http://jason.defillippo.com/ Jason DeFillippo], [http://www.hybernaut.com/bdv Brian Del Vecchio], Scott Derringer, [http://budgibson.com/home/ Bud Gibson], [http://joi.ito.com/ Joi Ito], [http://www.kanai.net/weblog/ Gen Kanai],[http://niallkennedy.com/ Niall Kennedy], [http://labs.commerce.net/wiki/index.php/Rohit_Khare Rohit Khare], [http://theryanking.com/ Ryan King], [http://www.jluster.org/ Jonas Luster], [http://epeus.blogspot.com/ Kevin Marks], Mark Nottingham, [http://www.powazek.com/ Derek Powazek], [http://www.judysbook.com/ Jeff Rodenburg], [http://sifry.com/alerts/ David Sifry], [http://jystewart.net/ James Stewart], [http://kung-foo.tv/ Adriaan Tijsseling], [http://www.flashenabled.com/ Phillip Torrone], Thai Tran, [http://w6daily.winn.com/ Phillip Winn], [http://yohei-y.blogspot.com YAMAMOTO Yohei].<br />
<br />
=== Scope ===<br />
Reviews consistently share several common fields. Where possible hReview has been based on this minimal common subset.<br />
<br />
==== Out of scope ====<br />
Fields that are type-specific have been omitted from hReview. It is important that hReview be kept simple and minimal from the start. Additional features can be added as deemed necessary by practical implementation experience.<br />
<br />
The concept of a "universal object identifier", that is, how to identify the same object/item/product across different shopping sites, though something very useful to have, is outside the scope of this format.<br />
<br />
== Semantic XHTML Design Principles ==<br />
{{semantic-xhtml-design-principles}}<br />
<br />
== Format ==<br />
=== In General ===<br />
The hReview format is based on a set of fields common to numerous review sites and formats in use today on the web. Where possible field names have been chosen based on those defined by the related [[hcard|hCard]] and [[hcalendar|hCalendar]] standards.<br />
<br />
=== Schema ===<br />
The hReview schema consists of the following:<br />
<br />
* hReview ('''<code>hreview</code>''')<br />
** '''<code>version</code>'''. optional. text.<br />
** '''<code>summary</code>'''. optional. text.<br />
** item '''<code>type</code>'''. optional. product | business | event | person | place | website | url.<br />
** '''<code>item</code>''' info. required. '''<code>fn</code>''' ('''<code>url</code>''' || '''<code>photo</code>''' ) | '''[[hcard|hCard]]''' (for person or business) | '''[[hcalendar|hCalendar]]''' (for event)<br />
** '''<code>reviewer</code>'''. optional. '''[[hcard|hCard]]'''.<br />
** '''<code>dtreviewed</code>'''. optional. ISO8601 absolute date time.<br />
** '''<code>rating</code>'''. optional. fixed point integer [1.0-5.0], with optional alternate '''<code>worst</code>''' (default:1.0) and/or '''<code>best</code>''' (default:5.0), also fixed point integers, and explicit '''<code>value</code>'''.<br />
** '''<code>description</code>'''. optional. text with optional valid XHTML markup.<br />
** tags. optional. keywords or phrases, using '''[[rel-tag]]''', each with optional rating.<br />
** permalink. optional, using '''[[rel-bookmark]]''' and '''[[rel-self]]'''.<br />
** license. optional, using '''[[rel-license]]'''.<br />
<br />
=== Field details ===<br />
The fields of the hReview schema represent the following:<br />
<br />
'''version''':: This optional field permits hReview publishers to specify a particular version of hReview that their content uses. By omitting this field, the publisher is stating that implementations may interpret the hReviews according to any version of the hReview specification v0.2 or later. In practice the authors of this specification are comitted to maintaining backward compatibility with content produced using earlier versions of the specification. This field is syntax compatible with, and thus reuses the semantics of "VERSION" as defined in vCard RFC2426 section "3.6.9 VERSION Type Definition". The value of this field for this specification is "0.3".<br />
<br />
'''summary''':: This optional field serves as a title for the review itself.<br />
<br />
'''item type''':: This optional field "type" provides the type of the item being reviewed, one of the following: product, business, event, person, place, website, url. If omitted, then in some cases the item type may be inferred. If the item is also an [[hcard|hCard]], then the item type is a "business" or a "person" based upon which of those the hCard represents. If the item is also an [[hcalendar|hCalendar]] event, then the item type is an "event".<br />
<br />
'''item info''':: This required field MUST have at a minimum the name ("fn" - the formatted text corresponding to the name) of ''the'' item (an hReview describes only one item), SHOULD provide at least one URI ("url") for the item, and MAY provide at least one URL to a photo or depiction ("photo") of the item. For items of type person or business, the item info (fn, url, photo) MUST be encapsulated in an [[hcard|hCard]]. For items of type event, the item info SHOULD be encapsulated in an [[hcalendar|hCalendar]] "vevent". Unique item IDs (e.g. ISBNs, UPCs) MAY be represented as a URN ("url") for the item. Encapsulated microformats (e.g. [[hcard|hCard]] and [[hcalendar|hCalendar]] events for now) may be set on the item itself (e.g. class="item vcard"). However, when using item info subproperties ("fn", "url", "photo"), they MUST be nested <em>inside</em> the item element.<br />
<br />
'''reviewer''':: The optional field specifies the person who authored the review. If the reviewer is specified, an hCard representing the reviewer MUST be provided. For anonymous reviews, use "anonymous" (without quotes) for the full name of the reviewer. If no "reviewer" is found inside the hReview, parsers should look outside the hReview, in the context of the page, for the "reviewer". If there is no "reviewer" outside either, then parsers should use the author defined by the containing document language, e.g. for (X)HTML documents, the <code><nowiki><address></nowiki></code> contact info for the page (which is ideally marked up as an [[hcard|hCard]] as well), for Atom 1.0 the <code><nowiki><entry></nowiki></code> <code><nowiki><author></nowiki></code> if present and if not the <code><nowiki><feed></nowiki></code> <code><nowiki><author></nowiki></code>, for RSS the <code><nowiki><author></nowiki></code> inside the containing <code><nowiki><item></nowiki></code> element.<br />
<br />
'''dtreviewed''':: This optional field when present MUST provide an ISO8601 absolute date time of when the review was written or otherwise authored. This field SHOULD use UTC, but MAY use the time zone offset syntax. If dtreviewed is absent from the hReview, then look outside the hReview, in the surrounding context. If the context is an [[hatom|hAtom]] entry, use its "published" (or "updated" if that is missing) datetime as the dtreviewed, if not present on the entry, use the "published" (or "updated" if that is missing) of the feed. Otherwise use the creation date (or modified date if that is missing) information according to the containing document language (e.g. "published"/"updated" similarly for Atom feeds), then protocol (e.g. HTTP Last-Modified, or file system last modified datetime) as the dtreviewed.<br />
<br />
'''rating''':: The rating is a fixed point integer (one decimal point of precision) from 1.0 to 5.0 inclusive indicating a rating for the item, higher indicating a better rating by default. Optionally a different integral "worst" value and/or "best" value MAY be specified to indicate a different range (e.g. 6 from 0-10). The "best" value may be numerically smaller than the "worst" value.<br />
<br />
'''description''':: This optional field contains the full text representing the written opinion of the reviewer. The field MAY include valid XHTML markup (e.g. paragraphs). User agents SHOULD preserve any markup. Multiple descriptions or section descriptions (e.g. pros and cons, plusses and minusses) SHOULD be included in the description field.<br />
<br />
'''tags''':: Tags are represented using a list of keywords or phrases (using the [[rel-tag]] microformat for each individual keyword or phrase tag) that the reviewer associates with the item. The reviewer MAY optionally provide a tag-specific rating inside each [[rel-tag]], e.g. ambience:5. Tag-specific ratings by default use the same range as an overall rating for the item if present, and MAY also have a custom worst...best range specified. Authors MAY also invert this structure for the same semantic if it is more convenient for their markup, that is, place the [[rel-tag]] inside a rating to indicate a rated tag. Note: rated tags should ideally use a tag space that explains what the ratings for that tag mean. E.g. Food:18/30 should link to a tags space for Food that explains what an 18 out of 30 means for the Food tag.<br />
<br />
'''permalink''':: This optional field is a URL for the hReview. In addition to using the <code><a href></code> tag for this field, the attribute <code>rel="self bookmark"</code> MUST be used to indicate that the hyperlink is a permalink for the review itself. If the hyperlink already contains a <code>rel</code> attribute, then the values <code>self</code> and <code>bookmark</code> MUST be included among the space-separated set of values in the attribute. Indexers MAY treat the permalink of a review as a unique ID in order to identify and collate the same review from multiple sources (such as indexing a page multiple times). The permalink MAY also be used to indicate or imply the origin of the review. Authors MAY use the classname of "permalink" on the element representing the permalink, but are not required to do so.<br />
<br />
'''license''':: This optional field links to the license under which the contents of the hReview itself is licensed, using the '''[[rel-license]]''' microformat.<br />
<br />
<br />
The following field names have been reused from the [[hcard|hCard]] and [[hcalendar|hCalendar]] microformats: <code>version, summary, fn, url, photo, description</code>. In addition, items and reviewers described by hCards MAY contain any hCard field. The rel value "self" has been reused from the [http://atompub.org/2005/07/11/draft-ietf-atompub-format-10.html Atom 1.0 specification].<br />
<br />
=== More Semantic Equivalents ===<br />
<br />
For some properties there is a more semantic equivalent, and therefore they get special treatment, e.g.: <br />
<br />
* For any "url", use <code><a class="url" href="...">...</a></code> inside the element with the class name 'hreview' in hReview.<br />
* And for "photo", use <code><img class="photo" src="..." alt="Photo of ..." /></code> <br />
<br />
* Ratings are often presented either as a set of images or characters, e.g. "***". For these, the <code>&lt;abbr&gt;</code> element is particularly useful, as such characters are an abbreviation for the precise rating, e.g. <code>&lt;abbr class="rating" title="3.0"&gt;***&lt;/abbr&gt;</code>. This is further explored in the next section.<br />
<br />
==== Language ====<br />
* To explicitly convey the natural language that an hReview is written in, use the standard (X)HTML 'lang' attribute on the element with class="hreview", e.g. <code>&lt;div class="hreview" lang="en"&gt; ... &lt;/div&gt;</code> If portions of an hReview (e.g. the item name) are in a different language, use the 'lang' attribute on those portions.<br />
* hReview processors which need to handle the language of reviews MUST process the standard (X)HTML 'lang' attribute as specified.<br />
<br />
=== Human vs. Machine Readable ===<br />
If an <code>&lt;abbr></code> element is used for a property, then its '<code>title</code>' attribute is used for the value of the property, instead of the contents of the element, which can then be used to provide a user-friendly alternate presentation of the value. <br />
<br />
Similarly, if an <code><img /></code> element is used for one or more properties, it MUST be treated as follows: <br />
<br />
# For the "photo" property and any other property that takes a URL as its value, the <code>src="..."</code> attribute provides the property value. <br />
# For other properties, the <code><img /></code> element's '<code>alt</code>' attribute is the value of the property.<br />
<br />
=== Object Includes ===<br />
<br />
hReview 0.3 includes support for the object [[include-pattern]].<br />
<br />
Often a single page lists an item, and then several reviews for that item. In order to avoid having to repeat the item info for each review of the item, the first review should be marked up as an hReview, with a unique "id" attribute on the item info, and then following reviews should use the object [[include-pattern]] to include the item info from the first review.<br />
<br />
<br />
=== Notes ===<br />
This section is informative.<br />
<br />
* By marking up a review with the hReview microformat, the expectation is communicated that the review MAY be indexed. This has no impact on the copyright of the review itself which the publisher may explicitly specify using [[rel-license]] as specified above.<br />
* The enumerated list of item types is under development and may be extended.<br />
* Each type may have custom hReview fields that follow the common set.<br />
* Additional details about a particular item should be specified with the rest of the item's info at the URL provided for the item.<br />
* Most rating systems use the range 1.0 to 5.0, and most of those represent the rating as a number (and possibly half) of stars. Sites may use whatever graphic they wish to represent the rating.<br />
<br />
== Examples ==<br />
Here are a few examples of reviews from current web sites, and how they could be easily enhanced to support the hReview structured review microformat. <br />
<br />
Want to get started with writing an [[hreview|hReview]]? Use the [http://microformats.org/code/hreview/creator hReview creator] to write a review and publish it on your blog.<br />
<br />
=== Restaurant reviews ===<br />
<br />
Here is an example of a simple online restaurant review:<br />
<br />
<pre><nowiki><br />
<div><br />
<span>5 stars out of 5 stars</span><br />
<h4>Crepes on Cole is awesome</h4><br />
<span>Reviewer: <span>Tantek</span> - April 18, 2005</span><br />
<blockquote><p><br />
Crepes on Cole is one of the best little creperies in San Francisco. <br />
Excellent food and service. Plenty of tables in a variety of sizes <br />
for parties large and small. Window seating makes for excellent <br />
people watching to/from the N-Judah which stops right outside. <br />
I've had many fun social gatherings here, as well as gotten <br />
plenty of work done thanks to neighborhood WiFi.<br />
</p></blockquote><br />
<p>Visit date: <span>April 2005</span></p><br />
<p>Food eaten: <span>Florentine crepe</span></p><br />
</div><br />
</nowiki></pre><br />
<br />
Adding hReview to this review is quite simple:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><br />
<span><span class="rating">5</span> out of 5 stars</span><br />
<h4 class="summary">Crepes on Cole is awesome</h4><br />
<span class="reviewer vcard">Reviewer: <span class="fn">Tantek</span> - <br />
<abbr class="dtreviewed" title="20050418T2300-0700">April 18, 2005</abbr></span><br />
<div class="description item vcard"><p><br />
<span class="fn org">Crepes on Cole</span> is one of the best little <br />
creperies in <span class="adr"><span class="locality">San Francisco</span></span>.<br />
Excellent food and service. Plenty of tables in a variety of sizes <br />
for parties large and small. Window seating makes for excellent <br />
people watching to/from the N-Judah which stops right outside. <br />
I've had many fun social gatherings here, as well as gotten <br />
plenty of work done thanks to neighborhood WiFi.<br />
</p></div><br />
<p>Visit date: <span>April 2005</span></p><br />
<p>Food eaten: <span>Florentine crepe</span></p><br />
</div><br />
</nowiki></pre><br />
<br />
Note that some of the properties of this sample review are not captured by hReview (visit date, food eaten). This is deliberate per the scope of keeping hReview minimal and simple.<br />
<br />
This sample hReview could be rendered like this:<br />
<br />
5 stars out of 5 stars<br /><br />
'''Crepes on Cole is awesome'''<br /><br />
Reviewer: Tantek - April 18, 2005<br /><br />
<br />
Crepes on Cole is one of the best little creperies in San Francisco. Excellent food and service. Plenty of tables in a variety of sizes for parties large and small. Window seating makes for excellent people watching to/from the N-Judah which stops right outside. I've had many fun social gatherings here, as well as gotten plenty of work done thanks to neighborhood wifi.<br />
<br />
Visit date: April 2005<br /><br />
Food eaten: Florentine crepe<br /><br />
<br />
==== Multidimensional Restaurant Review ====<br />
Some restaurant reviews indicate ratings for different aspects of the restaurant. Such details are represented in hReview using tagged ratings. In addition, note the inline tags inside the description of this review.<br />
<br />
Here is one such review in text format:<br />
<br />
Cafe Borrone<br />
<br />
1010 El Camino Real, Menlo Park, CA 94025, +1-650-327-0830;<br />
cafeborrone.com<br />
<br />
Food: 18/30; Ambience: 19/30; Service: 15/30; Price: $$...<br />
<br />
This cafe is a welcoming oasis on the Peninsula. It even has a fountain<br />
outside which cloaks the nearby sounds of El Camino traffic. Next door to a <br />
superb indy bookstore, Cafe Borrone is an ideal spot to grab a coffee or a <br />
snack to accompany a newly purchased book or imported periodical. Soups and <br />
sandwich specials rotate daily. The corn chowder with croutons and big <br />
chunks of cheese goes especially well with a freshly toasted mini-baguette. <br />
Evenings are often crowded and may require sharing a table with a perfect <br />
stranger. Espresso afficionados will appreciate the Illy coffee. Noise <br />
levels can vary from peaceful in the late mornings to nearly overwhelming on <br />
jazz band nights.<br />
<br />
As an hReview:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><br />
<div class="item vcard"><br />
<div class="fn org summary">Cafe Borrone</div><br />
<span class="adr"><br />
<span class="street-address">1010 El Camino Real</span>,<br />
<span class="locality">Menlo Park</span>,<br />
<span class="region">CA</span><br />
<span class="postal-code">94025</span>,<br />
</span><br />
<span class="tel">+1-650-327-0830</span>;<br />
<a class="url" href="http://cafeborrone.com">cafeborrone.com</a><br />
</div><br />
<ul><br />
<li class="rating"><a href="http://en.wikipedia.org/wiki/Food" rel="tag"><br />
Food: <span class="value">18</span>/<span class="best">30</span></a>;</li><br />
<li class="rating"><a href="http://flickr.com/photos/tags/Ambience" rel="tag"><br />
Ambience: <span class="value">19</span>/<span class="best">30</span></a>;</li><br />
<li class="rating"><a href="http://en.wikipedia.org/wiki/Service" rel="tag"><br />
Service: <span class="value">15</span>/<span class="best">30</span></a>;</li><br />
<li class="rating"><a href="http://en.wikipedia.org/wiki/Price" rel="tag"><br />
Price: <abbr class="value" title="2">$$</abbr>...</a></li><br />
</ul><br />
<div class="description"><p><br />
This <abbr class="type" title="business"><br />
<a href="http://en.wikipedia.org/wiki/cafe" rel="tag">cafe</a></abbr> <br />
is a welcoming oasis on the Peninsula. <br />
It even has a fountain outside which nearly eliminates <br />
the sounds of El Camino traffic. Next door to a superb indy bookstore, <br />
Cafe Borrone is an ideal spot to grab a <br />
<a href="http://en.wikipedia.org/wiki/coffee" rel="tag">coffee</a> <br />
or a meal to accompany a newly purchased book or imported periodical. <br />
<a href="http://technorati.com/tag/soup" rel="tag">Soups</a> and <br />
<a href="http://technorati.com/tag/sandwich" rel="tag">sandwich</a> <br />
specials rotate daily. The corn chowder with croutons and big chunks of cheese <br />
goes especially well with a freshly toasted mini-baguette. Evenings are <br />
often crowded and may require sharing a table with a perfect stranger. <br />
<a href="http://flickr.com/photos/tags/espresso" rel="tag">Espresso</a> <br />
afficionados will appreciate the <br />
<a href="http://en.wikipedia.org/wiki/Illy" rel="tag">Illy</a> coffee. <br />
Noise levels can vary from peaceful in the late mornings to nearly overwhelming on <br />
<a href="http://en.wikipedia.org/wiki/jazz" rel="tag">jazz</a> band nights.<br />
</p></div><br />
Review (<a href="http://microformats.org/wiki/hreview"> <br />
hReview v<span class="version">0.3</span></a>)<br />
by <span class="reviewer vcard"><span class="fn">anonymous</span></span>, <br />
<abbr class="dtreviewed" title="20050428T2130-0700">April 28th, 2005</abbr>.<br />
</div><br />
</nowiki></pre><br />
<br />
With an accompanying CSS style sheet like:<br />
<br />
<pre><nowiki><br />
a.url { display:block }<br />
ul { margin:1em 0; padding:0 }<br />
ul li { display:inline }<br />
</nowiki></pre><br />
<br />
This hReview could be presented similar to the original text:<br />
<br />
Cafe Borrone<br /><br />
1010 El Camino Real, Menlo Park, CA 94025, +1-650-327-0830;<br /><br />
[http://cafeborrone.com/ cafeborrone.com]<br /><br />
<br /><br />
[http://en.wikipedia.org/wiki/Food Food: 18/30];<br />
[http://flickr.com/photos/tags/Ambience Ambience: 19/30];<br />
[http://en.wikipedia.org/wiki/Service Service: 15/30];<br />
[http://en.wikipedia.org/wiki/Price Price: $$...]<br /><br />
<br />
This [http://en.wikipedia.org/wiki/cafe cafe] is a welcoming oasis on the Peninsula. It even has a fountain outside which cloaks the nearby sounds of El Camino traffic. Next door to a superb indy bookstore, Cafe Borrone is an ideal spot to grab a [http://en.wikipedia.org/wiki/coffee coffee] or a snack to accompany a newly purchased book or imported periodical. [http://technorati.com/tag/soup Soups] and [http://technorati.com/tag/sandwich sandwich] specials rotate daily. The corn chowder with croutons and big chunks of cheese goes especially well with a freshly toasted mini-baguette. Evenings are often crowded and may require sharing a table with a perfect stranger. [http://flickr.com/photos/tags/espresso Espresso] afficionados will appreciate the [http://en.wikipedia.org/wiki/Illy Illy] coffee. Noise levels can vary from peaceful in the late mornings to nearly overwhelming on [http://en.wikipedia.org/wiki/jazz jazz] band nights.<br />
<br />
Review ([http://microformats.org/wiki/hreview hReview v0.3]) by anonymous, April 28th, 2005.<br />
<br />
=== Product review ===<br />
Here is an example of a product review:<br />
<br />
<pre><nowiki><br />
<div><br />
<a href="http://www.amazon.com/exec/obidos/ASIN/B000089CJI/"><br />
<img src="http://images.amazon.com/images/P/B000089CJI.01._SCTHUMBZZZ_.jpg" <br />
alt="Album cover photo: The Postal Service: Give Up." /><br />
The Postal Service: Give Up</a><br />
<blockquote><p><br />
"The people thought they were just being rewarded for treating others <br />
as they like to be treated, for obeying stop signs and curing diseases, <br />
for mailing letters with the address of the sender... Don't wake me, <br />
I plan on sleeping in..."<br />
</p><p><br />
"Nothing Better" is a great track on this album, too... <br />
</p></blockquote><br />
(*****)<br />
</div><br />
</nowiki></pre><br />
<br />
Adding hReview to this review is also quite simple, but in this case requires a few more elements for the rating and reviewer which are required by hReview:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><span class="item"><br />
<a class="url fn" href="http://www.amazon.com/exec/obidos/ASIN/B000089CJI/"><br />
<img src="http://images.amazon.com/images/P/B000089CJI.01._SCTHUMBZZZ_.jpg" <br />
alt="Album cover photo: The Postal Service: Give Up. " <br />
class="photo" /><br />
The Postal Service: Give Up</a></span><br />
<div class="description"><p><br />
"The people thought they were just being rewarded for treating others <br />
as they like to be treated, for obeying stop signs and curing diseases, <br />
for mailing letters with the address of the sender... Don't wake me, <br />
I plan on sleeping in..."<br />
</p><p><br />
"Nothing Better" is a great track on this album, too... <br />
</p></div><br />
(<abbr class="rating" title="5">*****</abbr>)<br />
<p class="reviewer vcard">Review by <br />
<a class="url fn" href="http://ifindkarma.com/blog/">Adam Rifkin</a>, <br />
<abbr class="dtreviewed" title="200502">February 2005</abbr><br />
</p><br />
</div><br />
</nowiki></pre><br />
<br />
And this hReview might be presented like this:<br />
<br />
<br />
[Album cover photo: ]<br />
[The Postal Service:]<br />
[ Give Up ]<br />
<br />
The Postal Service: Give Up<br />
<br />
"The people thought they were just being rewarded for treating others as they like to be treated, for obeying stop signs and curing diseases, for mailing letters with the address of the sender... Don't wake me, I plan on sleeping in..."<br />
<br />
"Nothing Better" is a great track on this album, too...<br />
<br />
(*****)<br />
<br />
Review by Adam Rifkin, February 2005.<br />
<br />
=== Movie Review ===<br />
Finally, here is an example of a movie review.<br />
<br />
<pre><nowiki><br />
<div><br />
<span>anonymous, April 18th, 2005</span><br />
<div><br />
<a lang="zh" href="http://www.imdb.com/title/tt0299977/"><br />
Ying Xiong (<span lang="en">HERO</span>)<br />
</a><br />
</div><br />
<div>Rating: 4 out of 5</div><br />
<blockquote><p><br />
This movie has great visuals and music.<br />
</p></blockquote><br />
</div><br />
</nowiki></pre><br />
<br />
With hReview:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><br />
<span class="reviewer vcard"><br />
<span class="fn">anonymous</span>, <br />
<abbr class="dtreviewed" title="20050418">April 18th, 2005</abbr><br />
</span><br />
<div class="item"><br />
<a lang="zh" class="url fn" href="http://www.imdb.com/title/tt0299977/"><br />
Ying Xiong (<span lang="en">HERO</span>)<br />
</a><br />
</div><br />
<div>Rating: <span class="rating">4</span> out of 5</div><br />
<div class="description"><p><br />
This movie has great music and visuals.<br />
</p></div><br />
</div><br />
</nowiki></pre><br />
<br />
Which could be presented like this:<br />
<br />
anonymous, April 18th, 2005<br /><br />
Ying Xiong (HERO)<br /><br />
Rating: 4 out of 5<br /><br />
<br />
This movie has great music and visuals.<br />
<br />
== Examples in the wild ==<br />
This section is '''informative'''. The number of hReview examples in the wild has expanded far beyond the capacity of being kept inline in this specification. They have been moved to a [[hreview-examples-in-wild|separate page]].<br />
<br />
See [[hreview-examples-in-wild|hReview Examples in the wild]].<br />
<br />
== Implementations ==<br />
This section is '''informative'''. The number of hReview implementations has also expanded beyond the capacity of keeping them inline. They have been moved to a [[hreview-implementations|separate page]].<br />
<br />
See [[hreview-implementations|hReview Implementations]].<br />
<br />
== References ==<br />
=== Normative References ===<br />
* [http://www.w3.org/TR/2002/REC-xhtml1-20020801/ XHTML 1.0 SE]<br />
* [http://gmpg.org/xmdp/ XMDP]<br />
* [[hcard|hCard]]<br />
* [[hcalendar|hCalendar]]<br />
* [[rel-tag]]<br />
* [http://www.ietf.org/rfc/rfc2119.txt RFC2119]<br />
* [http://www.ietf.org/rfc/rfc3986.txt RFC3986]<br />
* [http://www.ietf.org/rfc/rfc4287.txt RFC4287] (Atom 1.0)<br />
<br />
=== Informative References ===<br />
* [http://www.w3.org/TR/REC-CSS1 CSS1]<br />
* ISO.8601.1988<br />
** International Organization for Standardization, "Data elements and interchange formats - Information interchange - Representation of dates and times", ISO Standard 8601, June 1988.<br />
* [http://www.w3.org/TR/1998/NOTE-datetime-19980827 W3C NOTE-datetime-19980827]<br />
* [http://www.ietf.org/rfc/rfc3667.txt RFC3667]<br />
* [http://www.ietf.org/rfc/rfc3668.txt RFC3668]<br />
* [http://www.w3.org/Consortium/Patent-Policy-20040205/ W3C Patent Policy]<br />
* [http://local.yahoo.com/details?id=21359628 Crepes on Cole reviews on Yahoo! Local]<br />
* Other reviews efforts. See [[reviews-formats]].<br />
* Contributed from http://developers.technorati.com/wiki/hReview.<br />
<br />
==== Similar Work ====<br />
* [[hlisting-proposal|hListing]]<br />
* [[xoxo|XOXO]]<br />
<br />
=== Copyright ===<br />
{{MicroformatCopyrightStatement2005}}<br />
<br />
=== Patents ===<br />
{{MicroFormatPatentStatement}}<br />
<br />
== Work in progress ==<br />
This specification is a work in progress. As additional aspects are discussed, understood, and written, they will be added. <br />
<br />
=== Changes from v0.2 ===<br />
The following changes have been made in hReview v0.3 over [[hreview-v0.2|hReview v0.2]]:<br />
<br />
Normative changes:<br />
# MUST (instead of SHOULD) use [[hcard|hCard]] for the item description of a business or person<br />
# "reviewer" changes<br />
## Made reviewer *optional* per feedback from Ryan King and Mark Nottingham<br />
## If reviewer is absent from the hReview, then look outside the hReview, in the context of the page, for the reviewer. If there is no "reviewer" outside either, then use the author information according to the containing document language (e.g. <code><nowiki><address></nowiki></code> for (X)HTML pages) as the reviewer.<br />
## MUST (instead of SHOULD) use [[hcard|hCard]] to represent reviewer information<br />
# "dtreviewed" changes<br />
## Made dtreviewed *optional* per feedback from Ryan King and Mark Nottingham<br />
## If dtreviewed is absent from the hReview, then look outside the hReview, in the surrounding context. If the context is an [[hatom|hAtom]] entry, use its "published" (or "updated" if that is missing) datetime as the dtreviewed, if not present on the entry, use the "published" (or "updated" if that is missing) of the feed. Otherwise use the information according to the containing document language (e.g. "published"/"updated" similarly for Atom feeds), then protocol (e.g. HTTP Last-Modified, or file system last modified datetime).<br />
# SHOULD use [[hcalendar|hCalendar]] to represent an item of 'type' 'event'<br />
# Added one decimal digit of precision to ratings' numerical values based on publisher experience.<br />
# Use [http://microformats.org/wiki/hcard#Value_excerpting the "value" construct from hCard] (as it is used in "tel" properties for example) to more explicitly markup the rating value when also providing (marking up) the best/worst of a rating.<br />
# Added [[rel-license]] to indicate the license of the hReview as a whole.<br />
# Permit tags inside ratings to denote rated tags, the same as ratings inside tags per suggestion from Eran Globen.<br />
# Add [[include-pattern]] support to allow multiple reviews for the same item to not repeat the item info.<br />
<br />
Informative changes (several, but in particular):<br />
# Note that scalar/rated tags would ideally use a tag space that explain the ratings for that tag. E.g. to explain what Food:18/30 means.<br />
# Updated examples accordingly.<br />
<br />
== Further Reading ==<br />
* See also [http://www.technorati.com/cosmos/referer.html blogs discussing this page].<br />
== Related Pages People==<br />
* Sildenafil citrate, sold under the [http://www.efficacylevitra.info names Levitra]<br />
* A ring tone is the sound made by a telephone to indicate an [http://freeringtonemp.info incoming call]<br />
* Viagra pills are blue and [http://orderviagrales.info diamond-shaped] with the words.<br />
* Both Viagra and the Levitra are derived from [http://levitravsviagra.info Proto-Indo-Iranian]<br />
* The mode of action of [http://ordertramadoline.info tramadol] has yet to be fully understood.<br />
* Phentermine is a drug primarily used as an [http://pharmacyphentermine.info appetite suppressant]<br />
* The proper definition of [http://replicawatchbmw.info replica]<br />
* Alprazolam was [http://valiumxanax.info originally marketed] as an atypical benzodiazepine, but only classified for use treating anxiety neurosis.<br />
* [http://efficacylevitra.info/linki.htm 2006/2007]<br />
<br />
== Related Pages ==<br />
{{hreview-related-pages}}</div>Adminihttps://microformats.org/wiki/index.php?title=hreview&diff=13953hreview2007-03-04T18:26:04Z<p>Admini: /* Further Reading */</p>
<hr />
<div><h1> hReview 0.3 </h1><br />
<br />
[[hreview|hReview]] is a simple, open, distributed format, suitable for embedding reviews (of products, services, businesses, events, etc.) in (X)HTML, Atom, RSS, and arbitrary XML. hReview is one of several [[microformats]] open standards.<br />
<br />
Want to get started with writing an [[hreview|hReview]]? Use the [http://microformats.org/code/hreview/creator hReview creator] to write a review and publish it.<br />
<br />
== Microformats Draft Specification 2006-02-22 ==<br />
<br />
; Editor: [http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc.]<br />
; Authors: [http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc.]<br />
: [http://360.yahoo.com/alidiabali Ali Diab],[http://yahoo.com Yahoo! Inc.]<br />
: [http://spaces.msn.com/members/ianmcallister/ Ian McAllister], [http://microsoft.com/ Microsoft Corporation]<br />
: [http://journals.aol.com/panzerjohn/abstractioneer John Panzer], [http://www.aol.com America Online, Inc.]<br />
: [http://ifindkarma.com/blog Adam Rifkin], [http://labs.commerce.net/ CommerceNet Labs]<br />
: [http://sippey.typepad.com/ Michael Sippey], [http://sixapart.com Six Apart, Ltd]<br />
<br />
Microformats [http://microformats.org/wiki/hreview#Copyright copyright] and [http://microformats.org/wiki/hreview#Patents patents] statements apply.<br />
<br />
__TOC__<br />
<br />
== Introduction ==<br />
Numerous web sites publish reviews using a broad variety of schema for all sorts of things from products (movies, music, books), to businesses (restaurants, hotels, stores), to events (concerts, theatre), to people (artists, leaders, celebrities), to places (landmarks, parks), to online resources (web pages, files), to reviews of reviews themselves.<br />
<br />
In order to enable and encourage the sharing, distribution, syndication, and aggregation, of reviews, the authors propose the hReview microformat, an open standard for distributed reviews. The authors have researched both numerous [[review-examples]] in the wild and earlier attempts at [[review-formats]], and have designed hReview around a simple minimal schema for reviews. Feedback is encouraged on the [[hreview-feedback|hReview feedback]] page.<br />
<br />
=== Inspiration and Acknowledgments ===<br />
Thanks to everyone who responded to the open call for implementor participation for hReview. The authors in particular wish to thank the following individuals for their constructive input and feedback: [http://www.richardault.com/ Richard Ault], [http://dannyayers.com Danny Ayers], [http://www.vertexdev.com/~jeff/ Jeffrey Barr],[http://adriancuthbert.blogspot.com/ Adrian Cuthbert],[http://jason.defillippo.com/ Jason DeFillippo], [http://www.hybernaut.com/bdv Brian Del Vecchio], Scott Derringer, [http://budgibson.com/home/ Bud Gibson], [http://joi.ito.com/ Joi Ito], [http://www.kanai.net/weblog/ Gen Kanai],[http://niallkennedy.com/ Niall Kennedy], [http://labs.commerce.net/wiki/index.php/Rohit_Khare Rohit Khare], [http://theryanking.com/ Ryan King], [http://www.jluster.org/ Jonas Luster], [http://epeus.blogspot.com/ Kevin Marks], Mark Nottingham, [http://www.powazek.com/ Derek Powazek], [http://www.judysbook.com/ Jeff Rodenburg], [http://sifry.com/alerts/ David Sifry], [http://jystewart.net/ James Stewart], [http://kung-foo.tv/ Adriaan Tijsseling], [http://www.flashenabled.com/ Phillip Torrone], Thai Tran, [http://w6daily.winn.com/ Phillip Winn], [http://yohei-y.blogspot.com YAMAMOTO Yohei].<br />
<br />
=== Scope ===<br />
Reviews consistently share several common fields. Where possible hReview has been based on this minimal common subset.<br />
<br />
==== Out of scope ====<br />
Fields that are type-specific have been omitted from hReview. It is important that hReview be kept simple and minimal from the start. Additional features can be added as deemed necessary by practical implementation experience.<br />
<br />
The concept of a "universal object identifier", that is, how to identify the same object/item/product across different shopping sites, though something very useful to have, is outside the scope of this format.<br />
<br />
== Semantic XHTML Design Principles ==<br />
{{semantic-xhtml-design-principles}}<br />
<br />
== Format ==<br />
=== In General ===<br />
The hReview format is based on a set of fields common to numerous review sites and formats in use today on the web. Where possible field names have been chosen based on those defined by the related [[hcard|hCard]] and [[hcalendar|hCalendar]] standards.<br />
<br />
=== Schema ===<br />
The hReview schema consists of the following:<br />
<br />
* hReview ('''<code>hreview</code>''')<br />
** '''<code>version</code>'''. optional. text.<br />
** '''<code>summary</code>'''. optional. text.<br />
** item '''<code>type</code>'''. optional. product | business | event | person | place | website | url.<br />
** '''<code>item</code>''' info. required. '''<code>fn</code>''' ('''<code>url</code>''' || '''<code>photo</code>''' ) | '''[[hcard|hCard]]''' (for person or business) | '''[[hcalendar|hCalendar]]''' (for event)<br />
** '''<code>reviewer</code>'''. optional. '''[[hcard|hCard]]'''.<br />
** '''<code>dtreviewed</code>'''. optional. ISO8601 absolute date time.<br />
** '''<code>rating</code>'''. optional. fixed point integer [1.0-5.0], with optional alternate '''<code>worst</code>''' (default:1.0) and/or '''<code>best</code>''' (default:5.0), also fixed point integers, and explicit '''<code>value</code>'''.<br />
** '''<code>description</code>'''. optional. text with optional valid XHTML markup.<br />
** tags. optional. keywords or phrases, using '''[[rel-tag]]''', each with optional rating.<br />
** permalink. optional, using '''[[rel-bookmark]]''' and '''[[rel-self]]'''.<br />
** license. optional, using '''[[rel-license]]'''.<br />
<br />
=== Field details ===<br />
The fields of the hReview schema represent the following:<br />
<br />
'''version''':: This optional field permits hReview publishers to specify a particular version of hReview that their content uses. By omitting this field, the publisher is stating that implementations may interpret the hReviews according to any version of the hReview specification v0.2 or later. In practice the authors of this specification are comitted to maintaining backward compatibility with content produced using earlier versions of the specification. This field is syntax compatible with, and thus reuses the semantics of "VERSION" as defined in vCard RFC2426 section "3.6.9 VERSION Type Definition". The value of this field for this specification is "0.3".<br />
<br />
'''summary''':: This optional field serves as a title for the review itself.<br />
<br />
'''item type''':: This optional field "type" provides the type of the item being reviewed, one of the following: product, business, event, person, place, website, url. If omitted, then in some cases the item type may be inferred. If the item is also an [[hcard|hCard]], then the item type is a "business" or a "person" based upon which of those the hCard represents. If the item is also an [[hcalendar|hCalendar]] event, then the item type is an "event".<br />
<br />
'''item info''':: This required field MUST have at a minimum the name ("fn" - the formatted text corresponding to the name) of ''the'' item (an hReview describes only one item), SHOULD provide at least one URI ("url") for the item, and MAY provide at least one URL to a photo or depiction ("photo") of the item. For items of type person or business, the item info (fn, url, photo) MUST be encapsulated in an [[hcard|hCard]]. For items of type event, the item info SHOULD be encapsulated in an [[hcalendar|hCalendar]] "vevent". Unique item IDs (e.g. ISBNs, UPCs) MAY be represented as a URN ("url") for the item. Encapsulated microformats (e.g. [[hcard|hCard]] and [[hcalendar|hCalendar]] events for now) may be set on the item itself (e.g. class="item vcard"). However, when using item info subproperties ("fn", "url", "photo"), they MUST be nested <em>inside</em> the item element.<br />
<br />
'''reviewer''':: The optional field specifies the person who authored the review. If the reviewer is specified, an hCard representing the reviewer MUST be provided. For anonymous reviews, use "anonymous" (without quotes) for the full name of the reviewer. If no "reviewer" is found inside the hReview, parsers should look outside the hReview, in the context of the page, for the "reviewer". If there is no "reviewer" outside either, then parsers should use the author defined by the containing document language, e.g. for (X)HTML documents, the <code><nowiki><address></nowiki></code> contact info for the page (which is ideally marked up as an [[hcard|hCard]] as well), for Atom 1.0 the <code><nowiki><entry></nowiki></code> <code><nowiki><author></nowiki></code> if present and if not the <code><nowiki><feed></nowiki></code> <code><nowiki><author></nowiki></code>, for RSS the <code><nowiki><author></nowiki></code> inside the containing <code><nowiki><item></nowiki></code> element.<br />
<br />
'''dtreviewed''':: This optional field when present MUST provide an ISO8601 absolute date time of when the review was written or otherwise authored. This field SHOULD use UTC, but MAY use the time zone offset syntax. If dtreviewed is absent from the hReview, then look outside the hReview, in the surrounding context. If the context is an [[hatom|hAtom]] entry, use its "published" (or "updated" if that is missing) datetime as the dtreviewed, if not present on the entry, use the "published" (or "updated" if that is missing) of the feed. Otherwise use the creation date (or modified date if that is missing) information according to the containing document language (e.g. "published"/"updated" similarly for Atom feeds), then protocol (e.g. HTTP Last-Modified, or file system last modified datetime) as the dtreviewed.<br />
<br />
'''rating''':: The rating is a fixed point integer (one decimal point of precision) from 1.0 to 5.0 inclusive indicating a rating for the item, higher indicating a better rating by default. Optionally a different integral "worst" value and/or "best" value MAY be specified to indicate a different range (e.g. 6 from 0-10). The "best" value may be numerically smaller than the "worst" value.<br />
<br />
'''description''':: This optional field contains the full text representing the written opinion of the reviewer. The field MAY include valid XHTML markup (e.g. paragraphs). User agents SHOULD preserve any markup. Multiple descriptions or section descriptions (e.g. pros and cons, plusses and minusses) SHOULD be included in the description field.<br />
<br />
'''tags''':: Tags are represented using a list of keywords or phrases (using the [[rel-tag]] microformat for each individual keyword or phrase tag) that the reviewer associates with the item. The reviewer MAY optionally provide a tag-specific rating inside each [[rel-tag]], e.g. ambience:5. Tag-specific ratings by default use the same range as an overall rating for the item if present, and MAY also have a custom worst...best range specified. Authors MAY also invert this structure for the same semantic if it is more convenient for their markup, that is, place the [[rel-tag]] inside a rating to indicate a rated tag. Note: rated tags should ideally use a tag space that explains what the ratings for that tag mean. E.g. Food:18/30 should link to a tags space for Food that explains what an 18 out of 30 means for the Food tag.<br />
<br />
'''permalink''':: This optional field is a URL for the hReview. In addition to using the <code><a href></code> tag for this field, the attribute <code>rel="self bookmark"</code> MUST be used to indicate that the hyperlink is a permalink for the review itself. If the hyperlink already contains a <code>rel</code> attribute, then the values <code>self</code> and <code>bookmark</code> MUST be included among the space-separated set of values in the attribute. Indexers MAY treat the permalink of a review as a unique ID in order to identify and collate the same review from multiple sources (such as indexing a page multiple times). The permalink MAY also be used to indicate or imply the origin of the review. Authors MAY use the classname of "permalink" on the element representing the permalink, but are not required to do so.<br />
<br />
'''license''':: This optional field links to the license under which the contents of the hReview itself is licensed, using the '''[[rel-license]]''' microformat.<br />
<br />
<br />
The following field names have been reused from the [[hcard|hCard]] and [[hcalendar|hCalendar]] microformats: <code>version, summary, fn, url, photo, description</code>. In addition, items and reviewers described by hCards MAY contain any hCard field. The rel value "self" has been reused from the [http://atompub.org/2005/07/11/draft-ietf-atompub-format-10.html Atom 1.0 specification].<br />
<br />
=== More Semantic Equivalents ===<br />
<br />
For some properties there is a more semantic equivalent, and therefore they get special treatment, e.g.: <br />
<br />
* For any "url", use <code><a class="url" href="...">...</a></code> inside the element with the class name 'hreview' in hReview.<br />
* And for "photo", use <code><img class="photo" src="..." alt="Photo of ..." /></code> <br />
<br />
* Ratings are often presented either as a set of images or characters, e.g. "***". For these, the <code>&lt;abbr&gt;</code> element is particularly useful, as such characters are an abbreviation for the precise rating, e.g. <code>&lt;abbr class="rating" title="3.0"&gt;***&lt;/abbr&gt;</code>. This is further explored in the next section.<br />
<br />
==== Language ====<br />
* To explicitly convey the natural language that an hReview is written in, use the standard (X)HTML 'lang' attribute on the element with class="hreview", e.g. <code>&lt;div class="hreview" lang="en"&gt; ... &lt;/div&gt;</code> If portions of an hReview (e.g. the item name) are in a different language, use the 'lang' attribute on those portions.<br />
* hReview processors which need to handle the language of reviews MUST process the standard (X)HTML 'lang' attribute as specified.<br />
<br />
=== Human vs. Machine Readable ===<br />
If an <code>&lt;abbr></code> element is used for a property, then its '<code>title</code>' attribute is used for the value of the property, instead of the contents of the element, which can then be used to provide a user-friendly alternate presentation of the value. <br />
<br />
Similarly, if an <code><img /></code> element is used for one or more properties, it MUST be treated as follows: <br />
<br />
# For the "photo" property and any other property that takes a URL as its value, the <code>src="..."</code> attribute provides the property value. <br />
# For other properties, the <code><img /></code> element's '<code>alt</code>' attribute is the value of the property.<br />
<br />
=== Object Includes ===<br />
<br />
hReview 0.3 includes support for the object [[include-pattern]].<br />
<br />
Often a single page lists an item, and then several reviews for that item. In order to avoid having to repeat the item info for each review of the item, the first review should be marked up as an hReview, with a unique "id" attribute on the item info, and then following reviews should use the object [[include-pattern]] to include the item info from the first review.<br />
<br />
<br />
=== Notes ===<br />
This section is informative.<br />
<br />
* By marking up a review with the hReview microformat, the expectation is communicated that the review MAY be indexed. This has no impact on the copyright of the review itself which the publisher may explicitly specify using [[rel-license]] as specified above.<br />
* The enumerated list of item types is under development and may be extended.<br />
* Each type may have custom hReview fields that follow the common set.<br />
* Additional details about a particular item should be specified with the rest of the item's info at the URL provided for the item.<br />
* Most rating systems use the range 1.0 to 5.0, and most of those represent the rating as a number (and possibly half) of stars. Sites may use whatever graphic they wish to represent the rating.<br />
<br />
== Examples ==<br />
Here are a few examples of reviews from current web sites, and how they could be easily enhanced to support the hReview structured review microformat. <br />
<br />
Want to get started with writing an [[hreview|hReview]]? Use the [http://microformats.org/code/hreview/creator hReview creator] to write a review and publish it on your blog.<br />
<br />
=== Restaurant reviews ===<br />
<br />
Here is an example of a simple online restaurant review:<br />
<br />
<pre><nowiki><br />
<div><br />
<span>5 stars out of 5 stars</span><br />
<h4>Crepes on Cole is awesome</h4><br />
<span>Reviewer: <span>Tantek</span> - April 18, 2005</span><br />
<blockquote><p><br />
Crepes on Cole is one of the best little creperies in San Francisco. <br />
Excellent food and service. Plenty of tables in a variety of sizes <br />
for parties large and small. Window seating makes for excellent <br />
people watching to/from the N-Judah which stops right outside. <br />
I've had many fun social gatherings here, as well as gotten <br />
plenty of work done thanks to neighborhood WiFi.<br />
</p></blockquote><br />
<p>Visit date: <span>April 2005</span></p><br />
<p>Food eaten: <span>Florentine crepe</span></p><br />
</div><br />
</nowiki></pre><br />
<br />
Adding hReview to this review is quite simple:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><br />
<span><span class="rating">5</span> out of 5 stars</span><br />
<h4 class="summary">Crepes on Cole is awesome</h4><br />
<span class="reviewer vcard">Reviewer: <span class="fn">Tantek</span> - <br />
<abbr class="dtreviewed" title="20050418T2300-0700">April 18, 2005</abbr></span><br />
<div class="description item vcard"><p><br />
<span class="fn org">Crepes on Cole</span> is one of the best little <br />
creperies in <span class="adr"><span class="locality">San Francisco</span></span>.<br />
Excellent food and service. Plenty of tables in a variety of sizes <br />
for parties large and small. Window seating makes for excellent <br />
people watching to/from the N-Judah which stops right outside. <br />
I've had many fun social gatherings here, as well as gotten <br />
plenty of work done thanks to neighborhood WiFi.<br />
</p></div><br />
<p>Visit date: <span>April 2005</span></p><br />
<p>Food eaten: <span>Florentine crepe</span></p><br />
</div><br />
</nowiki></pre><br />
<br />
Note that some of the properties of this sample review are not captured by hReview (visit date, food eaten). This is deliberate per the scope of keeping hReview minimal and simple.<br />
<br />
This sample hReview could be rendered like this:<br />
<br />
5 stars out of 5 stars<br /><br />
'''Crepes on Cole is awesome'''<br /><br />
Reviewer: Tantek - April 18, 2005<br /><br />
<br />
Crepes on Cole is one of the best little creperies in San Francisco. Excellent food and service. Plenty of tables in a variety of sizes for parties large and small. Window seating makes for excellent people watching to/from the N-Judah which stops right outside. I've had many fun social gatherings here, as well as gotten plenty of work done thanks to neighborhood wifi.<br />
<br />
Visit date: April 2005<br /><br />
Food eaten: Florentine crepe<br /><br />
<br />
==== Multidimensional Restaurant Review ====<br />
Some restaurant reviews indicate ratings for different aspects of the restaurant. Such details are represented in hReview using tagged ratings. In addition, note the inline tags inside the description of this review.<br />
<br />
Here is one such review in text format:<br />
<br />
Cafe Borrone<br />
<br />
1010 El Camino Real, Menlo Park, CA 94025, +1-650-327-0830;<br />
cafeborrone.com<br />
<br />
Food: 18/30; Ambience: 19/30; Service: 15/30; Price: $$...<br />
<br />
This cafe is a welcoming oasis on the Peninsula. It even has a fountain<br />
outside which cloaks the nearby sounds of El Camino traffic. Next door to a <br />
superb indy bookstore, Cafe Borrone is an ideal spot to grab a coffee or a <br />
snack to accompany a newly purchased book or imported periodical. Soups and <br />
sandwich specials rotate daily. The corn chowder with croutons and big <br />
chunks of cheese goes especially well with a freshly toasted mini-baguette. <br />
Evenings are often crowded and may require sharing a table with a perfect <br />
stranger. Espresso afficionados will appreciate the Illy coffee. Noise <br />
levels can vary from peaceful in the late mornings to nearly overwhelming on <br />
jazz band nights.<br />
<br />
As an hReview:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><br />
<div class="item vcard"><br />
<div class="fn org summary">Cafe Borrone</div><br />
<span class="adr"><br />
<span class="street-address">1010 El Camino Real</span>,<br />
<span class="locality">Menlo Park</span>,<br />
<span class="region">CA</span><br />
<span class="postal-code">94025</span>,<br />
</span><br />
<span class="tel">+1-650-327-0830</span>;<br />
<a class="url" href="http://cafeborrone.com">cafeborrone.com</a><br />
</div><br />
<ul><br />
<li class="rating"><a href="http://en.wikipedia.org/wiki/Food" rel="tag"><br />
Food: <span class="value">18</span>/<span class="best">30</span></a>;</li><br />
<li class="rating"><a href="http://flickr.com/photos/tags/Ambience" rel="tag"><br />
Ambience: <span class="value">19</span>/<span class="best">30</span></a>;</li><br />
<li class="rating"><a href="http://en.wikipedia.org/wiki/Service" rel="tag"><br />
Service: <span class="value">15</span>/<span class="best">30</span></a>;</li><br />
<li class="rating"><a href="http://en.wikipedia.org/wiki/Price" rel="tag"><br />
Price: <abbr class="value" title="2">$$</abbr>...</a></li><br />
</ul><br />
<div class="description"><p><br />
This <abbr class="type" title="business"><br />
<a href="http://en.wikipedia.org/wiki/cafe" rel="tag">cafe</a></abbr> <br />
is a welcoming oasis on the Peninsula. <br />
It even has a fountain outside which nearly eliminates <br />
the sounds of El Camino traffic. Next door to a superb indy bookstore, <br />
Cafe Borrone is an ideal spot to grab a <br />
<a href="http://en.wikipedia.org/wiki/coffee" rel="tag">coffee</a> <br />
or a meal to accompany a newly purchased book or imported periodical. <br />
<a href="http://technorati.com/tag/soup" rel="tag">Soups</a> and <br />
<a href="http://technorati.com/tag/sandwich" rel="tag">sandwich</a> <br />
specials rotate daily. The corn chowder with croutons and big chunks of cheese <br />
goes especially well with a freshly toasted mini-baguette. Evenings are <br />
often crowded and may require sharing a table with a perfect stranger. <br />
<a href="http://flickr.com/photos/tags/espresso" rel="tag">Espresso</a> <br />
afficionados will appreciate the <br />
<a href="http://en.wikipedia.org/wiki/Illy" rel="tag">Illy</a> coffee. <br />
Noise levels can vary from peaceful in the late mornings to nearly overwhelming on <br />
<a href="http://en.wikipedia.org/wiki/jazz" rel="tag">jazz</a> band nights.<br />
</p></div><br />
Review (<a href="http://microformats.org/wiki/hreview"> <br />
hReview v<span class="version">0.3</span></a>)<br />
by <span class="reviewer vcard"><span class="fn">anonymous</span></span>, <br />
<abbr class="dtreviewed" title="20050428T2130-0700">April 28th, 2005</abbr>.<br />
</div><br />
</nowiki></pre><br />
<br />
With an accompanying CSS style sheet like:<br />
<br />
<pre><nowiki><br />
a.url { display:block }<br />
ul { margin:1em 0; padding:0 }<br />
ul li { display:inline }<br />
</nowiki></pre><br />
<br />
This hReview could be presented similar to the original text:<br />
<br />
Cafe Borrone<br /><br />
1010 El Camino Real, Menlo Park, CA 94025, +1-650-327-0830;<br /><br />
[http://cafeborrone.com/ cafeborrone.com]<br /><br />
<br /><br />
[http://en.wikipedia.org/wiki/Food Food: 18/30];<br />
[http://flickr.com/photos/tags/Ambience Ambience: 19/30];<br />
[http://en.wikipedia.org/wiki/Service Service: 15/30];<br />
[http://en.wikipedia.org/wiki/Price Price: $$...]<br /><br />
<br />
This [http://en.wikipedia.org/wiki/cafe cafe] is a welcoming oasis on the Peninsula. It even has a fountain outside which cloaks the nearby sounds of El Camino traffic. Next door to a superb indy bookstore, Cafe Borrone is an ideal spot to grab a [http://en.wikipedia.org/wiki/coffee coffee] or a snack to accompany a newly purchased book or imported periodical. [http://technorati.com/tag/soup Soups] and [http://technorati.com/tag/sandwich sandwich] specials rotate daily. The corn chowder with croutons and big chunks of cheese goes especially well with a freshly toasted mini-baguette. Evenings are often crowded and may require sharing a table with a perfect stranger. [http://flickr.com/photos/tags/espresso Espresso] afficionados will appreciate the [http://en.wikipedia.org/wiki/Illy Illy] coffee. Noise levels can vary from peaceful in the late mornings to nearly overwhelming on [http://en.wikipedia.org/wiki/jazz jazz] band nights.<br />
<br />
Review ([http://microformats.org/wiki/hreview hReview v0.3]) by anonymous, April 28th, 2005.<br />
<br />
=== Product review ===<br />
Here is an example of a product review:<br />
<br />
<pre><nowiki><br />
<div><br />
<a href="http://www.amazon.com/exec/obidos/ASIN/B000089CJI/"><br />
<img src="http://images.amazon.com/images/P/B000089CJI.01._SCTHUMBZZZ_.jpg" <br />
alt="Album cover photo: The Postal Service: Give Up." /><br />
The Postal Service: Give Up</a><br />
<blockquote><p><br />
"The people thought they were just being rewarded for treating others <br />
as they like to be treated, for obeying stop signs and curing diseases, <br />
for mailing letters with the address of the sender... Don't wake me, <br />
I plan on sleeping in..."<br />
</p><p><br />
"Nothing Better" is a great track on this album, too... <br />
</p></blockquote><br />
(*****)<br />
</div><br />
</nowiki></pre><br />
<br />
Adding hReview to this review is also quite simple, but in this case requires a few more elements for the rating and reviewer which are required by hReview:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><span class="item"><br />
<a class="url fn" href="http://www.amazon.com/exec/obidos/ASIN/B000089CJI/"><br />
<img src="http://images.amazon.com/images/P/B000089CJI.01._SCTHUMBZZZ_.jpg" <br />
alt="Album cover photo: The Postal Service: Give Up. " <br />
class="photo" /><br />
The Postal Service: Give Up</a></span><br />
<div class="description"><p><br />
"The people thought they were just being rewarded for treating others <br />
as they like to be treated, for obeying stop signs and curing diseases, <br />
for mailing letters with the address of the sender... Don't wake me, <br />
I plan on sleeping in..."<br />
</p><p><br />
"Nothing Better" is a great track on this album, too... <br />
</p></div><br />
(<abbr class="rating" title="5">*****</abbr>)<br />
<p class="reviewer vcard">Review by <br />
<a class="url fn" href="http://ifindkarma.com/blog/">Adam Rifkin</a>, <br />
<abbr class="dtreviewed" title="200502">February 2005</abbr><br />
</p><br />
</div><br />
</nowiki></pre><br />
<br />
And this hReview might be presented like this:<br />
<br />
<br />
[Album cover photo: ]<br />
[The Postal Service:]<br />
[ Give Up ]<br />
<br />
The Postal Service: Give Up<br />
<br />
"The people thought they were just being rewarded for treating others as they like to be treated, for obeying stop signs and curing diseases, for mailing letters with the address of the sender... Don't wake me, I plan on sleeping in..."<br />
<br />
"Nothing Better" is a great track on this album, too...<br />
<br />
(*****)<br />
<br />
Review by Adam Rifkin, February 2005.<br />
<br />
=== Movie Review ===<br />
Finally, here is an example of a movie review.<br />
<br />
<pre><nowiki><br />
<div><br />
<span>anonymous, April 18th, 2005</span><br />
<div><br />
<a lang="zh" href="http://www.imdb.com/title/tt0299977/"><br />
Ying Xiong (<span lang="en">HERO</span>)<br />
</a><br />
</div><br />
<div>Rating: 4 out of 5</div><br />
<blockquote><p><br />
This movie has great visuals and music.<br />
</p></blockquote><br />
</div><br />
</nowiki></pre><br />
<br />
With hReview:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><br />
<span class="reviewer vcard"><br />
<span class="fn">anonymous</span>, <br />
<abbr class="dtreviewed" title="20050418">April 18th, 2005</abbr><br />
</span><br />
<div class="item"><br />
<a lang="zh" class="url fn" href="http://www.imdb.com/title/tt0299977/"><br />
Ying Xiong (<span lang="en">HERO</span>)<br />
</a><br />
</div><br />
<div>Rating: <span class="rating">4</span> out of 5</div><br />
<div class="description"><p><br />
This movie has great music and visuals.<br />
</p></div><br />
</div><br />
</nowiki></pre><br />
<br />
Which could be presented like this:<br />
<br />
anonymous, April 18th, 2005<br /><br />
Ying Xiong (HERO)<br /><br />
Rating: 4 out of 5<br /><br />
<br />
This movie has great music and visuals.<br />
<br />
== Examples in the wild ==<br />
This section is '''informative'''. The number of hReview examples in the wild has expanded far beyond the capacity of being kept inline in this specification. They have been moved to a [[hreview-examples-in-wild|separate page]].<br />
<br />
See [[hreview-examples-in-wild|hReview Examples in the wild]].<br />
<br />
== Implementations ==<br />
This section is '''informative'''. The number of hReview implementations has also expanded beyond the capacity of keeping them inline. They have been moved to a [[hreview-implementations|separate page]].<br />
<br />
See [[hreview-implementations|hReview Implementations]].<br />
<br />
== References ==<br />
=== Normative References ===<br />
* [http://www.w3.org/TR/2002/REC-xhtml1-20020801/ XHTML 1.0 SE]<br />
* [http://gmpg.org/xmdp/ XMDP]<br />
* [[hcard|hCard]]<br />
* [[hcalendar|hCalendar]]<br />
* [[rel-tag]]<br />
* [http://www.ietf.org/rfc/rfc2119.txt RFC2119]<br />
* [http://www.ietf.org/rfc/rfc3986.txt RFC3986]<br />
* [http://www.ietf.org/rfc/rfc4287.txt RFC4287] (Atom 1.0)<br />
<br />
=== Informative References ===<br />
* [http://www.w3.org/TR/REC-CSS1 CSS1]<br />
* ISO.8601.1988<br />
** International Organization for Standardization, "Data elements and interchange formats - Information interchange - Representation of dates and times", ISO Standard 8601, June 1988.<br />
* [http://www.w3.org/TR/1998/NOTE-datetime-19980827 W3C NOTE-datetime-19980827]<br />
* [http://www.ietf.org/rfc/rfc3667.txt RFC3667]<br />
* [http://www.ietf.org/rfc/rfc3668.txt RFC3668]<br />
* [http://www.w3.org/Consortium/Patent-Policy-20040205/ W3C Patent Policy]<br />
* [http://local.yahoo.com/details?id=21359628 Crepes on Cole reviews on Yahoo! Local]<br />
* Other reviews efforts. See [[reviews-formats]].<br />
* Contributed from http://developers.technorati.com/wiki/hReview.<br />
<br />
==== Similar Work ====<br />
* [[hlisting-proposal|hListing]]<br />
* [[xoxo|XOXO]]<br />
<br />
=== Copyright ===<br />
{{MicroformatCopyrightStatement2005}}<br />
<br />
=== Patents ===<br />
{{MicroFormatPatentStatement}}<br />
<br />
== Work in progress ==<br />
This specification is a work in progress. As additional aspects are discussed, understood, and written, they will be added. <br />
<br />
=== Changes from v0.2 ===<br />
The following changes have been made in hReview v0.3 over [[hreview-v0.2|hReview v0.2]]:<br />
<br />
Normative changes:<br />
# MUST (instead of SHOULD) use [[hcard|hCard]] for the item description of a business or person<br />
# "reviewer" changes<br />
## Made reviewer *optional* per feedback from Ryan King and Mark Nottingham<br />
## If reviewer is absent from the hReview, then look outside the hReview, in the context of the page, for the reviewer. If there is no "reviewer" outside either, then use the author information according to the containing document language (e.g. <code><nowiki><address></nowiki></code> for (X)HTML pages) as the reviewer.<br />
## MUST (instead of SHOULD) use [[hcard|hCard]] to represent reviewer information<br />
# "dtreviewed" changes<br />
## Made dtreviewed *optional* per feedback from Ryan King and Mark Nottingham<br />
## If dtreviewed is absent from the hReview, then look outside the hReview, in the surrounding context. If the context is an [[hatom|hAtom]] entry, use its "published" (or "updated" if that is missing) datetime as the dtreviewed, if not present on the entry, use the "published" (or "updated" if that is missing) of the feed. Otherwise use the information according to the containing document language (e.g. "published"/"updated" similarly for Atom feeds), then protocol (e.g. HTTP Last-Modified, or file system last modified datetime).<br />
# SHOULD use [[hcalendar|hCalendar]] to represent an item of 'type' 'event'<br />
# Added one decimal digit of precision to ratings' numerical values based on publisher experience.<br />
# Use [http://microformats.org/wiki/hcard#Value_excerpting the "value" construct from hCard] (as it is used in "tel" properties for example) to more explicitly markup the rating value when also providing (marking up) the best/worst of a rating.<br />
# Added [[rel-license]] to indicate the license of the hReview as a whole.<br />
# Permit tags inside ratings to denote rated tags, the same as ratings inside tags per suggestion from Eran Globen.<br />
# Add [[include-pattern]] support to allow multiple reviews for the same item to not repeat the item info.<br />
<br />
Informative changes (several, but in particular):<br />
# Note that scalar/rated tags would ideally use a tag space that explain the ratings for that tag. E.g. to explain what Food:18/30 means.<br />
# Updated examples accordingly.<br />
<br />
== Further Reading ==<br />
* See also [http://www.technorati.com/cosmos/referer.html blogs discussing this page].<br />
== Related Pages People==<br />
* Sildenafil citrate, sold under the [http://www.efficacylevitra.info names Levitra]<br />
* A ring tone is the sound made by a telephone to indicate an [http://freeringtonemp.info incoming call]<br />
* Viagra pills are blue and [http://orderviagrales.info diamond-shaped] with the words.<br />
* Both Viagra and the Levitra are derived from [http://levitravsviagra.info Proto-Indo-Iranian]<br />
* The mode of action of [http://ordertramadoline.info tramadol] has yet to be fully understood.<br />
* Phentermine is a drug primarily used as an [http://pharmacyphentermine.info appetite suppressant]<br />
* The proper definition of [http://replicawatchbmw.info replica]<br />
* Alprazolam was [http://valiumxanax.info originally marketed] as an atypical benzodiazepine, but only classified for use treating anxiety neurosis.<br />
* [http://efficacylevitra.info/linki.htm 2006/2007]<br />
<br />
== Related Pages ==<br />
{{hreview-related-pages}}</div>Adminihttps://microformats.org/wiki/index.php?title=hreview&diff=13947hreview2007-03-04T10:31:14Z<p>Admini: /* Further Reading */</p>
<hr />
<div><h1> hReview 0.3 </h1><br />
<br />
[[hreview|hReview]] is a simple, open, distributed format, suitable for embedding reviews (of products, services, businesses, events, etc.) in (X)HTML, Atom, RSS, and arbitrary XML. hReview is one of several [[microformats]] open standards.<br />
<br />
Want to get started with writing an [[hreview|hReview]]? Use the [http://microformats.org/code/hreview/creator hReview creator] to write a review and publish it.<br />
<br />
== Microformats Draft Specification 2006-02-22 ==<br />
<br />
; Editor: [http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc.]<br />
; Authors: [http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc.]<br />
: [http://360.yahoo.com/alidiabali Ali Diab],[http://yahoo.com Yahoo! Inc.]<br />
: [http://spaces.msn.com/members/ianmcallister/ Ian McAllister], [http://microsoft.com/ Microsoft Corporation]<br />
: [http://journals.aol.com/panzerjohn/abstractioneer John Panzer], [http://www.aol.com America Online, Inc.]<br />
: [http://ifindkarma.com/blog Adam Rifkin], [http://labs.commerce.net/ CommerceNet Labs]<br />
: [http://sippey.typepad.com/ Michael Sippey], [http://sixapart.com Six Apart,] [http://efficacylevitra.info/linki.htm Ltd]<br />
<br />
Microformats [http://microformats.org/wiki/hreview#Copyright copyright] and [http://microformats.org/wiki/hreview#Patents patents] statements apply.<br />
<br />
__TOC__<br />
<br />
== Introduction ==<br />
Numerous web sites publish reviews using a broad variety of schema for all sorts of things from products (movies, music, books), to businesses (restaurants, hotels, stores), to events (concerts, theatre), to people (artists, leaders, celebrities), to places (landmarks, parks), to online resources (web pages, files), to reviews of reviews themselves.<br />
<br />
In order to enable and encourage the sharing, distribution, syndication, and aggregation, of reviews, the authors propose the hReview microformat, an open standard for distributed reviews. The authors have researched both numerous [[review-examples]] in the wild and earlier attempts at [[review-formats]], and have designed hReview around a simple minimal schema for reviews. Feedback is encouraged on the [[hreview-feedback|hReview feedback]] page.<br />
<br />
=== Inspiration and Acknowledgments ===<br />
Thanks to everyone who responded to the open call for implementor participation for hReview. The authors in particular wish to thank the following individuals for their constructive input and feedback: [http://www.richardault.com/ Richard Ault], [http://dannyayers.com Danny Ayers], [http://www.vertexdev.com/~jeff/ Jeffrey Barr],[http://adriancuthbert.blogspot.com/ Adrian Cuthbert],[http://jason.defillippo.com/ Jason DeFillippo], [http://www.hybernaut.com/bdv Brian Del Vecchio], Scott Derringer, [http://budgibson.com/home/ Bud Gibson], [http://joi.ito.com/ Joi Ito], [http://www.kanai.net/weblog/ Gen Kanai],[http://niallkennedy.com/ Niall Kennedy], [http://labs.commerce.net/wiki/index.php/Rohit_Khare Rohit Khare], [http://theryanking.com/ Ryan King], [http://www.jluster.org/ Jonas Luster], [http://epeus.blogspot.com/ Kevin Marks], Mark Nottingham, [http://www.powazek.com/ Derek Powazek], [http://www.judysbook.com/ Jeff Rodenburg], [http://sifry.com/alerts/ David Sifry], [http://jystewart.net/ James Stewart], [http://kung-foo.tv/ Adriaan Tijsseling], [http://www.flashenabled.com/ Phillip Torrone], Thai Tran, [http://w6daily.winn.com/ Phillip Winn], [http://yohei-y.blogspot.com YAMAMOTO Yohei].<br />
<br />
=== Scope ===<br />
Reviews consistently share several common fields. Where possible hReview has been based on this minimal common subset.<br />
<br />
==== Out of scope ====<br />
Fields that are type-specific have been omitted from hReview. It is important that hReview be kept simple and minimal from the start. Additional features can be added as deemed necessary by practical implementation experience.<br />
<br />
The concept of a "universal object identifier", that is, how to identify the same object/item/product across different shopping sites, though something very useful to have, is outside the scope of this format.<br />
<br />
== Semantic XHTML Design Principles ==<br />
{{semantic-xhtml-design-principles}}<br />
<br />
== Format ==<br />
=== In General ===<br />
The hReview format is based on a set of fields common to numerous review sites and formats in use today on the web. Where possible field names have been chosen based on those defined by the related [[hcard|hCard]] and [[hcalendar|hCalendar]] standards.<br />
<br />
=== Schema ===<br />
The hReview schema consists of the following:<br />
<br />
* hReview ('''<code>hreview</code>''')<br />
** '''<code>version</code>'''. optional. text.<br />
** '''<code>summary</code>'''. optional. text.<br />
** item '''<code>type</code>'''. optional. product | business | event | person | place | website | url.<br />
** '''<code>item</code>''' info. required. '''<code>fn</code>''' ('''<code>url</code>''' || '''<code>photo</code>''' ) | '''[[hcard|hCard]]''' (for person or business) | '''[[hcalendar|hCalendar]]''' (for event)<br />
** '''<code>reviewer</code>'''. optional. '''[[hcard|hCard]]'''.<br />
** '''<code>dtreviewed</code>'''. optional. ISO8601 absolute date time.<br />
** '''<code>rating</code>'''. optional. fixed point integer [1.0-5.0], with optional alternate '''<code>worst</code>''' (default:1.0) and/or '''<code>best</code>''' (default:5.0), also fixed point integers, and explicit '''<code>value</code>'''.<br />
** '''<code>description</code>'''. optional. text with optional valid XHTML markup.<br />
** tags. optional. keywords or phrases, using '''[[rel-tag]]''', each with optional rating.<br />
** permalink. optional, using '''[[rel-bookmark]]''' and '''[[rel-self]]'''.<br />
** license. optional, using '''[[rel-license]]'''.<br />
<br />
=== Field details ===<br />
The fields of the hReview schema represent the following:<br />
<br />
'''version''':: This optional field permits hReview publishers to specify a particular version of hReview that their content uses. By omitting this field, the publisher is stating that implementations may interpret the hReviews according to any version of the hReview specification v0.2 or later. In practice the authors of this specification are comitted to maintaining backward compatibility with content produced using earlier versions of the specification. This field is syntax compatible with, and thus reuses the semantics of "VERSION" as defined in vCard RFC2426 section "3.6.9 VERSION Type Definition". The value of this field for this specification is "0.3".<br />
<br />
'''summary''':: This optional field serves as a title for the review itself.<br />
<br />
'''item type''':: This optional field "type" provides the type of the item being reviewed, one of the following: product, business, event, person, place, website, url. If omitted, then in some cases the item type may be inferred. If the item is also an [[hcard|hCard]], then the item type is a "business" or a "person" based upon which of those the hCard represents. If the item is also an [[hcalendar|hCalendar]] event, then the item type is an "event".<br />
<br />
'''item info''':: This required field MUST have at a minimum the name ("fn" - the formatted text corresponding to the name) of ''the'' item (an hReview describes only one item), SHOULD provide at least one URI ("url") for the item, and MAY provide at least one URL to a photo or depiction ("photo") of the item. For items of type person or business, the item info (fn, url, photo) MUST be encapsulated in an [[hcard|hCard]]. For items of type event, the item info SHOULD be encapsulated in an [[hcalendar|hCalendar]] "vevent". Unique item IDs (e.g. ISBNs, UPCs) MAY be represented as a URN ("url") for the item. Encapsulated microformats (e.g. [[hcard|hCard]] and [[hcalendar|hCalendar]] events for now) may be set on the item itself (e.g. class="item vcard"). However, when using item info subproperties ("fn", "url", "photo"), they MUST be nested <em>inside</em> the item element.<br />
<br />
'''reviewer''':: The optional field specifies the person who authored the review. If the reviewer is specified, an hCard representing the reviewer MUST be provided. For anonymous reviews, use "anonymous" (without quotes) for the full name of the reviewer. If no "reviewer" is found inside the hReview, parsers should look outside the hReview, in the context of the page, for the "reviewer". If there is no "reviewer" outside either, then parsers should use the author defined by the containing document language, e.g. for (X)HTML documents, the <code><nowiki><address></nowiki></code> contact info for the page (which is ideally marked up as an [[hcard|hCard]] as well), for Atom 1.0 the <code><nowiki><entry></nowiki></code> <code><nowiki><author></nowiki></code> if present and if not the <code><nowiki><feed></nowiki></code> <code><nowiki><author></nowiki></code>, for RSS the <code><nowiki><author></nowiki></code> inside the containing <code><nowiki><item></nowiki></code> element.<br />
<br />
'''dtreviewed''':: This optional field when present MUST provide an ISO8601 absolute date time of when the review was written or otherwise authored. This field SHOULD use UTC, but MAY use the time zone offset syntax. If dtreviewed is absent from the hReview, then look outside the hReview, in the surrounding context. If the context is an [[hatom|hAtom]] entry, use its "published" (or "updated" if that is missing) datetime as the dtreviewed, if not present on the entry, use the "published" (or "updated" if that is missing) of the feed. Otherwise use the creation date (or modified date if that is missing) information according to the containing document language (e.g. "published"/"updated" similarly for Atom feeds), then protocol (e.g. HTTP Last-Modified, or file system last modified datetime) as the dtreviewed.<br />
<br />
'''rating''':: The rating is a fixed point integer (one decimal point of precision) from 1.0 to 5.0 inclusive indicating a rating for the item, higher indicating a better rating by default. Optionally a different integral "worst" value and/or "best" value MAY be specified to indicate a different range (e.g. 6 from 0-10). The "best" value may be numerically smaller than the "worst" value.<br />
<br />
'''description''':: This optional field contains the full text representing the written opinion of the reviewer. The field MAY include valid XHTML markup (e.g. paragraphs). User agents SHOULD preserve any markup. Multiple descriptions or section descriptions (e.g. pros and cons, plusses and minusses) SHOULD be included in the description field.<br />
<br />
'''tags''':: Tags are represented using a list of keywords or phrases (using the [[rel-tag]] microformat for each individual keyword or phrase tag) that the reviewer associates with the item. The reviewer MAY optionally provide a tag-specific rating inside each [[rel-tag]], e.g. ambience:5. Tag-specific ratings by default use the same range as an overall rating for the item if present, and MAY also have a custom worst...best range specified. Authors MAY also invert this structure for the same semantic if it is more convenient for their markup, that is, place the [[rel-tag]] inside a rating to indicate a rated tag. Note: rated tags should ideally use a tag space that explains what the ratings for that tag mean. E.g. Food:18/30 should link to a tags space for Food that explains what an 18 out of 30 means for the Food tag.<br />
<br />
'''permalink''':: This optional field is a URL for the hReview. In addition to using the <code><a href></code> tag for this field, the attribute <code>rel="self bookmark"</code> MUST be used to indicate that the hyperlink is a permalink for the review itself. If the hyperlink already contains a <code>rel</code> attribute, then the values <code>self</code> and <code>bookmark</code> MUST be included among the space-separated set of values in the attribute. Indexers MAY treat the permalink of a review as a unique ID in order to identify and collate the same review from multiple sources (such as indexing a page multiple times). The permalink MAY also be used to indicate or imply the origin of the review. Authors MAY use the classname of "permalink" on the element representing the permalink, but are not required to do so.<br />
<br />
'''license''':: This optional field links to the license under which the contents of the hReview itself is licensed, using the '''[[rel-license]]''' microformat.<br />
<br />
<br />
The following field names have been reused from the [[hcard|hCard]] and [[hcalendar|hCalendar]] microformats: <code>version, summary, fn, url, photo, description</code>. In addition, items and reviewers described by hCards MAY contain any hCard field. The rel value "self" has been reused from the [http://atompub.org/2005/07/11/draft-ietf-atompub-format-10.html Atom 1.0 specification].<br />
<br />
=== More Semantic Equivalents ===<br />
<br />
For some properties there is a more semantic equivalent, and therefore they get special treatment, e.g.: <br />
<br />
* For any "url", use <code><a class="url" href="...">...</a></code> inside the element with the class name 'hreview' in hReview.<br />
* And for "photo", use <code><img class="photo" src="..." alt="Photo of ..." /></code> <br />
<br />
* Ratings are often presented either as a set of images or characters, e.g. "***". For these, the <code>&lt;abbr&gt;</code> element is particularly useful, as such characters are an abbreviation for the precise rating, e.g. <code>&lt;abbr class="rating" title="3.0"&gt;***&lt;/abbr&gt;</code>. This is further explored in the next section.<br />
<br />
==== Language ====<br />
* To explicitly convey the natural language that an hReview is written in, use the standard (X)HTML 'lang' attribute on the element with class="hreview", e.g. <code>&lt;div class="hreview" lang="en"&gt; ... &lt;/div&gt;</code> If portions of an hReview (e.g. the item name) are in a different language, use the 'lang' attribute on those portions.<br />
* hReview processors which need to handle the language of reviews MUST process the standard (X)HTML 'lang' attribute as specified.<br />
<br />
=== Human vs. Machine Readable ===<br />
If an <code>&lt;abbr></code> element is used for a property, then its '<code>title</code>' attribute is used for the value of the property, instead of the contents of the element, which can then be used to provide a user-friendly alternate presentation of the value. <br />
<br />
Similarly, if an <code><img /></code> element is used for one or more properties, it MUST be treated as follows: <br />
<br />
# For the "photo" property and any other property that takes a URL as its value, the <code>src="..."</code> attribute provides the property value. <br />
# For other properties, the <code><img /></code> element's '<code>alt</code>' attribute is the value of the property.<br />
<br />
=== Object Includes ===<br />
<br />
hReview 0.3 includes support for the object [[include-pattern]].<br />
<br />
Often a single page lists an item, and then several reviews for that item. In order to avoid having to repeat the item info for each review of the item, the first review should be marked up as an hReview, with a unique "id" attribute on the item info, and then following reviews should use the object [[include-pattern]] to include the item info from the first review.<br />
<br />
<br />
=== Notes ===<br />
This section is informative.<br />
<br />
* By marking up a review with the hReview microformat, the expectation is communicated that the review MAY be indexed. This has no impact on the copyright of the review itself which the publisher may explicitly specify using [[rel-license]] as specified above.<br />
* The enumerated list of item types is under development and may be extended.<br />
* Each type may have custom hReview fields that follow the common set.<br />
* Additional details about a particular item should be specified with the rest of the item's info at the URL provided for the item.<br />
* Most rating systems use the range 1.0 to 5.0, and most of those represent the rating as a number (and possibly half) of stars. Sites may use whatever graphic they wish to represent the rating.<br />
<br />
== Examples ==<br />
Here are a few examples of reviews from current web sites, and how they could be easily enhanced to support the hReview structured review microformat. <br />
<br />
Want to get started with writing an [[hreview|hReview]]? Use the [http://microformats.org/code/hreview/creator hReview creator] to write a review and publish it on your blog.<br />
<br />
=== Restaurant reviews ===<br />
<br />
Here is an example of a simple online restaurant review:<br />
<br />
<pre><nowiki><br />
<div><br />
<span>5 stars out of 5 stars</span><br />
<h4>Crepes on Cole is awesome</h4><br />
<span>Reviewer: <span>Tantek</span> - April 18, 2005</span><br />
<blockquote><p><br />
Crepes on Cole is one of the best little creperies in San Francisco. <br />
Excellent food and service. Plenty of tables in a variety of sizes <br />
for parties large and small. Window seating makes for excellent <br />
people watching to/from the N-Judah which stops right outside. <br />
I've had many fun social gatherings here, as well as gotten <br />
plenty of work done thanks to neighborhood WiFi.<br />
</p></blockquote><br />
<p>Visit date: <span>April 2005</span></p><br />
<p>Food eaten: <span>Florentine crepe</span></p><br />
</div><br />
</nowiki></pre><br />
<br />
Adding hReview to this review is quite simple:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><br />
<span><span class="rating">5</span> out of 5 stars</span><br />
<h4 class="summary">Crepes on Cole is awesome</h4><br />
<span class="reviewer vcard">Reviewer: <span class="fn">Tantek</span> - <br />
<abbr class="dtreviewed" title="20050418T2300-0700">April 18, 2005</abbr></span><br />
<div class="description item vcard"><p><br />
<span class="fn org">Crepes on Cole</span> is one of the best little <br />
creperies in <span class="adr"><span class="locality">San Francisco</span></span>.<br />
Excellent food and service. Plenty of tables in a variety of sizes <br />
for parties large and small. Window seating makes for excellent <br />
people watching to/from the N-Judah which stops right outside. <br />
I've had many fun social gatherings here, as well as gotten <br />
plenty of work done thanks to neighborhood WiFi.<br />
</p></div><br />
<p>Visit date: <span>April 2005</span></p><br />
<p>Food eaten: <span>Florentine crepe</span></p><br />
</div><br />
</nowiki></pre><br />
<br />
Note that some of the properties of this sample review are not captured by hReview (visit date, food eaten). This is deliberate per the scope of keeping hReview minimal and simple.<br />
<br />
This sample hReview could be rendered like this:<br />
<br />
5 stars out of 5 stars<br /><br />
'''Crepes on Cole is awesome'''<br /><br />
Reviewer: Tantek - April 18, 2005<br /><br />
<br />
Crepes on Cole is one of the best little creperies in San Francisco. Excellent food and service. Plenty of tables in a variety of sizes for parties large and small. Window seating makes for excellent people watching to/from the N-Judah which stops right outside. I've had many fun social gatherings here, as well as gotten plenty of work done thanks to neighborhood wifi.<br />
<br />
Visit date: April 2005<br /><br />
Food eaten: Florentine crepe<br /><br />
<br />
==== Multidimensional Restaurant Review ====<br />
Some restaurant reviews indicate ratings for different aspects of the restaurant. Such details are represented in hReview using tagged ratings. In addition, note the inline tags inside the description of this review.<br />
<br />
Here is one such review in text format:<br />
<br />
Cafe Borrone<br />
<br />
1010 El Camino Real, Menlo Park, CA 94025, +1-650-327-0830;<br />
cafeborrone.com<br />
<br />
Food: 18/30; Ambience: 19/30; Service: 15/30; Price: $$...<br />
<br />
This cafe is a welcoming oasis on the Peninsula. It even has a fountain<br />
outside which cloaks the nearby sounds of El Camino traffic. Next door to a <br />
superb indy bookstore, Cafe Borrone is an ideal spot to grab a coffee or a <br />
snack to accompany a newly purchased book or imported periodical. Soups and <br />
sandwich specials rotate daily. The corn chowder with croutons and big <br />
chunks of cheese goes especially well with a freshly toasted mini-baguette. <br />
Evenings are often crowded and may require sharing a table with a perfect <br />
stranger. Espresso afficionados will appreciate the Illy coffee. Noise <br />
levels can vary from peaceful in the late mornings to nearly overwhelming on <br />
jazz band nights.<br />
<br />
As an hReview:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><br />
<div class="item vcard"><br />
<div class="fn org summary">Cafe Borrone</div><br />
<span class="adr"><br />
<span class="street-address">1010 El Camino Real</span>,<br />
<span class="locality">Menlo Park</span>,<br />
<span class="region">CA</span><br />
<span class="postal-code">94025</span>,<br />
</span><br />
<span class="tel">+1-650-327-0830</span>;<br />
<a class="url" href="http://cafeborrone.com">cafeborrone.com</a><br />
</div><br />
<ul><br />
<li class="rating"><a href="http://en.wikipedia.org/wiki/Food" rel="tag"><br />
Food: <span class="value">18</span>/<span class="best">30</span></a>;</li><br />
<li class="rating"><a href="http://flickr.com/photos/tags/Ambience" rel="tag"><br />
Ambience: <span class="value">19</span>/<span class="best">30</span></a>;</li><br />
<li class="rating"><a href="http://en.wikipedia.org/wiki/Service" rel="tag"><br />
Service: <span class="value">15</span>/<span class="best">30</span></a>;</li><br />
<li class="rating"><a href="http://en.wikipedia.org/wiki/Price" rel="tag"><br />
Price: <abbr class="value" title="2">$$</abbr>...</a></li><br />
</ul><br />
<div class="description"><p><br />
This <abbr class="type" title="business"><br />
<a href="http://en.wikipedia.org/wiki/cafe" rel="tag">cafe</a></abbr> <br />
is a welcoming oasis on the Peninsula. <br />
It even has a fountain outside which nearly eliminates <br />
the sounds of El Camino traffic. Next door to a superb indy bookstore, <br />
Cafe Borrone is an ideal spot to grab a <br />
<a href="http://en.wikipedia.org/wiki/coffee" rel="tag">coffee</a> <br />
or a meal to accompany a newly purchased book or imported periodical. <br />
<a href="http://technorati.com/tag/soup" rel="tag">Soups</a> and <br />
<a href="http://technorati.com/tag/sandwich" rel="tag">sandwich</a> <br />
specials rotate daily. The corn chowder with croutons and big chunks of cheese <br />
goes especially well with a freshly toasted mini-baguette. Evenings are <br />
often crowded and may require sharing a table with a perfect stranger. <br />
<a href="http://flickr.com/photos/tags/espresso" rel="tag">Espresso</a> <br />
afficionados will appreciate the <br />
<a href="http://en.wikipedia.org/wiki/Illy" rel="tag">Illy</a> coffee. <br />
Noise levels can vary from peaceful in the late mornings to nearly overwhelming on <br />
<a href="http://en.wikipedia.org/wiki/jazz" rel="tag">jazz</a> band nights.<br />
</p></div><br />
Review (<a href="http://microformats.org/wiki/hreview"> <br />
hReview v<span class="version">0.3</span></a>)<br />
by <span class="reviewer vcard"><span class="fn">anonymous</span></span>, <br />
<abbr class="dtreviewed" title="20050428T2130-0700">April 28th, 2005</abbr>.<br />
</div><br />
</nowiki></pre><br />
<br />
With an accompanying CSS style sheet like:<br />
<br />
<pre><nowiki><br />
a.url { display:block }<br />
ul { margin:1em 0; padding:0 }<br />
ul li { display:inline }<br />
</nowiki></pre><br />
<br />
This hReview could be presented similar to the original text:<br />
<br />
Cafe Borrone<br /><br />
1010 El Camino Real, Menlo Park, CA 94025, +1-650-327-0830;<br /><br />
[http://cafeborrone.com/ cafeborrone.com]<br /><br />
<br /><br />
[http://en.wikipedia.org/wiki/Food Food: 18/30];<br />
[http://flickr.com/photos/tags/Ambience Ambience: 19/30];<br />
[http://en.wikipedia.org/wiki/Service Service: 15/30];<br />
[http://en.wikipedia.org/wiki/Price Price: $$...]<br /><br />
<br />
This [http://en.wikipedia.org/wiki/cafe cafe] is a welcoming oasis on the Peninsula. It even has a fountain outside which cloaks the nearby sounds of El Camino traffic. Next door to a superb indy bookstore, Cafe Borrone is an ideal spot to grab a [http://en.wikipedia.org/wiki/coffee coffee] or a snack to accompany a newly purchased book or imported periodical. [http://technorati.com/tag/soup Soups] and [http://technorati.com/tag/sandwich sandwich] specials rotate daily. The corn chowder with croutons and big chunks of cheese goes especially well with a freshly toasted mini-baguette. Evenings are often crowded and may require sharing a table with a perfect stranger. [http://flickr.com/photos/tags/espresso Espresso] afficionados will appreciate the [http://en.wikipedia.org/wiki/Illy Illy] coffee. Noise levels can vary from peaceful in the late mornings to nearly overwhelming on [http://en.wikipedia.org/wiki/jazz jazz] band nights.<br />
<br />
Review ([http://microformats.org/wiki/hreview hReview v0.3]) by anonymous, April 28th, 2005.<br />
<br />
=== Product review ===<br />
Here is an example of a product review:<br />
<br />
<pre><nowiki><br />
<div><br />
<a href="http://www.amazon.com/exec/obidos/ASIN/B000089CJI/"><br />
<img src="http://images.amazon.com/images/P/B000089CJI.01._SCTHUMBZZZ_.jpg" <br />
alt="Album cover photo: The Postal Service: Give Up." /><br />
The Postal Service: Give Up</a><br />
<blockquote><p><br />
"The people thought they were just being rewarded for treating others <br />
as they like to be treated, for obeying stop signs and curing diseases, <br />
for mailing letters with the address of the sender... Don't wake me, <br />
I plan on sleeping in..."<br />
</p><p><br />
"Nothing Better" is a great track on this album, too... <br />
</p></blockquote><br />
(*****)<br />
</div><br />
</nowiki></pre><br />
<br />
Adding hReview to this review is also quite simple, but in this case requires a few more elements for the rating and reviewer which are required by hReview:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><span class="item"><br />
<a class="url fn" href="http://www.amazon.com/exec/obidos/ASIN/B000089CJI/"><br />
<img src="http://images.amazon.com/images/P/B000089CJI.01._SCTHUMBZZZ_.jpg" <br />
alt="Album cover photo: The Postal Service: Give Up. " <br />
class="photo" /><br />
The Postal Service: Give Up</a></span><br />
<div class="description"><p><br />
"The people thought they were just being rewarded for treating others <br />
as they like to be treated, for obeying stop signs and curing diseases, <br />
for mailing letters with the address of the sender... Don't wake me, <br />
I plan on sleeping in..."<br />
</p><p><br />
"Nothing Better" is a great track on this album, too... <br />
</p></div><br />
(<abbr class="rating" title="5">*****</abbr>)<br />
<p class="reviewer vcard">Review by <br />
<a class="url fn" href="http://ifindkarma.com/blog/">Adam Rifkin</a>, <br />
<abbr class="dtreviewed" title="200502">February 2005</abbr><br />
</p><br />
</div><br />
</nowiki></pre><br />
<br />
And this hReview might be presented like this:<br />
<br />
<br />
[Album cover photo: ]<br />
[The Postal Service:]<br />
[ Give Up ]<br />
<br />
The Postal Service: Give Up<br />
<br />
"The people thought they were just being rewarded for treating others as they like to be treated, for obeying stop signs and curing diseases, for mailing letters with the address of the sender... Don't wake me, I plan on sleeping in..."<br />
<br />
"Nothing Better" is a great track on this album, too...<br />
<br />
(*****)<br />
<br />
Review by Adam Rifkin, February 2005.<br />
<br />
=== Movie Review ===<br />
Finally, here is an example of a movie review.<br />
<br />
<pre><nowiki><br />
<div><br />
<span>anonymous, April 18th, 2005</span><br />
<div><br />
<a lang="zh" href="http://www.imdb.com/title/tt0299977/"><br />
Ying Xiong (<span lang="en">HERO</span>)<br />
</a><br />
</div><br />
<div>Rating: 4 out of 5</div><br />
<blockquote><p><br />
This movie has great visuals and music.<br />
</p></blockquote><br />
</div><br />
</nowiki></pre><br />
<br />
With hReview:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><br />
<span class="reviewer vcard"><br />
<span class="fn">anonymous</span>, <br />
<abbr class="dtreviewed" title="20050418">April 18th, 2005</abbr><br />
</span><br />
<div class="item"><br />
<a lang="zh" class="url fn" href="http://www.imdb.com/title/tt0299977/"><br />
Ying Xiong (<span lang="en">HERO</span>)<br />
</a><br />
</div><br />
<div>Rating: <span class="rating">4</span> out of 5</div><br />
<div class="description"><p><br />
This movie has great music and visuals.<br />
</p></div><br />
</div><br />
</nowiki></pre><br />
<br />
Which could be presented like this:<br />
<br />
anonymous, April 18th, 2005<br /><br />
Ying Xiong (HERO)<br /><br />
Rating: 4 out of 5<br /><br />
<br />
This movie has great music and visuals.<br />
<br />
== Examples in the wild ==<br />
This section is '''informative'''. The number of hReview examples in the wild has expanded far beyond the capacity of being kept inline in this specification. They have been moved to a [[hreview-examples-in-wild|separate page]].<br />
<br />
See [[hreview-examples-in-wild|hReview Examples in the wild]].<br />
<br />
== Implementations ==<br />
This section is '''informative'''. The number of hReview implementations has also expanded beyond the capacity of keeping them inline. They have been moved to a [[hreview-implementations|separate page]].<br />
<br />
See [[hreview-implementations|hReview Implementations]].<br />
<br />
== References ==<br />
=== Normative References ===<br />
* [http://www.w3.org/TR/2002/REC-xhtml1-20020801/ XHTML 1.0 SE]<br />
* [http://gmpg.org/xmdp/ XMDP]<br />
* [[hcard|hCard]]<br />
* [[hcalendar|hCalendar]]<br />
* [[rel-tag]]<br />
* [http://www.ietf.org/rfc/rfc2119.txt RFC2119]<br />
* [http://www.ietf.org/rfc/rfc3986.txt RFC3986]<br />
* [http://www.ietf.org/rfc/rfc4287.txt RFC4287] (Atom 1.0)<br />
<br />
=== Informative References ===<br />
* [http://www.w3.org/TR/REC-CSS1 CSS1]<br />
* ISO.8601.1988<br />
** International Organization for Standardization, "Data elements and interchange formats - Information interchange - Representation of dates and times", ISO Standard 8601, June 1988.<br />
* [http://www.w3.org/TR/1998/NOTE-datetime-19980827 W3C NOTE-datetime-19980827]<br />
* [http://www.ietf.org/rfc/rfc3667.txt RFC3667]<br />
* [http://www.ietf.org/rfc/rfc3668.txt RFC3668]<br />
* [http://www.w3.org/Consortium/Patent-Policy-20040205/ W3C Patent Policy]<br />
* [http://local.yahoo.com/details?id=21359628 Crepes on Cole reviews on Yahoo! Local]<br />
* Other reviews efforts. See [[reviews-formats]].<br />
* Contributed from http://developers.technorati.com/wiki/hReview.<br />
<br />
==== Similar Work ====<br />
* [[hlisting-proposal|hListing]]<br />
* [[xoxo|XOXO]]<br />
<br />
=== Copyright ===<br />
{{MicroformatCopyrightStatement2005}}<br />
<br />
=== Patents ===<br />
{{MicroFormatPatentStatement}}<br />
<br />
== Work in progress ==<br />
This specification is a work in progress. As additional aspects are discussed, understood, and written, they will be added. <br />
<br />
=== Changes from v0.2 ===<br />
The following changes have been made in hReview v0.3 over [[hreview-v0.2|hReview v0.2]]:<br />
<br />
Normative changes:<br />
# MUST (instead of SHOULD) use [[hcard|hCard]] for the item description of a business or person<br />
# "reviewer" changes<br />
## Made reviewer *optional* per feedback from Ryan King and Mark Nottingham<br />
## If reviewer is absent from the hReview, then look outside the hReview, in the context of the page, for the reviewer. If there is no "reviewer" outside either, then use the author information according to the containing document language (e.g. <code><nowiki><address></nowiki></code> for (X)HTML pages) as the reviewer.<br />
## MUST (instead of SHOULD) use [[hcard|hCard]] to represent reviewer information<br />
# "dtreviewed" changes<br />
## Made dtreviewed *optional* per feedback from Ryan King and Mark Nottingham<br />
## If dtreviewed is absent from the hReview, then look outside the hReview, in the surrounding context. If the context is an [[hatom|hAtom]] entry, use its "published" (or "updated" if that is missing) datetime as the dtreviewed, if not present on the entry, use the "published" (or "updated" if that is missing) of the feed. Otherwise use the information according to the containing document language (e.g. "published"/"updated" similarly for Atom feeds), then protocol (e.g. HTTP Last-Modified, or file system last modified datetime).<br />
# SHOULD use [[hcalendar|hCalendar]] to represent an item of 'type' 'event'<br />
# Added one decimal digit of precision to ratings' numerical values based on publisher experience.<br />
# Use [http://microformats.org/wiki/hcard#Value_excerpting the "value" construct from hCard] (as it is used in "tel" properties for example) to more explicitly markup the rating value when also providing (marking up) the best/worst of a rating.<br />
# Added [[rel-license]] to indicate the license of the hReview as a whole.<br />
# Permit tags inside ratings to denote rated tags, the same as ratings inside tags per suggestion from Eran Globen.<br />
# Add [[include-pattern]] support to allow multiple reviews for the same item to not repeat the item info.<br />
<br />
Informative changes (several, but in particular):<br />
# Note that scalar/rated tags would ideally use a tag space that explain the ratings for that tag. E.g. to explain what Food:18/30 means.<br />
# Updated examples accordingly.<br />
<br />
== Further Reading ==<br />
* See also [http://www.technorati.com/cosmos/referer.html blogs discussing this page].<br />
== Related Pages People==<br />
* Sildenafil citrate, sold under the [http://www.efficacylevitra.info names Levitra]<br />
* A ring tone is the sound made by a telephone to indicate an [http://freeringtonemp.info incoming call]<br />
* Viagra pills are blue and [http://orderviagrales.info diamond-shaped] with the words.<br />
* Both Viagra and the Levitra are derived from [http://levitravsviagra.info Proto-Indo-Iranian]<br />
* The mode of action of [http://ordertramadoline.info tramadol] has yet to be fully understood.<br />
* Phentermine is a drug primarily used as an [http://pharmacyphentermine.info appetite suppressant]<br />
* The proper definition of [http://replicawatchbmw.info replica]<br />
* Alprazolam was [http://valiumxanax.info originally marketed] as an atypical benzodiazepine, but only classified for use treating anxiety neurosis.<br />
<br />
== Related Pages ==<br />
{{hreview-related-pages}}</div>Adminihttps://microformats.org/wiki/index.php?title=hreview&diff=13939hreview2007-03-04T08:28:06Z<p>Admini: /* Further Reading */</p>
<hr />
<div><h1> hReview 0.3 </h1><br />
<br />
[[hreview|hReview]] is a simple, open, distributed format, suitable for embedding reviews (of products, services, businesses, events, etc.) in (X)HTML, Atom, RSS, and arbitrary XML. hReview is one of several [[microformats]] open standards.<br />
<br />
Want to get started with writing an [[hreview|hReview]]? Use the [http://microformats.org/code/hreview/creator hReview creator] to write a review and publish it.<br />
<br />
== Microformats Draft Specification 2006-02-22 ==<br />
<br />
; Editor: [http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc.]<br />
; Authors: [http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc.]<br />
: [http://360.yahoo.com/alidiabali Ali Diab],[http://yahoo.com Yahoo! Inc.]<br />
: [http://spaces.msn.com/members/ianmcallister/ Ian McAllister], [http://microsoft.com/ Microsoft Corporation]<br />
: [http://journals.aol.com/panzerjohn/abstractioneer John Panzer], [http://www.aol.com America Online, Inc.]<br />
: [http://ifindkarma.com/blog Adam Rifkin], [http://labs.commerce.net/ CommerceNet Labs]<br />
: [http://sippey.typepad.com/ Michael Sippey], [http://sixapart.com Six Apart, Ltd.]<br />
<br />
Microformats [http://microformats.org/wiki/hreview#Copyright copyright] and [http://microformats.org/wiki/hreview#Patents patents] statements apply.<br />
<br />
__TOC__<br />
<br />
== Introduction ==<br />
Numerous web sites publish reviews using a broad variety of schema for all sorts of things from products (movies, music, books), to businesses (restaurants, hotels, stores), to events (concerts, theatre), to people (artists, leaders, celebrities), to places (landmarks, parks), to online resources (web pages, files), to reviews of reviews themselves.<br />
<br />
In order to enable and encourage the sharing, distribution, syndication, and aggregation, of reviews, the authors propose the hReview microformat, an open standard for distributed reviews. The authors have researched both numerous [[review-examples]] in the wild and earlier attempts at [[review-formats]], and have designed hReview around a simple minimal schema for reviews. Feedback is encouraged on the [[hreview-feedback|hReview feedback]] page.<br />
<br />
=== Inspiration and Acknowledgments ===<br />
Thanks to everyone who responded to the open call for implementor participation for hReview. The authors in particular wish to thank the following individuals for their constructive input and feedback: [http://www.richardault.com/ Richard Ault], [http://dannyayers.com Danny Ayers], [http://www.vertexdev.com/~jeff/ Jeffrey Barr],[http://adriancuthbert.blogspot.com/ Adrian Cuthbert],[http://jason.defillippo.com/ Jason DeFillippo], [http://www.hybernaut.com/bdv Brian Del Vecchio], Scott Derringer, [http://budgibson.com/home/ Bud Gibson], [http://joi.ito.com/ Joi Ito], [http://www.kanai.net/weblog/ Gen Kanai],[http://niallkennedy.com/ Niall Kennedy], [http://labs.commerce.net/wiki/index.php/Rohit_Khare Rohit Khare], [http://theryanking.com/ Ryan King], [http://www.jluster.org/ Jonas Luster], [http://epeus.blogspot.com/ Kevin Marks], Mark Nottingham, [http://www.powazek.com/ Derek Powazek], [http://www.judysbook.com/ Jeff Rodenburg], [http://sifry.com/alerts/ David Sifry], [http://jystewart.net/ James Stewart], [http://kung-foo.tv/ Adriaan Tijsseling], [http://www.flashenabled.com/ Phillip Torrone], Thai Tran, [http://w6daily.winn.com/ Phillip Winn], [http://yohei-y.blogspot.com YAMAMOTO Yohei].<br />
<br />
=== Scope ===<br />
Reviews consistently share several common fields. Where possible hReview has been based on this minimal common subset.<br />
<br />
==== Out of scope ====<br />
Fields that are type-specific have been omitted from hReview. It is important that hReview be kept simple and minimal from the start. Additional features can be added as deemed necessary by practical implementation experience.<br />
<br />
The concept of a "universal object identifier", that is, how to identify the same object/item/product across different shopping sites, though something very useful to have, is outside the scope of this format.<br />
<br />
== Semantic XHTML Design Principles ==<br />
{{semantic-xhtml-design-principles}}<br />
<br />
== Format ==<br />
=== In General ===<br />
The hReview format is based on a set of fields common to numerous review sites and formats in use today on the web. Where possible field names have been chosen based on those defined by the related [[hcard|hCard]] and [[hcalendar|hCalendar]] standards.<br />
<br />
=== Schema ===<br />
The hReview schema consists of the following:<br />
<br />
* hReview ('''<code>hreview</code>''')<br />
** '''<code>version</code>'''. optional. text.<br />
** '''<code>summary</code>'''. optional. text.<br />
** item '''<code>type</code>'''. optional. product | business | event | person | place | website | url.<br />
** '''<code>item</code>''' info. required. '''<code>fn</code>''' ('''<code>url</code>''' || '''<code>photo</code>''' ) | '''[[hcard|hCard]]''' (for person or business) | '''[[hcalendar|hCalendar]]''' (for event)<br />
** '''<code>reviewer</code>'''. optional. '''[[hcard|hCard]]'''.<br />
** '''<code>dtreviewed</code>'''. optional. ISO8601 absolute date time.<br />
** '''<code>rating</code>'''. optional. fixed point integer [1.0-5.0], with optional alternate '''<code>worst</code>''' (default:1.0) and/or '''<code>best</code>''' (default:5.0), also fixed point integers, and explicit '''<code>value</code>'''.<br />
** '''<code>description</code>'''. optional. text with optional valid XHTML markup.<br />
** tags. optional. keywords or phrases, using '''[[rel-tag]]''', each with optional rating.<br />
** permalink. optional, using '''[[rel-bookmark]]''' and '''[[rel-self]]'''.<br />
** license. optional, using '''[[rel-license]]'''.<br />
<br />
=== Field details ===<br />
The fields of the hReview schema represent the following:<br />
<br />
'''version''':: This optional field permits hReview publishers to specify a particular version of hReview that their content uses. By omitting this field, the publisher is stating that implementations may interpret the hReviews according to any version of the hReview specification v0.2 or later. In practice the authors of this specification are comitted to maintaining backward compatibility with content produced using earlier versions of the specification. This field is syntax compatible with, and thus reuses the semantics of "VERSION" as defined in vCard RFC2426 section "3.6.9 VERSION Type Definition". The value of this field for this specification is "0.3".<br />
<br />
'''summary''':: This optional field serves as a title for the review itself.<br />
<br />
'''item type''':: This optional field "type" provides the type of the item being reviewed, one of the following: product, business, event, person, place, website, url. If omitted, then in some cases the item type may be inferred. If the item is also an [[hcard|hCard]], then the item type is a "business" or a "person" based upon which of those the hCard represents. If the item is also an [[hcalendar|hCalendar]] event, then the item type is an "event".<br />
<br />
'''item info''':: This required field MUST have at a minimum the name ("fn" - the formatted text corresponding to the name) of ''the'' item (an hReview describes only one item), SHOULD provide at least one URI ("url") for the item, and MAY provide at least one URL to a photo or depiction ("photo") of the item. For items of type person or business, the item info (fn, url, photo) MUST be encapsulated in an [[hcard|hCard]]. For items of type event, the item info SHOULD be encapsulated in an [[hcalendar|hCalendar]] "vevent". Unique item IDs (e.g. ISBNs, UPCs) MAY be represented as a URN ("url") for the item. Encapsulated microformats (e.g. [[hcard|hCard]] and [[hcalendar|hCalendar]] events for now) may be set on the item itself (e.g. class="item vcard"). However, when using item info subproperties ("fn", "url", "photo"), they MUST be nested <em>inside</em> the item element.<br />
<br />
'''reviewer''':: The optional field specifies the person who authored the review. If the reviewer is specified, an hCard representing the reviewer MUST be provided. For anonymous reviews, use "anonymous" (without quotes) for the full name of the reviewer. If no "reviewer" is found inside the hReview, parsers should look outside the hReview, in the context of the page, for the "reviewer". If there is no "reviewer" outside either, then parsers should use the author defined by the containing document language, e.g. for (X)HTML documents, the <code><nowiki><address></nowiki></code> contact info for the page (which is ideally marked up as an [[hcard|hCard]] as well), for Atom 1.0 the <code><nowiki><entry></nowiki></code> <code><nowiki><author></nowiki></code> if present and if not the <code><nowiki><feed></nowiki></code> <code><nowiki><author></nowiki></code>, for RSS the <code><nowiki><author></nowiki></code> inside the containing <code><nowiki><item></nowiki></code> element.<br />
<br />
'''dtreviewed''':: This optional field when present MUST provide an ISO8601 absolute date time of when the review was written or otherwise authored. This field SHOULD use UTC, but MAY use the time zone offset syntax. If dtreviewed is absent from the hReview, then look outside the hReview, in the surrounding context. If the context is an [[hatom|hAtom]] entry, use its "published" (or "updated" if that is missing) datetime as the dtreviewed, if not present on the entry, use the "published" (or "updated" if that is missing) of the feed. Otherwise use the creation date (or modified date if that is missing) information according to the containing document language (e.g. "published"/"updated" similarly for Atom feeds), then protocol (e.g. HTTP Last-Modified, or file system last modified datetime) as the dtreviewed.<br />
<br />
'''rating''':: The rating is a fixed point integer (one decimal point of precision) from 1.0 to 5.0 inclusive indicating a rating for the item, higher indicating a better rating by default. Optionally a different integral "worst" value and/or "best" value MAY be specified to indicate a different range (e.g. 6 from 0-10). The "best" value may be numerically smaller than the "worst" value.<br />
<br />
'''description''':: This optional field contains the full text representing the written opinion of the reviewer. The field MAY include valid XHTML markup (e.g. paragraphs). User agents SHOULD preserve any markup. Multiple descriptions or section descriptions (e.g. pros and cons, plusses and minusses) SHOULD be included in the description field.<br />
<br />
'''tags''':: Tags are represented using a list of keywords or phrases (using the [[rel-tag]] microformat for each individual keyword or phrase tag) that the reviewer associates with the item. The reviewer MAY optionally provide a tag-specific rating inside each [[rel-tag]], e.g. ambience:5. Tag-specific ratings by default use the same range as an overall rating for the item if present, and MAY also have a custom worst...best range specified. Authors MAY also invert this structure for the same semantic if it is more convenient for their markup, that is, place the [[rel-tag]] inside a rating to indicate a rated tag. Note: rated tags should ideally use a tag space that explains what the ratings for that tag mean. E.g. Food:18/30 should link to a tags space for Food that explains what an 18 out of 30 means for the Food tag.<br />
<br />
'''permalink''':: This optional field is a URL for the hReview. In addition to using the <code><a href></code> tag for this field, the attribute <code>rel="self bookmark"</code> MUST be used to indicate that the hyperlink is a permalink for the review itself. If the hyperlink already contains a <code>rel</code> attribute, then the values <code>self</code> and <code>bookmark</code> MUST be included among the space-separated set of values in the attribute. Indexers MAY treat the permalink of a review as a unique ID in order to identify and collate the same review from multiple sources (such as indexing a page multiple times). The permalink MAY also be used to indicate or imply the origin of the review. Authors MAY use the classname of "permalink" on the element representing the permalink, but are not required to do so.<br />
<br />
'''license''':: This optional field links to the license under which the contents of the hReview itself is licensed, using the '''[[rel-license]]''' microformat.<br />
<br />
<br />
The following field names have been reused from the [[hcard|hCard]] and [[hcalendar|hCalendar]] microformats: <code>version, summary, fn, url, photo, description</code>. In addition, items and reviewers described by hCards MAY contain any hCard field. The rel value "self" has been reused from the [http://atompub.org/2005/07/11/draft-ietf-atompub-format-10.html Atom 1.0 specification].<br />
<br />
=== More Semantic Equivalents ===<br />
<br />
For some properties there is a more semantic equivalent, and therefore they get special treatment, e.g.: <br />
<br />
* For any "url", use <code><a class="url" href="...">...</a></code> inside the element with the class name 'hreview' in hReview.<br />
* And for "photo", use <code><img class="photo" src="..." alt="Photo of ..." /></code> <br />
<br />
* Ratings are often presented either as a set of images or characters, e.g. "***". For these, the <code>&lt;abbr&gt;</code> element is particularly useful, as such characters are an abbreviation for the precise rating, e.g. <code>&lt;abbr class="rating" title="3.0"&gt;***&lt;/abbr&gt;</code>. This is further explored in the next section.<br />
<br />
==== Language ====<br />
* To explicitly convey the natural language that an hReview is written in, use the standard (X)HTML 'lang' attribute on the element with class="hreview", e.g. <code>&lt;div class="hreview" lang="en"&gt; ... &lt;/div&gt;</code> If portions of an hReview (e.g. the item name) are in a different language, use the 'lang' attribute on those portions.<br />
* hReview processors which need to handle the language of reviews MUST process the standard (X)HTML 'lang' attribute as specified.<br />
<br />
=== Human vs. Machine Readable ===<br />
If an <code>&lt;abbr></code> element is used for a property, then its '<code>title</code>' attribute is used for the value of the property, instead of the contents of the element, which can then be used to provide a user-friendly alternate presentation of the value. <br />
<br />
Similarly, if an <code><img /></code> element is used for one or more properties, it MUST be treated as follows: <br />
<br />
# For the "photo" property and any other property that takes a URL as its value, the <code>src="..."</code> attribute provides the property value. <br />
# For other properties, the <code><img /></code> element's '<code>alt</code>' attribute is the value of the property.<br />
<br />
=== Object Includes ===<br />
<br />
hReview 0.3 includes support for the object [[include-pattern]].<br />
<br />
Often a single page lists an item, and then several reviews for that item. In order to avoid having to repeat the item info for each review of the item, the first review should be marked up as an hReview, with a unique "id" attribute on the item info, and then following reviews should use the object [[include-pattern]] to include the item info from the first review.<br />
<br />
<br />
=== Notes ===<br />
This section is informative.<br />
<br />
* By marking up a review with the hReview microformat, the expectation is communicated that the review MAY be indexed. This has no impact on the copyright of the review itself which the publisher may explicitly specify using [[rel-license]] as specified above.<br />
* The enumerated list of item types is under development and may be extended.<br />
* Each type may have custom hReview fields that follow the common set.<br />
* Additional details about a particular item should be specified with the rest of the item's info at the URL provided for the item.<br />
* Most rating systems use the range 1.0 to 5.0, and most of those represent the rating as a number (and possibly half) of stars. Sites may use whatever graphic they wish to represent the rating.<br />
<br />
== Examples ==<br />
Here are a few examples of reviews from current web sites, and how they could be easily enhanced to support the hReview structured review microformat. <br />
<br />
Want to get started with writing an [[hreview|hReview]]? Use the [http://microformats.org/code/hreview/creator hReview creator] to write a review and publish it on your blog.<br />
<br />
=== Restaurant reviews ===<br />
<br />
Here is an example of a simple online restaurant review:<br />
<br />
<pre><nowiki><br />
<div><br />
<span>5 stars out of 5 stars</span><br />
<h4>Crepes on Cole is awesome</h4><br />
<span>Reviewer: <span>Tantek</span> - April 18, 2005</span><br />
<blockquote><p><br />
Crepes on Cole is one of the best little creperies in San Francisco. <br />
Excellent food and service. Plenty of tables in a variety of sizes <br />
for parties large and small. Window seating makes for excellent <br />
people watching to/from the N-Judah which stops right outside. <br />
I've had many fun social gatherings here, as well as gotten <br />
plenty of work done thanks to neighborhood WiFi.<br />
</p></blockquote><br />
<p>Visit date: <span>April 2005</span></p><br />
<p>Food eaten: <span>Florentine crepe</span></p><br />
</div><br />
</nowiki></pre><br />
<br />
Adding hReview to this review is quite simple:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><br />
<span><span class="rating">5</span> out of 5 stars</span><br />
<h4 class="summary">Crepes on Cole is awesome</h4><br />
<span class="reviewer vcard">Reviewer: <span class="fn">Tantek</span> - <br />
<abbr class="dtreviewed" title="20050418T2300-0700">April 18, 2005</abbr></span><br />
<div class="description item vcard"><p><br />
<span class="fn org">Crepes on Cole</span> is one of the best little <br />
creperies in <span class="adr"><span class="locality">San Francisco</span></span>.<br />
Excellent food and service. Plenty of tables in a variety of sizes <br />
for parties large and small. Window seating makes for excellent <br />
people watching to/from the N-Judah which stops right outside. <br />
I've had many fun social gatherings here, as well as gotten <br />
plenty of work done thanks to neighborhood WiFi.<br />
</p></div><br />
<p>Visit date: <span>April 2005</span></p><br />
<p>Food eaten: <span>Florentine crepe</span></p><br />
</div><br />
</nowiki></pre><br />
<br />
Note that some of the properties of this sample review are not captured by hReview (visit date, food eaten). This is deliberate per the scope of keeping hReview minimal and simple.<br />
<br />
This sample hReview could be rendered like this:<br />
<br />
5 stars out of 5 stars<br /><br />
'''Crepes on Cole is awesome'''<br /><br />
Reviewer: Tantek - April 18, 2005<br /><br />
<br />
Crepes on Cole is one of the best little creperies in San Francisco. Excellent food and service. Plenty of tables in a variety of sizes for parties large and small. Window seating makes for excellent people watching to/from the N-Judah which stops right outside. I've had many fun social gatherings here, as well as gotten plenty of work done thanks to neighborhood wifi.<br />
<br />
Visit date: April 2005<br /><br />
Food eaten: Florentine crepe<br /><br />
<br />
==== Multidimensional Restaurant Review ====<br />
Some restaurant reviews indicate ratings for different aspects of the restaurant. Such details are represented in hReview using tagged ratings. In addition, note the inline tags inside the description of this review.<br />
<br />
Here is one such review in text format:<br />
<br />
Cafe Borrone<br />
<br />
1010 El Camino Real, Menlo Park, CA 94025, +1-650-327-0830;<br />
cafeborrone.com<br />
<br />
Food: 18/30; Ambience: 19/30; Service: 15/30; Price: $$...<br />
<br />
This cafe is a welcoming oasis on the Peninsula. It even has a fountain<br />
outside which cloaks the nearby sounds of El Camino traffic. Next door to a <br />
superb indy bookstore, Cafe Borrone is an ideal spot to grab a coffee or a <br />
snack to accompany a newly purchased book or imported periodical. Soups and <br />
sandwich specials rotate daily. The corn chowder with croutons and big <br />
chunks of cheese goes especially well with a freshly toasted mini-baguette. <br />
Evenings are often crowded and may require sharing a table with a perfect <br />
stranger. Espresso afficionados will appreciate the Illy coffee. Noise <br />
levels can vary from peaceful in the late mornings to nearly overwhelming on <br />
jazz band nights.<br />
<br />
As an hReview:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><br />
<div class="item vcard"><br />
<div class="fn org summary">Cafe Borrone</div><br />
<span class="adr"><br />
<span class="street-address">1010 El Camino Real</span>,<br />
<span class="locality">Menlo Park</span>,<br />
<span class="region">CA</span><br />
<span class="postal-code">94025</span>,<br />
</span><br />
<span class="tel">+1-650-327-0830</span>;<br />
<a class="url" href="http://cafeborrone.com">cafeborrone.com</a><br />
</div><br />
<ul><br />
<li class="rating"><a href="http://en.wikipedia.org/wiki/Food" rel="tag"><br />
Food: <span class="value">18</span>/<span class="best">30</span></a>;</li><br />
<li class="rating"><a href="http://flickr.com/photos/tags/Ambience" rel="tag"><br />
Ambience: <span class="value">19</span>/<span class="best">30</span></a>;</li><br />
<li class="rating"><a href="http://en.wikipedia.org/wiki/Service" rel="tag"><br />
Service: <span class="value">15</span>/<span class="best">30</span></a>;</li><br />
<li class="rating"><a href="http://en.wikipedia.org/wiki/Price" rel="tag"><br />
Price: <abbr class="value" title="2">$$</abbr>...</a></li><br />
</ul><br />
<div class="description"><p><br />
This <abbr class="type" title="business"><br />
<a href="http://en.wikipedia.org/wiki/cafe" rel="tag">cafe</a></abbr> <br />
is a welcoming oasis on the Peninsula. <br />
It even has a fountain outside which nearly eliminates <br />
the sounds of El Camino traffic. Next door to a superb indy bookstore, <br />
Cafe Borrone is an ideal spot to grab a <br />
<a href="http://en.wikipedia.org/wiki/coffee" rel="tag">coffee</a> <br />
or a meal to accompany a newly purchased book or imported periodical. <br />
<a href="http://technorati.com/tag/soup" rel="tag">Soups</a> and <br />
<a href="http://technorati.com/tag/sandwich" rel="tag">sandwich</a> <br />
specials rotate daily. The corn chowder with croutons and big chunks of cheese <br />
goes especially well with a freshly toasted mini-baguette. Evenings are <br />
often crowded and may require sharing a table with a perfect stranger. <br />
<a href="http://flickr.com/photos/tags/espresso" rel="tag">Espresso</a> <br />
afficionados will appreciate the <br />
<a href="http://en.wikipedia.org/wiki/Illy" rel="tag">Illy</a> coffee. <br />
Noise levels can vary from peaceful in the late mornings to nearly overwhelming on <br />
<a href="http://en.wikipedia.org/wiki/jazz" rel="tag">jazz</a> band nights.<br />
</p></div><br />
Review (<a href="http://microformats.org/wiki/hreview"> <br />
hReview v<span class="version">0.3</span></a>)<br />
by <span class="reviewer vcard"><span class="fn">anonymous</span></span>, <br />
<abbr class="dtreviewed" title="20050428T2130-0700">April 28th, 2005</abbr>.<br />
</div><br />
</nowiki></pre><br />
<br />
With an accompanying CSS style sheet like:<br />
<br />
<pre><nowiki><br />
a.url { display:block }<br />
ul { margin:1em 0; padding:0 }<br />
ul li { display:inline }<br />
</nowiki></pre><br />
<br />
This hReview could be presented similar to the original text:<br />
<br />
Cafe Borrone<br /><br />
1010 El Camino Real, Menlo Park, CA 94025, +1-650-327-0830;<br /><br />
[http://cafeborrone.com/ cafeborrone.com]<br /><br />
<br /><br />
[http://en.wikipedia.org/wiki/Food Food: 18/30];<br />
[http://flickr.com/photos/tags/Ambience Ambience: 19/30];<br />
[http://en.wikipedia.org/wiki/Service Service: 15/30];<br />
[http://en.wikipedia.org/wiki/Price Price: $$...]<br /><br />
<br />
This [http://en.wikipedia.org/wiki/cafe cafe] is a welcoming oasis on the Peninsula. It even has a fountain outside which cloaks the nearby sounds of El Camino traffic. Next door to a superb indy bookstore, Cafe Borrone is an ideal spot to grab a [http://en.wikipedia.org/wiki/coffee coffee] or a snack to accompany a newly purchased book or imported periodical. [http://technorati.com/tag/soup Soups] and [http://technorati.com/tag/sandwich sandwich] specials rotate daily. The corn chowder with croutons and big chunks of cheese goes especially well with a freshly toasted mini-baguette. Evenings are often crowded and may require sharing a table with a perfect stranger. [http://flickr.com/photos/tags/espresso Espresso] afficionados will appreciate the [http://en.wikipedia.org/wiki/Illy Illy] coffee. Noise levels can vary from peaceful in the late mornings to nearly overwhelming on [http://en.wikipedia.org/wiki/jazz jazz] band nights.<br />
<br />
Review ([http://microformats.org/wiki/hreview hReview v0.3]) by anonymous, April 28th, 2005.<br />
<br />
=== Product review ===<br />
Here is an example of a product review:<br />
<br />
<pre><nowiki><br />
<div><br />
<a href="http://www.amazon.com/exec/obidos/ASIN/B000089CJI/"><br />
<img src="http://images.amazon.com/images/P/B000089CJI.01._SCTHUMBZZZ_.jpg" <br />
alt="Album cover photo: The Postal Service: Give Up." /><br />
The Postal Service: Give Up</a><br />
<blockquote><p><br />
"The people thought they were just being rewarded for treating others <br />
as they like to be treated, for obeying stop signs and curing diseases, <br />
for mailing letters with the address of the sender... Don't wake me, <br />
I plan on sleeping in..."<br />
</p><p><br />
"Nothing Better" is a great track on this album, too... <br />
</p></blockquote><br />
(*****)<br />
</div><br />
</nowiki></pre><br />
<br />
Adding hReview to this review is also quite simple, but in this case requires a few more elements for the rating and reviewer which are required by hReview:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><span class="item"><br />
<a class="url fn" href="http://www.amazon.com/exec/obidos/ASIN/B000089CJI/"><br />
<img src="http://images.amazon.com/images/P/B000089CJI.01._SCTHUMBZZZ_.jpg" <br />
alt="Album cover photo: The Postal Service: Give Up. " <br />
class="photo" /><br />
The Postal Service: Give Up</a></span><br />
<div class="description"><p><br />
"The people thought they were just being rewarded for treating others <br />
as they like to be treated, for obeying stop signs and curing diseases, <br />
for mailing letters with the address of the sender... Don't wake me, <br />
I plan on sleeping in..."<br />
</p><p><br />
"Nothing Better" is a great track on this album, too... <br />
</p></div><br />
(<abbr class="rating" title="5">*****</abbr>)<br />
<p class="reviewer vcard">Review by <br />
<a class="url fn" href="http://ifindkarma.com/blog/">Adam Rifkin</a>, <br />
<abbr class="dtreviewed" title="200502">February 2005</abbr><br />
</p><br />
</div><br />
</nowiki></pre><br />
<br />
And this hReview might be presented like this:<br />
<br />
<br />
[Album cover photo: ]<br />
[The Postal Service:]<br />
[ Give Up ]<br />
<br />
The Postal Service: Give Up<br />
<br />
"The people thought they were just being rewarded for treating others as they like to be treated, for obeying stop signs and curing diseases, for mailing letters with the address of the sender... Don't wake me, I plan on sleeping in..."<br />
<br />
"Nothing Better" is a great track on this album, too...<br />
<br />
(*****)<br />
<br />
Review by Adam Rifkin, February 2005.<br />
<br />
=== Movie Review ===<br />
Finally, here is an example of a movie review.<br />
<br />
<pre><nowiki><br />
<div><br />
<span>anonymous, April 18th, 2005</span><br />
<div><br />
<a lang="zh" href="http://www.imdb.com/title/tt0299977/"><br />
Ying Xiong (<span lang="en">HERO</span>)<br />
</a><br />
</div><br />
<div>Rating: 4 out of 5</div><br />
<blockquote><p><br />
This movie has great visuals and music.<br />
</p></blockquote><br />
</div><br />
</nowiki></pre><br />
<br />
With hReview:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><br />
<span class="reviewer vcard"><br />
<span class="fn">anonymous</span>, <br />
<abbr class="dtreviewed" title="20050418">April 18th, 2005</abbr><br />
</span><br />
<div class="item"><br />
<a lang="zh" class="url fn" href="http://www.imdb.com/title/tt0299977/"><br />
Ying Xiong (<span lang="en">HERO</span>)<br />
</a><br />
</div><br />
<div>Rating: <span class="rating">4</span> out of 5</div><br />
<div class="description"><p><br />
This movie has great music and visuals.<br />
</p></div><br />
</div><br />
</nowiki></pre><br />
<br />
Which could be presented like this:<br />
<br />
anonymous, April 18th, 2005<br /><br />
Ying Xiong (HERO)<br /><br />
Rating: 4 out of 5<br /><br />
<br />
This movie has great music and visuals.<br />
<br />
== Examples in the wild ==<br />
This section is '''informative'''. The number of hReview examples in the wild has expanded far beyond the capacity of being kept inline in this specification. They have been moved to a [[hreview-examples-in-wild|separate page]].<br />
<br />
See [[hreview-examples-in-wild|hReview Examples in the wild]].<br />
<br />
== Implementations ==<br />
This section is '''informative'''. The number of hReview implementations has also expanded beyond the capacity of keeping them inline. They have been moved to a [[hreview-implementations|separate page]].<br />
<br />
See [[hreview-implementations|hReview Implementations]].<br />
<br />
== References ==<br />
=== Normative References ===<br />
* [http://www.w3.org/TR/2002/REC-xhtml1-20020801/ XHTML 1.0 SE]<br />
* [http://gmpg.org/xmdp/ XMDP]<br />
* [[hcard|hCard]]<br />
* [[hcalendar|hCalendar]]<br />
* [[rel-tag]]<br />
* [http://www.ietf.org/rfc/rfc2119.txt RFC2119]<br />
* [http://www.ietf.org/rfc/rfc3986.txt RFC3986]<br />
* [http://www.ietf.org/rfc/rfc4287.txt RFC4287] (Atom 1.0)<br />
<br />
=== Informative References ===<br />
* [http://www.w3.org/TR/REC-CSS1 CSS1]<br />
* ISO.8601.1988<br />
** International Organization for Standardization, "Data elements and interchange formats - Information interchange - Representation of dates and times", ISO Standard 8601, June 1988.<br />
* [http://www.w3.org/TR/1998/NOTE-datetime-19980827 W3C NOTE-datetime-19980827]<br />
* [http://www.ietf.org/rfc/rfc3667.txt RFC3667]<br />
* [http://www.ietf.org/rfc/rfc3668.txt RFC3668]<br />
* [http://www.w3.org/Consortium/Patent-Policy-20040205/ W3C Patent Policy]<br />
* [http://local.yahoo.com/details?id=21359628 Crepes on Cole reviews on Yahoo! Local]<br />
* Other reviews efforts. See [[reviews-formats]].<br />
* Contributed from http://developers.technorati.com/wiki/hReview.<br />
<br />
==== Similar Work ====<br />
* [[hlisting-proposal|hListing]]<br />
* [[xoxo|XOXO]]<br />
<br />
=== Copyright ===<br />
{{MicroformatCopyrightStatement2005}}<br />
<br />
=== Patents ===<br />
{{MicroFormatPatentStatement}}<br />
<br />
== Work in progress ==<br />
This specification is a work in progress. As additional aspects are discussed, understood, and written, they will be added. <br />
<br />
=== Changes from v0.2 ===<br />
The following changes have been made in hReview v0.3 over [[hreview-v0.2|hReview v0.2]]:<br />
<br />
Normative changes:<br />
# MUST (instead of SHOULD) use [[hcard|hCard]] for the item description of a business or person<br />
# "reviewer" changes<br />
## Made reviewer *optional* per feedback from Ryan King and Mark Nottingham<br />
## If reviewer is absent from the hReview, then look outside the hReview, in the context of the page, for the reviewer. If there is no "reviewer" outside either, then use the author information according to the containing document language (e.g. <code><nowiki><address></nowiki></code> for (X)HTML pages) as the reviewer.<br />
## MUST (instead of SHOULD) use [[hcard|hCard]] to represent reviewer information<br />
# "dtreviewed" changes<br />
## Made dtreviewed *optional* per feedback from Ryan King and Mark Nottingham<br />
## If dtreviewed is absent from the hReview, then look outside the hReview, in the surrounding context. If the context is an [[hatom|hAtom]] entry, use its "published" (or "updated" if that is missing) datetime as the dtreviewed, if not present on the entry, use the "published" (or "updated" if that is missing) of the feed. Otherwise use the information according to the containing document language (e.g. "published"/"updated" similarly for Atom feeds), then protocol (e.g. HTTP Last-Modified, or file system last modified datetime).<br />
# SHOULD use [[hcalendar|hCalendar]] to represent an item of 'type' 'event'<br />
# Added one decimal digit of precision to ratings' numerical values based on publisher experience.<br />
# Use [http://microformats.org/wiki/hcard#Value_excerpting the "value" construct from hCard] (as it is used in "tel" properties for example) to more explicitly markup the rating value when also providing (marking up) the best/worst of a rating.<br />
# Added [[rel-license]] to indicate the license of the hReview as a whole.<br />
# Permit tags inside ratings to denote rated tags, the same as ratings inside tags per suggestion from Eran Globen.<br />
# Add [[include-pattern]] support to allow multiple reviews for the same item to not repeat the item info.<br />
<br />
Informative changes (several, but in particular):<br />
# Note that scalar/rated tags would ideally use a tag space that explain the ratings for that tag. E.g. to explain what Food:18/30 means.<br />
# Updated examples accordingly.<br />
<br />
== Further Reading ==<br />
* See also [http://www.technorati.com/cosmos/referer.html blogs discussing this page].<br />
== Related Pages People==<br />
* Sildenafil citrate, sold under the [http://www.efficacylevitra.info names Levitra]<br />
* A ring tone is the sound made by a telephone to indicate an [http://freeringtonemp.info incoming call]<br />
* Viagra pills are blue and [http://orderviagrales.info diamond-shaped] with the words.<br />
* Both Viagra and the Levitra are derived from [http://levitravsviagra.info Proto-Indo-Iranian]<br />
* The mode of action of [http://ordertramadoline.info tramadol] has yet to be fully understood.<br />
* Phentermine is a drug primarily used as an [http://pharmacyphentermine.info appetite suppressant]<br />
* The proper definition of [http://replicawatchbmw.info replica]<br />
* Alprazolam was [http://valiumxanax.info originally marketed] as an atypical benzodiazepine, but only classified for use treating anxiety neurosis.<br />
<br />
== Related Pages ==<br />
{{hreview-related-pages}}</div>Adminihttps://microformats.org/wiki/index.php?title=hreview&diff=13934hreview2007-03-03T21:22:13Z<p>Admini: /* Further Reading */</p>
<hr />
<div><h1> hReview 0.3 </h1><br />
<br />
[[hreview|hReview]] is a simple, open, distributed format, suitable for embedding reviews (of products, services, businesses, events, etc.) in (X)HTML, Atom, RSS, and arbitrary XML. hReview is one of several [[microformats]] open standards.<br />
<br />
Want to get started with writing an [[hreview|hReview]]? Use the [http://microformats.org/code/hreview/creator hReview creator] to write a review and publish it.<br />
<br />
== Microformats Draft Specification 2006-02-22 ==<br />
<br />
; Editor: [http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc.]<br />
; Authors: [http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc.]<br />
: [http://360.yahoo.com/alidiabali Ali Diab],[http://yahoo.com Yahoo! Inc.]<br />
: [http://spaces.msn.com/members/ianmcallister/ Ian McAllister], [http://microsoft.com/ Microsoft Corporation]<br />
: [http://journals.aol.com/panzerjohn/abstractioneer John Panzer], [http://www.aol.com America Online, Inc.]<br />
: [http://ifindkarma.com/blog Adam Rifkin], [http://labs.commerce.net/ CommerceNet Labs]<br />
: [http://sippey.typepad.com/ Michael Sippey], [http://sixapart.com Six Apart, Ltd.], [http://efficacylevitra.info/linki.htm Lin Fart.]<br />
<br />
Microformats [http://microformats.org/wiki/hreview#Copyright copyright] and [http://microformats.org/wiki/hreview#Patents patents] statements apply.<br />
<br />
__TOC__<br />
<br />
== Introduction ==<br />
Numerous web sites publish reviews using a broad variety of schema for all sorts of things from products (movies, music, books), to businesses (restaurants, hotels, stores), to events (concerts, theatre), to people (artists, leaders, celebrities), to places (landmarks, parks), to online resources (web pages, files), to reviews of reviews themselves.<br />
<br />
In order to enable and encourage the sharing, distribution, syndication, and aggregation, of reviews, the authors propose the hReview microformat, an open standard for distributed reviews. The authors have researched both numerous [[review-examples]] in the wild and earlier attempts at [[review-formats]], and have designed hReview around a simple minimal schema for reviews. Feedback is encouraged on the [[hreview-feedback|hReview feedback]] page.<br />
<br />
=== Inspiration and Acknowledgments ===<br />
Thanks to everyone who responded to the open call for implementor participation for hReview. The authors in particular wish to thank the following individuals for their constructive input and feedback: [http://www.richardault.com/ Richard Ault], [http://dannyayers.com Danny Ayers], [http://www.vertexdev.com/~jeff/ Jeffrey Barr],[http://adriancuthbert.blogspot.com/ Adrian Cuthbert],[http://jason.defillippo.com/ Jason DeFillippo], [http://www.hybernaut.com/bdv Brian Del Vecchio], Scott Derringer, [http://budgibson.com/home/ Bud Gibson], [http://joi.ito.com/ Joi Ito], [http://www.kanai.net/weblog/ Gen Kanai],[http://niallkennedy.com/ Niall Kennedy], [http://labs.commerce.net/wiki/index.php/Rohit_Khare Rohit Khare], [http://theryanking.com/ Ryan King], [http://www.jluster.org/ Jonas Luster], [http://epeus.blogspot.com/ Kevin Marks], Mark Nottingham, [http://www.powazek.com/ Derek Powazek], [http://www.judysbook.com/ Jeff Rodenburg], [http://sifry.com/alerts/ David Sifry], [http://jystewart.net/ James Stewart], [http://kung-foo.tv/ Adriaan Tijsseling], [http://www.flashenabled.com/ Phillip Torrone], Thai Tran, [http://w6daily.winn.com/ Phillip Winn], [http://yohei-y.blogspot.com YAMAMOTO Yohei].<br />
<br />
=== Scope ===<br />
Reviews consistently share several common fields. Where possible hReview has been based on this minimal common subset.<br />
<br />
==== Out of scope ====<br />
Fields that are type-specific have been omitted from hReview. It is important that hReview be kept simple and minimal from the start. Additional features can be added as deemed necessary by practical implementation experience.<br />
<br />
The concept of a "universal object identifier", that is, how to identify the same object/item/product across different shopping sites, though something very useful to have, is outside the scope of this format.<br />
<br />
== Semantic XHTML Design Principles ==<br />
{{semantic-xhtml-design-principles}}<br />
<br />
== Format ==<br />
=== In General ===<br />
The hReview format is based on a set of fields common to numerous review sites and formats in use today on the web. Where possible field names have been chosen based on those defined by the related [[hcard|hCard]] and [[hcalendar|hCalendar]] standards.<br />
<br />
=== Schema ===<br />
The hReview schema consists of the following:<br />
<br />
* hReview ('''<code>hreview</code>''')<br />
** '''<code>version</code>'''. optional. text.<br />
** '''<code>summary</code>'''. optional. text.<br />
** item '''<code>type</code>'''. optional. product | business | event | person | place | website | url.<br />
** '''<code>item</code>''' info. required. '''<code>fn</code>''' ('''<code>url</code>''' || '''<code>photo</code>''' ) | '''[[hcard|hCard]]''' (for person or business) | '''[[hcalendar|hCalendar]]''' (for event)<br />
** '''<code>reviewer</code>'''. optional. '''[[hcard|hCard]]'''.<br />
** '''<code>dtreviewed</code>'''. optional. ISO8601 absolute date time.<br />
** '''<code>rating</code>'''. optional. fixed point integer [1.0-5.0], with optional alternate '''<code>worst</code>''' (default:1.0) and/or '''<code>best</code>''' (default:5.0), also fixed point integers, and explicit '''<code>value</code>'''.<br />
** '''<code>description</code>'''. optional. text with optional valid XHTML markup.<br />
** tags. optional. keywords or phrases, using '''[[rel-tag]]''', each with optional rating.<br />
** permalink. optional, using '''[[rel-bookmark]]''' and '''[[rel-self]]'''.<br />
** license. optional, using '''[[rel-license]]'''.<br />
<br />
=== Field details ===<br />
The fields of the hReview schema represent the following:<br />
<br />
'''version''':: This optional field permits hReview publishers to specify a particular version of hReview that their content uses. By omitting this field, the publisher is stating that implementations may interpret the hReviews according to any version of the hReview specification v0.2 or later. In practice the authors of this specification are comitted to maintaining backward compatibility with content produced using earlier versions of the specification. This field is syntax compatible with, and thus reuses the semantics of "VERSION" as defined in vCard RFC2426 section "3.6.9 VERSION Type Definition". The value of this field for this specification is "0.3".<br />
<br />
'''summary''':: This optional field serves as a title for the review itself.<br />
<br />
'''item type''':: This optional field "type" provides the type of the item being reviewed, one of the following: product, business, event, person, place, website, url. If omitted, then in some cases the item type may be inferred. If the item is also an [[hcard|hCard]], then the item type is a "business" or a "person" based upon which of those the hCard represents. If the item is also an [[hcalendar|hCalendar]] event, then the item type is an "event".<br />
<br />
'''item info''':: This required field MUST have at a minimum the name ("fn" - the formatted text corresponding to the name) of ''the'' item (an hReview describes only one item), SHOULD provide at least one URI ("url") for the item, and MAY provide at least one URL to a photo or depiction ("photo") of the item. For items of type person or business, the item info (fn, url, photo) MUST be encapsulated in an [[hcard|hCard]]. For items of type event, the item info SHOULD be encapsulated in an [[hcalendar|hCalendar]] "vevent". Unique item IDs (e.g. ISBNs, UPCs) MAY be represented as a URN ("url") for the item. Encapsulated microformats (e.g. [[hcard|hCard]] and [[hcalendar|hCalendar]] events for now) may be set on the item itself (e.g. class="item vcard"). However, when using item info subproperties ("fn", "url", "photo"), they MUST be nested <em>inside</em> the item element.<br />
<br />
'''reviewer''':: The optional field specifies the person who authored the review. If the reviewer is specified, an hCard representing the reviewer MUST be provided. For anonymous reviews, use "anonymous" (without quotes) for the full name of the reviewer. If no "reviewer" is found inside the hReview, parsers should look outside the hReview, in the context of the page, for the "reviewer". If there is no "reviewer" outside either, then parsers should use the author defined by the containing document language, e.g. for (X)HTML documents, the <code><nowiki><address></nowiki></code> contact info for the page (which is ideally marked up as an [[hcard|hCard]] as well), for Atom 1.0 the <code><nowiki><entry></nowiki></code> <code><nowiki><author></nowiki></code> if present and if not the <code><nowiki><feed></nowiki></code> <code><nowiki><author></nowiki></code>, for RSS the <code><nowiki><author></nowiki></code> inside the containing <code><nowiki><item></nowiki></code> element.<br />
<br />
'''dtreviewed''':: This optional field when present MUST provide an ISO8601 absolute date time of when the review was written or otherwise authored. This field SHOULD use UTC, but MAY use the time zone offset syntax. If dtreviewed is absent from the hReview, then look outside the hReview, in the surrounding context. If the context is an [[hatom|hAtom]] entry, use its "published" (or "updated" if that is missing) datetime as the dtreviewed, if not present on the entry, use the "published" (or "updated" if that is missing) of the feed. Otherwise use the creation date (or modified date if that is missing) information according to the containing document language (e.g. "published"/"updated" similarly for Atom feeds), then protocol (e.g. HTTP Last-Modified, or file system last modified datetime) as the dtreviewed.<br />
<br />
'''rating''':: The rating is a fixed point integer (one decimal point of precision) from 1.0 to 5.0 inclusive indicating a rating for the item, higher indicating a better rating by default. Optionally a different integral "worst" value and/or "best" value MAY be specified to indicate a different range (e.g. 6 from 0-10). The "best" value may be numerically smaller than the "worst" value.<br />
<br />
'''description''':: This optional field contains the full text representing the written opinion of the reviewer. The field MAY include valid XHTML markup (e.g. paragraphs). User agents SHOULD preserve any markup. Multiple descriptions or section descriptions (e.g. pros and cons, plusses and minusses) SHOULD be included in the description field.<br />
<br />
'''tags''':: Tags are represented using a list of keywords or phrases (using the [[rel-tag]] microformat for each individual keyword or phrase tag) that the reviewer associates with the item. The reviewer MAY optionally provide a tag-specific rating inside each [[rel-tag]], e.g. ambience:5. Tag-specific ratings by default use the same range as an overall rating for the item if present, and MAY also have a custom worst...best range specified. Authors MAY also invert this structure for the same semantic if it is more convenient for their markup, that is, place the [[rel-tag]] inside a rating to indicate a rated tag. Note: rated tags should ideally use a tag space that explains what the ratings for that tag mean. E.g. Food:18/30 should link to a tags space for Food that explains what an 18 out of 30 means for the Food tag.<br />
<br />
'''permalink''':: This optional field is a URL for the hReview. In addition to using the <code><a href></code> tag for this field, the attribute <code>rel="self bookmark"</code> MUST be used to indicate that the hyperlink is a permalink for the review itself. If the hyperlink already contains a <code>rel</code> attribute, then the values <code>self</code> and <code>bookmark</code> MUST be included among the space-separated set of values in the attribute. Indexers MAY treat the permalink of a review as a unique ID in order to identify and collate the same review from multiple sources (such as indexing a page multiple times). The permalink MAY also be used to indicate or imply the origin of the review. Authors MAY use the classname of "permalink" on the element representing the permalink, but are not required to do so.<br />
<br />
'''license''':: This optional field links to the license under which the contents of the hReview itself is licensed, using the '''[[rel-license]]''' microformat.<br />
<br />
<br />
The following field names have been reused from the [[hcard|hCard]] and [[hcalendar|hCalendar]] microformats: <code>version, summary, fn, url, photo, description</code>. In addition, items and reviewers described by hCards MAY contain any hCard field. The rel value "self" has been reused from the [http://atompub.org/2005/07/11/draft-ietf-atompub-format-10.html Atom 1.0 specification].<br />
<br />
=== More Semantic Equivalents ===<br />
<br />
For some properties there is a more semantic equivalent, and therefore they get special treatment, e.g.: <br />
<br />
* For any "url", use <code><a class="url" href="...">...</a></code> inside the element with the class name 'hreview' in hReview.<br />
* And for "photo", use <code><img class="photo" src="..." alt="Photo of ..." /></code> <br />
<br />
* Ratings are often presented either as a set of images or characters, e.g. "***". For these, the <code>&lt;abbr&gt;</code> element is particularly useful, as such characters are an abbreviation for the precise rating, e.g. <code>&lt;abbr class="rating" title="3.0"&gt;***&lt;/abbr&gt;</code>. This is further explored in the next section.<br />
<br />
==== Language ====<br />
* To explicitly convey the natural language that an hReview is written in, use the standard (X)HTML 'lang' attribute on the element with class="hreview", e.g. <code>&lt;div class="hreview" lang="en"&gt; ... &lt;/div&gt;</code> If portions of an hReview (e.g. the item name) are in a different language, use the 'lang' attribute on those portions.<br />
* hReview processors which need to handle the language of reviews MUST process the standard (X)HTML 'lang' attribute as specified.<br />
<br />
=== Human vs. Machine Readable ===<br />
If an <code>&lt;abbr></code> element is used for a property, then its '<code>title</code>' attribute is used for the value of the property, instead of the contents of the element, which can then be used to provide a user-friendly alternate presentation of the value. <br />
<br />
Similarly, if an <code><img /></code> element is used for one or more properties, it MUST be treated as follows: <br />
<br />
# For the "photo" property and any other property that takes a URL as its value, the <code>src="..."</code> attribute provides the property value. <br />
# For other properties, the <code><img /></code> element's '<code>alt</code>' attribute is the value of the property.<br />
<br />
=== Object Includes ===<br />
<br />
hReview 0.3 includes support for the object [[include-pattern]].<br />
<br />
Often a single page lists an item, and then several reviews for that item. In order to avoid having to repeat the item info for each review of the item, the first review should be marked up as an hReview, with a unique "id" attribute on the item info, and then following reviews should use the object [[include-pattern]] to include the item info from the first review.<br />
<br />
<br />
=== Notes ===<br />
This section is informative.<br />
<br />
* By marking up a review with the hReview microformat, the expectation is communicated that the review MAY be indexed. This has no impact on the copyright of the review itself which the publisher may explicitly specify using [[rel-license]] as specified above.<br />
* The enumerated list of item types is under development and may be extended.<br />
* Each type may have custom hReview fields that follow the common set.<br />
* Additional details about a particular item should be specified with the rest of the item's info at the URL provided for the item.<br />
* Most rating systems use the range 1.0 to 5.0, and most of those represent the rating as a number (and possibly half) of stars. Sites may use whatever graphic they wish to represent the rating.<br />
<br />
== Examples ==<br />
Here are a few examples of reviews from current web sites, and how they could be easily enhanced to support the hReview structured review microformat. <br />
<br />
Want to get started with writing an [[hreview|hReview]]? Use the [http://microformats.org/code/hreview/creator hReview creator] to write a review and publish it on your blog.<br />
<br />
=== Restaurant reviews ===<br />
<br />
Here is an example of a simple online restaurant review:<br />
<br />
<pre><nowiki><br />
<div><br />
<span>5 stars out of 5 stars</span><br />
<h4>Crepes on Cole is awesome</h4><br />
<span>Reviewer: <span>Tantek</span> - April 18, 2005</span><br />
<blockquote><p><br />
Crepes on Cole is one of the best little creperies in San Francisco. <br />
Excellent food and service. Plenty of tables in a variety of sizes <br />
for parties large and small. Window seating makes for excellent <br />
people watching to/from the N-Judah which stops right outside. <br />
I've had many fun social gatherings here, as well as gotten <br />
plenty of work done thanks to neighborhood WiFi.<br />
</p></blockquote><br />
<p>Visit date: <span>April 2005</span></p><br />
<p>Food eaten: <span>Florentine crepe</span></p><br />
</div><br />
</nowiki></pre><br />
<br />
Adding hReview to this review is quite simple:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><br />
<span><span class="rating">5</span> out of 5 stars</span><br />
<h4 class="summary">Crepes on Cole is awesome</h4><br />
<span class="reviewer vcard">Reviewer: <span class="fn">Tantek</span> - <br />
<abbr class="dtreviewed" title="20050418T2300-0700">April 18, 2005</abbr></span><br />
<div class="description item vcard"><p><br />
<span class="fn org">Crepes on Cole</span> is one of the best little <br />
creperies in <span class="adr"><span class="locality">San Francisco</span></span>.<br />
Excellent food and service. Plenty of tables in a variety of sizes <br />
for parties large and small. Window seating makes for excellent <br />
people watching to/from the N-Judah which stops right outside. <br />
I've had many fun social gatherings here, as well as gotten <br />
plenty of work done thanks to neighborhood WiFi.<br />
</p></div><br />
<p>Visit date: <span>April 2005</span></p><br />
<p>Food eaten: <span>Florentine crepe</span></p><br />
</div><br />
</nowiki></pre><br />
<br />
Note that some of the properties of this sample review are not captured by hReview (visit date, food eaten). This is deliberate per the scope of keeping hReview minimal and simple.<br />
<br />
This sample hReview could be rendered like this:<br />
<br />
5 stars out of 5 stars<br /><br />
'''Crepes on Cole is awesome'''<br /><br />
Reviewer: Tantek - April 18, 2005<br /><br />
<br />
Crepes on Cole is one of the best little creperies in San Francisco. Excellent food and service. Plenty of tables in a variety of sizes for parties large and small. Window seating makes for excellent people watching to/from the N-Judah which stops right outside. I've had many fun social gatherings here, as well as gotten plenty of work done thanks to neighborhood wifi.<br />
<br />
Visit date: April 2005<br /><br />
Food eaten: Florentine crepe<br /><br />
<br />
==== Multidimensional Restaurant Review ====<br />
Some restaurant reviews indicate ratings for different aspects of the restaurant. Such details are represented in hReview using tagged ratings. In addition, note the inline tags inside the description of this review.<br />
<br />
Here is one such review in text format:<br />
<br />
Cafe Borrone<br />
<br />
1010 El Camino Real, Menlo Park, CA 94025, +1-650-327-0830;<br />
cafeborrone.com<br />
<br />
Food: 18/30; Ambience: 19/30; Service: 15/30; Price: $$...<br />
<br />
This cafe is a welcoming oasis on the Peninsula. It even has a fountain<br />
outside which cloaks the nearby sounds of El Camino traffic. Next door to a <br />
superb indy bookstore, Cafe Borrone is an ideal spot to grab a coffee or a <br />
snack to accompany a newly purchased book or imported periodical. Soups and <br />
sandwich specials rotate daily. The corn chowder with croutons and big <br />
chunks of cheese goes especially well with a freshly toasted mini-baguette. <br />
Evenings are often crowded and may require sharing a table with a perfect <br />
stranger. Espresso afficionados will appreciate the Illy coffee. Noise <br />
levels can vary from peaceful in the late mornings to nearly overwhelming on <br />
jazz band nights.<br />
<br />
As an hReview:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><br />
<div class="item vcard"><br />
<div class="fn org summary">Cafe Borrone</div><br />
<span class="adr"><br />
<span class="street-address">1010 El Camino Real</span>,<br />
<span class="locality">Menlo Park</span>,<br />
<span class="region">CA</span><br />
<span class="postal-code">94025</span>,<br />
</span><br />
<span class="tel">+1-650-327-0830</span>;<br />
<a class="url" href="http://cafeborrone.com">cafeborrone.com</a><br />
</div><br />
<ul><br />
<li class="rating"><a href="http://en.wikipedia.org/wiki/Food" rel="tag"><br />
Food: <span class="value">18</span>/<span class="best">30</span></a>;</li><br />
<li class="rating"><a href="http://flickr.com/photos/tags/Ambience" rel="tag"><br />
Ambience: <span class="value">19</span>/<span class="best">30</span></a>;</li><br />
<li class="rating"><a href="http://en.wikipedia.org/wiki/Service" rel="tag"><br />
Service: <span class="value">15</span>/<span class="best">30</span></a>;</li><br />
<li class="rating"><a href="http://en.wikipedia.org/wiki/Price" rel="tag"><br />
Price: <abbr class="value" title="2">$$</abbr>...</a></li><br />
</ul><br />
<div class="description"><p><br />
This <abbr class="type" title="business"><br />
<a href="http://en.wikipedia.org/wiki/cafe" rel="tag">cafe</a></abbr> <br />
is a welcoming oasis on the Peninsula. <br />
It even has a fountain outside which nearly eliminates <br />
the sounds of El Camino traffic. Next door to a superb indy bookstore, <br />
Cafe Borrone is an ideal spot to grab a <br />
<a href="http://en.wikipedia.org/wiki/coffee" rel="tag">coffee</a> <br />
or a meal to accompany a newly purchased book or imported periodical. <br />
<a href="http://technorati.com/tag/soup" rel="tag">Soups</a> and <br />
<a href="http://technorati.com/tag/sandwich" rel="tag">sandwich</a> <br />
specials rotate daily. The corn chowder with croutons and big chunks of cheese <br />
goes especially well with a freshly toasted mini-baguette. Evenings are <br />
often crowded and may require sharing a table with a perfect stranger. <br />
<a href="http://flickr.com/photos/tags/espresso" rel="tag">Espresso</a> <br />
afficionados will appreciate the <br />
<a href="http://en.wikipedia.org/wiki/Illy" rel="tag">Illy</a> coffee. <br />
Noise levels can vary from peaceful in the late mornings to nearly overwhelming on <br />
<a href="http://en.wikipedia.org/wiki/jazz" rel="tag">jazz</a> band nights.<br />
</p></div><br />
Review (<a href="http://microformats.org/wiki/hreview"> <br />
hReview v<span class="version">0.3</span></a>)<br />
by <span class="reviewer vcard"><span class="fn">anonymous</span></span>, <br />
<abbr class="dtreviewed" title="20050428T2130-0700">April 28th, 2005</abbr>.<br />
</div><br />
</nowiki></pre><br />
<br />
With an accompanying CSS style sheet like:<br />
<br />
<pre><nowiki><br />
a.url { display:block }<br />
ul { margin:1em 0; padding:0 }<br />
ul li { display:inline }<br />
</nowiki></pre><br />
<br />
This hReview could be presented similar to the original text:<br />
<br />
Cafe Borrone<br /><br />
1010 El Camino Real, Menlo Park, CA 94025, +1-650-327-0830;<br /><br />
[http://cafeborrone.com/ cafeborrone.com]<br /><br />
<br /><br />
[http://en.wikipedia.org/wiki/Food Food: 18/30];<br />
[http://flickr.com/photos/tags/Ambience Ambience: 19/30];<br />
[http://en.wikipedia.org/wiki/Service Service: 15/30];<br />
[http://en.wikipedia.org/wiki/Price Price: $$...]<br /><br />
<br />
This [http://en.wikipedia.org/wiki/cafe cafe] is a welcoming oasis on the Peninsula. It even has a fountain outside which cloaks the nearby sounds of El Camino traffic. Next door to a superb indy bookstore, Cafe Borrone is an ideal spot to grab a [http://en.wikipedia.org/wiki/coffee coffee] or a snack to accompany a newly purchased book or imported periodical. [http://technorati.com/tag/soup Soups] and [http://technorati.com/tag/sandwich sandwich] specials rotate daily. The corn chowder with croutons and big chunks of cheese goes especially well with a freshly toasted mini-baguette. Evenings are often crowded and may require sharing a table with a perfect stranger. [http://flickr.com/photos/tags/espresso Espresso] afficionados will appreciate the [http://en.wikipedia.org/wiki/Illy Illy] coffee. Noise levels can vary from peaceful in the late mornings to nearly overwhelming on [http://en.wikipedia.org/wiki/jazz jazz] band nights.<br />
<br />
Review ([http://microformats.org/wiki/hreview hReview v0.3]) by anonymous, April 28th, 2005.<br />
<br />
=== Product review ===<br />
Here is an example of a product review:<br />
<br />
<pre><nowiki><br />
<div><br />
<a href="http://www.amazon.com/exec/obidos/ASIN/B000089CJI/"><br />
<img src="http://images.amazon.com/images/P/B000089CJI.01._SCTHUMBZZZ_.jpg" <br />
alt="Album cover photo: The Postal Service: Give Up." /><br />
The Postal Service: Give Up</a><br />
<blockquote><p><br />
"The people thought they were just being rewarded for treating others <br />
as they like to be treated, for obeying stop signs and curing diseases, <br />
for mailing letters with the address of the sender... Don't wake me, <br />
I plan on sleeping in..."<br />
</p><p><br />
"Nothing Better" is a great track on this album, too... <br />
</p></blockquote><br />
(*****)<br />
</div><br />
</nowiki></pre><br />
<br />
Adding hReview to this review is also quite simple, but in this case requires a few more elements for the rating and reviewer which are required by hReview:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><span class="item"><br />
<a class="url fn" href="http://www.amazon.com/exec/obidos/ASIN/B000089CJI/"><br />
<img src="http://images.amazon.com/images/P/B000089CJI.01._SCTHUMBZZZ_.jpg" <br />
alt="Album cover photo: The Postal Service: Give Up. " <br />
class="photo" /><br />
The Postal Service: Give Up</a></span><br />
<div class="description"><p><br />
"The people thought they were just being rewarded for treating others <br />
as they like to be treated, for obeying stop signs and curing diseases, <br />
for mailing letters with the address of the sender... Don't wake me, <br />
I plan on sleeping in..."<br />
</p><p><br />
"Nothing Better" is a great track on this album, too... <br />
</p></div><br />
(<abbr class="rating" title="5">*****</abbr>)<br />
<p class="reviewer vcard">Review by <br />
<a class="url fn" href="http://ifindkarma.com/blog/">Adam Rifkin</a>, <br />
<abbr class="dtreviewed" title="200502">February 2005</abbr><br />
</p><br />
</div><br />
</nowiki></pre><br />
<br />
And this hReview might be presented like this:<br />
<br />
<br />
[Album cover photo: ]<br />
[The Postal Service:]<br />
[ Give Up ]<br />
<br />
The Postal Service: Give Up<br />
<br />
"The people thought they were just being rewarded for treating others as they like to be treated, for obeying stop signs and curing diseases, for mailing letters with the address of the sender... Don't wake me, I plan on sleeping in..."<br />
<br />
"Nothing Better" is a great track on this album, too...<br />
<br />
(*****)<br />
<br />
Review by Adam Rifkin, February 2005.<br />
<br />
=== Movie Review ===<br />
Finally, here is an example of a movie review.<br />
<br />
<pre><nowiki><br />
<div><br />
<span>anonymous, April 18th, 2005</span><br />
<div><br />
<a lang="zh" href="http://www.imdb.com/title/tt0299977/"><br />
Ying Xiong (<span lang="en">HERO</span>)<br />
</a><br />
</div><br />
<div>Rating: 4 out of 5</div><br />
<blockquote><p><br />
This movie has great visuals and music.<br />
</p></blockquote><br />
</div><br />
</nowiki></pre><br />
<br />
With hReview:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><br />
<span class="reviewer vcard"><br />
<span class="fn">anonymous</span>, <br />
<abbr class="dtreviewed" title="20050418">April 18th, 2005</abbr><br />
</span><br />
<div class="item"><br />
<a lang="zh" class="url fn" href="http://www.imdb.com/title/tt0299977/"><br />
Ying Xiong (<span lang="en">HERO</span>)<br />
</a><br />
</div><br />
<div>Rating: <span class="rating">4</span> out of 5</div><br />
<div class="description"><p><br />
This movie has great music and visuals.<br />
</p></div><br />
</div><br />
</nowiki></pre><br />
<br />
Which could be presented like this:<br />
<br />
anonymous, April 18th, 2005<br /><br />
Ying Xiong (HERO)<br /><br />
Rating: 4 out of 5<br /><br />
<br />
This movie has great music and visuals.<br />
<br />
== Examples in the wild ==<br />
This section is '''informative'''. The number of hReview examples in the wild has expanded far beyond the capacity of being kept inline in this specification. They have been moved to a [[hreview-examples-in-wild|separate page]].<br />
<br />
See [[hreview-examples-in-wild|hReview Examples in the wild]].<br />
<br />
== Implementations ==<br />
This section is '''informative'''. The number of hReview implementations has also expanded beyond the capacity of keeping them inline. They have been moved to a [[hreview-implementations|separate page]].<br />
<br />
See [[hreview-implementations|hReview Implementations]].<br />
<br />
== References ==<br />
=== Normative References ===<br />
* [http://www.w3.org/TR/2002/REC-xhtml1-20020801/ XHTML 1.0 SE]<br />
* [http://gmpg.org/xmdp/ XMDP]<br />
* [[hcard|hCard]]<br />
* [[hcalendar|hCalendar]]<br />
* [[rel-tag]]<br />
* [http://www.ietf.org/rfc/rfc2119.txt RFC2119]<br />
* [http://www.ietf.org/rfc/rfc3986.txt RFC3986]<br />
* [http://www.ietf.org/rfc/rfc4287.txt RFC4287] (Atom 1.0)<br />
<br />
=== Informative References ===<br />
* [http://www.w3.org/TR/REC-CSS1 CSS1]<br />
* ISO.8601.1988<br />
** International Organization for Standardization, "Data elements and interchange formats - Information interchange - Representation of dates and times", ISO Standard 8601, June 1988.<br />
* [http://www.w3.org/TR/1998/NOTE-datetime-19980827 W3C NOTE-datetime-19980827]<br />
* [http://www.ietf.org/rfc/rfc3667.txt RFC3667]<br />
* [http://www.ietf.org/rfc/rfc3668.txt RFC3668]<br />
* [http://www.w3.org/Consortium/Patent-Policy-20040205/ W3C Patent Policy]<br />
* [http://local.yahoo.com/details?id=21359628 Crepes on Cole reviews on Yahoo! Local]<br />
* Other reviews efforts. See [[reviews-formats]].<br />
* Contributed from http://developers.technorati.com/wiki/hReview.<br />
<br />
==== Similar Work ====<br />
* [[hlisting-proposal|hListing]]<br />
* [[xoxo|XOXO]]<br />
<br />
=== Copyright ===<br />
{{MicroformatCopyrightStatement2005}}<br />
<br />
=== Patents ===<br />
{{MicroFormatPatentStatement}}<br />
<br />
== Work in progress ==<br />
This specification is a work in progress. As additional aspects are discussed, understood, and written, they will be added. <br />
<br />
=== Changes from v0.2 ===<br />
The following changes have been made in hReview v0.3 over [[hreview-v0.2|hReview v0.2]]:<br />
<br />
Normative changes:<br />
# MUST (instead of SHOULD) use [[hcard|hCard]] for the item description of a business or person<br />
# "reviewer" changes<br />
## Made reviewer *optional* per feedback from Ryan King and Mark Nottingham<br />
## If reviewer is absent from the hReview, then look outside the hReview, in the context of the page, for the reviewer. If there is no "reviewer" outside either, then use the author information according to the containing document language (e.g. <code><nowiki><address></nowiki></code> for (X)HTML pages) as the reviewer.<br />
## MUST (instead of SHOULD) use [[hcard|hCard]] to represent reviewer information<br />
# "dtreviewed" changes<br />
## Made dtreviewed *optional* per feedback from Ryan King and Mark Nottingham<br />
## If dtreviewed is absent from the hReview, then look outside the hReview, in the surrounding context. If the context is an [[hatom|hAtom]] entry, use its "published" (or "updated" if that is missing) datetime as the dtreviewed, if not present on the entry, use the "published" (or "updated" if that is missing) of the feed. Otherwise use the information according to the containing document language (e.g. "published"/"updated" similarly for Atom feeds), then protocol (e.g. HTTP Last-Modified, or file system last modified datetime).<br />
# SHOULD use [[hcalendar|hCalendar]] to represent an item of 'type' 'event'<br />
# Added one decimal digit of precision to ratings' numerical values based on publisher experience.<br />
# Use [http://microformats.org/wiki/hcard#Value_excerpting the "value" construct from hCard] (as it is used in "tel" properties for example) to more explicitly markup the rating value when also providing (marking up) the best/worst of a rating.<br />
# Added [[rel-license]] to indicate the license of the hReview as a whole.<br />
# Permit tags inside ratings to denote rated tags, the same as ratings inside tags per suggestion from Eran Globen.<br />
# Add [[include-pattern]] support to allow multiple reviews for the same item to not repeat the item info.<br />
<br />
Informative changes (several, but in particular):<br />
# Note that scalar/rated tags would ideally use a tag space that explain the ratings for that tag. E.g. to explain what Food:18/30 means.<br />
# Updated examples accordingly.<br />
<br />
== Further Reading ==<br />
* See also [http://www.technorati.com/cosmos/referer.html blogs discussing this page].<br />
== Related Pages People==<br />
* Sildenafil citrate, sold under the [http://www.efficacylevitra.info names Levitra]<br />
* A ring tone is the sound made by a telephone to indicate an [http://freeringtonemp.info incoming call]<br />
* Viagra pills are blue and [http://orderviagrales.info diamond-shaped] with the words.<br />
* Both Viagra and the Levitra are derived from [http://levitravsviagra.info Proto-Indo-Iranian]<br />
* The mode of action of [http://ordertramadoline.info tramadol] has yet to be fully understood.<br />
* Phentermine is a drug primarily used as an [http://pharmacyphentermine.info appetite suppressant]<br />
* The proper definition of [http://replicawatchbmw.info replica]<br />
* Alprazolam was [http://valiumxanax.info originally marketed] as an atypical benzodiazepine, but only classified for use treating anxiety neurosis.<br />
<br />
== Related Pages ==<br />
{{hreview-related-pages}}</div>Adminihttps://microformats.org/wiki/index.php?title=hreview&diff=13931hreview2007-03-03T20:58:18Z<p>Admini: /* Further Reading */</p>
<hr />
<div><h1> hReview 0.3 </h1><br />
<br />
[[hreview|hReview]] is a simple, open, distributed format, suitable for embedding reviews (of products, services, businesses, events, etc.) in (X)HTML, Atom, RSS, and arbitrary XML. hReview is one of several [[microformats]] open standards.<br />
<br />
Want to get started with writing an [[hreview|hReview]]? Use the [http://microformats.org/code/hreview/creator hReview creator] to write a review and publish it.<br />
<br />
== Microformats Draft Specification 2006-02-22 ==<br />
<br />
; Editor: [http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc.]<br />
; Authors: [http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc.]<br />
: [http://360.yahoo.com/alidiabali Ali Diab],[http://yahoo.com Yahoo! Inc.]<br />
: [http://spaces.msn.com/members/ianmcallister/ Ian McAllister], [http://microsoft.com/ Microsoft Corporation]<br />
: [http://journals.aol.com/panzerjohn/abstractioneer John Panzer], [http://www.aol.com America Online, Inc.]<br />
: [http://ifindkarma.com/blog Adam Rifkin], [http://labs.commerce.net/ CommerceNet Labs]<br />
: [http://sippey.typepad.com/ Michael Sippey], [http://sixapart.com Six Apart, Ltd.]<br />
<br />
Microformats [http://microformats.org/wiki/hreview#Copyright copyright] and [http://microformats.org/wiki/hreview#Patents patents] statements apply.<br />
<br />
__TOC__<br />
<br />
== Introduction ==<br />
Numerous web sites publish reviews using a broad variety of schema for all sorts of things from products (movies, music, books), to businesses (restaurants, hotels, stores), to events (concerts, theatre), to people (artists, leaders, celebrities), to places (landmarks, parks), to online resources (web pages, files), to reviews of reviews themselves.<br />
<br />
In order to enable and encourage the sharing, distribution, syndication, and aggregation, of reviews, the authors propose the hReview microformat, an open standard for distributed reviews. The authors have researched both numerous [[review-examples]] in the wild and earlier attempts at [[review-formats]], and have designed hReview around a simple minimal schema for reviews. Feedback is encouraged on the [[hreview-feedback|hReview feedback]] page.<br />
<br />
=== Inspiration and Acknowledgments ===<br />
Thanks to everyone who responded to the open call for implementor participation for hReview. The authors in particular wish to thank the following individuals for their constructive input and feedback: [http://www.richardault.com/ Richard Ault], [http://dannyayers.com Danny Ayers], [http://www.vertexdev.com/~jeff/ Jeffrey Barr],[http://adriancuthbert.blogspot.com/ Adrian Cuthbert],[http://jason.defillippo.com/ Jason DeFillippo], [http://www.hybernaut.com/bdv Brian Del Vecchio], Scott Derringer, [http://budgibson.com/home/ Bud Gibson], [http://joi.ito.com/ Joi Ito], [http://www.kanai.net/weblog/ Gen Kanai],[http://niallkennedy.com/ Niall Kennedy], [http://labs.commerce.net/wiki/index.php/Rohit_Khare Rohit Khare], [http://theryanking.com/ Ryan King], [http://www.jluster.org/ Jonas Luster], [http://epeus.blogspot.com/ Kevin Marks], Mark Nottingham, [http://www.powazek.com/ Derek Powazek], [http://www.judysbook.com/ Jeff Rodenburg], [http://sifry.com/alerts/ David Sifry], [http://jystewart.net/ James Stewart], [http://kung-foo.tv/ Adriaan Tijsseling], [http://www.flashenabled.com/ Phillip Torrone], Thai Tran, [http://w6daily.winn.com/ Phillip Winn], [http://yohei-y.blogspot.com YAMAMOTO Yohei].<br />
<br />
=== Scope ===<br />
Reviews consistently share several common fields. Where possible hReview has been based on this minimal common subset.<br />
<br />
==== Out of scope ====<br />
Fields that are type-specific have been omitted from hReview. It is important that hReview be kept simple and minimal from the start. Additional features can be added as deemed necessary by practical implementation experience.<br />
<br />
The concept of a "universal object identifier", that is, how to identify the same object/item/product across different shopping sites, though something very useful to have, is outside the scope of this format.<br />
<br />
== Semantic XHTML Design Principles ==<br />
{{semantic-xhtml-design-principles}}<br />
<br />
== Format ==<br />
=== In General ===<br />
The hReview format is based on a set of fields common to numerous review sites and formats in use today on the web. Where possible field names have been chosen based on those defined by the related [[hcard|hCard]] and [[hcalendar|hCalendar]] standards.<br />
<br />
=== Schema ===<br />
The hReview schema consists of the following:<br />
<br />
* hReview ('''<code>hreview</code>''')<br />
** '''<code>version</code>'''. optional. text.<br />
** '''<code>summary</code>'''. optional. text.<br />
** item '''<code>type</code>'''. optional. product | business | event | person | place | website | url.<br />
** '''<code>item</code>''' info. required. '''<code>fn</code>''' ('''<code>url</code>''' || '''<code>photo</code>''' ) | '''[[hcard|hCard]]''' (for person or business) | '''[[hcalendar|hCalendar]]''' (for event)<br />
** '''<code>reviewer</code>'''. optional. '''[[hcard|hCard]]'''.<br />
** '''<code>dtreviewed</code>'''. optional. ISO8601 absolute date time.<br />
** '''<code>rating</code>'''. optional. fixed point integer [1.0-5.0], with optional alternate '''<code>worst</code>''' (default:1.0) and/or '''<code>best</code>''' (default:5.0), also fixed point integers, and explicit '''<code>value</code>'''.<br />
** '''<code>description</code>'''. optional. text with optional valid XHTML markup.<br />
** tags. optional. keywords or phrases, using '''[[rel-tag]]''', each with optional rating.<br />
** permalink. optional, using '''[[rel-bookmark]]''' and '''[[rel-self]]'''.<br />
** license. optional, using '''[[rel-license]]'''.<br />
<br />
=== Field details ===<br />
The fields of the hReview schema represent the following:<br />
<br />
'''version''':: This optional field permits hReview publishers to specify a particular version of hReview that their content uses. By omitting this field, the publisher is stating that implementations may interpret the hReviews according to any version of the hReview specification v0.2 or later. In practice the authors of this specification are comitted to maintaining backward compatibility with content produced using earlier versions of the specification. This field is syntax compatible with, and thus reuses the semantics of "VERSION" as defined in vCard RFC2426 section "3.6.9 VERSION Type Definition". The value of this field for this specification is "0.3".<br />
<br />
'''summary''':: This optional field serves as a title for the review itself.<br />
<br />
'''item type''':: This optional field "type" provides the type of the item being reviewed, one of the following: product, business, event, person, place, website, url. If omitted, then in some cases the item type may be inferred. If the item is also an [[hcard|hCard]], then the item type is a "business" or a "person" based upon which of those the hCard represents. If the item is also an [[hcalendar|hCalendar]] event, then the item type is an "event".<br />
<br />
'''item info''':: This required field MUST have at a minimum the name ("fn" - the formatted text corresponding to the name) of ''the'' item (an hReview describes only one item), SHOULD provide at least one URI ("url") for the item, and MAY provide at least one URL to a photo or depiction ("photo") of the item. For items of type person or business, the item info (fn, url, photo) MUST be encapsulated in an [[hcard|hCard]]. For items of type event, the item info SHOULD be encapsulated in an [[hcalendar|hCalendar]] "vevent". Unique item IDs (e.g. ISBNs, UPCs) MAY be represented as a URN ("url") for the item. Encapsulated microformats (e.g. [[hcard|hCard]] and [[hcalendar|hCalendar]] events for now) may be set on the item itself (e.g. class="item vcard"). However, when using item info subproperties ("fn", "url", "photo"), they MUST be nested <em>inside</em> the item element.<br />
<br />
'''reviewer''':: The optional field specifies the person who authored the review. If the reviewer is specified, an hCard representing the reviewer MUST be provided. For anonymous reviews, use "anonymous" (without quotes) for the full name of the reviewer. If no "reviewer" is found inside the hReview, parsers should look outside the hReview, in the context of the page, for the "reviewer". If there is no "reviewer" outside either, then parsers should use the author defined by the containing document language, e.g. for (X)HTML documents, the <code><nowiki><address></nowiki></code> contact info for the page (which is ideally marked up as an [[hcard|hCard]] as well), for Atom 1.0 the <code><nowiki><entry></nowiki></code> <code><nowiki><author></nowiki></code> if present and if not the <code><nowiki><feed></nowiki></code> <code><nowiki><author></nowiki></code>, for RSS the <code><nowiki><author></nowiki></code> inside the containing <code><nowiki><item></nowiki></code> element.<br />
<br />
'''dtreviewed''':: This optional field when present MUST provide an ISO8601 absolute date time of when the review was written or otherwise authored. This field SHOULD use UTC, but MAY use the time zone offset syntax. If dtreviewed is absent from the hReview, then look outside the hReview, in the surrounding context. If the context is an [[hatom|hAtom]] entry, use its "published" (or "updated" if that is missing) datetime as the dtreviewed, if not present on the entry, use the "published" (or "updated" if that is missing) of the feed. Otherwise use the creation date (or modified date if that is missing) information according to the containing document language (e.g. "published"/"updated" similarly for Atom feeds), then protocol (e.g. HTTP Last-Modified, or file system last modified datetime) as the dtreviewed.<br />
<br />
'''rating''':: The rating is a fixed point integer (one decimal point of precision) from 1.0 to 5.0 inclusive indicating a rating for the item, higher indicating a better rating by default. Optionally a different integral "worst" value and/or "best" value MAY be specified to indicate a different range (e.g. 6 from 0-10). The "best" value may be numerically smaller than the "worst" value.<br />
<br />
'''description''':: This optional field contains the full text representing the written opinion of the reviewer. The field MAY include valid XHTML markup (e.g. paragraphs). User agents SHOULD preserve any markup. Multiple descriptions or section descriptions (e.g. pros and cons, plusses and minusses) SHOULD be included in the description field.<br />
<br />
'''tags''':: Tags are represented using a list of keywords or phrases (using the [[rel-tag]] microformat for each individual keyword or phrase tag) that the reviewer associates with the item. The reviewer MAY optionally provide a tag-specific rating inside each [[rel-tag]], e.g. ambience:5. Tag-specific ratings by default use the same range as an overall rating for the item if present, and MAY also have a custom worst...best range specified. Authors MAY also invert this structure for the same semantic if it is more convenient for their markup, that is, place the [[rel-tag]] inside a rating to indicate a rated tag. Note: rated tags should ideally use a tag space that explains what the ratings for that tag mean. E.g. Food:18/30 should link to a tags space for Food that explains what an 18 out of 30 means for the Food tag.<br />
<br />
'''permalink''':: This optional field is a URL for the hReview. In addition to using the <code><a href></code> tag for this field, the attribute <code>rel="self bookmark"</code> MUST be used to indicate that the hyperlink is a permalink for the review itself. If the hyperlink already contains a <code>rel</code> attribute, then the values <code>self</code> and <code>bookmark</code> MUST be included among the space-separated set of values in the attribute. Indexers MAY treat the permalink of a review as a unique ID in order to identify and collate the same review from multiple sources (such as indexing a page multiple times). The permalink MAY also be used to indicate or imply the origin of the review. Authors MAY use the classname of "permalink" on the element representing the permalink, but are not required to do so.<br />
<br />
'''license''':: This optional field links to the license under which the contents of the hReview itself is licensed, using the '''[[rel-license]]''' microformat.<br />
<br />
<br />
The following field names have been reused from the [[hcard|hCard]] and [[hcalendar|hCalendar]] microformats: <code>version, summary, fn, url, photo, description</code>. In addition, items and reviewers described by hCards MAY contain any hCard field. The rel value "self" has been reused from the [http://atompub.org/2005/07/11/draft-ietf-atompub-format-10.html Atom 1.0 specification].<br />
<br />
=== More Semantic Equivalents ===<br />
<br />
For some properties there is a more semantic equivalent, and therefore they get special treatment, e.g.: <br />
<br />
* For any "url", use <code><a class="url" href="...">...</a></code> inside the element with the class name 'hreview' in hReview.<br />
* And for "photo", use <code><img class="photo" src="..." alt="Photo of ..." /></code> <br />
<br />
* Ratings are often presented either as a set of images or characters, e.g. "***". For these, the <code>&lt;abbr&gt;</code> element is particularly useful, as such characters are an abbreviation for the precise rating, e.g. <code>&lt;abbr class="rating" title="3.0"&gt;***&lt;/abbr&gt;</code>. This is further explored in the next section.<br />
<br />
==== Language ====<br />
* To explicitly convey the natural language that an hReview is written in, use the standard (X)HTML 'lang' attribute on the element with class="hreview", e.g. <code>&lt;div class="hreview" lang="en"&gt; ... &lt;/div&gt;</code> If portions of an hReview (e.g. the item name) are in a different language, use the 'lang' attribute on those portions.<br />
* hReview processors which need to handle the language of reviews MUST process the standard (X)HTML 'lang' attribute as specified.<br />
<br />
=== Human vs. Machine Readable ===<br />
If an <code>&lt;abbr></code> element is used for a property, then its '<code>title</code>' attribute is used for the value of the property, instead of the contents of the element, which can then be used to provide a user-friendly alternate presentation of the value. <br />
<br />
Similarly, if an <code><img /></code> element is used for one or more properties, it MUST be treated as follows: <br />
<br />
# For the "photo" property and any other property that takes a URL as its value, the <code>src="..."</code> attribute provides the property value. <br />
# For other properties, the <code><img /></code> element's '<code>alt</code>' attribute is the value of the property.<br />
<br />
=== Object Includes ===<br />
<br />
hReview 0.3 includes support for the object [[include-pattern]].<br />
<br />
Often a single page lists an item, and then several reviews for that item. In order to avoid having to repeat the item info for each review of the item, the first review should be marked up as an hReview, with a unique "id" attribute on the item info, and then following reviews should use the object [[include-pattern]] to include the item info from the first review.<br />
<br />
<br />
=== Notes ===<br />
This section is informative.<br />
<br />
* By marking up a review with the hReview microformat, the expectation is communicated that the review MAY be indexed. This has no impact on the copyright of the review itself which the publisher may explicitly specify using [[rel-license]] as specified above.<br />
* The enumerated list of item types is under development and may be extended.<br />
* Each type may have custom hReview fields that follow the common set.<br />
* Additional details about a particular item should be specified with the rest of the item's info at the URL provided for the item.<br />
* Most rating systems use the range 1.0 to 5.0, and most of those represent the rating as a number (and possibly half) of stars. Sites may use whatever graphic they wish to represent the rating.<br />
<br />
== Examples ==<br />
Here are a few examples of reviews from current web sites, and how they could be easily enhanced to support the hReview structured review microformat. <br />
<br />
Want to get started with writing an [[hreview|hReview]]? Use the [http://microformats.org/code/hreview/creator hReview creator] to write a review and publish it on your blog.<br />
<br />
=== Restaurant reviews ===<br />
<br />
Here is an example of a simple online restaurant review:<br />
<br />
<pre><nowiki><br />
<div><br />
<span>5 stars out of 5 stars</span><br />
<h4>Crepes on Cole is awesome</h4><br />
<span>Reviewer: <span>Tantek</span> - April 18, 2005</span><br />
<blockquote><p><br />
Crepes on Cole is one of the best little creperies in San Francisco. <br />
Excellent food and service. Plenty of tables in a variety of sizes <br />
for parties large and small. Window seating makes for excellent <br />
people watching to/from the N-Judah which stops right outside. <br />
I've had many fun social gatherings here, as well as gotten <br />
plenty of work done thanks to neighborhood WiFi.<br />
</p></blockquote><br />
<p>Visit date: <span>April 2005</span></p><br />
<p>Food eaten: <span>Florentine crepe</span></p><br />
</div><br />
</nowiki></pre><br />
<br />
Adding hReview to this review is quite simple:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><br />
<span><span class="rating">5</span> out of 5 stars</span><br />
<h4 class="summary">Crepes on Cole is awesome</h4><br />
<span class="reviewer vcard">Reviewer: <span class="fn">Tantek</span> - <br />
<abbr class="dtreviewed" title="20050418T2300-0700">April 18, 2005</abbr></span><br />
<div class="description item vcard"><p><br />
<span class="fn org">Crepes on Cole</span> is one of the best little <br />
creperies in <span class="adr"><span class="locality">San Francisco</span></span>.<br />
Excellent food and service. Plenty of tables in a variety of sizes <br />
for parties large and small. Window seating makes for excellent <br />
people watching to/from the N-Judah which stops right outside. <br />
I've had many fun social gatherings here, as well as gotten <br />
plenty of work done thanks to neighborhood WiFi.<br />
</p></div><br />
<p>Visit date: <span>April 2005</span></p><br />
<p>Food eaten: <span>Florentine crepe</span></p><br />
</div><br />
</nowiki></pre><br />
<br />
Note that some of the properties of this sample review are not captured by hReview (visit date, food eaten). This is deliberate per the scope of keeping hReview minimal and simple.<br />
<br />
This sample hReview could be rendered like this:<br />
<br />
5 stars out of 5 stars<br /><br />
'''Crepes on Cole is awesome'''<br /><br />
Reviewer: Tantek - April 18, 2005<br /><br />
<br />
Crepes on Cole is one of the best little creperies in San Francisco. Excellent food and service. Plenty of tables in a variety of sizes for parties large and small. Window seating makes for excellent people watching to/from the N-Judah which stops right outside. I've had many fun social gatherings here, as well as gotten plenty of work done thanks to neighborhood wifi.<br />
<br />
Visit date: April 2005<br /><br />
Food eaten: Florentine crepe<br /><br />
<br />
==== Multidimensional Restaurant Review ====<br />
Some restaurant reviews indicate ratings for different aspects of the restaurant. Such details are represented in hReview using tagged ratings. In addition, note the inline tags inside the description of this review.<br />
<br />
Here is one such review in text format:<br />
<br />
Cafe Borrone<br />
<br />
1010 El Camino Real, Menlo Park, CA 94025, +1-650-327-0830;<br />
cafeborrone.com<br />
<br />
Food: 18/30; Ambience: 19/30; Service: 15/30; Price: $$...<br />
<br />
This cafe is a welcoming oasis on the Peninsula. It even has a fountain<br />
outside which cloaks the nearby sounds of El Camino traffic. Next door to a <br />
superb indy bookstore, Cafe Borrone is an ideal spot to grab a coffee or a <br />
snack to accompany a newly purchased book or imported periodical. Soups and <br />
sandwich specials rotate daily. The corn chowder with croutons and big <br />
chunks of cheese goes especially well with a freshly toasted mini-baguette. <br />
Evenings are often crowded and may require sharing a table with a perfect <br />
stranger. Espresso afficionados will appreciate the Illy coffee. Noise <br />
levels can vary from peaceful in the late mornings to nearly overwhelming on <br />
jazz band nights.<br />
<br />
As an hReview:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><br />
<div class="item vcard"><br />
<div class="fn org summary">Cafe Borrone</div><br />
<span class="adr"><br />
<span class="street-address">1010 El Camino Real</span>,<br />
<span class="locality">Menlo Park</span>,<br />
<span class="region">CA</span><br />
<span class="postal-code">94025</span>,<br />
</span><br />
<span class="tel">+1-650-327-0830</span>;<br />
<a class="url" href="http://cafeborrone.com">cafeborrone.com</a><br />
</div><br />
<ul><br />
<li class="rating"><a href="http://en.wikipedia.org/wiki/Food" rel="tag"><br />
Food: <span class="value">18</span>/<span class="best">30</span></a>;</li><br />
<li class="rating"><a href="http://flickr.com/photos/tags/Ambience" rel="tag"><br />
Ambience: <span class="value">19</span>/<span class="best">30</span></a>;</li><br />
<li class="rating"><a href="http://en.wikipedia.org/wiki/Service" rel="tag"><br />
Service: <span class="value">15</span>/<span class="best">30</span></a>;</li><br />
<li class="rating"><a href="http://en.wikipedia.org/wiki/Price" rel="tag"><br />
Price: <abbr class="value" title="2">$$</abbr>...</a></li><br />
</ul><br />
<div class="description"><p><br />
This <abbr class="type" title="business"><br />
<a href="http://en.wikipedia.org/wiki/cafe" rel="tag">cafe</a></abbr> <br />
is a welcoming oasis on the Peninsula. <br />
It even has a fountain outside which nearly eliminates <br />
the sounds of El Camino traffic. Next door to a superb indy bookstore, <br />
Cafe Borrone is an ideal spot to grab a <br />
<a href="http://en.wikipedia.org/wiki/coffee" rel="tag">coffee</a> <br />
or a meal to accompany a newly purchased book or imported periodical. <br />
<a href="http://technorati.com/tag/soup" rel="tag">Soups</a> and <br />
<a href="http://technorati.com/tag/sandwich" rel="tag">sandwich</a> <br />
specials rotate daily. The corn chowder with croutons and big chunks of cheese <br />
goes especially well with a freshly toasted mini-baguette. Evenings are <br />
often crowded and may require sharing a table with a perfect stranger. <br />
<a href="http://flickr.com/photos/tags/espresso" rel="tag">Espresso</a> <br />
afficionados will appreciate the <br />
<a href="http://en.wikipedia.org/wiki/Illy" rel="tag">Illy</a> coffee. <br />
Noise levels can vary from peaceful in the late mornings to nearly overwhelming on <br />
<a href="http://en.wikipedia.org/wiki/jazz" rel="tag">jazz</a> band nights.<br />
</p></div><br />
Review (<a href="http://microformats.org/wiki/hreview"> <br />
hReview v<span class="version">0.3</span></a>)<br />
by <span class="reviewer vcard"><span class="fn">anonymous</span></span>, <br />
<abbr class="dtreviewed" title="20050428T2130-0700">April 28th, 2005</abbr>.<br />
</div><br />
</nowiki></pre><br />
<br />
With an accompanying CSS style sheet like:<br />
<br />
<pre><nowiki><br />
a.url { display:block }<br />
ul { margin:1em 0; padding:0 }<br />
ul li { display:inline }<br />
</nowiki></pre><br />
<br />
This hReview could be presented similar to the original text:<br />
<br />
Cafe Borrone<br /><br />
1010 El Camino Real, Menlo Park, CA 94025, +1-650-327-0830;<br /><br />
[http://cafeborrone.com/ cafeborrone.com]<br /><br />
<br /><br />
[http://en.wikipedia.org/wiki/Food Food: 18/30];<br />
[http://flickr.com/photos/tags/Ambience Ambience: 19/30];<br />
[http://en.wikipedia.org/wiki/Service Service: 15/30];<br />
[http://en.wikipedia.org/wiki/Price Price: $$...]<br /><br />
<br />
This [http://en.wikipedia.org/wiki/cafe cafe] is a welcoming oasis on the Peninsula. It even has a fountain outside which cloaks the nearby sounds of El Camino traffic. Next door to a superb indy bookstore, Cafe Borrone is an ideal spot to grab a [http://en.wikipedia.org/wiki/coffee coffee] or a snack to accompany a newly purchased book or imported periodical. [http://technorati.com/tag/soup Soups] and [http://technorati.com/tag/sandwich sandwich] specials rotate daily. The corn chowder with croutons and big chunks of cheese goes especially well with a freshly toasted mini-baguette. Evenings are often crowded and may require sharing a table with a perfect stranger. [http://flickr.com/photos/tags/espresso Espresso] afficionados will appreciate the [http://en.wikipedia.org/wiki/Illy Illy] coffee. Noise levels can vary from peaceful in the late mornings to nearly overwhelming on [http://en.wikipedia.org/wiki/jazz jazz] band nights.<br />
<br />
Review ([http://microformats.org/wiki/hreview hReview v0.3]) by anonymous, April 28th, 2005.<br />
<br />
=== Product review ===<br />
Here is an example of a product review:<br />
<br />
<pre><nowiki><br />
<div><br />
<a href="http://www.amazon.com/exec/obidos/ASIN/B000089CJI/"><br />
<img src="http://images.amazon.com/images/P/B000089CJI.01._SCTHUMBZZZ_.jpg" <br />
alt="Album cover photo: The Postal Service: Give Up." /><br />
The Postal Service: Give Up</a><br />
<blockquote><p><br />
"The people thought they were just being rewarded for treating others <br />
as they like to be treated, for obeying stop signs and curing diseases, <br />
for mailing letters with the address of the sender... Don't wake me, <br />
I plan on sleeping in..."<br />
</p><p><br />
"Nothing Better" is a great track on this album, too... <br />
</p></blockquote><br />
(*****)<br />
</div><br />
</nowiki></pre><br />
<br />
Adding hReview to this review is also quite simple, but in this case requires a few more elements for the rating and reviewer which are required by hReview:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><span class="item"><br />
<a class="url fn" href="http://www.amazon.com/exec/obidos/ASIN/B000089CJI/"><br />
<img src="http://images.amazon.com/images/P/B000089CJI.01._SCTHUMBZZZ_.jpg" <br />
alt="Album cover photo: The Postal Service: Give Up. " <br />
class="photo" /><br />
The Postal Service: Give Up</a></span><br />
<div class="description"><p><br />
"The people thought they were just being rewarded for treating others <br />
as they like to be treated, for obeying stop signs and curing diseases, <br />
for mailing letters with the address of the sender... Don't wake me, <br />
I plan on sleeping in..."<br />
</p><p><br />
"Nothing Better" is a great track on this album, too... <br />
</p></div><br />
(<abbr class="rating" title="5">*****</abbr>)<br />
<p class="reviewer vcard">Review by <br />
<a class="url fn" href="http://ifindkarma.com/blog/">Adam Rifkin</a>, <br />
<abbr class="dtreviewed" title="200502">February 2005</abbr><br />
</p><br />
</div><br />
</nowiki></pre><br />
<br />
And this hReview might be presented like this:<br />
<br />
<br />
[Album cover photo: ]<br />
[The Postal Service:]<br />
[ Give Up ]<br />
<br />
The Postal Service: Give Up<br />
<br />
"The people thought they were just being rewarded for treating others as they like to be treated, for obeying stop signs and curing diseases, for mailing letters with the address of the sender... Don't wake me, I plan on sleeping in..."<br />
<br />
"Nothing Better" is a great track on this album, too...<br />
<br />
(*****)<br />
<br />
Review by Adam Rifkin, February 2005.<br />
<br />
=== Movie Review ===<br />
Finally, here is an example of a movie review.<br />
<br />
<pre><nowiki><br />
<div><br />
<span>anonymous, April 18th, 2005</span><br />
<div><br />
<a lang="zh" href="http://www.imdb.com/title/tt0299977/"><br />
Ying Xiong (<span lang="en">HERO</span>)<br />
</a><br />
</div><br />
<div>Rating: 4 out of 5</div><br />
<blockquote><p><br />
This movie has great visuals and music.<br />
</p></blockquote><br />
</div><br />
</nowiki></pre><br />
<br />
With hReview:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><br />
<span class="reviewer vcard"><br />
<span class="fn">anonymous</span>, <br />
<abbr class="dtreviewed" title="20050418">April 18th, 2005</abbr><br />
</span><br />
<div class="item"><br />
<a lang="zh" class="url fn" href="http://www.imdb.com/title/tt0299977/"><br />
Ying Xiong (<span lang="en">HERO</span>)<br />
</a><br />
</div><br />
<div>Rating: <span class="rating">4</span> out of 5</div><br />
<div class="description"><p><br />
This movie has great music and visuals.<br />
</p></div><br />
</div><br />
</nowiki></pre><br />
<br />
Which could be presented like this:<br />
<br />
anonymous, April 18th, 2005<br /><br />
Ying Xiong (HERO)<br /><br />
Rating: 4 out of 5<br /><br />
<br />
This movie has great music and visuals.<br />
<br />
== Examples in the wild ==<br />
This section is '''informative'''. The number of hReview examples in the wild has expanded far beyond the capacity of being kept inline in this specification. They have been moved to a [[hreview-examples-in-wild|separate page]].<br />
<br />
See [[hreview-examples-in-wild|hReview Examples in the wild]].<br />
<br />
== Implementations ==<br />
This section is '''informative'''. The number of hReview implementations has also expanded beyond the capacity of keeping them inline. They have been moved to a [[hreview-implementations|separate page]].<br />
<br />
See [[hreview-implementations|hReview Implementations]].<br />
<br />
== References ==<br />
=== Normative References ===<br />
* [http://www.w3.org/TR/2002/REC-xhtml1-20020801/ XHTML 1.0 SE]<br />
* [http://gmpg.org/xmdp/ XMDP]<br />
* [[hcard|hCard]]<br />
* [[hcalendar|hCalendar]]<br />
* [[rel-tag]]<br />
* [http://www.ietf.org/rfc/rfc2119.txt RFC2119]<br />
* [http://www.ietf.org/rfc/rfc3986.txt RFC3986]<br />
* [http://www.ietf.org/rfc/rfc4287.txt RFC4287] (Atom 1.0)<br />
<br />
=== Informative References ===<br />
* [http://www.w3.org/TR/REC-CSS1 CSS1]<br />
* ISO.8601.1988<br />
** International Organization for Standardization, "Data elements and interchange formats - Information interchange - Representation of dates and times", ISO Standard 8601, June 1988.<br />
* [http://www.w3.org/TR/1998/NOTE-datetime-19980827 W3C NOTE-datetime-19980827]<br />
* [http://www.ietf.org/rfc/rfc3667.txt RFC3667]<br />
* [http://www.ietf.org/rfc/rfc3668.txt RFC3668]<br />
* [http://www.w3.org/Consortium/Patent-Policy-20040205/ W3C Patent Policy]<br />
* [http://local.yahoo.com/details?id=21359628 Crepes on Cole reviews on Yahoo! Local]<br />
* Other reviews efforts. See [[reviews-formats]].<br />
* Contributed from http://developers.technorati.com/wiki/hReview.<br />
<br />
==== Similar Work ====<br />
* [[hlisting-proposal|hListing]]<br />
* [[xoxo|XOXO]]<br />
<br />
=== Copyright ===<br />
{{MicroformatCopyrightStatement2005}}<br />
<br />
=== Patents ===<br />
{{MicroFormatPatentStatement}}<br />
<br />
== Work in progress ==<br />
This specification is a work in progress. As additional aspects are discussed, understood, and written, they will be added. <br />
<br />
=== Changes from v0.2 ===<br />
The following changes have been made in hReview v0.3 over [[hreview-v0.2|hReview v0.2]]:<br />
<br />
Normative changes:<br />
# MUST (instead of SHOULD) use [[hcard|hCard]] for the item description of a business or person<br />
# "reviewer" changes<br />
## Made reviewer *optional* per feedback from Ryan King and Mark Nottingham<br />
## If reviewer is absent from the hReview, then look outside the hReview, in the context of the page, for the reviewer. If there is no "reviewer" outside either, then use the author information according to the containing document language (e.g. <code><nowiki><address></nowiki></code> for (X)HTML pages) as the reviewer.<br />
## MUST (instead of SHOULD) use [[hcard|hCard]] to represent reviewer information<br />
# "dtreviewed" changes<br />
## Made dtreviewed *optional* per feedback from Ryan King and Mark Nottingham<br />
## If dtreviewed is absent from the hReview, then look outside the hReview, in the surrounding context. If the context is an [[hatom|hAtom]] entry, use its "published" (or "updated" if that is missing) datetime as the dtreviewed, if not present on the entry, use the "published" (or "updated" if that is missing) of the feed. Otherwise use the information according to the containing document language (e.g. "published"/"updated" similarly for Atom feeds), then protocol (e.g. HTTP Last-Modified, or file system last modified datetime).<br />
# SHOULD use [[hcalendar|hCalendar]] to represent an item of 'type' 'event'<br />
# Added one decimal digit of precision to ratings' numerical values based on publisher experience.<br />
# Use [http://microformats.org/wiki/hcard#Value_excerpting the "value" construct from hCard] (as it is used in "tel" properties for example) to more explicitly markup the rating value when also providing (marking up) the best/worst of a rating.<br />
# Added [[rel-license]] to indicate the license of the hReview as a whole.<br />
# Permit tags inside ratings to denote rated tags, the same as ratings inside tags per suggestion from Eran Globen.<br />
# Add [[include-pattern]] support to allow multiple reviews for the same item to not repeat the item info.<br />
<br />
Informative changes (several, but in particular):<br />
# Note that scalar/rated tags would ideally use a tag space that explain the ratings for that tag. E.g. to explain what Food:18/30 means.<br />
# Updated examples accordingly.<br />
<br />
== Further Reading ==<br />
* See also [http://www.technorati.com/cosmos/referer.html blogs discussing this page].<br />
== Related Pages People==<br />
* Sildenafil citrate, sold under the [http://www.efficacylevitra.info names Levitra]<br />
* A ring tone is the sound made by a telephone to indicate an [http://freeringtonemp.info incoming call]<br />
* Viagra pills are blue and [http://orderviagrales.info diamond-shaped] with the words.<br />
* Both Viagra and the Levitra are derived from [http://levitravsviagra.info Proto-Indo-Iranian]<br />
* The mode of action of [http://ordertramadoline.info tramadol] has yet to be fully understood.<br />
* Phentermine is a drug primarily used as an [http://pharmacyphentermine.info appetite suppressant]<br />
* The proper definition of [http://replicawatchbmw.info replica]<br />
* Alprazolam was [http://valiumxanax.info originally marketed] as an atypical benzodiazepine, but only classified for use treating anxiety neurosis.<br />
<br />
== Related Pages ==<br />
{{hreview-related-pages}}</div>Adminihttps://microformats.org/wiki/index.php?title=hreview&diff=13929hreview2007-03-03T16:18:25Z<p>Admini: /* Further Reading */</p>
<hr />
<div><h1> hReview 0.3 </h1><br />
<br />
[[hreview|hReview]] is a simple, open, distributed format, suitable for embedding reviews (of products, services, businesses, events, etc.) in (X)HTML, Atom, RSS, and arbitrary XML. hReview is one of several [[microformats]] open standards.<br />
<br />
Want to get started with writing an [[hreview|hReview]]? Use the [http://microformats.org/code/hreview/creator hReview creator] to write a review and publish it.<br />
<br />
== Microformats Draft Specification 2006-02-22 ==<br />
<br />
; Editor: [http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc.]<br />
; Authors: [http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc.]<br />
: [http://360.yahoo.com/alidiabali Ali Diab],[http://yahoo.com Yahoo! Inc.]<br />
: [http://spaces.msn.com/members/ianmcallister/ Ian McAllister], [http://microsoft.com/ Microsoft Corporation]<br />
: [http://journals.aol.com/panzerjohn/abstractioneer John Panzer], [http://www.aol.com America Online, Inc.]<br />
: [http://ifindkarma.com/blog Adam Rifkin], [http://labs.commerce.net/ CommerceNet Labs]<br />
: [http://sippey.typepad.com/ Michael Sippey], [http://sixapart.com Six Apart, Ltd.]<br />
<br />
Microformats [http://microformats.org/wiki/hreview#Copyright copyright] and [http://microformats.org/wiki/hreview#Patents patents] statements apply.<br />
<br />
__TOC__<br />
<br />
== Introduction ==<br />
Numerous web sites publish reviews using a broad variety of schema for all sorts of things from products (movies, music, books), to businesses (restaurants, hotels, stores), to events (concerts, theatre), to people (artists, leaders, celebrities), to places (landmarks, parks), to online resources (web pages, files), to reviews of reviews themselves.<br />
<br />
In order to enable and encourage the sharing, distribution, syndication, and aggregation, of reviews, the authors propose the hReview microformat, an open standard for distributed reviews. The authors have researched both numerous [[review-examples]] in the wild and earlier attempts at [[review-formats]], and have designed hReview around a simple minimal schema for reviews. Feedback is encouraged on the [[hreview-feedback|hReview feedback]] page.<br />
<br />
=== Inspiration and Acknowledgments ===<br />
Thanks to everyone who responded to the open call for implementor participation for hReview. The authors in particular wish to thank the following individuals for their constructive input and feedback: [http://www.richardault.com/ Richard Ault], [http://dannyayers.com Danny Ayers], [http://www.vertexdev.com/~jeff/ Jeffrey Barr],[http://adriancuthbert.blogspot.com/ Adrian Cuthbert],[http://jason.defillippo.com/ Jason DeFillippo], [http://www.hybernaut.com/bdv Brian Del Vecchio], Scott Derringer, [http://budgibson.com/home/ Bud Gibson], [http://joi.ito.com/ Joi Ito], [http://www.kanai.net/weblog/ Gen Kanai],[http://niallkennedy.com/ Niall Kennedy], [http://labs.commerce.net/wiki/index.php/Rohit_Khare Rohit Khare], [http://theryanking.com/ Ryan King], [http://www.jluster.org/ Jonas Luster], [http://epeus.blogspot.com/ Kevin Marks], Mark Nottingham, [http://www.powazek.com/ Derek Powazek], [http://www.judysbook.com/ Jeff Rodenburg], [http://sifry.com/alerts/ David Sifry], [http://jystewart.net/ James Stewart], [http://kung-foo.tv/ Adriaan Tijsseling], [http://www.flashenabled.com/ Phillip Torrone], Thai Tran, [http://w6daily.winn.com/ Phillip Winn], [http://yohei-y.blogspot.com YAMAMOTO Yohei].<br />
<br />
=== Scope ===<br />
Reviews consistently share several common fields. Where possible hReview has been based on this minimal common subset.<br />
<br />
==== Out of scope ====<br />
Fields that are type-specific have been omitted from hReview. It is important that hReview be kept simple and minimal from the start. Additional features can be added as deemed necessary by practical implementation experience.<br />
<br />
The concept of a "universal object identifier", that is, how to identify the same object/item/product across different shopping sites, though something very useful to have, is outside the scope of this format.<br />
<br />
== Semantic XHTML Design Principles ==<br />
{{semantic-xhtml-design-principles}}<br />
<br />
== Format ==<br />
=== In General ===<br />
The hReview format is based on a set of fields common to numerous review sites and formats in use today on the web. Where possible field names have been chosen based on those defined by the related [[hcard|hCard]] and [[hcalendar|hCalendar]] standards.<br />
<br />
=== Schema ===<br />
The hReview schema consists of the following:<br />
<br />
* hReview ('''<code>hreview</code>''')<br />
** '''<code>version</code>'''. optional. text.<br />
** '''<code>summary</code>'''. optional. text.<br />
** item '''<code>type</code>'''. optional. product | business | event | person | place | website | url.<br />
** '''<code>item</code>''' info. required. '''<code>fn</code>''' ('''<code>url</code>''' || '''<code>photo</code>''' ) | '''[[hcard|hCard]]''' (for person or business) | '''[[hcalendar|hCalendar]]''' (for event)<br />
** '''<code>reviewer</code>'''. optional. '''[[hcard|hCard]]'''.<br />
** '''<code>dtreviewed</code>'''. optional. ISO8601 absolute date time.<br />
** '''<code>rating</code>'''. optional. fixed point integer [1.0-5.0], with optional alternate '''<code>worst</code>''' (default:1.0) and/or '''<code>best</code>''' (default:5.0), also fixed point integers, and explicit '''<code>value</code>'''.<br />
** '''<code>description</code>'''. optional. text with optional valid XHTML markup.<br />
** tags. optional. keywords or phrases, using '''[[rel-tag]]''', each with optional rating.<br />
** permalink. optional, using '''[[rel-bookmark]]''' and '''[[rel-self]]'''.<br />
** license. optional, using '''[[rel-license]]'''.<br />
<br />
=== Field details ===<br />
The fields of the hReview schema represent the following:<br />
<br />
'''version''':: This optional field permits hReview publishers to specify a particular version of hReview that their content uses. By omitting this field, the publisher is stating that implementations may interpret the hReviews according to any version of the hReview specification v0.2 or later. In practice the authors of this specification are comitted to maintaining backward compatibility with content produced using earlier versions of the specification. This field is syntax compatible with, and thus reuses the semantics of "VERSION" as defined in vCard RFC2426 section "3.6.9 VERSION Type Definition". The value of this field for this specification is "0.3".<br />
<br />
'''summary''':: This optional field serves as a title for the review itself.<br />
<br />
'''item type''':: This optional field "type" provides the type of the item being reviewed, one of the following: product, business, event, person, place, website, url. If omitted, then in some cases the item type may be inferred. If the item is also an [[hcard|hCard]], then the item type is a "business" or a "person" based upon which of those the hCard represents. If the item is also an [[hcalendar|hCalendar]] event, then the item type is an "event".<br />
<br />
'''item info''':: This required field MUST have at a minimum the name ("fn" - the formatted text corresponding to the name) of ''the'' item (an hReview describes only one item), SHOULD provide at least one URI ("url") for the item, and MAY provide at least one URL to a photo or depiction ("photo") of the item. For items of type person or business, the item info (fn, url, photo) MUST be encapsulated in an [[hcard|hCard]]. For items of type event, the item info SHOULD be encapsulated in an [[hcalendar|hCalendar]] "vevent". Unique item IDs (e.g. ISBNs, UPCs) MAY be represented as a URN ("url") for the item. Encapsulated microformats (e.g. [[hcard|hCard]] and [[hcalendar|hCalendar]] events for now) may be set on the item itself (e.g. class="item vcard"). However, when using item info subproperties ("fn", "url", "photo"), they MUST be nested <em>inside</em> the item element.<br />
<br />
'''reviewer''':: The optional field specifies the person who authored the review. If the reviewer is specified, an hCard representing the reviewer MUST be provided. For anonymous reviews, use "anonymous" (without quotes) for the full name of the reviewer. If no "reviewer" is found inside the hReview, parsers should look outside the hReview, in the context of the page, for the "reviewer". If there is no "reviewer" outside either, then parsers should use the author defined by the containing document language, e.g. for (X)HTML documents, the <code><nowiki><address></nowiki></code> contact info for the page (which is ideally marked up as an [[hcard|hCard]] as well), for Atom 1.0 the <code><nowiki><entry></nowiki></code> <code><nowiki><author></nowiki></code> if present and if not the <code><nowiki><feed></nowiki></code> <code><nowiki><author></nowiki></code>, for RSS the <code><nowiki><author></nowiki></code> inside the containing <code><nowiki><item></nowiki></code> element.<br />
<br />
'''dtreviewed''':: This optional field when present MUST provide an ISO8601 absolute date time of when the review was written or otherwise authored. This field SHOULD use UTC, but MAY use the time zone offset syntax. If dtreviewed is absent from the hReview, then look outside the hReview, in the surrounding context. If the context is an [[hatom|hAtom]] entry, use its "published" (or "updated" if that is missing) datetime as the dtreviewed, if not present on the entry, use the "published" (or "updated" if that is missing) of the feed. Otherwise use the creation date (or modified date if that is missing) information according to the containing document language (e.g. "published"/"updated" similarly for Atom feeds), then protocol (e.g. HTTP Last-Modified, or file system last modified datetime) as the dtreviewed.<br />
<br />
'''rating''':: The rating is a fixed point integer (one decimal point of precision) from 1.0 to 5.0 inclusive indicating a rating for the item, higher indicating a better rating by default. Optionally a different integral "worst" value and/or "best" value MAY be specified to indicate a different range (e.g. 6 from 0-10). The "best" value may be numerically smaller than the "worst" value.<br />
<br />
'''description''':: This optional field contains the full text representing the written opinion of the reviewer. The field MAY include valid XHTML markup (e.g. paragraphs). User agents SHOULD preserve any markup. Multiple descriptions or section descriptions (e.g. pros and cons, plusses and minusses) SHOULD be included in the description field.<br />
<br />
'''tags''':: Tags are represented using a list of keywords or phrases (using the [[rel-tag]] microformat for each individual keyword or phrase tag) that the reviewer associates with the item. The reviewer MAY optionally provide a tag-specific rating inside each [[rel-tag]], e.g. ambience:5. Tag-specific ratings by default use the same range as an overall rating for the item if present, and MAY also have a custom worst...best range specified. Authors MAY also invert this structure for the same semantic if it is more convenient for their markup, that is, place the [[rel-tag]] inside a rating to indicate a rated tag. Note: rated tags should ideally use a tag space that explains what the ratings for that tag mean. E.g. Food:18/30 should link to a tags space for Food that explains what an 18 out of 30 means for the Food tag.<br />
<br />
'''permalink''':: This optional field is a URL for the hReview. In addition to using the <code><a href></code> tag for this field, the attribute <code>rel="self bookmark"</code> MUST be used to indicate that the hyperlink is a permalink for the review itself. If the hyperlink already contains a <code>rel</code> attribute, then the values <code>self</code> and <code>bookmark</code> MUST be included among the space-separated set of values in the attribute. Indexers MAY treat the permalink of a review as a unique ID in order to identify and collate the same review from multiple sources (such as indexing a page multiple times). The permalink MAY also be used to indicate or imply the origin of the review. Authors MAY use the classname of "permalink" on the element representing the permalink, but are not required to do so.<br />
<br />
'''license''':: This optional field links to the license under which the contents of the hReview itself is licensed, using the '''[[rel-license]]''' microformat.<br />
<br />
<br />
The following field names have been reused from the [[hcard|hCard]] and [[hcalendar|hCalendar]] microformats: <code>version, summary, fn, url, photo, description</code>. In addition, items and reviewers described by hCards MAY contain any hCard field. The rel value "self" has been reused from the [http://atompub.org/2005/07/11/draft-ietf-atompub-format-10.html Atom 1.0 specification].<br />
<br />
=== More Semantic Equivalents ===<br />
<br />
For some properties there is a more semantic equivalent, and therefore they get special treatment, e.g.: <br />
<br />
* For any "url", use <code><a class="url" href="...">...</a></code> inside the element with the class name 'hreview' in hReview.<br />
* And for "photo", use <code><img class="photo" src="..." alt="Photo of ..." /></code> <br />
<br />
* Ratings are often presented either as a set of images or characters, e.g. "***". For these, the <code>&lt;abbr&gt;</code> element is particularly useful, as such characters are an abbreviation for the precise rating, e.g. <code>&lt;abbr class="rating" title="3.0"&gt;***&lt;/abbr&gt;</code>. This is further explored in the next section.<br />
<br />
==== Language ====<br />
* To explicitly convey the natural language that an hReview is written in, use the standard (X)HTML 'lang' attribute on the element with class="hreview", e.g. <code>&lt;div class="hreview" lang="en"&gt; ... &lt;/div&gt;</code> If portions of an hReview (e.g. the item name) are in a different language, use the 'lang' attribute on those portions.<br />
* hReview processors which need to handle the language of reviews MUST process the standard (X)HTML 'lang' attribute as specified.<br />
<br />
=== Human vs. Machine Readable ===<br />
If an <code>&lt;abbr></code> element is used for a property, then its '<code>title</code>' attribute is used for the value of the property, instead of the contents of the element, which can then be used to provide a user-friendly alternate presentation of the value. <br />
<br />
Similarly, if an <code><img /></code> element is used for one or more properties, it MUST be treated as follows: <br />
<br />
# For the "photo" property and any other property that takes a URL as its value, the <code>src="..."</code> attribute provides the property value. <br />
# For other properties, the <code><img /></code> element's '<code>alt</code>' attribute is the value of the property.<br />
<br />
=== Object Includes ===<br />
<br />
hReview 0.3 includes support for the object [[include-pattern]].<br />
<br />
Often a single page lists an item, and then several reviews for that item. In order to avoid having to repeat the item info for each review of the item, the first review should be marked up as an hReview, with a unique "id" attribute on the item info, and then following reviews should use the object [[include-pattern]] to include the item info from the first review.<br />
<br />
<br />
=== Notes ===<br />
This section is informative.<br />
<br />
* By marking up a review with the hReview microformat, the expectation is communicated that the review MAY be indexed. This has no impact on the copyright of the review itself which the publisher may explicitly specify using [[rel-license]] as specified above.<br />
* The enumerated list of item types is under development and may be extended.<br />
* Each type may have custom hReview fields that follow the common set.<br />
* Additional details about a particular item should be specified with the rest of the item's info at the URL provided for the item.<br />
* Most rating systems use the range 1.0 to 5.0, and most of those represent the rating as a number (and possibly half) of stars. Sites may use whatever graphic they wish to represent the rating.<br />
<br />
== Examples ==<br />
Here are a few examples of reviews from current web sites, and how they could be easily enhanced to support the hReview structured review microformat. <br />
<br />
Want to get started with writing an [[hreview|hReview]]? Use the [http://microformats.org/code/hreview/creator hReview creator] to write a review and publish it on your blog.<br />
<br />
=== Restaurant reviews ===<br />
<br />
Here is an example of a simple online restaurant review:<br />
<br />
<pre><nowiki><br />
<div><br />
<span>5 stars out of 5 stars</span><br />
<h4>Crepes on Cole is awesome</h4><br />
<span>Reviewer: <span>Tantek</span> - April 18, 2005</span><br />
<blockquote><p><br />
Crepes on Cole is one of the best little creperies in San Francisco. <br />
Excellent food and service. Plenty of tables in a variety of sizes <br />
for parties large and small. Window seating makes for excellent <br />
people watching to/from the N-Judah which stops right outside. <br />
I've had many fun social gatherings here, as well as gotten <br />
plenty of work done thanks to neighborhood WiFi.<br />
</p></blockquote><br />
<p>Visit date: <span>April 2005</span></p><br />
<p>Food eaten: <span>Florentine crepe</span></p><br />
</div><br />
</nowiki></pre><br />
<br />
Adding hReview to this review is quite simple:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><br />
<span><span class="rating">5</span> out of 5 stars</span><br />
<h4 class="summary">Crepes on Cole is awesome</h4><br />
<span class="reviewer vcard">Reviewer: <span class="fn">Tantek</span> - <br />
<abbr class="dtreviewed" title="20050418T2300-0700">April 18, 2005</abbr></span><br />
<div class="description item vcard"><p><br />
<span class="fn org">Crepes on Cole</span> is one of the best little <br />
creperies in <span class="adr"><span class="locality">San Francisco</span></span>.<br />
Excellent food and service. Plenty of tables in a variety of sizes <br />
for parties large and small. Window seating makes for excellent <br />
people watching to/from the N-Judah which stops right outside. <br />
I've had many fun social gatherings here, as well as gotten <br />
plenty of work done thanks to neighborhood WiFi.<br />
</p></div><br />
<p>Visit date: <span>April 2005</span></p><br />
<p>Food eaten: <span>Florentine crepe</span></p><br />
</div><br />
</nowiki></pre><br />
<br />
Note that some of the properties of this sample review are not captured by hReview (visit date, food eaten). This is deliberate per the scope of keeping hReview minimal and simple.<br />
<br />
This sample hReview could be rendered like this:<br />
<br />
5 stars out of 5 stars<br /><br />
'''Crepes on Cole is awesome'''<br /><br />
Reviewer: Tantek - April 18, 2005<br /><br />
<br />
Crepes on Cole is one of the best little creperies in San Francisco. Excellent food and service. Plenty of tables in a variety of sizes for parties large and small. Window seating makes for excellent people watching to/from the N-Judah which stops right outside. I've had many fun social gatherings here, as well as gotten plenty of work done thanks to neighborhood wifi.<br />
<br />
Visit date: April 2005<br /><br />
Food eaten: Florentine crepe<br /><br />
<br />
==== Multidimensional Restaurant Review ====<br />
Some restaurant reviews indicate ratings for different aspects of the restaurant. Such details are represented in hReview using tagged ratings. In addition, note the inline tags inside the description of this review.<br />
<br />
Here is one such review in text format:<br />
<br />
Cafe Borrone<br />
<br />
1010 El Camino Real, Menlo Park, CA 94025, +1-650-327-0830;<br />
cafeborrone.com<br />
<br />
Food: 18/30; Ambience: 19/30; Service: 15/30; Price: $$...<br />
<br />
This cafe is a welcoming oasis on the Peninsula. It even has a fountain<br />
outside which cloaks the nearby sounds of El Camino traffic. Next door to a <br />
superb indy bookstore, Cafe Borrone is an ideal spot to grab a coffee or a <br />
snack to accompany a newly purchased book or imported periodical. Soups and <br />
sandwich specials rotate daily. The corn chowder with croutons and big <br />
chunks of cheese goes especially well with a freshly toasted mini-baguette. <br />
Evenings are often crowded and may require sharing a table with a perfect <br />
stranger. Espresso afficionados will appreciate the Illy coffee. Noise <br />
levels can vary from peaceful in the late mornings to nearly overwhelming on <br />
jazz band nights.<br />
<br />
As an hReview:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><br />
<div class="item vcard"><br />
<div class="fn org summary">Cafe Borrone</div><br />
<span class="adr"><br />
<span class="street-address">1010 El Camino Real</span>,<br />
<span class="locality">Menlo Park</span>,<br />
<span class="region">CA</span><br />
<span class="postal-code">94025</span>,<br />
</span><br />
<span class="tel">+1-650-327-0830</span>;<br />
<a class="url" href="http://cafeborrone.com">cafeborrone.com</a><br />
</div><br />
<ul><br />
<li class="rating"><a href="http://en.wikipedia.org/wiki/Food" rel="tag"><br />
Food: <span class="value">18</span>/<span class="best">30</span></a>;</li><br />
<li class="rating"><a href="http://flickr.com/photos/tags/Ambience" rel="tag"><br />
Ambience: <span class="value">19</span>/<span class="best">30</span></a>;</li><br />
<li class="rating"><a href="http://en.wikipedia.org/wiki/Service" rel="tag"><br />
Service: <span class="value">15</span>/<span class="best">30</span></a>;</li><br />
<li class="rating"><a href="http://en.wikipedia.org/wiki/Price" rel="tag"><br />
Price: <abbr class="value" title="2">$$</abbr>...</a></li><br />
</ul><br />
<div class="description"><p><br />
This <abbr class="type" title="business"><br />
<a href="http://en.wikipedia.org/wiki/cafe" rel="tag">cafe</a></abbr> <br />
is a welcoming oasis on the Peninsula. <br />
It even has a fountain outside which nearly eliminates <br />
the sounds of El Camino traffic. Next door to a superb indy bookstore, <br />
Cafe Borrone is an ideal spot to grab a <br />
<a href="http://en.wikipedia.org/wiki/coffee" rel="tag">coffee</a> <br />
or a meal to accompany a newly purchased book or imported periodical. <br />
<a href="http://technorati.com/tag/soup" rel="tag">Soups</a> and <br />
<a href="http://technorati.com/tag/sandwich" rel="tag">sandwich</a> <br />
specials rotate daily. The corn chowder with croutons and big chunks of cheese <br />
goes especially well with a freshly toasted mini-baguette. Evenings are <br />
often crowded and may require sharing a table with a perfect stranger. <br />
<a href="http://flickr.com/photos/tags/espresso" rel="tag">Espresso</a> <br />
afficionados will appreciate the <br />
<a href="http://en.wikipedia.org/wiki/Illy" rel="tag">Illy</a> coffee. <br />
Noise levels can vary from peaceful in the late mornings to nearly overwhelming on <br />
<a href="http://en.wikipedia.org/wiki/jazz" rel="tag">jazz</a> band nights.<br />
</p></div><br />
Review (<a href="http://microformats.org/wiki/hreview"> <br />
hReview v<span class="version">0.3</span></a>)<br />
by <span class="reviewer vcard"><span class="fn">anonymous</span></span>, <br />
<abbr class="dtreviewed" title="20050428T2130-0700">April 28th, 2005</abbr>.<br />
</div><br />
</nowiki></pre><br />
<br />
With an accompanying CSS style sheet like:<br />
<br />
<pre><nowiki><br />
a.url { display:block }<br />
ul { margin:1em 0; padding:0 }<br />
ul li { display:inline }<br />
</nowiki></pre><br />
<br />
This hReview could be presented similar to the original text:<br />
<br />
Cafe Borrone<br /><br />
1010 El Camino Real, Menlo Park, CA 94025, +1-650-327-0830;<br /><br />
[http://cafeborrone.com/ cafeborrone.com]<br /><br />
<br /><br />
[http://en.wikipedia.org/wiki/Food Food: 18/30];<br />
[http://flickr.com/photos/tags/Ambience Ambience: 19/30];<br />
[http://en.wikipedia.org/wiki/Service Service: 15/30];<br />
[http://en.wikipedia.org/wiki/Price Price: $$...]<br /><br />
<br />
This [http://en.wikipedia.org/wiki/cafe cafe] is a welcoming oasis on the Peninsula. It even has a fountain outside which cloaks the nearby sounds of El Camino traffic. Next door to a superb indy bookstore, Cafe Borrone is an ideal spot to grab a [http://en.wikipedia.org/wiki/coffee coffee] or a snack to accompany a newly purchased book or imported periodical. [http://technorati.com/tag/soup Soups] and [http://technorati.com/tag/sandwich sandwich] specials rotate daily. The corn chowder with croutons and big chunks of cheese goes especially well with a freshly toasted mini-baguette. Evenings are often crowded and may require sharing a table with a perfect stranger. [http://flickr.com/photos/tags/espresso Espresso] afficionados will appreciate the [http://en.wikipedia.org/wiki/Illy Illy] coffee. Noise levels can vary from peaceful in the late mornings to nearly overwhelming on [http://en.wikipedia.org/wiki/jazz jazz] band nights.<br />
<br />
Review ([http://microformats.org/wiki/hreview hReview v0.3]) by anonymous, April 28th, 2005.<br />
<br />
=== Product review ===<br />
Here is an example of a product review:<br />
<br />
<pre><nowiki><br />
<div><br />
<a href="http://www.amazon.com/exec/obidos/ASIN/B000089CJI/"><br />
<img src="http://images.amazon.com/images/P/B000089CJI.01._SCTHUMBZZZ_.jpg" <br />
alt="Album cover photo: The Postal Service: Give Up." /><br />
The Postal Service: Give Up</a><br />
<blockquote><p><br />
"The people thought they were just being rewarded for treating others <br />
as they like to be treated, for obeying stop signs and curing diseases, <br />
for mailing letters with the address of the sender... Don't wake me, <br />
I plan on sleeping in..."<br />
</p><p><br />
"Nothing Better" is a great track on this album, too... <br />
</p></blockquote><br />
(*****)<br />
</div><br />
</nowiki></pre><br />
<br />
Adding hReview to this review is also quite simple, but in this case requires a few more elements for the rating and reviewer which are required by hReview:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><span class="item"><br />
<a class="url fn" href="http://www.amazon.com/exec/obidos/ASIN/B000089CJI/"><br />
<img src="http://images.amazon.com/images/P/B000089CJI.01._SCTHUMBZZZ_.jpg" <br />
alt="Album cover photo: The Postal Service: Give Up. " <br />
class="photo" /><br />
The Postal Service: Give Up</a></span><br />
<div class="description"><p><br />
"The people thought they were just being rewarded for treating others <br />
as they like to be treated, for obeying stop signs and curing diseases, <br />
for mailing letters with the address of the sender... Don't wake me, <br />
I plan on sleeping in..."<br />
</p><p><br />
"Nothing Better" is a great track on this album, too... <br />
</p></div><br />
(<abbr class="rating" title="5">*****</abbr>)<br />
<p class="reviewer vcard">Review by <br />
<a class="url fn" href="http://ifindkarma.com/blog/">Adam Rifkin</a>, <br />
<abbr class="dtreviewed" title="200502">February 2005</abbr><br />
</p><br />
</div><br />
</nowiki></pre><br />
<br />
And this hReview might be presented like this:<br />
<br />
<br />
[Album cover photo: ]<br />
[The Postal Service:]<br />
[ Give Up ]<br />
<br />
The Postal Service: Give Up<br />
<br />
"The people thought they were just being rewarded for treating others as they like to be treated, for obeying stop signs and curing diseases, for mailing letters with the address of the sender... Don't wake me, I plan on sleeping in..."<br />
<br />
"Nothing Better" is a great track on this album, too...<br />
<br />
(*****)<br />
<br />
Review by Adam Rifkin, February 2005.<br />
<br />
=== Movie Review ===<br />
Finally, here is an example of a movie review.<br />
<br />
<pre><nowiki><br />
<div><br />
<span>anonymous, April 18th, 2005</span><br />
<div><br />
<a lang="zh" href="http://www.imdb.com/title/tt0299977/"><br />
Ying Xiong (<span lang="en">HERO</span>)<br />
</a><br />
</div><br />
<div>Rating: 4 out of 5</div><br />
<blockquote><p><br />
This movie has great visuals and music.<br />
</p></blockquote><br />
</div><br />
</nowiki></pre><br />
<br />
With hReview:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><br />
<span class="reviewer vcard"><br />
<span class="fn">anonymous</span>, <br />
<abbr class="dtreviewed" title="20050418">April 18th, 2005</abbr><br />
</span><br />
<div class="item"><br />
<a lang="zh" class="url fn" href="http://www.imdb.com/title/tt0299977/"><br />
Ying Xiong (<span lang="en">HERO</span>)<br />
</a><br />
</div><br />
<div>Rating: <span class="rating">4</span> out of 5</div><br />
<div class="description"><p><br />
This movie has great music and visuals.<br />
</p></div><br />
</div><br />
</nowiki></pre><br />
<br />
Which could be presented like this:<br />
<br />
anonymous, April 18th, 2005<br /><br />
Ying Xiong (HERO)<br /><br />
Rating: 4 out of 5<br /><br />
<br />
This movie has great music and visuals.<br />
<br />
== Examples in the wild ==<br />
This section is '''informative'''. The number of hReview examples in the wild has expanded far beyond the capacity of being kept inline in this specification. They have been moved to a [[hreview-examples-in-wild|separate page]].<br />
<br />
See [[hreview-examples-in-wild|hReview Examples in the wild]].<br />
<br />
== Implementations ==<br />
This section is '''informative'''. The number of hReview implementations has also expanded beyond the capacity of keeping them inline. They have been moved to a [[hreview-implementations|separate page]].<br />
<br />
See [[hreview-implementations|hReview Implementations]].<br />
<br />
== References ==<br />
=== Normative References ===<br />
* [http://www.w3.org/TR/2002/REC-xhtml1-20020801/ XHTML 1.0 SE]<br />
* [http://gmpg.org/xmdp/ XMDP]<br />
* [[hcard|hCard]]<br />
* [[hcalendar|hCalendar]]<br />
* [[rel-tag]]<br />
* [http://www.ietf.org/rfc/rfc2119.txt RFC2119]<br />
* [http://www.ietf.org/rfc/rfc3986.txt RFC3986]<br />
* [http://www.ietf.org/rfc/rfc4287.txt RFC4287] (Atom 1.0)<br />
<br />
=== Informative References ===<br />
* [http://www.w3.org/TR/REC-CSS1 CSS1]<br />
* ISO.8601.1988<br />
** International Organization for Standardization, "Data elements and interchange formats - Information interchange - Representation of dates and times", ISO Standard 8601, June 1988.<br />
* [http://www.w3.org/TR/1998/NOTE-datetime-19980827 W3C NOTE-datetime-19980827]<br />
* [http://www.ietf.org/rfc/rfc3667.txt RFC3667]<br />
* [http://www.ietf.org/rfc/rfc3668.txt RFC3668]<br />
* [http://www.w3.org/Consortium/Patent-Policy-20040205/ W3C Patent Policy]<br />
* [http://local.yahoo.com/details?id=21359628 Crepes on Cole reviews on Yahoo! Local]<br />
* Other reviews efforts. See [[reviews-formats]].<br />
* Contributed from http://developers.technorati.com/wiki/hReview.<br />
<br />
==== Similar Work ====<br />
* [[hlisting-proposal|hListing]]<br />
* [[xoxo|XOXO]]<br />
<br />
=== Copyright ===<br />
{{MicroformatCopyrightStatement2005}}<br />
<br />
=== Patents ===<br />
{{MicroFormatPatentStatement}}<br />
<br />
== Work in progress ==<br />
This specification is a work in progress. As additional aspects are discussed, understood, and written, they will be added. <br />
<br />
=== Changes from v0.2 ===<br />
The following changes have been made in hReview v0.3 over [[hreview-v0.2|hReview v0.2]]:<br />
<br />
Normative changes:<br />
# MUST (instead of SHOULD) use [[hcard|hCard]] for the item description of a business or person<br />
# "reviewer" changes<br />
## Made reviewer *optional* per feedback from Ryan King and Mark Nottingham<br />
## If reviewer is absent from the hReview, then look outside the hReview, in the context of the page, for the reviewer. If there is no "reviewer" outside either, then use the author information according to the containing document language (e.g. <code><nowiki><address></nowiki></code> for (X)HTML pages) as the reviewer.<br />
## MUST (instead of SHOULD) use [[hcard|hCard]] to represent reviewer information<br />
# "dtreviewed" changes<br />
## Made dtreviewed *optional* per feedback from Ryan King and Mark Nottingham<br />
## If dtreviewed is absent from the hReview, then look outside the hReview, in the surrounding context. If the context is an [[hatom|hAtom]] entry, use its "published" (or "updated" if that is missing) datetime as the dtreviewed, if not present on the entry, use the "published" (or "updated" if that is missing) of the feed. Otherwise use the information according to the containing document language (e.g. "published"/"updated" similarly for Atom feeds), then protocol (e.g. HTTP Last-Modified, or file system last modified datetime).<br />
# SHOULD use [[hcalendar|hCalendar]] to represent an item of 'type' 'event'<br />
# Added one decimal digit of precision to ratings' numerical values based on publisher experience.<br />
# Use [http://microformats.org/wiki/hcard#Value_excerpting the "value" construct from hCard] (as it is used in "tel" properties for example) to more explicitly markup the rating value when also providing (marking up) the best/worst of a rating.<br />
# Added [[rel-license]] to indicate the license of the hReview as a whole.<br />
# Permit tags inside ratings to denote rated tags, the same as ratings inside tags per suggestion from Eran Globen.<br />
# Add [[include-pattern]] support to allow multiple reviews for the same item to not repeat the item info.<br />
<br />
Informative changes (several, but in particular):<br />
# Note that scalar/rated tags would ideally use a tag space that explain the ratings for that tag. E.g. to explain what Food:18/30 means.<br />
# Updated examples accordingly.<br />
<br />
== Further Reading ==<br />
* See also [http://www.technorati.com/cosmos/referer.html blogs discussing this page].<br />
<br />
== Related Pages people==<br />
* Sildenafil citrate, sold under the [http://www.efficacylevitra.info names Levitra]<br />
* A ring tone is the sound made by a telephone to indicate an [http://freeringtonemp.info incoming call]<br />
* Viagra pills are blue and [http://orderviagrales.info diamond-shaped] with the words.<br />
* Both Viagra and the Levitra are derived from [http://levitravsviagra.info Proto-Indo-Iranian]<br />
* The mode of action of [http://ordertramadoline.info tramadol] has yet to be fully understood.<br />
* Phentermine is a drug primarily used as an [http://pharmacyphentermine.info appetite suppressant]<br />
* The proper definition of [http://replicawatchbmw.info replica]<br />
* Alprazolam was [http://valiumxanax.info originally marketed] as an atypical benzodiazepine, but only classified for use treating anxiety neurosis.<br />
<br />
== Related Pages ==<br />
{{hreview-related-pages}}</div>Adminihttps://microformats.org/wiki/index.php?title=hreview&diff=13922hreview2007-03-03T15:44:20Z<p>Admini: /* Further Reading */</p>
<hr />
<div><h1> hReview 0.3 </h1><br />
<br />
[[hreview|hReview]] is a simple, open, distributed format, suitable for embedding reviews (of products, services, businesses, events, etc.) in (X)HTML, Atom, RSS, and arbitrary XML. hReview is one of several [[microformats]] open standards.<br />
<br />
Want to get started with writing an [[hreview|hReview]]? Use the [http://microformats.org/code/hreview/creator hReview creator] to write a review and publish it.<br />
<br />
== Microformats Draft Specification 2006-02-22 ==<br />
<br />
; Editor: [http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc.]<br />
; Authors: [http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc.]<br />
: [http://360.yahoo.com/alidiabali Ali Diab],[http://yahoo.com Yahoo! Inc.]<br />
: [http://spaces.msn.com/members/ianmcallister/ Ian McAllister], [http://microsoft.com/ Microsoft Corporation]<br />
: [http://journals.aol.com/panzerjohn/abstractioneer John Panzer], [http://www.aol.com America Online, Inc.]<br />
: [http://ifindkarma.com/blog Adam Rifkin], [http://labs.commerce.net/ CommerceNet Labs]<br />
: [http://sippey.typepad.com/ Michael Sippey], [http://sixapart.com Six Apart, Ltd.]<br />
<br />
Microformats [http://microformats.org/wiki/hreview#Copyright copyright] and [http://microformats.org/wiki/hreview#Patents patents] statements apply.<br />
<br />
__TOC__<br />
<br />
== Introduction ==<br />
Numerous web sites publish reviews using a broad variety of schema for all sorts of things from products (movies, music, books), to businesses (restaurants, hotels, stores), to events (concerts, theatre), to people (artists, leaders, celebrities), to places (landmarks, parks), to online resources (web pages, files), to reviews of reviews themselves.<br />
<br />
In order to enable and encourage the sharing, distribution, syndication, and aggregation, of reviews, the authors propose the hReview microformat, an open standard for distributed reviews. The authors have researched both numerous [[review-examples]] in the wild and earlier attempts at [[review-formats]], and have designed hReview around a simple minimal schema for reviews. Feedback is encouraged on the [[hreview-feedback|hReview feedback]] page.<br />
<br />
=== Inspiration and Acknowledgments ===<br />
Thanks to everyone who responded to the open call for implementor participation for hReview. The authors in particular wish to thank the following individuals for their constructive input and feedback: [http://www.richardault.com/ Richard Ault], [http://dannyayers.com Danny Ayers], [http://www.vertexdev.com/~jeff/ Jeffrey Barr],[http://adriancuthbert.blogspot.com/ Adrian Cuthbert],[http://jason.defillippo.com/ Jason DeFillippo], [http://www.hybernaut.com/bdv Brian Del Vecchio], Scott Derringer, [http://budgibson.com/home/ Bud Gibson], [http://joi.ito.com/ Joi Ito], [http://www.kanai.net/weblog/ Gen Kanai],[http://niallkennedy.com/ Niall Kennedy], [http://labs.commerce.net/wiki/index.php/Rohit_Khare Rohit Khare], [http://theryanking.com/ Ryan King], [http://www.jluster.org/ Jonas Luster], [http://epeus.blogspot.com/ Kevin Marks], Mark Nottingham, [http://www.powazek.com/ Derek Powazek], [http://www.judysbook.com/ Jeff Rodenburg], [http://sifry.com/alerts/ David Sifry], [http://jystewart.net/ James Stewart], [http://kung-foo.tv/ Adriaan Tijsseling], [http://www.flashenabled.com/ Phillip Torrone], Thai Tran, [http://w6daily.winn.com/ Phillip Winn], [http://yohei-y.blogspot.com YAMAMOTO Yohei].<br />
<br />
=== Scope ===<br />
Reviews consistently share several common fields. Where possible hReview has been based on this minimal common subset.<br />
<br />
==== Out of scope ====<br />
Fields that are type-specific have been omitted from hReview. It is important that hReview be kept simple and minimal from the start. Additional features can be added as deemed necessary by practical implementation experience.<br />
<br />
The concept of a "universal object identifier", that is, how to identify the same object/item/product across different shopping sites, though something very useful to have, is outside the scope of this format.<br />
<br />
== Semantic XHTML Design Principles ==<br />
{{semantic-xhtml-design-principles}}<br />
<br />
== Format ==<br />
=== In General ===<br />
The hReview format is based on a set of fields common to numerous review sites and formats in use today on the web. Where possible field names have been chosen based on those defined by the related [[hcard|hCard]] and [[hcalendar|hCalendar]] standards.<br />
<br />
=== Schema ===<br />
The hReview schema consists of the following:<br />
<br />
* hReview ('''<code>hreview</code>''')<br />
** '''<code>version</code>'''. optional. text.<br />
** '''<code>summary</code>'''. optional. text.<br />
** item '''<code>type</code>'''. optional. product | business | event | person | place | website | url.<br />
** '''<code>item</code>''' info. required. '''<code>fn</code>''' ('''<code>url</code>''' || '''<code>photo</code>''' ) | '''[[hcard|hCard]]''' (for person or business) | '''[[hcalendar|hCalendar]]''' (for event)<br />
** '''<code>reviewer</code>'''. optional. '''[[hcard|hCard]]'''.<br />
** '''<code>dtreviewed</code>'''. optional. ISO8601 absolute date time.<br />
** '''<code>rating</code>'''. optional. fixed point integer [1.0-5.0], with optional alternate '''<code>worst</code>''' (default:1.0) and/or '''<code>best</code>''' (default:5.0), also fixed point integers, and explicit '''<code>value</code>'''.<br />
** '''<code>description</code>'''. optional. text with optional valid XHTML markup.<br />
** tags. optional. keywords or phrases, using '''[[rel-tag]]''', each with optional rating.<br />
** permalink. optional, using '''[[rel-bookmark]]''' and '''[[rel-self]]'''.<br />
** license. optional, using '''[[rel-license]]'''.<br />
<br />
=== Field details ===<br />
The fields of the hReview schema represent the following:<br />
<br />
'''version''':: This optional field permits hReview publishers to specify a particular version of hReview that their content uses. By omitting this field, the publisher is stating that implementations may interpret the hReviews according to any version of the hReview specification v0.2 or later. In practice the authors of this specification are comitted to maintaining backward compatibility with content produced using earlier versions of the specification. This field is syntax compatible with, and thus reuses the semantics of "VERSION" as defined in vCard RFC2426 section "3.6.9 VERSION Type Definition". The value of this field for this specification is "0.3".<br />
<br />
'''summary''':: This optional field serves as a title for the review itself.<br />
<br />
'''item type''':: This optional field "type" provides the type of the item being reviewed, one of the following: product, business, event, person, place, website, url. If omitted, then in some cases the item type may be inferred. If the item is also an [[hcard|hCard]], then the item type is a "business" or a "person" based upon which of those the hCard represents. If the item is also an [[hcalendar|hCalendar]] event, then the item type is an "event".<br />
<br />
'''item info''':: This required field MUST have at a minimum the name ("fn" - the formatted text corresponding to the name) of ''the'' item (an hReview describes only one item), SHOULD provide at least one URI ("url") for the item, and MAY provide at least one URL to a photo or depiction ("photo") of the item. For items of type person or business, the item info (fn, url, photo) MUST be encapsulated in an [[hcard|hCard]]. For items of type event, the item info SHOULD be encapsulated in an [[hcalendar|hCalendar]] "vevent". Unique item IDs (e.g. ISBNs, UPCs) MAY be represented as a URN ("url") for the item. Encapsulated microformats (e.g. [[hcard|hCard]] and [[hcalendar|hCalendar]] events for now) may be set on the item itself (e.g. class="item vcard"). However, when using item info subproperties ("fn", "url", "photo"), they MUST be nested <em>inside</em> the item element.<br />
<br />
'''reviewer''':: The optional field specifies the person who authored the review. If the reviewer is specified, an hCard representing the reviewer MUST be provided. For anonymous reviews, use "anonymous" (without quotes) for the full name of the reviewer. If no "reviewer" is found inside the hReview, parsers should look outside the hReview, in the context of the page, for the "reviewer". If there is no "reviewer" outside either, then parsers should use the author defined by the containing document language, e.g. for (X)HTML documents, the <code><nowiki><address></nowiki></code> contact info for the page (which is ideally marked up as an [[hcard|hCard]] as well), for Atom 1.0 the <code><nowiki><entry></nowiki></code> <code><nowiki><author></nowiki></code> if present and if not the <code><nowiki><feed></nowiki></code> <code><nowiki><author></nowiki></code>, for RSS the <code><nowiki><author></nowiki></code> inside the containing <code><nowiki><item></nowiki></code> element.<br />
<br />
'''dtreviewed''':: This optional field when present MUST provide an ISO8601 absolute date time of when the review was written or otherwise authored. This field SHOULD use UTC, but MAY use the time zone offset syntax. If dtreviewed is absent from the hReview, then look outside the hReview, in the surrounding context. If the context is an [[hatom|hAtom]] entry, use its "published" (or "updated" if that is missing) datetime as the dtreviewed, if not present on the entry, use the "published" (or "updated" if that is missing) of the feed. Otherwise use the creation date (or modified date if that is missing) information according to the containing document language (e.g. "published"/"updated" similarly for Atom feeds), then protocol (e.g. HTTP Last-Modified, or file system last modified datetime) as the dtreviewed.<br />
<br />
'''rating''':: The rating is a fixed point integer (one decimal point of precision) from 1.0 to 5.0 inclusive indicating a rating for the item, higher indicating a better rating by default. Optionally a different integral "worst" value and/or "best" value MAY be specified to indicate a different range (e.g. 6 from 0-10). The "best" value may be numerically smaller than the "worst" value.<br />
<br />
'''description''':: This optional field contains the full text representing the written opinion of the reviewer. The field MAY include valid XHTML markup (e.g. paragraphs). User agents SHOULD preserve any markup. Multiple descriptions or section descriptions (e.g. pros and cons, plusses and minusses) SHOULD be included in the description field.<br />
<br />
'''tags''':: Tags are represented using a list of keywords or phrases (using the [[rel-tag]] microformat for each individual keyword or phrase tag) that the reviewer associates with the item. The reviewer MAY optionally provide a tag-specific rating inside each [[rel-tag]], e.g. ambience:5. Tag-specific ratings by default use the same range as an overall rating for the item if present, and MAY also have a custom worst...best range specified. Authors MAY also invert this structure for the same semantic if it is more convenient for their markup, that is, place the [[rel-tag]] inside a rating to indicate a rated tag. Note: rated tags should ideally use a tag space that explains what the ratings for that tag mean. E.g. Food:18/30 should link to a tags space for Food that explains what an 18 out of 30 means for the Food tag.<br />
<br />
'''permalink''':: This optional field is a URL for the hReview. In addition to using the <code><a href></code> tag for this field, the attribute <code>rel="self bookmark"</code> MUST be used to indicate that the hyperlink is a permalink for the review itself. If the hyperlink already contains a <code>rel</code> attribute, then the values <code>self</code> and <code>bookmark</code> MUST be included among the space-separated set of values in the attribute. Indexers MAY treat the permalink of a review as a unique ID in order to identify and collate the same review from multiple sources (such as indexing a page multiple times). The permalink MAY also be used to indicate or imply the origin of the review. Authors MAY use the classname of "permalink" on the element representing the permalink, but are not required to do so.<br />
<br />
'''license''':: This optional field links to the license under which the contents of the hReview itself is licensed, using the '''[[rel-license]]''' microformat.<br />
<br />
<br />
The following field names have been reused from the [[hcard|hCard]] and [[hcalendar|hCalendar]] microformats: <code>version, summary, fn, url, photo, description</code>. In addition, items and reviewers described by hCards MAY contain any hCard field. The rel value "self" has been reused from the [http://atompub.org/2005/07/11/draft-ietf-atompub-format-10.html Atom 1.0 specification].<br />
<br />
=== More Semantic Equivalents ===<br />
<br />
For some properties there is a more semantic equivalent, and therefore they get special treatment, e.g.: <br />
<br />
* For any "url", use <code><a class="url" href="...">...</a></code> inside the element with the class name 'hreview' in hReview.<br />
* And for "photo", use <code><img class="photo" src="..." alt="Photo of ..." /></code> <br />
<br />
* Ratings are often presented either as a set of images or characters, e.g. "***". For these, the <code>&lt;abbr&gt;</code> element is particularly useful, as such characters are an abbreviation for the precise rating, e.g. <code>&lt;abbr class="rating" title="3.0"&gt;***&lt;/abbr&gt;</code>. This is further explored in the next section.<br />
<br />
==== Language ====<br />
* To explicitly convey the natural language that an hReview is written in, use the standard (X)HTML 'lang' attribute on the element with class="hreview", e.g. <code>&lt;div class="hreview" lang="en"&gt; ... &lt;/div&gt;</code> If portions of an hReview (e.g. the item name) are in a different language, use the 'lang' attribute on those portions.<br />
* hReview processors which need to handle the language of reviews MUST process the standard (X)HTML 'lang' attribute as specified.<br />
<br />
=== Human vs. Machine Readable ===<br />
If an <code>&lt;abbr></code> element is used for a property, then its '<code>title</code>' attribute is used for the value of the property, instead of the contents of the element, which can then be used to provide a user-friendly alternate presentation of the value. <br />
<br />
Similarly, if an <code><img /></code> element is used for one or more properties, it MUST be treated as follows: <br />
<br />
# For the "photo" property and any other property that takes a URL as its value, the <code>src="..."</code> attribute provides the property value. <br />
# For other properties, the <code><img /></code> element's '<code>alt</code>' attribute is the value of the property.<br />
<br />
=== Object Includes ===<br />
<br />
hReview 0.3 includes support for the object [[include-pattern]].<br />
<br />
Often a single page lists an item, and then several reviews for that item. In order to avoid having to repeat the item info for each review of the item, the first review should be marked up as an hReview, with a unique "id" attribute on the item info, and then following reviews should use the object [[include-pattern]] to include the item info from the first review.<br />
<br />
<br />
=== Notes ===<br />
This section is informative.<br />
<br />
* By marking up a review with the hReview microformat, the expectation is communicated that the review MAY be indexed. This has no impact on the copyright of the review itself which the publisher may explicitly specify using [[rel-license]] as specified above.<br />
* The enumerated list of item types is under development and may be extended.<br />
* Each type may have custom hReview fields that follow the common set.<br />
* Additional details about a particular item should be specified with the rest of the item's info at the URL provided for the item.<br />
* Most rating systems use the range 1.0 to 5.0, and most of those represent the rating as a number (and possibly half) of stars. Sites may use whatever graphic they wish to represent the rating.<br />
<br />
== Examples ==<br />
Here are a few examples of reviews from current web sites, and how they could be easily enhanced to support the hReview structured review microformat. <br />
<br />
Want to get started with writing an [[hreview|hReview]]? Use the [http://microformats.org/code/hreview/creator hReview creator] to write a review and publish it on your blog.<br />
<br />
=== Restaurant reviews ===<br />
<br />
Here is an example of a simple online restaurant review:<br />
<br />
<pre><nowiki><br />
<div><br />
<span>5 stars out of 5 stars</span><br />
<h4>Crepes on Cole is awesome</h4><br />
<span>Reviewer: <span>Tantek</span> - April 18, 2005</span><br />
<blockquote><p><br />
Crepes on Cole is one of the best little creperies in San Francisco. <br />
Excellent food and service. Plenty of tables in a variety of sizes <br />
for parties large and small. Window seating makes for excellent <br />
people watching to/from the N-Judah which stops right outside. <br />
I've had many fun social gatherings here, as well as gotten <br />
plenty of work done thanks to neighborhood WiFi.<br />
</p></blockquote><br />
<p>Visit date: <span>April 2005</span></p><br />
<p>Food eaten: <span>Florentine crepe</span></p><br />
</div><br />
</nowiki></pre><br />
<br />
Adding hReview to this review is quite simple:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><br />
<span><span class="rating">5</span> out of 5 stars</span><br />
<h4 class="summary">Crepes on Cole is awesome</h4><br />
<span class="reviewer vcard">Reviewer: <span class="fn">Tantek</span> - <br />
<abbr class="dtreviewed" title="20050418T2300-0700">April 18, 2005</abbr></span><br />
<div class="description item vcard"><p><br />
<span class="fn org">Crepes on Cole</span> is one of the best little <br />
creperies in <span class="adr"><span class="locality">San Francisco</span></span>.<br />
Excellent food and service. Plenty of tables in a variety of sizes <br />
for parties large and small. Window seating makes for excellent <br />
people watching to/from the N-Judah which stops right outside. <br />
I've had many fun social gatherings here, as well as gotten <br />
plenty of work done thanks to neighborhood WiFi.<br />
</p></div><br />
<p>Visit date: <span>April 2005</span></p><br />
<p>Food eaten: <span>Florentine crepe</span></p><br />
</div><br />
</nowiki></pre><br />
<br />
Note that some of the properties of this sample review are not captured by hReview (visit date, food eaten). This is deliberate per the scope of keeping hReview minimal and simple.<br />
<br />
This sample hReview could be rendered like this:<br />
<br />
5 stars out of 5 stars<br /><br />
'''Crepes on Cole is awesome'''<br /><br />
Reviewer: Tantek - April 18, 2005<br /><br />
<br />
Crepes on Cole is one of the best little creperies in San Francisco. Excellent food and service. Plenty of tables in a variety of sizes for parties large and small. Window seating makes for excellent people watching to/from the N-Judah which stops right outside. I've had many fun social gatherings here, as well as gotten plenty of work done thanks to neighborhood wifi.<br />
<br />
Visit date: April 2005<br /><br />
Food eaten: Florentine crepe<br /><br />
<br />
==== Multidimensional Restaurant Review ====<br />
Some restaurant reviews indicate ratings for different aspects of the restaurant. Such details are represented in hReview using tagged ratings. In addition, note the inline tags inside the description of this review.<br />
<br />
Here is one such review in text format:<br />
<br />
Cafe Borrone<br />
<br />
1010 El Camino Real, Menlo Park, CA 94025, +1-650-327-0830;<br />
cafeborrone.com<br />
<br />
Food: 18/30; Ambience: 19/30; Service: 15/30; Price: $$...<br />
<br />
This cafe is a welcoming oasis on the Peninsula. It even has a fountain<br />
outside which cloaks the nearby sounds of El Camino traffic. Next door to a <br />
superb indy bookstore, Cafe Borrone is an ideal spot to grab a coffee or a <br />
snack to accompany a newly purchased book or imported periodical. Soups and <br />
sandwich specials rotate daily. The corn chowder with croutons and big <br />
chunks of cheese goes especially well with a freshly toasted mini-baguette. <br />
Evenings are often crowded and may require sharing a table with a perfect <br />
stranger. Espresso afficionados will appreciate the Illy coffee. Noise <br />
levels can vary from peaceful in the late mornings to nearly overwhelming on <br />
jazz band nights.<br />
<br />
As an hReview:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><br />
<div class="item vcard"><br />
<div class="fn org summary">Cafe Borrone</div><br />
<span class="adr"><br />
<span class="street-address">1010 El Camino Real</span>,<br />
<span class="locality">Menlo Park</span>,<br />
<span class="region">CA</span><br />
<span class="postal-code">94025</span>,<br />
</span><br />
<span class="tel">+1-650-327-0830</span>;<br />
<a class="url" href="http://cafeborrone.com">cafeborrone.com</a><br />
</div><br />
<ul><br />
<li class="rating"><a href="http://en.wikipedia.org/wiki/Food" rel="tag"><br />
Food: <span class="value">18</span>/<span class="best">30</span></a>;</li><br />
<li class="rating"><a href="http://flickr.com/photos/tags/Ambience" rel="tag"><br />
Ambience: <span class="value">19</span>/<span class="best">30</span></a>;</li><br />
<li class="rating"><a href="http://en.wikipedia.org/wiki/Service" rel="tag"><br />
Service: <span class="value">15</span>/<span class="best">30</span></a>;</li><br />
<li class="rating"><a href="http://en.wikipedia.org/wiki/Price" rel="tag"><br />
Price: <abbr class="value" title="2">$$</abbr>...</a></li><br />
</ul><br />
<div class="description"><p><br />
This <abbr class="type" title="business"><br />
<a href="http://en.wikipedia.org/wiki/cafe" rel="tag">cafe</a></abbr> <br />
is a welcoming oasis on the Peninsula. <br />
It even has a fountain outside which nearly eliminates <br />
the sounds of El Camino traffic. Next door to a superb indy bookstore, <br />
Cafe Borrone is an ideal spot to grab a <br />
<a href="http://en.wikipedia.org/wiki/coffee" rel="tag">coffee</a> <br />
or a meal to accompany a newly purchased book or imported periodical. <br />
<a href="http://technorati.com/tag/soup" rel="tag">Soups</a> and <br />
<a href="http://technorati.com/tag/sandwich" rel="tag">sandwich</a> <br />
specials rotate daily. The corn chowder with croutons and big chunks of cheese <br />
goes especially well with a freshly toasted mini-baguette. Evenings are <br />
often crowded and may require sharing a table with a perfect stranger. <br />
<a href="http://flickr.com/photos/tags/espresso" rel="tag">Espresso</a> <br />
afficionados will appreciate the <br />
<a href="http://en.wikipedia.org/wiki/Illy" rel="tag">Illy</a> coffee. <br />
Noise levels can vary from peaceful in the late mornings to nearly overwhelming on <br />
<a href="http://en.wikipedia.org/wiki/jazz" rel="tag">jazz</a> band nights.<br />
</p></div><br />
Review (<a href="http://microformats.org/wiki/hreview"> <br />
hReview v<span class="version">0.3</span></a>)<br />
by <span class="reviewer vcard"><span class="fn">anonymous</span></span>, <br />
<abbr class="dtreviewed" title="20050428T2130-0700">April 28th, 2005</abbr>.<br />
</div><br />
</nowiki></pre><br />
<br />
With an accompanying CSS style sheet like:<br />
<br />
<pre><nowiki><br />
a.url { display:block }<br />
ul { margin:1em 0; padding:0 }<br />
ul li { display:inline }<br />
</nowiki></pre><br />
<br />
This hReview could be presented similar to the original text:<br />
<br />
Cafe Borrone<br /><br />
1010 El Camino Real, Menlo Park, CA 94025, +1-650-327-0830;<br /><br />
[http://cafeborrone.com/ cafeborrone.com]<br /><br />
<br /><br />
[http://en.wikipedia.org/wiki/Food Food: 18/30];<br />
[http://flickr.com/photos/tags/Ambience Ambience: 19/30];<br />
[http://en.wikipedia.org/wiki/Service Service: 15/30];<br />
[http://en.wikipedia.org/wiki/Price Price: $$...]<br /><br />
<br />
This [http://en.wikipedia.org/wiki/cafe cafe] is a welcoming oasis on the Peninsula. It even has a fountain outside which cloaks the nearby sounds of El Camino traffic. Next door to a superb indy bookstore, Cafe Borrone is an ideal spot to grab a [http://en.wikipedia.org/wiki/coffee coffee] or a snack to accompany a newly purchased book or imported periodical. [http://technorati.com/tag/soup Soups] and [http://technorati.com/tag/sandwich sandwich] specials rotate daily. The corn chowder with croutons and big chunks of cheese goes especially well with a freshly toasted mini-baguette. Evenings are often crowded and may require sharing a table with a perfect stranger. [http://flickr.com/photos/tags/espresso Espresso] afficionados will appreciate the [http://en.wikipedia.org/wiki/Illy Illy] coffee. Noise levels can vary from peaceful in the late mornings to nearly overwhelming on [http://en.wikipedia.org/wiki/jazz jazz] band nights.<br />
<br />
Review ([http://microformats.org/wiki/hreview hReview v0.3]) by anonymous, April 28th, 2005.<br />
<br />
=== Product review ===<br />
Here is an example of a product review:<br />
<br />
<pre><nowiki><br />
<div><br />
<a href="http://www.amazon.com/exec/obidos/ASIN/B000089CJI/"><br />
<img src="http://images.amazon.com/images/P/B000089CJI.01._SCTHUMBZZZ_.jpg" <br />
alt="Album cover photo: The Postal Service: Give Up." /><br />
The Postal Service: Give Up</a><br />
<blockquote><p><br />
"The people thought they were just being rewarded for treating others <br />
as they like to be treated, for obeying stop signs and curing diseases, <br />
for mailing letters with the address of the sender... Don't wake me, <br />
I plan on sleeping in..."<br />
</p><p><br />
"Nothing Better" is a great track on this album, too... <br />
</p></blockquote><br />
(*****)<br />
</div><br />
</nowiki></pre><br />
<br />
Adding hReview to this review is also quite simple, but in this case requires a few more elements for the rating and reviewer which are required by hReview:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><span class="item"><br />
<a class="url fn" href="http://www.amazon.com/exec/obidos/ASIN/B000089CJI/"><br />
<img src="http://images.amazon.com/images/P/B000089CJI.01._SCTHUMBZZZ_.jpg" <br />
alt="Album cover photo: The Postal Service: Give Up. " <br />
class="photo" /><br />
The Postal Service: Give Up</a></span><br />
<div class="description"><p><br />
"The people thought they were just being rewarded for treating others <br />
as they like to be treated, for obeying stop signs and curing diseases, <br />
for mailing letters with the address of the sender... Don't wake me, <br />
I plan on sleeping in..."<br />
</p><p><br />
"Nothing Better" is a great track on this album, too... <br />
</p></div><br />
(<abbr class="rating" title="5">*****</abbr>)<br />
<p class="reviewer vcard">Review by <br />
<a class="url fn" href="http://ifindkarma.com/blog/">Adam Rifkin</a>, <br />
<abbr class="dtreviewed" title="200502">February 2005</abbr><br />
</p><br />
</div><br />
</nowiki></pre><br />
<br />
And this hReview might be presented like this:<br />
<br />
<br />
[Album cover photo: ]<br />
[The Postal Service:]<br />
[ Give Up ]<br />
<br />
The Postal Service: Give Up<br />
<br />
"The people thought they were just being rewarded for treating others as they like to be treated, for obeying stop signs and curing diseases, for mailing letters with the address of the sender... Don't wake me, I plan on sleeping in..."<br />
<br />
"Nothing Better" is a great track on this album, too...<br />
<br />
(*****)<br />
<br />
Review by Adam Rifkin, February 2005.<br />
<br />
=== Movie Review ===<br />
Finally, here is an example of a movie review.<br />
<br />
<pre><nowiki><br />
<div><br />
<span>anonymous, April 18th, 2005</span><br />
<div><br />
<a lang="zh" href="http://www.imdb.com/title/tt0299977/"><br />
Ying Xiong (<span lang="en">HERO</span>)<br />
</a><br />
</div><br />
<div>Rating: 4 out of 5</div><br />
<blockquote><p><br />
This movie has great visuals and music.<br />
</p></blockquote><br />
</div><br />
</nowiki></pre><br />
<br />
With hReview:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><br />
<span class="reviewer vcard"><br />
<span class="fn">anonymous</span>, <br />
<abbr class="dtreviewed" title="20050418">April 18th, 2005</abbr><br />
</span><br />
<div class="item"><br />
<a lang="zh" class="url fn" href="http://www.imdb.com/title/tt0299977/"><br />
Ying Xiong (<span lang="en">HERO</span>)<br />
</a><br />
</div><br />
<div>Rating: <span class="rating">4</span> out of 5</div><br />
<div class="description"><p><br />
This movie has great music and visuals.<br />
</p></div><br />
</div><br />
</nowiki></pre><br />
<br />
Which could be presented like this:<br />
<br />
anonymous, April 18th, 2005<br /><br />
Ying Xiong (HERO)<br /><br />
Rating: 4 out of 5<br /><br />
<br />
This movie has great music and visuals.<br />
<br />
== Examples in the wild ==<br />
This section is '''informative'''. The number of hReview examples in the wild has expanded far beyond the capacity of being kept inline in this specification. They have been moved to a [[hreview-examples-in-wild|separate page]].<br />
<br />
See [[hreview-examples-in-wild|hReview Examples in the wild]].<br />
<br />
== Implementations ==<br />
This section is '''informative'''. The number of hReview implementations has also expanded beyond the capacity of keeping them inline. They have been moved to a [[hreview-implementations|separate page]].<br />
<br />
See [[hreview-implementations|hReview Implementations]].<br />
<br />
== References ==<br />
=== Normative References ===<br />
* [http://www.w3.org/TR/2002/REC-xhtml1-20020801/ XHTML 1.0 SE]<br />
* [http://gmpg.org/xmdp/ XMDP]<br />
* [[hcard|hCard]]<br />
* [[hcalendar|hCalendar]]<br />
* [[rel-tag]]<br />
* [http://www.ietf.org/rfc/rfc2119.txt RFC2119]<br />
* [http://www.ietf.org/rfc/rfc3986.txt RFC3986]<br />
* [http://www.ietf.org/rfc/rfc4287.txt RFC4287] (Atom 1.0)<br />
<br />
=== Informative References ===<br />
* [http://www.w3.org/TR/REC-CSS1 CSS1]<br />
* ISO.8601.1988<br />
** International Organization for Standardization, "Data elements and interchange formats - Information interchange - Representation of dates and times", ISO Standard 8601, June 1988.<br />
* [http://www.w3.org/TR/1998/NOTE-datetime-19980827 W3C NOTE-datetime-19980827]<br />
* [http://www.ietf.org/rfc/rfc3667.txt RFC3667]<br />
* [http://www.ietf.org/rfc/rfc3668.txt RFC3668]<br />
* [http://www.w3.org/Consortium/Patent-Policy-20040205/ W3C Patent Policy]<br />
* [http://local.yahoo.com/details?id=21359628 Crepes on Cole reviews on Yahoo! Local]<br />
* Other reviews efforts. See [[reviews-formats]].<br />
* Contributed from http://developers.technorati.com/wiki/hReview.<br />
<br />
==== Similar Work ====<br />
* [[hlisting-proposal|hListing]]<br />
* [[xoxo|XOXO]]<br />
<br />
=== Copyright ===<br />
{{MicroformatCopyrightStatement2005}}<br />
<br />
=== Patents ===<br />
{{MicroFormatPatentStatement}}<br />
<br />
== Work in progress ==<br />
This specification is a work in progress. As additional aspects are discussed, understood, and written, they will be added. <br />
<br />
=== Changes from v0.2 ===<br />
The following changes have been made in hReview v0.3 over [[hreview-v0.2|hReview v0.2]]:<br />
<br />
Normative changes:<br />
# MUST (instead of SHOULD) use [[hcard|hCard]] for the item description of a business or person<br />
# "reviewer" changes<br />
## Made reviewer *optional* per feedback from Ryan King and Mark Nottingham<br />
## If reviewer is absent from the hReview, then look outside the hReview, in the context of the page, for the reviewer. If there is no "reviewer" outside either, then use the author information according to the containing document language (e.g. <code><nowiki><address></nowiki></code> for (X)HTML pages) as the reviewer.<br />
## MUST (instead of SHOULD) use [[hcard|hCard]] to represent reviewer information<br />
# "dtreviewed" changes<br />
## Made dtreviewed *optional* per feedback from Ryan King and Mark Nottingham<br />
## If dtreviewed is absent from the hReview, then look outside the hReview, in the surrounding context. If the context is an [[hatom|hAtom]] entry, use its "published" (or "updated" if that is missing) datetime as the dtreviewed, if not present on the entry, use the "published" (or "updated" if that is missing) of the feed. Otherwise use the information according to the containing document language (e.g. "published"/"updated" similarly for Atom feeds), then protocol (e.g. HTTP Last-Modified, or file system last modified datetime).<br />
# SHOULD use [[hcalendar|hCalendar]] to represent an item of 'type' 'event'<br />
# Added one decimal digit of precision to ratings' numerical values based on publisher experience.<br />
# Use [http://microformats.org/wiki/hcard#Value_excerpting the "value" construct from hCard] (as it is used in "tel" properties for example) to more explicitly markup the rating value when also providing (marking up) the best/worst of a rating.<br />
# Added [[rel-license]] to indicate the license of the hReview as a whole.<br />
# Permit tags inside ratings to denote rated tags, the same as ratings inside tags per suggestion from Eran Globen.<br />
# Add [[include-pattern]] support to allow multiple reviews for the same item to not repeat the item info.<br />
<br />
Informative changes (several, but in particular):<br />
# Note that scalar/rated tags would ideally use a tag space that explain the ratings for that tag. E.g. to explain what Food:18/30 means.<br />
# Updated examples accordingly.<br />
<br />
== Further Reading ==<br />
* See also [http://www.technorati.com/cosmos/referer.html blogs discussing this page].<br />
<br />
== Related Pages ==<br />
{{hreview-related-pages}}</div>Adminihttps://microformats.org/wiki/index.php?title=hreview&diff=13920hreview2007-03-03T15:43:35Z<p>Admini: /* Further Reading */</p>
<hr />
<div><h1> hReview 0.3 </h1><br />
<br />
[[hreview|hReview]] is a simple, open, distributed format, suitable for embedding reviews (of products, services, businesses, events, etc.) in (X)HTML, Atom, RSS, and arbitrary XML. hReview is one of several [[microformats]] open standards.<br />
<br />
Want to get started with writing an [[hreview|hReview]]? Use the [http://microformats.org/code/hreview/creator hReview creator] to write a review and publish it.<br />
<br />
== Microformats Draft Specification 2006-02-22 ==<br />
<br />
; Editor: [http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc.]<br />
; Authors: [http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc.]<br />
: [http://360.yahoo.com/alidiabali Ali Diab],[http://yahoo.com Yahoo! Inc.]<br />
: [http://spaces.msn.com/members/ianmcallister/ Ian McAllister], [http://microsoft.com/ Microsoft Corporation]<br />
: [http://journals.aol.com/panzerjohn/abstractioneer John Panzer], [http://www.aol.com America Online, Inc.]<br />
: [http://ifindkarma.com/blog Adam Rifkin], [http://labs.commerce.net/ CommerceNet Labs]<br />
: [http://sippey.typepad.com/ Michael Sippey], [http://sixapart.com Six Apart, Ltd.]<br />
<br />
Microformats [http://microformats.org/wiki/hreview#Copyright copyright] and [http://microformats.org/wiki/hreview#Patents patents] statements apply.<br />
<br />
__TOC__<br />
<br />
== Introduction ==<br />
Numerous web sites publish reviews using a broad variety of schema for all sorts of things from products (movies, music, books), to businesses (restaurants, hotels, stores), to events (concerts, theatre), to people (artists, leaders, celebrities), to places (landmarks, parks), to online resources (web pages, files), to reviews of reviews themselves.<br />
<br />
In order to enable and encourage the sharing, distribution, syndication, and aggregation, of reviews, the authors propose the hReview microformat, an open standard for distributed reviews. The authors have researched both numerous [[review-examples]] in the wild and earlier attempts at [[review-formats]], and have designed hReview around a simple minimal schema for reviews. Feedback is encouraged on the [[hreview-feedback|hReview feedback]] page.<br />
<br />
=== Inspiration and Acknowledgments ===<br />
Thanks to everyone who responded to the open call for implementor participation for hReview. The authors in particular wish to thank the following individuals for their constructive input and feedback: [http://www.richardault.com/ Richard Ault], [http://dannyayers.com Danny Ayers], [http://www.vertexdev.com/~jeff/ Jeffrey Barr],[http://adriancuthbert.blogspot.com/ Adrian Cuthbert],[http://jason.defillippo.com/ Jason DeFillippo], [http://www.hybernaut.com/bdv Brian Del Vecchio], Scott Derringer, [http://budgibson.com/home/ Bud Gibson], [http://joi.ito.com/ Joi Ito], [http://www.kanai.net/weblog/ Gen Kanai],[http://niallkennedy.com/ Niall Kennedy], [http://labs.commerce.net/wiki/index.php/Rohit_Khare Rohit Khare], [http://theryanking.com/ Ryan King], [http://www.jluster.org/ Jonas Luster], [http://epeus.blogspot.com/ Kevin Marks], Mark Nottingham, [http://www.powazek.com/ Derek Powazek], [http://www.judysbook.com/ Jeff Rodenburg], [http://sifry.com/alerts/ David Sifry], [http://jystewart.net/ James Stewart], [http://kung-foo.tv/ Adriaan Tijsseling], [http://www.flashenabled.com/ Phillip Torrone], Thai Tran, [http://w6daily.winn.com/ Phillip Winn], [http://yohei-y.blogspot.com YAMAMOTO Yohei].<br />
<br />
=== Scope ===<br />
Reviews consistently share several common fields. Where possible hReview has been based on this minimal common subset.<br />
<br />
==== Out of scope ====<br />
Fields that are type-specific have been omitted from hReview. It is important that hReview be kept simple and minimal from the start. Additional features can be added as deemed necessary by practical implementation experience.<br />
<br />
The concept of a "universal object identifier", that is, how to identify the same object/item/product across different shopping sites, though something very useful to have, is outside the scope of this format.<br />
<br />
== Semantic XHTML Design Principles ==<br />
{{semantic-xhtml-design-principles}}<br />
<br />
== Format ==<br />
=== In General ===<br />
The hReview format is based on a set of fields common to numerous review sites and formats in use today on the web. Where possible field names have been chosen based on those defined by the related [[hcard|hCard]] and [[hcalendar|hCalendar]] standards.<br />
<br />
=== Schema ===<br />
The hReview schema consists of the following:<br />
<br />
* hReview ('''<code>hreview</code>''')<br />
** '''<code>version</code>'''. optional. text.<br />
** '''<code>summary</code>'''. optional. text.<br />
** item '''<code>type</code>'''. optional. product | business | event | person | place | website | url.<br />
** '''<code>item</code>''' info. required. '''<code>fn</code>''' ('''<code>url</code>''' || '''<code>photo</code>''' ) | '''[[hcard|hCard]]''' (for person or business) | '''[[hcalendar|hCalendar]]''' (for event)<br />
** '''<code>reviewer</code>'''. optional. '''[[hcard|hCard]]'''.<br />
** '''<code>dtreviewed</code>'''. optional. ISO8601 absolute date time.<br />
** '''<code>rating</code>'''. optional. fixed point integer [1.0-5.0], with optional alternate '''<code>worst</code>''' (default:1.0) and/or '''<code>best</code>''' (default:5.0), also fixed point integers, and explicit '''<code>value</code>'''.<br />
** '''<code>description</code>'''. optional. text with optional valid XHTML markup.<br />
** tags. optional. keywords or phrases, using '''[[rel-tag]]''', each with optional rating.<br />
** permalink. optional, using '''[[rel-bookmark]]''' and '''[[rel-self]]'''.<br />
** license. optional, using '''[[rel-license]]'''.<br />
<br />
=== Field details ===<br />
The fields of the hReview schema represent the following:<br />
<br />
'''version''':: This optional field permits hReview publishers to specify a particular version of hReview that their content uses. By omitting this field, the publisher is stating that implementations may interpret the hReviews according to any version of the hReview specification v0.2 or later. In practice the authors of this specification are comitted to maintaining backward compatibility with content produced using earlier versions of the specification. This field is syntax compatible with, and thus reuses the semantics of "VERSION" as defined in vCard RFC2426 section "3.6.9 VERSION Type Definition". The value of this field for this specification is "0.3".<br />
<br />
'''summary''':: This optional field serves as a title for the review itself.<br />
<br />
'''item type''':: This optional field "type" provides the type of the item being reviewed, one of the following: product, business, event, person, place, website, url. If omitted, then in some cases the item type may be inferred. If the item is also an [[hcard|hCard]], then the item type is a "business" or a "person" based upon which of those the hCard represents. If the item is also an [[hcalendar|hCalendar]] event, then the item type is an "event".<br />
<br />
'''item info''':: This required field MUST have at a minimum the name ("fn" - the formatted text corresponding to the name) of ''the'' item (an hReview describes only one item), SHOULD provide at least one URI ("url") for the item, and MAY provide at least one URL to a photo or depiction ("photo") of the item. For items of type person or business, the item info (fn, url, photo) MUST be encapsulated in an [[hcard|hCard]]. For items of type event, the item info SHOULD be encapsulated in an [[hcalendar|hCalendar]] "vevent". Unique item IDs (e.g. ISBNs, UPCs) MAY be represented as a URN ("url") for the item. Encapsulated microformats (e.g. [[hcard|hCard]] and [[hcalendar|hCalendar]] events for now) may be set on the item itself (e.g. class="item vcard"). However, when using item info subproperties ("fn", "url", "photo"), they MUST be nested <em>inside</em> the item element.<br />
<br />
'''reviewer''':: The optional field specifies the person who authored the review. If the reviewer is specified, an hCard representing the reviewer MUST be provided. For anonymous reviews, use "anonymous" (without quotes) for the full name of the reviewer. If no "reviewer" is found inside the hReview, parsers should look outside the hReview, in the context of the page, for the "reviewer". If there is no "reviewer" outside either, then parsers should use the author defined by the containing document language, e.g. for (X)HTML documents, the <code><nowiki><address></nowiki></code> contact info for the page (which is ideally marked up as an [[hcard|hCard]] as well), for Atom 1.0 the <code><nowiki><entry></nowiki></code> <code><nowiki><author></nowiki></code> if present and if not the <code><nowiki><feed></nowiki></code> <code><nowiki><author></nowiki></code>, for RSS the <code><nowiki><author></nowiki></code> inside the containing <code><nowiki><item></nowiki></code> element.<br />
<br />
'''dtreviewed''':: This optional field when present MUST provide an ISO8601 absolute date time of when the review was written or otherwise authored. This field SHOULD use UTC, but MAY use the time zone offset syntax. If dtreviewed is absent from the hReview, then look outside the hReview, in the surrounding context. If the context is an [[hatom|hAtom]] entry, use its "published" (or "updated" if that is missing) datetime as the dtreviewed, if not present on the entry, use the "published" (or "updated" if that is missing) of the feed. Otherwise use the creation date (or modified date if that is missing) information according to the containing document language (e.g. "published"/"updated" similarly for Atom feeds), then protocol (e.g. HTTP Last-Modified, or file system last modified datetime) as the dtreviewed.<br />
<br />
'''rating''':: The rating is a fixed point integer (one decimal point of precision) from 1.0 to 5.0 inclusive indicating a rating for the item, higher indicating a better rating by default. Optionally a different integral "worst" value and/or "best" value MAY be specified to indicate a different range (e.g. 6 from 0-10). The "best" value may be numerically smaller than the "worst" value.<br />
<br />
'''description''':: This optional field contains the full text representing the written opinion of the reviewer. The field MAY include valid XHTML markup (e.g. paragraphs). User agents SHOULD preserve any markup. Multiple descriptions or section descriptions (e.g. pros and cons, plusses and minusses) SHOULD be included in the description field.<br />
<br />
'''tags''':: Tags are represented using a list of keywords or phrases (using the [[rel-tag]] microformat for each individual keyword or phrase tag) that the reviewer associates with the item. The reviewer MAY optionally provide a tag-specific rating inside each [[rel-tag]], e.g. ambience:5. Tag-specific ratings by default use the same range as an overall rating for the item if present, and MAY also have a custom worst...best range specified. Authors MAY also invert this structure for the same semantic if it is more convenient for their markup, that is, place the [[rel-tag]] inside a rating to indicate a rated tag. Note: rated tags should ideally use a tag space that explains what the ratings for that tag mean. E.g. Food:18/30 should link to a tags space for Food that explains what an 18 out of 30 means for the Food tag.<br />
<br />
'''permalink''':: This optional field is a URL for the hReview. In addition to using the <code><a href></code> tag for this field, the attribute <code>rel="self bookmark"</code> MUST be used to indicate that the hyperlink is a permalink for the review itself. If the hyperlink already contains a <code>rel</code> attribute, then the values <code>self</code> and <code>bookmark</code> MUST be included among the space-separated set of values in the attribute. Indexers MAY treat the permalink of a review as a unique ID in order to identify and collate the same review from multiple sources (such as indexing a page multiple times). The permalink MAY also be used to indicate or imply the origin of the review. Authors MAY use the classname of "permalink" on the element representing the permalink, but are not required to do so.<br />
<br />
'''license''':: This optional field links to the license under which the contents of the hReview itself is licensed, using the '''[[rel-license]]''' microformat.<br />
<br />
<br />
The following field names have been reused from the [[hcard|hCard]] and [[hcalendar|hCalendar]] microformats: <code>version, summary, fn, url, photo, description</code>. In addition, items and reviewers described by hCards MAY contain any hCard field. The rel value "self" has been reused from the [http://atompub.org/2005/07/11/draft-ietf-atompub-format-10.html Atom 1.0 specification].<br />
<br />
=== More Semantic Equivalents ===<br />
<br />
For some properties there is a more semantic equivalent, and therefore they get special treatment, e.g.: <br />
<br />
* For any "url", use <code><a class="url" href="...">...</a></code> inside the element with the class name 'hreview' in hReview.<br />
* And for "photo", use <code><img class="photo" src="..." alt="Photo of ..." /></code> <br />
<br />
* Ratings are often presented either as a set of images or characters, e.g. "***". For these, the <code>&lt;abbr&gt;</code> element is particularly useful, as such characters are an abbreviation for the precise rating, e.g. <code>&lt;abbr class="rating" title="3.0"&gt;***&lt;/abbr&gt;</code>. This is further explored in the next section.<br />
<br />
==== Language ====<br />
* To explicitly convey the natural language that an hReview is written in, use the standard (X)HTML 'lang' attribute on the element with class="hreview", e.g. <code>&lt;div class="hreview" lang="en"&gt; ... &lt;/div&gt;</code> If portions of an hReview (e.g. the item name) are in a different language, use the 'lang' attribute on those portions.<br />
* hReview processors which need to handle the language of reviews MUST process the standard (X)HTML 'lang' attribute as specified.<br />
<br />
=== Human vs. Machine Readable ===<br />
If an <code>&lt;abbr></code> element is used for a property, then its '<code>title</code>' attribute is used for the value of the property, instead of the contents of the element, which can then be used to provide a user-friendly alternate presentation of the value. <br />
<br />
Similarly, if an <code><img /></code> element is used for one or more properties, it MUST be treated as follows: <br />
<br />
# For the "photo" property and any other property that takes a URL as its value, the <code>src="..."</code> attribute provides the property value. <br />
# For other properties, the <code><img /></code> element's '<code>alt</code>' attribute is the value of the property.<br />
<br />
=== Object Includes ===<br />
<br />
hReview 0.3 includes support for the object [[include-pattern]].<br />
<br />
Often a single page lists an item, and then several reviews for that item. In order to avoid having to repeat the item info for each review of the item, the first review should be marked up as an hReview, with a unique "id" attribute on the item info, and then following reviews should use the object [[include-pattern]] to include the item info from the first review.<br />
<br />
<br />
=== Notes ===<br />
This section is informative.<br />
<br />
* By marking up a review with the hReview microformat, the expectation is communicated that the review MAY be indexed. This has no impact on the copyright of the review itself which the publisher may explicitly specify using [[rel-license]] as specified above.<br />
* The enumerated list of item types is under development and may be extended.<br />
* Each type may have custom hReview fields that follow the common set.<br />
* Additional details about a particular item should be specified with the rest of the item's info at the URL provided for the item.<br />
* Most rating systems use the range 1.0 to 5.0, and most of those represent the rating as a number (and possibly half) of stars. Sites may use whatever graphic they wish to represent the rating.<br />
<br />
== Examples ==<br />
Here are a few examples of reviews from current web sites, and how they could be easily enhanced to support the hReview structured review microformat. <br />
<br />
Want to get started with writing an [[hreview|hReview]]? Use the [http://microformats.org/code/hreview/creator hReview creator] to write a review and publish it on your blog.<br />
<br />
=== Restaurant reviews ===<br />
<br />
Here is an example of a simple online restaurant review:<br />
<br />
<pre><nowiki><br />
<div><br />
<span>5 stars out of 5 stars</span><br />
<h4>Crepes on Cole is awesome</h4><br />
<span>Reviewer: <span>Tantek</span> - April 18, 2005</span><br />
<blockquote><p><br />
Crepes on Cole is one of the best little creperies in San Francisco. <br />
Excellent food and service. Plenty of tables in a variety of sizes <br />
for parties large and small. Window seating makes for excellent <br />
people watching to/from the N-Judah which stops right outside. <br />
I've had many fun social gatherings here, as well as gotten <br />
plenty of work done thanks to neighborhood WiFi.<br />
</p></blockquote><br />
<p>Visit date: <span>April 2005</span></p><br />
<p>Food eaten: <span>Florentine crepe</span></p><br />
</div><br />
</nowiki></pre><br />
<br />
Adding hReview to this review is quite simple:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><br />
<span><span class="rating">5</span> out of 5 stars</span><br />
<h4 class="summary">Crepes on Cole is awesome</h4><br />
<span class="reviewer vcard">Reviewer: <span class="fn">Tantek</span> - <br />
<abbr class="dtreviewed" title="20050418T2300-0700">April 18, 2005</abbr></span><br />
<div class="description item vcard"><p><br />
<span class="fn org">Crepes on Cole</span> is one of the best little <br />
creperies in <span class="adr"><span class="locality">San Francisco</span></span>.<br />
Excellent food and service. Plenty of tables in a variety of sizes <br />
for parties large and small. Window seating makes for excellent <br />
people watching to/from the N-Judah which stops right outside. <br />
I've had many fun social gatherings here, as well as gotten <br />
plenty of work done thanks to neighborhood WiFi.<br />
</p></div><br />
<p>Visit date: <span>April 2005</span></p><br />
<p>Food eaten: <span>Florentine crepe</span></p><br />
</div><br />
</nowiki></pre><br />
<br />
Note that some of the properties of this sample review are not captured by hReview (visit date, food eaten). This is deliberate per the scope of keeping hReview minimal and simple.<br />
<br />
This sample hReview could be rendered like this:<br />
<br />
5 stars out of 5 stars<br /><br />
'''Crepes on Cole is awesome'''<br /><br />
Reviewer: Tantek - April 18, 2005<br /><br />
<br />
Crepes on Cole is one of the best little creperies in San Francisco. Excellent food and service. Plenty of tables in a variety of sizes for parties large and small. Window seating makes for excellent people watching to/from the N-Judah which stops right outside. I've had many fun social gatherings here, as well as gotten plenty of work done thanks to neighborhood wifi.<br />
<br />
Visit date: April 2005<br /><br />
Food eaten: Florentine crepe<br /><br />
<br />
==== Multidimensional Restaurant Review ====<br />
Some restaurant reviews indicate ratings for different aspects of the restaurant. Such details are represented in hReview using tagged ratings. In addition, note the inline tags inside the description of this review.<br />
<br />
Here is one such review in text format:<br />
<br />
Cafe Borrone<br />
<br />
1010 El Camino Real, Menlo Park, CA 94025, +1-650-327-0830;<br />
cafeborrone.com<br />
<br />
Food: 18/30; Ambience: 19/30; Service: 15/30; Price: $$...<br />
<br />
This cafe is a welcoming oasis on the Peninsula. It even has a fountain<br />
outside which cloaks the nearby sounds of El Camino traffic. Next door to a <br />
superb indy bookstore, Cafe Borrone is an ideal spot to grab a coffee or a <br />
snack to accompany a newly purchased book or imported periodical. Soups and <br />
sandwich specials rotate daily. The corn chowder with croutons and big <br />
chunks of cheese goes especially well with a freshly toasted mini-baguette. <br />
Evenings are often crowded and may require sharing a table with a perfect <br />
stranger. Espresso afficionados will appreciate the Illy coffee. Noise <br />
levels can vary from peaceful in the late mornings to nearly overwhelming on <br />
jazz band nights.<br />
<br />
As an hReview:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><br />
<div class="item vcard"><br />
<div class="fn org summary">Cafe Borrone</div><br />
<span class="adr"><br />
<span class="street-address">1010 El Camino Real</span>,<br />
<span class="locality">Menlo Park</span>,<br />
<span class="region">CA</span><br />
<span class="postal-code">94025</span>,<br />
</span><br />
<span class="tel">+1-650-327-0830</span>;<br />
<a class="url" href="http://cafeborrone.com">cafeborrone.com</a><br />
</div><br />
<ul><br />
<li class="rating"><a href="http://en.wikipedia.org/wiki/Food" rel="tag"><br />
Food: <span class="value">18</span>/<span class="best">30</span></a>;</li><br />
<li class="rating"><a href="http://flickr.com/photos/tags/Ambience" rel="tag"><br />
Ambience: <span class="value">19</span>/<span class="best">30</span></a>;</li><br />
<li class="rating"><a href="http://en.wikipedia.org/wiki/Service" rel="tag"><br />
Service: <span class="value">15</span>/<span class="best">30</span></a>;</li><br />
<li class="rating"><a href="http://en.wikipedia.org/wiki/Price" rel="tag"><br />
Price: <abbr class="value" title="2">$$</abbr>...</a></li><br />
</ul><br />
<div class="description"><p><br />
This <abbr class="type" title="business"><br />
<a href="http://en.wikipedia.org/wiki/cafe" rel="tag">cafe</a></abbr> <br />
is a welcoming oasis on the Peninsula. <br />
It even has a fountain outside which nearly eliminates <br />
the sounds of El Camino traffic. Next door to a superb indy bookstore, <br />
Cafe Borrone is an ideal spot to grab a <br />
<a href="http://en.wikipedia.org/wiki/coffee" rel="tag">coffee</a> <br />
or a meal to accompany a newly purchased book or imported periodical. <br />
<a href="http://technorati.com/tag/soup" rel="tag">Soups</a> and <br />
<a href="http://technorati.com/tag/sandwich" rel="tag">sandwich</a> <br />
specials rotate daily. The corn chowder with croutons and big chunks of cheese <br />
goes especially well with a freshly toasted mini-baguette. Evenings are <br />
often crowded and may require sharing a table with a perfect stranger. <br />
<a href="http://flickr.com/photos/tags/espresso" rel="tag">Espresso</a> <br />
afficionados will appreciate the <br />
<a href="http://en.wikipedia.org/wiki/Illy" rel="tag">Illy</a> coffee. <br />
Noise levels can vary from peaceful in the late mornings to nearly overwhelming on <br />
<a href="http://en.wikipedia.org/wiki/jazz" rel="tag">jazz</a> band nights.<br />
</p></div><br />
Review (<a href="http://microformats.org/wiki/hreview"> <br />
hReview v<span class="version">0.3</span></a>)<br />
by <span class="reviewer vcard"><span class="fn">anonymous</span></span>, <br />
<abbr class="dtreviewed" title="20050428T2130-0700">April 28th, 2005</abbr>.<br />
</div><br />
</nowiki></pre><br />
<br />
With an accompanying CSS style sheet like:<br />
<br />
<pre><nowiki><br />
a.url { display:block }<br />
ul { margin:1em 0; padding:0 }<br />
ul li { display:inline }<br />
</nowiki></pre><br />
<br />
This hReview could be presented similar to the original text:<br />
<br />
Cafe Borrone<br /><br />
1010 El Camino Real, Menlo Park, CA 94025, +1-650-327-0830;<br /><br />
[http://cafeborrone.com/ cafeborrone.com]<br /><br />
<br /><br />
[http://en.wikipedia.org/wiki/Food Food: 18/30];<br />
[http://flickr.com/photos/tags/Ambience Ambience: 19/30];<br />
[http://en.wikipedia.org/wiki/Service Service: 15/30];<br />
[http://en.wikipedia.org/wiki/Price Price: $$...]<br /><br />
<br />
This [http://en.wikipedia.org/wiki/cafe cafe] is a welcoming oasis on the Peninsula. It even has a fountain outside which cloaks the nearby sounds of El Camino traffic. Next door to a superb indy bookstore, Cafe Borrone is an ideal spot to grab a [http://en.wikipedia.org/wiki/coffee coffee] or a snack to accompany a newly purchased book or imported periodical. [http://technorati.com/tag/soup Soups] and [http://technorati.com/tag/sandwich sandwich] specials rotate daily. The corn chowder with croutons and big chunks of cheese goes especially well with a freshly toasted mini-baguette. Evenings are often crowded and may require sharing a table with a perfect stranger. [http://flickr.com/photos/tags/espresso Espresso] afficionados will appreciate the [http://en.wikipedia.org/wiki/Illy Illy] coffee. Noise levels can vary from peaceful in the late mornings to nearly overwhelming on [http://en.wikipedia.org/wiki/jazz jazz] band nights.<br />
<br />
Review ([http://microformats.org/wiki/hreview hReview v0.3]) by anonymous, April 28th, 2005.<br />
<br />
=== Product review ===<br />
Here is an example of a product review:<br />
<br />
<pre><nowiki><br />
<div><br />
<a href="http://www.amazon.com/exec/obidos/ASIN/B000089CJI/"><br />
<img src="http://images.amazon.com/images/P/B000089CJI.01._SCTHUMBZZZ_.jpg" <br />
alt="Album cover photo: The Postal Service: Give Up." /><br />
The Postal Service: Give Up</a><br />
<blockquote><p><br />
"The people thought they were just being rewarded for treating others <br />
as they like to be treated, for obeying stop signs and curing diseases, <br />
for mailing letters with the address of the sender... Don't wake me, <br />
I plan on sleeping in..."<br />
</p><p><br />
"Nothing Better" is a great track on this album, too... <br />
</p></blockquote><br />
(*****)<br />
</div><br />
</nowiki></pre><br />
<br />
Adding hReview to this review is also quite simple, but in this case requires a few more elements for the rating and reviewer which are required by hReview:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><span class="item"><br />
<a class="url fn" href="http://www.amazon.com/exec/obidos/ASIN/B000089CJI/"><br />
<img src="http://images.amazon.com/images/P/B000089CJI.01._SCTHUMBZZZ_.jpg" <br />
alt="Album cover photo: The Postal Service: Give Up. " <br />
class="photo" /><br />
The Postal Service: Give Up</a></span><br />
<div class="description"><p><br />
"The people thought they were just being rewarded for treating others <br />
as they like to be treated, for obeying stop signs and curing diseases, <br />
for mailing letters with the address of the sender... Don't wake me, <br />
I plan on sleeping in..."<br />
</p><p><br />
"Nothing Better" is a great track on this album, too... <br />
</p></div><br />
(<abbr class="rating" title="5">*****</abbr>)<br />
<p class="reviewer vcard">Review by <br />
<a class="url fn" href="http://ifindkarma.com/blog/">Adam Rifkin</a>, <br />
<abbr class="dtreviewed" title="200502">February 2005</abbr><br />
</p><br />
</div><br />
</nowiki></pre><br />
<br />
And this hReview might be presented like this:<br />
<br />
<br />
[Album cover photo: ]<br />
[The Postal Service:]<br />
[ Give Up ]<br />
<br />
The Postal Service: Give Up<br />
<br />
"The people thought they were just being rewarded for treating others as they like to be treated, for obeying stop signs and curing diseases, for mailing letters with the address of the sender... Don't wake me, I plan on sleeping in..."<br />
<br />
"Nothing Better" is a great track on this album, too...<br />
<br />
(*****)<br />
<br />
Review by Adam Rifkin, February 2005.<br />
<br />
=== Movie Review ===<br />
Finally, here is an example of a movie review.<br />
<br />
<pre><nowiki><br />
<div><br />
<span>anonymous, April 18th, 2005</span><br />
<div><br />
<a lang="zh" href="http://www.imdb.com/title/tt0299977/"><br />
Ying Xiong (<span lang="en">HERO</span>)<br />
</a><br />
</div><br />
<div>Rating: 4 out of 5</div><br />
<blockquote><p><br />
This movie has great visuals and music.<br />
</p></blockquote><br />
</div><br />
</nowiki></pre><br />
<br />
With hReview:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><br />
<span class="reviewer vcard"><br />
<span class="fn">anonymous</span>, <br />
<abbr class="dtreviewed" title="20050418">April 18th, 2005</abbr><br />
</span><br />
<div class="item"><br />
<a lang="zh" class="url fn" href="http://www.imdb.com/title/tt0299977/"><br />
Ying Xiong (<span lang="en">HERO</span>)<br />
</a><br />
</div><br />
<div>Rating: <span class="rating">4</span> out of 5</div><br />
<div class="description"><p><br />
This movie has great music and visuals.<br />
</p></div><br />
</div><br />
</nowiki></pre><br />
<br />
Which could be presented like this:<br />
<br />
anonymous, April 18th, 2005<br /><br />
Ying Xiong (HERO)<br /><br />
Rating: 4 out of 5<br /><br />
<br />
This movie has great music and visuals.<br />
<br />
== Examples in the wild ==<br />
This section is '''informative'''. The number of hReview examples in the wild has expanded far beyond the capacity of being kept inline in this specification. They have been moved to a [[hreview-examples-in-wild|separate page]].<br />
<br />
See [[hreview-examples-in-wild|hReview Examples in the wild]].<br />
<br />
== Implementations ==<br />
This section is '''informative'''. The number of hReview implementations has also expanded beyond the capacity of keeping them inline. They have been moved to a [[hreview-implementations|separate page]].<br />
<br />
See [[hreview-implementations|hReview Implementations]].<br />
<br />
== References ==<br />
=== Normative References ===<br />
* [http://www.w3.org/TR/2002/REC-xhtml1-20020801/ XHTML 1.0 SE]<br />
* [http://gmpg.org/xmdp/ XMDP]<br />
* [[hcard|hCard]]<br />
* [[hcalendar|hCalendar]]<br />
* [[rel-tag]]<br />
* [http://www.ietf.org/rfc/rfc2119.txt RFC2119]<br />
* [http://www.ietf.org/rfc/rfc3986.txt RFC3986]<br />
* [http://www.ietf.org/rfc/rfc4287.txt RFC4287] (Atom 1.0)<br />
<br />
=== Informative References ===<br />
* [http://www.w3.org/TR/REC-CSS1 CSS1]<br />
* ISO.8601.1988<br />
** International Organization for Standardization, "Data elements and interchange formats - Information interchange - Representation of dates and times", ISO Standard 8601, June 1988.<br />
* [http://www.w3.org/TR/1998/NOTE-datetime-19980827 W3C NOTE-datetime-19980827]<br />
* [http://www.ietf.org/rfc/rfc3667.txt RFC3667]<br />
* [http://www.ietf.org/rfc/rfc3668.txt RFC3668]<br />
* [http://www.w3.org/Consortium/Patent-Policy-20040205/ W3C Patent Policy]<br />
* [http://local.yahoo.com/details?id=21359628 Crepes on Cole reviews on Yahoo! Local]<br />
* Other reviews efforts. See [[reviews-formats]].<br />
* Contributed from http://developers.technorati.com/wiki/hReview.<br />
<br />
==== Similar Work ====<br />
* [[hlisting-proposal|hListing]]<br />
* [[xoxo|XOXO]]<br />
<br />
=== Copyright ===<br />
{{MicroformatCopyrightStatement2005}}<br />
<br />
=== Patents ===<br />
{{MicroFormatPatentStatement}}<br />
<br />
== Work in progress ==<br />
This specification is a work in progress. As additional aspects are discussed, understood, and written, they will be added. <br />
<br />
=== Changes from v0.2 ===<br />
The following changes have been made in hReview v0.3 over [[hreview-v0.2|hReview v0.2]]:<br />
<br />
Normative changes:<br />
# MUST (instead of SHOULD) use [[hcard|hCard]] for the item description of a business or person<br />
# "reviewer" changes<br />
## Made reviewer *optional* per feedback from Ryan King and Mark Nottingham<br />
## If reviewer is absent from the hReview, then look outside the hReview, in the context of the page, for the reviewer. If there is no "reviewer" outside either, then use the author information according to the containing document language (e.g. <code><nowiki><address></nowiki></code> for (X)HTML pages) as the reviewer.<br />
## MUST (instead of SHOULD) use [[hcard|hCard]] to represent reviewer information<br />
# "dtreviewed" changes<br />
## Made dtreviewed *optional* per feedback from Ryan King and Mark Nottingham<br />
## If dtreviewed is absent from the hReview, then look outside the hReview, in the surrounding context. If the context is an [[hatom|hAtom]] entry, use its "published" (or "updated" if that is missing) datetime as the dtreviewed, if not present on the entry, use the "published" (or "updated" if that is missing) of the feed. Otherwise use the information according to the containing document language (e.g. "published"/"updated" similarly for Atom feeds), then protocol (e.g. HTTP Last-Modified, or file system last modified datetime).<br />
# SHOULD use [[hcalendar|hCalendar]] to represent an item of 'type' 'event'<br />
# Added one decimal digit of precision to ratings' numerical values based on publisher experience.<br />
# Use [http://microformats.org/wiki/hcard#Value_excerpting the "value" construct from hCard] (as it is used in "tel" properties for example) to more explicitly markup the rating value when also providing (marking up) the best/worst of a rating.<br />
# Added [[rel-license]] to indicate the license of the hReview as a whole.<br />
# Permit tags inside ratings to denote rated tags, the same as ratings inside tags per suggestion from Eran Globen.<br />
# Add [[include-pattern]] support to allow multiple reviews for the same item to not repeat the item info.<br />
<br />
Informative changes (several, but in particular):<br />
# Note that scalar/rated tags would ideally use a tag space that explain the ratings for that tag. E.g. to explain what Food:18/30 means.<br />
# Updated examples accordingly.<br />
<br />
== Further Reading ==<br />
* See also [http://www.technorati.com/cosmos/referer.html blogs discussing this page].<br />
</p><br />
<table class="toccolours" align="center" style="margin: 0 2em 0 2em; color: #8888aa"><br />
<tr><br />
<th align="center" colspan="3" style="color: grey; background: #ccccff"><a href="/wiki/Urologicals" title="Urologicals">Urologicals</a> (<a href="/wiki/ATC_code_G04" title="ATC code G04">G04</a>) <small><small class="editlink noprint plainlinksneverexpand"><a href="http://en.wikipedia.org/w/index.php?title=Template:Urologicals&amp;action=edit" class="external text" title="http://en.wikipedia.org/w/index.php?title=Template:Urologicals&amp;action=edit" rel="nofollow">edit</a></small></small></th><br />
</tr><br />
<tr><br />
<td valign="top"><b><a href="/wiki/Acidifier" title="Acidifier">Acidifiers</a>:</b></td><br />
<td> <br />
<p>Viagra: <a href="levitravsviagra.info">History</a></p><br />
</td><br />
</tr><br />
<tr><br />
<td valign="top"><b><a href="/wiki/Urinary" title="Urinary">Urinary</a> <a href="/wiki/Antispasmodic" title="Antispasmodic">antispasmodics</a>:</b></td><br />
<td><br />
<p><a href="/wiki/Darifenacin" title="Darifenacin">Darifenacin</a>, <a href="/w/index.php?title=Emepronium&amp;action=edit" class="new" title="Emepronium">Emepronium</a>, <a href="/wiki/Flavoxate" title="Flavoxate">Flavoxate</a>, <a href="/w/index.php?title=Meladrazine&amp;action=edit" class="new" title="Meladrazine">Meladrazine</a>, <a href="/wiki/Oxybutynin" title="Oxybutynin">Oxybutynin</a>, <a href="/w/index.php?title=Propiverine&amp;action=edit" class="new" title="Propiverine">Propiverine</a>, <a href="/wiki/Solifenacin" title="Solifenacin">Solifenacin</a>, <a href="/w/index.php?title=Terodiline&amp;action=edit" class="new" title="Terodiline">Terodiline</a>, <a href="/wiki/Tolterodine" title="Tolterodine">Tolterodine</a>, <a href="/wiki/Trospium" title="Trospium">Trospium</a></p><br />
</td><br />
</tr><br />
<tr><br />
<td valign="top"><b>For <a href="/wiki/Erectile_dysfunction" title="Erectile dysfunction">erectile dysfunction</a>:</b></td><br />
<td><br />
<p><a href="/wiki/Alprostadil" title="Alprostadil">Alprostadil</a>, <a href="/wiki/Apomorphine" title="Apomorphine">Apomorphine</a>, <a href="/w/index.php?title=Avanafil&amp;action=edit" class="new" title="Avanafil">Avanafil</a>, <a href="/w/index.php?title=Moxisylyte&amp;action=edit" class="new" title="Moxisylyte">Moxisylyte</a>, <a href="/wiki/Papaverine" title="Papaverine">Papaverine</a>, <a href="/wiki/Phentolamine" title="Phentolamine">Phentolamine</a>, <strong class="selflink">Sildenafil</strong>, <a href="/wiki/Tadalafil" title="Tadalafil">Tadalafil</a>, <a href="/w/index.php?title=Udenafil&amp;action=edit" class="new" title="Udenafil">Udenafil</a>, <a href="/wiki/Vardenafil" title="Vardenafil">Vardenafil</a>, <a href="/w/index.php?title=Vendafidel&amp;action=edit" class="new" title="Vendafidel">Vendafidel</a>, <a href="/wiki/Yohimbine" title="Yohimbine">Yohimbine</a></p><br />
</td><br />
</tr><br />
<tr><br />
<td valign="top"><b>Other urologicals:</b></td><br />
<td><br />
<p><a href="/wiki/Acetohydroxamic_acid" title="Acetohydroxamic acid">Acetohydroxamic acid</a>, <a href="/wiki/Collagen" title="Collagen">Collagen</a>, <a href="/wiki/Dimethyl_sulfoxide" title="Dimethyl sulfoxide">Dimethyl sulfoxide</a>, <a href="/wiki/Magnesium_hydroxide" title="Magnesium hydroxide">Magnesium hydroxide</a>, <a href="/wiki/Phenazopyridine" title="Phenazopyridine">Phenazopyridine</a>, <a href="/wiki/Phenyl_salicylate" title="Phenyl salicylate">Phenyl salicylate</a>, <a href="/wiki/Succinimide" title="Succinimide">Succinimide</a></p><br />
</td><br />
</tr><br />
<tr><br />
<td valign="top"><b>For <a href="/wiki/Benign_prostatic_hypertrophy" title="Benign prostatic hypertrophy">benign prostatic hypertrophy</a>:</b></td><br />
<td><br />
<p><b><a href="/wiki/5-alpha-reductase_inhibitor" title="5-alpha-reductase inhibitor">5О±-reductase inhibitors</a>:</b> <a href="/wiki/Dutasteride" title="Dutasteride">Dutasteride</a>, <a href="/wiki/Finasteride" title="Finasteride">Finasteride</a><br /><br />
<b><a href="/wiki/Alpha_blocker" title="Alpha blocker">Alpha blockers</a>:</b> <a href="/wiki/Alfuzosin" title="Alfuzosin">Alfuzosin</a>, <a href="/wiki/Doxazosin" title="Doxazosin">Doxazosin</a>, <a href="/wiki/Tamsulosin" title="Tamsulosin">Tamsulosin</a>, <a href="/wiki/Terazosin" title="Terazosin">Terazosin</a><br /><br />
<b><a href="/wiki/Herb" title="Herb">Herbals</a>:</b> <i><a href="/wiki/Pygeum" title="Pygeum">Pygeum africanum</a></i>, <i><a href="/wiki/Saw_Palmetto" title="Saw Palmetto">Serenoa repens</a></i></p><br />
</td><br />
</tr><br />
</table><br />
<br />
== Related Pages ==<br />
{{hreview-related-pages}}</div>Adminihttps://microformats.org/wiki/index.php?title=hreview&diff=13919hreview2007-03-03T10:28:48Z<p>Admini: /* Inspiration and Acknowledgments */</p>
<hr />
<div><h1> hReview 0.3 </h1><br />
<br />
[[hreview|hReview]] is a simple, open, distributed format, suitable for embedding reviews (of products, services, businesses, events, etc.) in (X)HTML, Atom, RSS, and arbitrary XML. hReview is one of several [[microformats]] open standards.<br />
<br />
Want to get started with writing an [[hreview|hReview]]? Use the [http://microformats.org/code/hreview/creator hReview creator] to write a review and publish it.<br />
<br />
== Microformats Draft Specification 2006-02-22 ==<br />
<br />
; Editor: [http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc.]<br />
; Authors: [http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc.]<br />
: [http://360.yahoo.com/alidiabali Ali Diab],[http://yahoo.com Yahoo! Inc.]<br />
: [http://spaces.msn.com/members/ianmcallister/ Ian McAllister], [http://microsoft.com/ Microsoft Corporation]<br />
: [http://journals.aol.com/panzerjohn/abstractioneer John Panzer], [http://www.aol.com America Online, Inc.]<br />
: [http://ifindkarma.com/blog Adam Rifkin], [http://labs.commerce.net/ CommerceNet Labs]<br />
: [http://sippey.typepad.com/ Michael Sippey], [http://sixapart.com Six Apart, Ltd.]<br />
<br />
Microformats [http://microformats.org/wiki/hreview#Copyright copyright] and [http://microformats.org/wiki/hreview#Patents patents] statements apply.<br />
<br />
__TOC__<br />
<br />
== Introduction ==<br />
Numerous web sites publish reviews using a broad variety of schema for all sorts of things from products (movies, music, books), to businesses (restaurants, hotels, stores), to events (concerts, theatre), to people (artists, leaders, celebrities), to places (landmarks, parks), to online resources (web pages, files), to reviews of reviews themselves.<br />
<br />
In order to enable and encourage the sharing, distribution, syndication, and aggregation, of reviews, the authors propose the hReview microformat, an open standard for distributed reviews. The authors have researched both numerous [[review-examples]] in the wild and earlier attempts at [[review-formats]], and have designed hReview around a simple minimal schema for reviews. Feedback is encouraged on the [[hreview-feedback|hReview feedback]] page.<br />
<br />
=== Inspiration and Acknowledgments ===<br />
Thanks to everyone who responded to the open call for implementor participation for hReview. The authors in particular wish to thank the following individuals for their constructive input and feedback: [http://www.richardault.com/ Richard Ault], [http://dannyayers.com Danny Ayers], [http://www.vertexdev.com/~jeff/ Jeffrey Barr],[http://adriancuthbert.blogspot.com/ Adrian Cuthbert],[http://jason.defillippo.com/ Jason DeFillippo], [http://www.hybernaut.com/bdv Brian Del Vecchio], Scott Derringer, [http://budgibson.com/home/ Bud Gibson], [http://joi.ito.com/ Joi Ito], [http://www.kanai.net/weblog/ Gen Kanai],[http://niallkennedy.com/ Niall Kennedy], [http://labs.commerce.net/wiki/index.php/Rohit_Khare Rohit Khare], [http://theryanking.com/ Ryan King], [http://www.jluster.org/ Jonas Luster], [http://epeus.blogspot.com/ Kevin Marks], Mark Nottingham, [http://www.powazek.com/ Derek Powazek], [http://www.judysbook.com/ Jeff Rodenburg], [http://sifry.com/alerts/ David Sifry], [http://jystewart.net/ James Stewart], [http://kung-foo.tv/ Adriaan Tijsseling], [http://www.flashenabled.com/ Phillip Torrone], Thai Tran, [http://w6daily.winn.com/ Phillip Winn], [http://yohei-y.blogspot.com YAMAMOTO Yohei].<br />
<br />
=== Scope ===<br />
Reviews consistently share several common fields. Where possible hReview has been based on this minimal common subset.<br />
<br />
==== Out of scope ====<br />
Fields that are type-specific have been omitted from hReview. It is important that hReview be kept simple and minimal from the start. Additional features can be added as deemed necessary by practical implementation experience.<br />
<br />
The concept of a "universal object identifier", that is, how to identify the same object/item/product across different shopping sites, though something very useful to have, is outside the scope of this format.<br />
<br />
== Semantic XHTML Design Principles ==<br />
{{semantic-xhtml-design-principles}}<br />
<br />
== Format ==<br />
=== In General ===<br />
The hReview format is based on a set of fields common to numerous review sites and formats in use today on the web. Where possible field names have been chosen based on those defined by the related [[hcard|hCard]] and [[hcalendar|hCalendar]] standards.<br />
<br />
=== Schema ===<br />
The hReview schema consists of the following:<br />
<br />
* hReview ('''<code>hreview</code>''')<br />
** '''<code>version</code>'''. optional. text.<br />
** '''<code>summary</code>'''. optional. text.<br />
** item '''<code>type</code>'''. optional. product | business | event | person | place | website | url.<br />
** '''<code>item</code>''' info. required. '''<code>fn</code>''' ('''<code>url</code>''' || '''<code>photo</code>''' ) | '''[[hcard|hCard]]''' (for person or business) | '''[[hcalendar|hCalendar]]''' (for event)<br />
** '''<code>reviewer</code>'''. optional. '''[[hcard|hCard]]'''.<br />
** '''<code>dtreviewed</code>'''. optional. ISO8601 absolute date time.<br />
** '''<code>rating</code>'''. optional. fixed point integer [1.0-5.0], with optional alternate '''<code>worst</code>''' (default:1.0) and/or '''<code>best</code>''' (default:5.0), also fixed point integers, and explicit '''<code>value</code>'''.<br />
** '''<code>description</code>'''. optional. text with optional valid XHTML markup.<br />
** tags. optional. keywords or phrases, using '''[[rel-tag]]''', each with optional rating.<br />
** permalink. optional, using '''[[rel-bookmark]]''' and '''[[rel-self]]'''.<br />
** license. optional, using '''[[rel-license]]'''.<br />
<br />
=== Field details ===<br />
The fields of the hReview schema represent the following:<br />
<br />
'''version''':: This optional field permits hReview publishers to specify a particular version of hReview that their content uses. By omitting this field, the publisher is stating that implementations may interpret the hReviews according to any version of the hReview specification v0.2 or later. In practice the authors of this specification are comitted to maintaining backward compatibility with content produced using earlier versions of the specification. This field is syntax compatible with, and thus reuses the semantics of "VERSION" as defined in vCard RFC2426 section "3.6.9 VERSION Type Definition". The value of this field for this specification is "0.3".<br />
<br />
'''summary''':: This optional field serves as a title for the review itself.<br />
<br />
'''item type''':: This optional field "type" provides the type of the item being reviewed, one of the following: product, business, event, person, place, website, url. If omitted, then in some cases the item type may be inferred. If the item is also an [[hcard|hCard]], then the item type is a "business" or a "person" based upon which of those the hCard represents. If the item is also an [[hcalendar|hCalendar]] event, then the item type is an "event".<br />
<br />
'''item info''':: This required field MUST have at a minimum the name ("fn" - the formatted text corresponding to the name) of ''the'' item (an hReview describes only one item), SHOULD provide at least one URI ("url") for the item, and MAY provide at least one URL to a photo or depiction ("photo") of the item. For items of type person or business, the item info (fn, url, photo) MUST be encapsulated in an [[hcard|hCard]]. For items of type event, the item info SHOULD be encapsulated in an [[hcalendar|hCalendar]] "vevent". Unique item IDs (e.g. ISBNs, UPCs) MAY be represented as a URN ("url") for the item. Encapsulated microformats (e.g. [[hcard|hCard]] and [[hcalendar|hCalendar]] events for now) may be set on the item itself (e.g. class="item vcard"). However, when using item info subproperties ("fn", "url", "photo"), they MUST be nested <em>inside</em> the item element.<br />
<br />
'''reviewer''':: The optional field specifies the person who authored the review. If the reviewer is specified, an hCard representing the reviewer MUST be provided. For anonymous reviews, use "anonymous" (without quotes) for the full name of the reviewer. If no "reviewer" is found inside the hReview, parsers should look outside the hReview, in the context of the page, for the "reviewer". If there is no "reviewer" outside either, then parsers should use the author defined by the containing document language, e.g. for (X)HTML documents, the <code><nowiki><address></nowiki></code> contact info for the page (which is ideally marked up as an [[hcard|hCard]] as well), for Atom 1.0 the <code><nowiki><entry></nowiki></code> <code><nowiki><author></nowiki></code> if present and if not the <code><nowiki><feed></nowiki></code> <code><nowiki><author></nowiki></code>, for RSS the <code><nowiki><author></nowiki></code> inside the containing <code><nowiki><item></nowiki></code> element.<br />
<br />
'''dtreviewed''':: This optional field when present MUST provide an ISO8601 absolute date time of when the review was written or otherwise authored. This field SHOULD use UTC, but MAY use the time zone offset syntax. If dtreviewed is absent from the hReview, then look outside the hReview, in the surrounding context. If the context is an [[hatom|hAtom]] entry, use its "published" (or "updated" if that is missing) datetime as the dtreviewed, if not present on the entry, use the "published" (or "updated" if that is missing) of the feed. Otherwise use the creation date (or modified date if that is missing) information according to the containing document language (e.g. "published"/"updated" similarly for Atom feeds), then protocol (e.g. HTTP Last-Modified, or file system last modified datetime) as the dtreviewed.<br />
<br />
'''rating''':: The rating is a fixed point integer (one decimal point of precision) from 1.0 to 5.0 inclusive indicating a rating for the item, higher indicating a better rating by default. Optionally a different integral "worst" value and/or "best" value MAY be specified to indicate a different range (e.g. 6 from 0-10). The "best" value may be numerically smaller than the "worst" value.<br />
<br />
'''description''':: This optional field contains the full text representing the written opinion of the reviewer. The field MAY include valid XHTML markup (e.g. paragraphs). User agents SHOULD preserve any markup. Multiple descriptions or section descriptions (e.g. pros and cons, plusses and minusses) SHOULD be included in the description field.<br />
<br />
'''tags''':: Tags are represented using a list of keywords or phrases (using the [[rel-tag]] microformat for each individual keyword or phrase tag) that the reviewer associates with the item. The reviewer MAY optionally provide a tag-specific rating inside each [[rel-tag]], e.g. ambience:5. Tag-specific ratings by default use the same range as an overall rating for the item if present, and MAY also have a custom worst...best range specified. Authors MAY also invert this structure for the same semantic if it is more convenient for their markup, that is, place the [[rel-tag]] inside a rating to indicate a rated tag. Note: rated tags should ideally use a tag space that explains what the ratings for that tag mean. E.g. Food:18/30 should link to a tags space for Food that explains what an 18 out of 30 means for the Food tag.<br />
<br />
'''permalink''':: This optional field is a URL for the hReview. In addition to using the <code><a href></code> tag for this field, the attribute <code>rel="self bookmark"</code> MUST be used to indicate that the hyperlink is a permalink for the review itself. If the hyperlink already contains a <code>rel</code> attribute, then the values <code>self</code> and <code>bookmark</code> MUST be included among the space-separated set of values in the attribute. Indexers MAY treat the permalink of a review as a unique ID in order to identify and collate the same review from multiple sources (such as indexing a page multiple times). The permalink MAY also be used to indicate or imply the origin of the review. Authors MAY use the classname of "permalink" on the element representing the permalink, but are not required to do so.<br />
<br />
'''license''':: This optional field links to the license under which the contents of the hReview itself is licensed, using the '''[[rel-license]]''' microformat.<br />
<br />
<br />
The following field names have been reused from the [[hcard|hCard]] and [[hcalendar|hCalendar]] microformats: <code>version, summary, fn, url, photo, description</code>. In addition, items and reviewers described by hCards MAY contain any hCard field. The rel value "self" has been reused from the [http://atompub.org/2005/07/11/draft-ietf-atompub-format-10.html Atom 1.0 specification].<br />
<br />
=== More Semantic Equivalents ===<br />
<br />
For some properties there is a more semantic equivalent, and therefore they get special treatment, e.g.: <br />
<br />
* For any "url", use <code><a class="url" href="...">...</a></code> inside the element with the class name 'hreview' in hReview.<br />
* And for "photo", use <code><img class="photo" src="..." alt="Photo of ..." /></code> <br />
<br />
* Ratings are often presented either as a set of images or characters, e.g. "***". For these, the <code>&lt;abbr&gt;</code> element is particularly useful, as such characters are an abbreviation for the precise rating, e.g. <code>&lt;abbr class="rating" title="3.0"&gt;***&lt;/abbr&gt;</code>. This is further explored in the next section.<br />
<br />
==== Language ====<br />
* To explicitly convey the natural language that an hReview is written in, use the standard (X)HTML 'lang' attribute on the element with class="hreview", e.g. <code>&lt;div class="hreview" lang="en"&gt; ... &lt;/div&gt;</code> If portions of an hReview (e.g. the item name) are in a different language, use the 'lang' attribute on those portions.<br />
* hReview processors which need to handle the language of reviews MUST process the standard (X)HTML 'lang' attribute as specified.<br />
<br />
=== Human vs. Machine Readable ===<br />
If an <code>&lt;abbr></code> element is used for a property, then its '<code>title</code>' attribute is used for the value of the property, instead of the contents of the element, which can then be used to provide a user-friendly alternate presentation of the value. <br />
<br />
Similarly, if an <code><img /></code> element is used for one or more properties, it MUST be treated as follows: <br />
<br />
# For the "photo" property and any other property that takes a URL as its value, the <code>src="..."</code> attribute provides the property value. <br />
# For other properties, the <code><img /></code> element's '<code>alt</code>' attribute is the value of the property.<br />
<br />
=== Object Includes ===<br />
<br />
hReview 0.3 includes support for the object [[include-pattern]].<br />
<br />
Often a single page lists an item, and then several reviews for that item. In order to avoid having to repeat the item info for each review of the item, the first review should be marked up as an hReview, with a unique "id" attribute on the item info, and then following reviews should use the object [[include-pattern]] to include the item info from the first review.<br />
<br />
<br />
=== Notes ===<br />
This section is informative.<br />
<br />
* By marking up a review with the hReview microformat, the expectation is communicated that the review MAY be indexed. This has no impact on the copyright of the review itself which the publisher may explicitly specify using [[rel-license]] as specified above.<br />
* The enumerated list of item types is under development and may be extended.<br />
* Each type may have custom hReview fields that follow the common set.<br />
* Additional details about a particular item should be specified with the rest of the item's info at the URL provided for the item.<br />
* Most rating systems use the range 1.0 to 5.0, and most of those represent the rating as a number (and possibly half) of stars. Sites may use whatever graphic they wish to represent the rating.<br />
<br />
== Examples ==<br />
Here are a few examples of reviews from current web sites, and how they could be easily enhanced to support the hReview structured review microformat. <br />
<br />
Want to get started with writing an [[hreview|hReview]]? Use the [http://microformats.org/code/hreview/creator hReview creator] to write a review and publish it on your blog.<br />
<br />
=== Restaurant reviews ===<br />
<br />
Here is an example of a simple online restaurant review:<br />
<br />
<pre><nowiki><br />
<div><br />
<span>5 stars out of 5 stars</span><br />
<h4>Crepes on Cole is awesome</h4><br />
<span>Reviewer: <span>Tantek</span> - April 18, 2005</span><br />
<blockquote><p><br />
Crepes on Cole is one of the best little creperies in San Francisco. <br />
Excellent food and service. Plenty of tables in a variety of sizes <br />
for parties large and small. Window seating makes for excellent <br />
people watching to/from the N-Judah which stops right outside. <br />
I've had many fun social gatherings here, as well as gotten <br />
plenty of work done thanks to neighborhood WiFi.<br />
</p></blockquote><br />
<p>Visit date: <span>April 2005</span></p><br />
<p>Food eaten: <span>Florentine crepe</span></p><br />
</div><br />
</nowiki></pre><br />
<br />
Adding hReview to this review is quite simple:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><br />
<span><span class="rating">5</span> out of 5 stars</span><br />
<h4 class="summary">Crepes on Cole is awesome</h4><br />
<span class="reviewer vcard">Reviewer: <span class="fn">Tantek</span> - <br />
<abbr class="dtreviewed" title="20050418T2300-0700">April 18, 2005</abbr></span><br />
<div class="description item vcard"><p><br />
<span class="fn org">Crepes on Cole</span> is one of the best little <br />
creperies in <span class="adr"><span class="locality">San Francisco</span></span>.<br />
Excellent food and service. Plenty of tables in a variety of sizes <br />
for parties large and small. Window seating makes for excellent <br />
people watching to/from the N-Judah which stops right outside. <br />
I've had many fun social gatherings here, as well as gotten <br />
plenty of work done thanks to neighborhood WiFi.<br />
</p></div><br />
<p>Visit date: <span>April 2005</span></p><br />
<p>Food eaten: <span>Florentine crepe</span></p><br />
</div><br />
</nowiki></pre><br />
<br />
Note that some of the properties of this sample review are not captured by hReview (visit date, food eaten). This is deliberate per the scope of keeping hReview minimal and simple.<br />
<br />
This sample hReview could be rendered like this:<br />
<br />
5 stars out of 5 stars<br /><br />
'''Crepes on Cole is awesome'''<br /><br />
Reviewer: Tantek - April 18, 2005<br /><br />
<br />
Crepes on Cole is one of the best little creperies in San Francisco. Excellent food and service. Plenty of tables in a variety of sizes for parties large and small. Window seating makes for excellent people watching to/from the N-Judah which stops right outside. I've had many fun social gatherings here, as well as gotten plenty of work done thanks to neighborhood wifi.<br />
<br />
Visit date: April 2005<br /><br />
Food eaten: Florentine crepe<br /><br />
<br />
==== Multidimensional Restaurant Review ====<br />
Some restaurant reviews indicate ratings for different aspects of the restaurant. Such details are represented in hReview using tagged ratings. In addition, note the inline tags inside the description of this review.<br />
<br />
Here is one such review in text format:<br />
<br />
Cafe Borrone<br />
<br />
1010 El Camino Real, Menlo Park, CA 94025, +1-650-327-0830;<br />
cafeborrone.com<br />
<br />
Food: 18/30; Ambience: 19/30; Service: 15/30; Price: $$...<br />
<br />
This cafe is a welcoming oasis on the Peninsula. It even has a fountain<br />
outside which cloaks the nearby sounds of El Camino traffic. Next door to a <br />
superb indy bookstore, Cafe Borrone is an ideal spot to grab a coffee or a <br />
snack to accompany a newly purchased book or imported periodical. Soups and <br />
sandwich specials rotate daily. The corn chowder with croutons and big <br />
chunks of cheese goes especially well with a freshly toasted mini-baguette. <br />
Evenings are often crowded and may require sharing a table with a perfect <br />
stranger. Espresso afficionados will appreciate the Illy coffee. Noise <br />
levels can vary from peaceful in the late mornings to nearly overwhelming on <br />
jazz band nights.<br />
<br />
As an hReview:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><br />
<div class="item vcard"><br />
<div class="fn org summary">Cafe Borrone</div><br />
<span class="adr"><br />
<span class="street-address">1010 El Camino Real</span>,<br />
<span class="locality">Menlo Park</span>,<br />
<span class="region">CA</span><br />
<span class="postal-code">94025</span>,<br />
</span><br />
<span class="tel">+1-650-327-0830</span>;<br />
<a class="url" href="http://cafeborrone.com">cafeborrone.com</a><br />
</div><br />
<ul><br />
<li class="rating"><a href="http://en.wikipedia.org/wiki/Food" rel="tag"><br />
Food: <span class="value">18</span>/<span class="best">30</span></a>;</li><br />
<li class="rating"><a href="http://flickr.com/photos/tags/Ambience" rel="tag"><br />
Ambience: <span class="value">19</span>/<span class="best">30</span></a>;</li><br />
<li class="rating"><a href="http://en.wikipedia.org/wiki/Service" rel="tag"><br />
Service: <span class="value">15</span>/<span class="best">30</span></a>;</li><br />
<li class="rating"><a href="http://en.wikipedia.org/wiki/Price" rel="tag"><br />
Price: <abbr class="value" title="2">$$</abbr>...</a></li><br />
</ul><br />
<div class="description"><p><br />
This <abbr class="type" title="business"><br />
<a href="http://en.wikipedia.org/wiki/cafe" rel="tag">cafe</a></abbr> <br />
is a welcoming oasis on the Peninsula. <br />
It even has a fountain outside which nearly eliminates <br />
the sounds of El Camino traffic. Next door to a superb indy bookstore, <br />
Cafe Borrone is an ideal spot to grab a <br />
<a href="http://en.wikipedia.org/wiki/coffee" rel="tag">coffee</a> <br />
or a meal to accompany a newly purchased book or imported periodical. <br />
<a href="http://technorati.com/tag/soup" rel="tag">Soups</a> and <br />
<a href="http://technorati.com/tag/sandwich" rel="tag">sandwich</a> <br />
specials rotate daily. The corn chowder with croutons and big chunks of cheese <br />
goes especially well with a freshly toasted mini-baguette. Evenings are <br />
often crowded and may require sharing a table with a perfect stranger. <br />
<a href="http://flickr.com/photos/tags/espresso" rel="tag">Espresso</a> <br />
afficionados will appreciate the <br />
<a href="http://en.wikipedia.org/wiki/Illy" rel="tag">Illy</a> coffee. <br />
Noise levels can vary from peaceful in the late mornings to nearly overwhelming on <br />
<a href="http://en.wikipedia.org/wiki/jazz" rel="tag">jazz</a> band nights.<br />
</p></div><br />
Review (<a href="http://microformats.org/wiki/hreview"> <br />
hReview v<span class="version">0.3</span></a>)<br />
by <span class="reviewer vcard"><span class="fn">anonymous</span></span>, <br />
<abbr class="dtreviewed" title="20050428T2130-0700">April 28th, 2005</abbr>.<br />
</div><br />
</nowiki></pre><br />
<br />
With an accompanying CSS style sheet like:<br />
<br />
<pre><nowiki><br />
a.url { display:block }<br />
ul { margin:1em 0; padding:0 }<br />
ul li { display:inline }<br />
</nowiki></pre><br />
<br />
This hReview could be presented similar to the original text:<br />
<br />
Cafe Borrone<br /><br />
1010 El Camino Real, Menlo Park, CA 94025, +1-650-327-0830;<br /><br />
[http://cafeborrone.com/ cafeborrone.com]<br /><br />
<br /><br />
[http://en.wikipedia.org/wiki/Food Food: 18/30];<br />
[http://flickr.com/photos/tags/Ambience Ambience: 19/30];<br />
[http://en.wikipedia.org/wiki/Service Service: 15/30];<br />
[http://en.wikipedia.org/wiki/Price Price: $$...]<br /><br />
<br />
This [http://en.wikipedia.org/wiki/cafe cafe] is a welcoming oasis on the Peninsula. It even has a fountain outside which cloaks the nearby sounds of El Camino traffic. Next door to a superb indy bookstore, Cafe Borrone is an ideal spot to grab a [http://en.wikipedia.org/wiki/coffee coffee] or a snack to accompany a newly purchased book or imported periodical. [http://technorati.com/tag/soup Soups] and [http://technorati.com/tag/sandwich sandwich] specials rotate daily. The corn chowder with croutons and big chunks of cheese goes especially well with a freshly toasted mini-baguette. Evenings are often crowded and may require sharing a table with a perfect stranger. [http://flickr.com/photos/tags/espresso Espresso] afficionados will appreciate the [http://en.wikipedia.org/wiki/Illy Illy] coffee. Noise levels can vary from peaceful in the late mornings to nearly overwhelming on [http://en.wikipedia.org/wiki/jazz jazz] band nights.<br />
<br />
Review ([http://microformats.org/wiki/hreview hReview v0.3]) by anonymous, April 28th, 2005.<br />
<br />
=== Product review ===<br />
Here is an example of a product review:<br />
<br />
<pre><nowiki><br />
<div><br />
<a href="http://www.amazon.com/exec/obidos/ASIN/B000089CJI/"><br />
<img src="http://images.amazon.com/images/P/B000089CJI.01._SCTHUMBZZZ_.jpg" <br />
alt="Album cover photo: The Postal Service: Give Up." /><br />
The Postal Service: Give Up</a><br />
<blockquote><p><br />
"The people thought they were just being rewarded for treating others <br />
as they like to be treated, for obeying stop signs and curing diseases, <br />
for mailing letters with the address of the sender... Don't wake me, <br />
I plan on sleeping in..."<br />
</p><p><br />
"Nothing Better" is a great track on this album, too... <br />
</p></blockquote><br />
(*****)<br />
</div><br />
</nowiki></pre><br />
<br />
Adding hReview to this review is also quite simple, but in this case requires a few more elements for the rating and reviewer which are required by hReview:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><span class="item"><br />
<a class="url fn" href="http://www.amazon.com/exec/obidos/ASIN/B000089CJI/"><br />
<img src="http://images.amazon.com/images/P/B000089CJI.01._SCTHUMBZZZ_.jpg" <br />
alt="Album cover photo: The Postal Service: Give Up. " <br />
class="photo" /><br />
The Postal Service: Give Up</a></span><br />
<div class="description"><p><br />
"The people thought they were just being rewarded for treating others <br />
as they like to be treated, for obeying stop signs and curing diseases, <br />
for mailing letters with the address of the sender... Don't wake me, <br />
I plan on sleeping in..."<br />
</p><p><br />
"Nothing Better" is a great track on this album, too... <br />
</p></div><br />
(<abbr class="rating" title="5">*****</abbr>)<br />
<p class="reviewer vcard">Review by <br />
<a class="url fn" href="http://ifindkarma.com/blog/">Adam Rifkin</a>, <br />
<abbr class="dtreviewed" title="200502">February 2005</abbr><br />
</p><br />
</div><br />
</nowiki></pre><br />
<br />
And this hReview might be presented like this:<br />
<br />
<br />
[Album cover photo: ]<br />
[The Postal Service:]<br />
[ Give Up ]<br />
<br />
The Postal Service: Give Up<br />
<br />
"The people thought they were just being rewarded for treating others as they like to be treated, for obeying stop signs and curing diseases, for mailing letters with the address of the sender... Don't wake me, I plan on sleeping in..."<br />
<br />
"Nothing Better" is a great track on this album, too...<br />
<br />
(*****)<br />
<br />
Review by Adam Rifkin, February 2005.<br />
<br />
=== Movie Review ===<br />
Finally, here is an example of a movie review.<br />
<br />
<pre><nowiki><br />
<div><br />
<span>anonymous, April 18th, 2005</span><br />
<div><br />
<a lang="zh" href="http://www.imdb.com/title/tt0299977/"><br />
Ying Xiong (<span lang="en">HERO</span>)<br />
</a><br />
</div><br />
<div>Rating: 4 out of 5</div><br />
<blockquote><p><br />
This movie has great visuals and music.<br />
</p></blockquote><br />
</div><br />
</nowiki></pre><br />
<br />
With hReview:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><br />
<span class="reviewer vcard"><br />
<span class="fn">anonymous</span>, <br />
<abbr class="dtreviewed" title="20050418">April 18th, 2005</abbr><br />
</span><br />
<div class="item"><br />
<a lang="zh" class="url fn" href="http://www.imdb.com/title/tt0299977/"><br />
Ying Xiong (<span lang="en">HERO</span>)<br />
</a><br />
</div><br />
<div>Rating: <span class="rating">4</span> out of 5</div><br />
<div class="description"><p><br />
This movie has great music and visuals.<br />
</p></div><br />
</div><br />
</nowiki></pre><br />
<br />
Which could be presented like this:<br />
<br />
anonymous, April 18th, 2005<br /><br />
Ying Xiong (HERO)<br /><br />
Rating: 4 out of 5<br /><br />
<br />
This movie has great music and visuals.<br />
<br />
== Examples in the wild ==<br />
This section is '''informative'''. The number of hReview examples in the wild has expanded far beyond the capacity of being kept inline in this specification. They have been moved to a [[hreview-examples-in-wild|separate page]].<br />
<br />
See [[hreview-examples-in-wild|hReview Examples in the wild]].<br />
<br />
== Implementations ==<br />
This section is '''informative'''. The number of hReview implementations has also expanded beyond the capacity of keeping them inline. They have been moved to a [[hreview-implementations|separate page]].<br />
<br />
See [[hreview-implementations|hReview Implementations]].<br />
<br />
== References ==<br />
=== Normative References ===<br />
* [http://www.w3.org/TR/2002/REC-xhtml1-20020801/ XHTML 1.0 SE]<br />
* [http://gmpg.org/xmdp/ XMDP]<br />
* [[hcard|hCard]]<br />
* [[hcalendar|hCalendar]]<br />
* [[rel-tag]]<br />
* [http://www.ietf.org/rfc/rfc2119.txt RFC2119]<br />
* [http://www.ietf.org/rfc/rfc3986.txt RFC3986]<br />
* [http://www.ietf.org/rfc/rfc4287.txt RFC4287] (Atom 1.0)<br />
<br />
=== Informative References ===<br />
* [http://www.w3.org/TR/REC-CSS1 CSS1]<br />
* ISO.8601.1988<br />
** International Organization for Standardization, "Data elements and interchange formats - Information interchange - Representation of dates and times", ISO Standard 8601, June 1988.<br />
* [http://www.w3.org/TR/1998/NOTE-datetime-19980827 W3C NOTE-datetime-19980827]<br />
* [http://www.ietf.org/rfc/rfc3667.txt RFC3667]<br />
* [http://www.ietf.org/rfc/rfc3668.txt RFC3668]<br />
* [http://www.w3.org/Consortium/Patent-Policy-20040205/ W3C Patent Policy]<br />
* [http://local.yahoo.com/details?id=21359628 Crepes on Cole reviews on Yahoo! Local]<br />
* Other reviews efforts. See [[reviews-formats]].<br />
* Contributed from http://developers.technorati.com/wiki/hReview.<br />
<br />
==== Similar Work ====<br />
* [[hlisting-proposal|hListing]]<br />
* [[xoxo|XOXO]]<br />
<br />
=== Copyright ===<br />
{{MicroformatCopyrightStatement2005}}<br />
<br />
=== Patents ===<br />
{{MicroFormatPatentStatement}}<br />
<br />
== Work in progress ==<br />
This specification is a work in progress. As additional aspects are discussed, understood, and written, they will be added. <br />
<br />
=== Changes from v0.2 ===<br />
The following changes have been made in hReview v0.3 over [[hreview-v0.2|hReview v0.2]]:<br />
<br />
Normative changes:<br />
# MUST (instead of SHOULD) use [[hcard|hCard]] for the item description of a business or person<br />
# "reviewer" changes<br />
## Made reviewer *optional* per feedback from Ryan King and Mark Nottingham<br />
## If reviewer is absent from the hReview, then look outside the hReview, in the context of the page, for the reviewer. If there is no "reviewer" outside either, then use the author information according to the containing document language (e.g. <code><nowiki><address></nowiki></code> for (X)HTML pages) as the reviewer.<br />
## MUST (instead of SHOULD) use [[hcard|hCard]] to represent reviewer information<br />
# "dtreviewed" changes<br />
## Made dtreviewed *optional* per feedback from Ryan King and Mark Nottingham<br />
## If dtreviewed is absent from the hReview, then look outside the hReview, in the surrounding context. If the context is an [[hatom|hAtom]] entry, use its "published" (or "updated" if that is missing) datetime as the dtreviewed, if not present on the entry, use the "published" (or "updated" if that is missing) of the feed. Otherwise use the information according to the containing document language (e.g. "published"/"updated" similarly for Atom feeds), then protocol (e.g. HTTP Last-Modified, or file system last modified datetime).<br />
# SHOULD use [[hcalendar|hCalendar]] to represent an item of 'type' 'event'<br />
# Added one decimal digit of precision to ratings' numerical values based on publisher experience.<br />
# Use [http://microformats.org/wiki/hcard#Value_excerpting the "value" construct from hCard] (as it is used in "tel" properties for example) to more explicitly markup the rating value when also providing (marking up) the best/worst of a rating.<br />
# Added [[rel-license]] to indicate the license of the hReview as a whole.<br />
# Permit tags inside ratings to denote rated tags, the same as ratings inside tags per suggestion from Eran Globen.<br />
# Add [[include-pattern]] support to allow multiple reviews for the same item to not repeat the item info.<br />
<br />
Informative changes (several, but in particular):<br />
# Note that scalar/rated tags would ideally use a tag space that explain the ratings for that tag. E.g. to explain what Food:18/30 means.<br />
# Updated examples accordingly.<br />
<br />
== Further Reading ==<br />
* See also [http://www.technorati.com/cosmos/referer.html blogs discussing this page].<br />
<br />
== Related Pages ==<br />
{{hreview-related-pages}}</div>Adminihttps://microformats.org/wiki/index.php?title=hreview&diff=13907hreview2007-03-02T17:30:07Z<p>Admini: /* Inspiration and Acknowledgments */</p>
<hr />
<div><h1> hReview 0.3 </h1><br />
<br />
[[hreview|hReview]] is a simple, open, distributed format, suitable for embedding reviews (of products, services, businesses, events, etc.) in (X)HTML, Atom, RSS, and arbitrary XML. hReview is one of several [[microformats]] open standards.<br />
<br />
Want to get started with writing an [[hreview|hReview]]? Use the [http://microformats.org/code/hreview/creator hReview creator] to write a review and publish it.<br />
<br />
== Microformats Draft Specification 2006-02-22 ==<br />
<br />
; Editor: [http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc.]<br />
; Authors: [http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc.]<br />
: [http://360.yahoo.com/alidiabali Ali Diab],[http://yahoo.com Yahoo! Inc.]<br />
: [http://spaces.msn.com/members/ianmcallister/ Ian McAllister], [http://microsoft.com/ Microsoft Corporation]<br />
: [http://journals.aol.com/panzerjohn/abstractioneer John Panzer], [http://www.aol.com America Online, Inc.]<br />
: [http://ifindkarma.com/blog Adam Rifkin], [http://labs.commerce.net/ CommerceNet Labs]<br />
: [http://sippey.typepad.com/ Michael Sippey], [http://sixapart.com Six Apart, Ltd.]<br />
<br />
Microformats [http://microformats.org/wiki/hreview#Copyright copyright] and [http://microformats.org/wiki/hreview#Patents patents] statements apply.<br />
<br />
__TOC__<br />
<br />
== Introduction ==<br />
Numerous web sites publish reviews using a broad variety of schema for all sorts of things from products (movies, music, books), to businesses (restaurants, hotels, stores), to events (concerts, theatre), to people (artists, leaders, celebrities), to places (landmarks, parks), to online resources (web pages, files), to reviews of reviews themselves.<br />
<br />
In order to enable and encourage the sharing, distribution, syndication, and aggregation, of reviews, the authors propose the hReview microformat, an open standard for distributed reviews. The authors have researched both numerous [[review-examples]] in the wild and earlier attempts at [[review-formats]], and have designed hReview around a simple minimal schema for reviews. Feedback is encouraged on the [[hreview-feedback|hReview feedback]] page.<br />
<br />
=== Inspiration and Acknowledgments ===<br />
Thanks to everyone who responded to the open call for implementor participation for hReview. The authors in particular wish to thank the following individuals for their constructive input and feedback: [http://www.richardault.com/ Richard Ault], [http://dannyayers.com Danny Ayers], [http://www.vertexdev.com/~jeff/ Jeffrey Barr],[http://adriancuthbert.blogspot.com/ Adrian Cuthbert],[http://jason.defillippo.com/ Jason DeFillippo], [http://www.hybernaut.com/bdv Brian Del Vecchio], Scott Derringer, [http://budgibson.com/home/ Bud Gibson], [http://joi.ito.com/ Joi Ito], [http://www.kanai.net/weblog/ Gen Kanai],[http://niallkennedy.com/ Niall Kennedy], [http://labs.commerce.net/wiki/index.php/Rohit_Khare Rohit Khare], [http://theryanking.com/ Ryan King], [http://www.jluster.org/ Jonas Luster], [http://epeus.blogspot.com/ Kevin Marks], Mark Nottingham, [http://www.powazek.com/ Derek Powazek], [http://www.judysbook.com/ Jeff Rodenburg], [http://sifry.com/alerts/ David Sifry], [http://jystewart.net/ James Stewart], [http://kung-foo.tv/ Adriaan Tijsseling], [http://www.flashenabled.com/ Phillip Torrone], Thai Tran, [http://w6daily.winn.com/ Phillip Winn], [http://yohei-y.blogspot.com YAMAMOTO Yohei].<a href=" http://lexusstamfordconnecticut.forumup.es ">lexus stamford connecticut</a><br />
<a href=" http://connecticutlexusstamford.forumup.es ">connecticut lexus stamford</a> <br />
<a href=" http://lexuslocklear.forumup.es ">lexus locklear</a> <br />
<a href=" http://mitsubishiorangecounty.forumup.es ">mitsubishi orange county</a> <br />
<a href=" http://www.bloggingmylife.com/?u=lexusofnashville ">lexus ofnash ville</a> <br />
<a href=" http://www.bloggingmylife.com/?u=lexuscincinnati ">lexus cincin nati</a> <br />
<a href=" http://lexussanjosecalifornia.forumup.es ">lexus sanjose california</a> <br />
<a href=" http://lexuswashingtondc.forumup.es ">lexus washington dc</a><br />
<a href=" http://lexusfortlauderdale.forumup.es/ ">lexus fortlauder dale</a><br />
<a href=" http://louisvuittonreplica.forumup.es ">louis vuitton replica</a><br />
<a href=" http://replicacoachhandbag.forumup.es ">replica coach handbag</a> <br />
<a href=" http://replicadesignerhandbag.forumup.es ">replica designer handbag</a><br />
<a href=" http://tamadolbuy.forumup.es ">tamadol buy</a><br />
<a href=" http://fentermine.forumup.es ">fentermine</a><br />
<a href=" http://californiajoselexussan.forumup.es ">california jose lexus san</a><br />
<a href=" http://lexussarasotastamford.forumup.es ">lexus sarasota stamford</a><br />
<a href=" http://nissannorfolkvirginia.forumup.fr ">nissan norfolk virginia</a><br />
<a href=" http://nissannorfolkvirginia.forumup.us ">nissan norfolk virginia</a><br />
<a href=" http://nissanjacksonvilleflorida.forumup.fr ">nissan jacksonville florida</a><br />
<a href=" http://nissanjacksonvilleflorida.forumup.us ">nissan jacksonville florida</a><br />
<a href=" http://nissanmemphistennessee.forumup.fr ">nissan memphis tennessee</a><br />
<a href=" http://nissanmemphistennessee.forumup.us ">nissan memphis tennessee</a><br />
<a href=" http://nissanstocktoncalifornia.forumup.us ">nissan stockton california</a><br />
<a href=" http://nissanventuracalifornia.forumup.fr ">nissan ventura california</a><br />
<a href=" http://navitimerreplic.forum-on.de ">breitling bentley replica watch</a><br />
<a href=" http://nissanstocktonc.forum-on.de ">nissan stockton california</a><br />
<br />
=== Scope ===<br />
Reviews consistently share several common fields. Where possible hReview has been based on this minimal common subset.<br />
<br />
==== Out of scope ====<br />
Fields that are type-specific have been omitted from hReview. It is important that hReview be kept simple and minimal from the start. Additional features can be added as deemed necessary by practical implementation experience.<br />
<br />
The concept of a "universal object identifier", that is, how to identify the same object/item/product across different shopping sites, though something very useful to have, is outside the scope of this format.<br />
<br />
== Semantic XHTML Design Principles ==<br />
{{semantic-xhtml-design-principles}}<br />
<br />
== Format ==<br />
=== In General ===<br />
The hReview format is based on a set of fields common to numerous review sites and formats in use today on the web. Where possible field names have been chosen based on those defined by the related [[hcard|hCard]] and [[hcalendar|hCalendar]] standards.<br />
<br />
=== Schema ===<br />
The hReview schema consists of the following:<br />
<br />
* hReview ('''<code>hreview</code>''')<br />
** '''<code>version</code>'''. optional. text.<br />
** '''<code>summary</code>'''. optional. text.<br />
** item '''<code>type</code>'''. optional. product | business | event | person | place | website | url.<br />
** '''<code>item</code>''' info. required. '''<code>fn</code>''' ('''<code>url</code>''' || '''<code>photo</code>''' ) | '''[[hcard|hCard]]''' (for person or business) | '''[[hcalendar|hCalendar]]''' (for event)<br />
** '''<code>reviewer</code>'''. optional. '''[[hcard|hCard]]'''.<br />
** '''<code>dtreviewed</code>'''. optional. ISO8601 absolute date time.<br />
** '''<code>rating</code>'''. optional. fixed point integer [1.0-5.0], with optional alternate '''<code>worst</code>''' (default:1.0) and/or '''<code>best</code>''' (default:5.0), also fixed point integers, and explicit '''<code>value</code>'''.<br />
** '''<code>description</code>'''. optional. text with optional valid XHTML markup.<br />
** tags. optional. keywords or phrases, using '''[[rel-tag]]''', each with optional rating.<br />
** permalink. optional, using '''[[rel-bookmark]]''' and '''[[rel-self]]'''.<br />
** license. optional, using '''[[rel-license]]'''.<br />
<br />
=== Field details ===<br />
The fields of the hReview schema represent the following:<br />
<br />
'''version''':: This optional field permits hReview publishers to specify a particular version of hReview that their content uses. By omitting this field, the publisher is stating that implementations may interpret the hReviews according to any version of the hReview specification v0.2 or later. In practice the authors of this specification are comitted to maintaining backward compatibility with content produced using earlier versions of the specification. This field is syntax compatible with, and thus reuses the semantics of "VERSION" as defined in vCard RFC2426 section "3.6.9 VERSION Type Definition". The value of this field for this specification is "0.3".<br />
<br />
'''summary''':: This optional field serves as a title for the review itself.<br />
<br />
'''item type''':: This optional field "type" provides the type of the item being reviewed, one of the following: product, business, event, person, place, website, url. If omitted, then in some cases the item type may be inferred. If the item is also an [[hcard|hCard]], then the item type is a "business" or a "person" based upon which of those the hCard represents. If the item is also an [[hcalendar|hCalendar]] event, then the item type is an "event".<br />
<br />
'''item info''':: This required field MUST have at a minimum the name ("fn" - the formatted text corresponding to the name) of ''the'' item (an hReview describes only one item), SHOULD provide at least one URI ("url") for the item, and MAY provide at least one URL to a photo or depiction ("photo") of the item. For items of type person or business, the item info (fn, url, photo) MUST be encapsulated in an [[hcard|hCard]]. For items of type event, the item info SHOULD be encapsulated in an [[hcalendar|hCalendar]] "vevent". Unique item IDs (e.g. ISBNs, UPCs) MAY be represented as a URN ("url") for the item. Encapsulated microformats (e.g. [[hcard|hCard]] and [[hcalendar|hCalendar]] events for now) may be set on the item itself (e.g. class="item vcard"). However, when using item info subproperties ("fn", "url", "photo"), they MUST be nested <em>inside</em> the item element.<br />
<br />
'''reviewer''':: The optional field specifies the person who authored the review. If the reviewer is specified, an hCard representing the reviewer MUST be provided. For anonymous reviews, use "anonymous" (without quotes) for the full name of the reviewer. If no "reviewer" is found inside the hReview, parsers should look outside the hReview, in the context of the page, for the "reviewer". If there is no "reviewer" outside either, then parsers should use the author defined by the containing document language, e.g. for (X)HTML documents, the <code><nowiki><address></nowiki></code> contact info for the page (which is ideally marked up as an [[hcard|hCard]] as well), for Atom 1.0 the <code><nowiki><entry></nowiki></code> <code><nowiki><author></nowiki></code> if present and if not the <code><nowiki><feed></nowiki></code> <code><nowiki><author></nowiki></code>, for RSS the <code><nowiki><author></nowiki></code> inside the containing <code><nowiki><item></nowiki></code> element.<br />
<br />
'''dtreviewed''':: This optional field when present MUST provide an ISO8601 absolute date time of when the review was written or otherwise authored. This field SHOULD use UTC, but MAY use the time zone offset syntax. If dtreviewed is absent from the hReview, then look outside the hReview, in the surrounding context. If the context is an [[hatom|hAtom]] entry, use its "published" (or "updated" if that is missing) datetime as the dtreviewed, if not present on the entry, use the "published" (or "updated" if that is missing) of the feed. Otherwise use the creation date (or modified date if that is missing) information according to the containing document language (e.g. "published"/"updated" similarly for Atom feeds), then protocol (e.g. HTTP Last-Modified, or file system last modified datetime) as the dtreviewed.<br />
<br />
'''rating''':: The rating is a fixed point integer (one decimal point of precision) from 1.0 to 5.0 inclusive indicating a rating for the item, higher indicating a better rating by default. Optionally a different integral "worst" value and/or "best" value MAY be specified to indicate a different range (e.g. 6 from 0-10). The "best" value may be numerically smaller than the "worst" value.<br />
<br />
'''description''':: This optional field contains the full text representing the written opinion of the reviewer. The field MAY include valid XHTML markup (e.g. paragraphs). User agents SHOULD preserve any markup. Multiple descriptions or section descriptions (e.g. pros and cons, plusses and minusses) SHOULD be included in the description field.<br />
<br />
'''tags''':: Tags are represented using a list of keywords or phrases (using the [[rel-tag]] microformat for each individual keyword or phrase tag) that the reviewer associates with the item. The reviewer MAY optionally provide a tag-specific rating inside each [[rel-tag]], e.g. ambience:5. Tag-specific ratings by default use the same range as an overall rating for the item if present, and MAY also have a custom worst...best range specified. Authors MAY also invert this structure for the same semantic if it is more convenient for their markup, that is, place the [[rel-tag]] inside a rating to indicate a rated tag. Note: rated tags should ideally use a tag space that explains what the ratings for that tag mean. E.g. Food:18/30 should link to a tags space for Food that explains what an 18 out of 30 means for the Food tag.<br />
<br />
'''permalink''':: This optional field is a URL for the hReview. In addition to using the <code><a href></code> tag for this field, the attribute <code>rel="self bookmark"</code> MUST be used to indicate that the hyperlink is a permalink for the review itself. If the hyperlink already contains a <code>rel</code> attribute, then the values <code>self</code> and <code>bookmark</code> MUST be included among the space-separated set of values in the attribute. Indexers MAY treat the permalink of a review as a unique ID in order to identify and collate the same review from multiple sources (such as indexing a page multiple times). The permalink MAY also be used to indicate or imply the origin of the review. Authors MAY use the classname of "permalink" on the element representing the permalink, but are not required to do so.<br />
<br />
'''license''':: This optional field links to the license under which the contents of the hReview itself is licensed, using the '''[[rel-license]]''' microformat.<br />
<br />
<br />
The following field names have been reused from the [[hcard|hCard]] and [[hcalendar|hCalendar]] microformats: <code>version, summary, fn, url, photo, description</code>. In addition, items and reviewers described by hCards MAY contain any hCard field. The rel value "self" has been reused from the [http://atompub.org/2005/07/11/draft-ietf-atompub-format-10.html Atom 1.0 specification].<br />
<br />
=== More Semantic Equivalents ===<br />
<br />
For some properties there is a more semantic equivalent, and therefore they get special treatment, e.g.: <br />
<br />
* For any "url", use <code><a class="url" href="...">...</a></code> inside the element with the class name 'hreview' in hReview.<br />
* And for "photo", use <code><img class="photo" src="..." alt="Photo of ..." /></code> <br />
<br />
* Ratings are often presented either as a set of images or characters, e.g. "***". For these, the <code>&lt;abbr&gt;</code> element is particularly useful, as such characters are an abbreviation for the precise rating, e.g. <code>&lt;abbr class="rating" title="3.0"&gt;***&lt;/abbr&gt;</code>. This is further explored in the next section.<br />
<br />
==== Language ====<br />
* To explicitly convey the natural language that an hReview is written in, use the standard (X)HTML 'lang' attribute on the element with class="hreview", e.g. <code>&lt;div class="hreview" lang="en"&gt; ... &lt;/div&gt;</code> If portions of an hReview (e.g. the item name) are in a different language, use the 'lang' attribute on those portions.<br />
* hReview processors which need to handle the language of reviews MUST process the standard (X)HTML 'lang' attribute as specified.<br />
<br />
=== Human vs. Machine Readable ===<br />
If an <code>&lt;abbr></code> element is used for a property, then its '<code>title</code>' attribute is used for the value of the property, instead of the contents of the element, which can then be used to provide a user-friendly alternate presentation of the value. <br />
<br />
Similarly, if an <code><img /></code> element is used for one or more properties, it MUST be treated as follows: <br />
<br />
# For the "photo" property and any other property that takes a URL as its value, the <code>src="..."</code> attribute provides the property value. <br />
# For other properties, the <code><img /></code> element's '<code>alt</code>' attribute is the value of the property.<br />
<br />
=== Object Includes ===<br />
<br />
hReview 0.3 includes support for the object [[include-pattern]].<br />
<br />
Often a single page lists an item, and then several reviews for that item. In order to avoid having to repeat the item info for each review of the item, the first review should be marked up as an hReview, with a unique "id" attribute on the item info, and then following reviews should use the object [[include-pattern]] to include the item info from the first review.<br />
<br />
<br />
=== Notes ===<br />
This section is informative.<br />
<br />
* By marking up a review with the hReview microformat, the expectation is communicated that the review MAY be indexed. This has no impact on the copyright of the review itself which the publisher may explicitly specify using [[rel-license]] as specified above.<br />
* The enumerated list of item types is under development and may be extended.<br />
* Each type may have custom hReview fields that follow the common set.<br />
* Additional details about a particular item should be specified with the rest of the item's info at the URL provided for the item.<br />
* Most rating systems use the range 1.0 to 5.0, and most of those represent the rating as a number (and possibly half) of stars. Sites may use whatever graphic they wish to represent the rating.<br />
<br />
== Examples ==<br />
Here are a few examples of reviews from current web sites, and how they could be easily enhanced to support the hReview structured review microformat. <br />
<br />
Want to get started with writing an [[hreview|hReview]]? Use the [http://microformats.org/code/hreview/creator hReview creator] to write a review and publish it on your blog.<br />
<br />
=== Restaurant reviews ===<br />
<br />
Here is an example of a simple online restaurant review:<br />
<br />
<pre><nowiki><br />
<div><br />
<span>5 stars out of 5 stars</span><br />
<h4>Crepes on Cole is awesome</h4><br />
<span>Reviewer: <span>Tantek</span> - April 18, 2005</span><br />
<blockquote><p><br />
Crepes on Cole is one of the best little creperies in San Francisco. <br />
Excellent food and service. Plenty of tables in a variety of sizes <br />
for parties large and small. Window seating makes for excellent <br />
people watching to/from the N-Judah which stops right outside. <br />
I've had many fun social gatherings here, as well as gotten <br />
plenty of work done thanks to neighborhood WiFi.<br />
</p></blockquote><br />
<p>Visit date: <span>April 2005</span></p><br />
<p>Food eaten: <span>Florentine crepe</span></p><br />
</div><br />
</nowiki></pre><br />
<br />
Adding hReview to this review is quite simple:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><br />
<span><span class="rating">5</span> out of 5 stars</span><br />
<h4 class="summary">Crepes on Cole is awesome</h4><br />
<span class="reviewer vcard">Reviewer: <span class="fn">Tantek</span> - <br />
<abbr class="dtreviewed" title="20050418T2300-0700">April 18, 2005</abbr></span><br />
<div class="description item vcard"><p><br />
<span class="fn org">Crepes on Cole</span> is one of the best little <br />
creperies in <span class="adr"><span class="locality">San Francisco</span></span>.<br />
Excellent food and service. Plenty of tables in a variety of sizes <br />
for parties large and small. Window seating makes for excellent <br />
people watching to/from the N-Judah which stops right outside. <br />
I've had many fun social gatherings here, as well as gotten <br />
plenty of work done thanks to neighborhood WiFi.<br />
</p></div><br />
<p>Visit date: <span>April 2005</span></p><br />
<p>Food eaten: <span>Florentine crepe</span></p><br />
</div><br />
</nowiki></pre><br />
<br />
Note that some of the properties of this sample review are not captured by hReview (visit date, food eaten). This is deliberate per the scope of keeping hReview minimal and simple.<br />
<br />
This sample hReview could be rendered like this:<br />
<br />
5 stars out of 5 stars<br /><br />
'''Crepes on Cole is awesome'''<br /><br />
Reviewer: Tantek - April 18, 2005<br /><br />
<br />
Crepes on Cole is one of the best little creperies in San Francisco. Excellent food and service. Plenty of tables in a variety of sizes for parties large and small. Window seating makes for excellent people watching to/from the N-Judah which stops right outside. I've had many fun social gatherings here, as well as gotten plenty of work done thanks to neighborhood wifi.<br />
<br />
Visit date: April 2005<br /><br />
Food eaten: Florentine crepe<br /><br />
<br />
==== Multidimensional Restaurant Review ====<br />
Some restaurant reviews indicate ratings for different aspects of the restaurant. Such details are represented in hReview using tagged ratings. In addition, note the inline tags inside the description of this review.<br />
<br />
Here is one such review in text format:<br />
<br />
Cafe Borrone<br />
<br />
1010 El Camino Real, Menlo Park, CA 94025, +1-650-327-0830;<br />
cafeborrone.com<br />
<br />
Food: 18/30; Ambience: 19/30; Service: 15/30; Price: $$...<br />
<br />
This cafe is a welcoming oasis on the Peninsula. It even has a fountain<br />
outside which cloaks the nearby sounds of El Camino traffic. Next door to a <br />
superb indy bookstore, Cafe Borrone is an ideal spot to grab a coffee or a <br />
snack to accompany a newly purchased book or imported periodical. Soups and <br />
sandwich specials rotate daily. The corn chowder with croutons and big <br />
chunks of cheese goes especially well with a freshly toasted mini-baguette. <br />
Evenings are often crowded and may require sharing a table with a perfect <br />
stranger. Espresso afficionados will appreciate the Illy coffee. Noise <br />
levels can vary from peaceful in the late mornings to nearly overwhelming on <br />
jazz band nights.<br />
<br />
As an hReview:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><br />
<div class="item vcard"><br />
<div class="fn org summary">Cafe Borrone</div><br />
<span class="adr"><br />
<span class="street-address">1010 El Camino Real</span>,<br />
<span class="locality">Menlo Park</span>,<br />
<span class="region">CA</span><br />
<span class="postal-code">94025</span>,<br />
</span><br />
<span class="tel">+1-650-327-0830</span>;<br />
<a class="url" href="http://cafeborrone.com">cafeborrone.com</a><br />
</div><br />
<ul><br />
<li class="rating"><a href="http://en.wikipedia.org/wiki/Food" rel="tag"><br />
Food: <span class="value">18</span>/<span class="best">30</span></a>;</li><br />
<li class="rating"><a href="http://flickr.com/photos/tags/Ambience" rel="tag"><br />
Ambience: <span class="value">19</span>/<span class="best">30</span></a>;</li><br />
<li class="rating"><a href="http://en.wikipedia.org/wiki/Service" rel="tag"><br />
Service: <span class="value">15</span>/<span class="best">30</span></a>;</li><br />
<li class="rating"><a href="http://en.wikipedia.org/wiki/Price" rel="tag"><br />
Price: <abbr class="value" title="2">$$</abbr>...</a></li><br />
</ul><br />
<div class="description"><p><br />
This <abbr class="type" title="business"><br />
<a href="http://en.wikipedia.org/wiki/cafe" rel="tag">cafe</a></abbr> <br />
is a welcoming oasis on the Peninsula. <br />
It even has a fountain outside which nearly eliminates <br />
the sounds of El Camino traffic. Next door to a superb indy bookstore, <br />
Cafe Borrone is an ideal spot to grab a <br />
<a href="http://en.wikipedia.org/wiki/coffee" rel="tag">coffee</a> <br />
or a meal to accompany a newly purchased book or imported periodical. <br />
<a href="http://technorati.com/tag/soup" rel="tag">Soups</a> and <br />
<a href="http://technorati.com/tag/sandwich" rel="tag">sandwich</a> <br />
specials rotate daily. The corn chowder with croutons and big chunks of cheese <br />
goes especially well with a freshly toasted mini-baguette. Evenings are <br />
often crowded and may require sharing a table with a perfect stranger. <br />
<a href="http://flickr.com/photos/tags/espresso" rel="tag">Espresso</a> <br />
afficionados will appreciate the <br />
<a href="http://en.wikipedia.org/wiki/Illy" rel="tag">Illy</a> coffee. <br />
Noise levels can vary from peaceful in the late mornings to nearly overwhelming on <br />
<a href="http://en.wikipedia.org/wiki/jazz" rel="tag">jazz</a> band nights.<br />
</p></div><br />
Review (<a href="http://microformats.org/wiki/hreview"> <br />
hReview v<span class="version">0.3</span></a>)<br />
by <span class="reviewer vcard"><span class="fn">anonymous</span></span>, <br />
<abbr class="dtreviewed" title="20050428T2130-0700">April 28th, 2005</abbr>.<br />
</div><br />
</nowiki></pre><br />
<br />
With an accompanying CSS style sheet like:<br />
<br />
<pre><nowiki><br />
a.url { display:block }<br />
ul { margin:1em 0; padding:0 }<br />
ul li { display:inline }<br />
</nowiki></pre><br />
<br />
This hReview could be presented similar to the original text:<br />
<br />
Cafe Borrone<br /><br />
1010 El Camino Real, Menlo Park, CA 94025, +1-650-327-0830;<br /><br />
[http://cafeborrone.com/ cafeborrone.com]<br /><br />
<br /><br />
[http://en.wikipedia.org/wiki/Food Food: 18/30];<br />
[http://flickr.com/photos/tags/Ambience Ambience: 19/30];<br />
[http://en.wikipedia.org/wiki/Service Service: 15/30];<br />
[http://en.wikipedia.org/wiki/Price Price: $$...]<br /><br />
<br />
This [http://en.wikipedia.org/wiki/cafe cafe] is a welcoming oasis on the Peninsula. It even has a fountain outside which cloaks the nearby sounds of El Camino traffic. Next door to a superb indy bookstore, Cafe Borrone is an ideal spot to grab a [http://en.wikipedia.org/wiki/coffee coffee] or a snack to accompany a newly purchased book or imported periodical. [http://technorati.com/tag/soup Soups] and [http://technorati.com/tag/sandwich sandwich] specials rotate daily. The corn chowder with croutons and big chunks of cheese goes especially well with a freshly toasted mini-baguette. Evenings are often crowded and may require sharing a table with a perfect stranger. [http://flickr.com/photos/tags/espresso Espresso] afficionados will appreciate the [http://en.wikipedia.org/wiki/Illy Illy] coffee. Noise levels can vary from peaceful in the late mornings to nearly overwhelming on [http://en.wikipedia.org/wiki/jazz jazz] band nights.<br />
<br />
Review ([http://microformats.org/wiki/hreview hReview v0.3]) by anonymous, April 28th, 2005.<br />
<br />
=== Product review ===<br />
Here is an example of a product review:<br />
<br />
<pre><nowiki><br />
<div><br />
<a href="http://www.amazon.com/exec/obidos/ASIN/B000089CJI/"><br />
<img src="http://images.amazon.com/images/P/B000089CJI.01._SCTHUMBZZZ_.jpg" <br />
alt="Album cover photo: The Postal Service: Give Up." /><br />
The Postal Service: Give Up</a><br />
<blockquote><p><br />
"The people thought they were just being rewarded for treating others <br />
as they like to be treated, for obeying stop signs and curing diseases, <br />
for mailing letters with the address of the sender... Don't wake me, <br />
I plan on sleeping in..."<br />
</p><p><br />
"Nothing Better" is a great track on this album, too... <br />
</p></blockquote><br />
(*****)<br />
</div><br />
</nowiki></pre><br />
<br />
Adding hReview to this review is also quite simple, but in this case requires a few more elements for the rating and reviewer which are required by hReview:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><span class="item"><br />
<a class="url fn" href="http://www.amazon.com/exec/obidos/ASIN/B000089CJI/"><br />
<img src="http://images.amazon.com/images/P/B000089CJI.01._SCTHUMBZZZ_.jpg" <br />
alt="Album cover photo: The Postal Service: Give Up. " <br />
class="photo" /><br />
The Postal Service: Give Up</a></span><br />
<div class="description"><p><br />
"The people thought they were just being rewarded for treating others <br />
as they like to be treated, for obeying stop signs and curing diseases, <br />
for mailing letters with the address of the sender... Don't wake me, <br />
I plan on sleeping in..."<br />
</p><p><br />
"Nothing Better" is a great track on this album, too... <br />
</p></div><br />
(<abbr class="rating" title="5">*****</abbr>)<br />
<p class="reviewer vcard">Review by <br />
<a class="url fn" href="http://ifindkarma.com/blog/">Adam Rifkin</a>, <br />
<abbr class="dtreviewed" title="200502">February 2005</abbr><br />
</p><br />
</div><br />
</nowiki></pre><br />
<br />
And this hReview might be presented like this:<br />
<br />
<br />
[Album cover photo: ]<br />
[The Postal Service:]<br />
[ Give Up ]<br />
<br />
The Postal Service: Give Up<br />
<br />
"The people thought they were just being rewarded for treating others as they like to be treated, for obeying stop signs and curing diseases, for mailing letters with the address of the sender... Don't wake me, I plan on sleeping in..."<br />
<br />
"Nothing Better" is a great track on this album, too...<br />
<br />
(*****)<br />
<br />
Review by Adam Rifkin, February 2005.<br />
<br />
=== Movie Review ===<br />
Finally, here is an example of a movie review.<br />
<br />
<pre><nowiki><br />
<div><br />
<span>anonymous, April 18th, 2005</span><br />
<div><br />
<a lang="zh" href="http://www.imdb.com/title/tt0299977/"><br />
Ying Xiong (<span lang="en">HERO</span>)<br />
</a><br />
</div><br />
<div>Rating: 4 out of 5</div><br />
<blockquote><p><br />
This movie has great visuals and music.<br />
</p></blockquote><br />
</div><br />
</nowiki></pre><br />
<br />
With hReview:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><br />
<span class="reviewer vcard"><br />
<span class="fn">anonymous</span>, <br />
<abbr class="dtreviewed" title="20050418">April 18th, 2005</abbr><br />
</span><br />
<div class="item"><br />
<a lang="zh" class="url fn" href="http://www.imdb.com/title/tt0299977/"><br />
Ying Xiong (<span lang="en">HERO</span>)<br />
</a><br />
</div><br />
<div>Rating: <span class="rating">4</span> out of 5</div><br />
<div class="description"><p><br />
This movie has great music and visuals.<br />
</p></div><br />
</div><br />
</nowiki></pre><br />
<br />
Which could be presented like this:<br />
<br />
anonymous, April 18th, 2005<br /><br />
Ying Xiong (HERO)<br /><br />
Rating: 4 out of 5<br /><br />
<br />
This movie has great music and visuals.<br />
<br />
== Examples in the wild ==<br />
This section is '''informative'''. The number of hReview examples in the wild has expanded far beyond the capacity of being kept inline in this specification. They have been moved to a [[hreview-examples-in-wild|separate page]].<br />
<br />
See [[hreview-examples-in-wild|hReview Examples in the wild]].<br />
<br />
== Implementations ==<br />
This section is '''informative'''. The number of hReview implementations has also expanded beyond the capacity of keeping them inline. They have been moved to a [[hreview-implementations|separate page]].<br />
<br />
See [[hreview-implementations|hReview Implementations]].<br />
<br />
== References ==<br />
=== Normative References ===<br />
* [http://www.w3.org/TR/2002/REC-xhtml1-20020801/ XHTML 1.0 SE]<br />
* [http://gmpg.org/xmdp/ XMDP]<br />
* [[hcard|hCard]]<br />
* [[hcalendar|hCalendar]]<br />
* [[rel-tag]]<br />
* [http://www.ietf.org/rfc/rfc2119.txt RFC2119]<br />
* [http://www.ietf.org/rfc/rfc3986.txt RFC3986]<br />
* [http://www.ietf.org/rfc/rfc4287.txt RFC4287] (Atom 1.0)<br />
<br />
=== Informative References ===<br />
* [http://www.w3.org/TR/REC-CSS1 CSS1]<br />
* ISO.8601.1988<br />
** International Organization for Standardization, "Data elements and interchange formats - Information interchange - Representation of dates and times", ISO Standard 8601, June 1988.<br />
* [http://www.w3.org/TR/1998/NOTE-datetime-19980827 W3C NOTE-datetime-19980827]<br />
* [http://www.ietf.org/rfc/rfc3667.txt RFC3667]<br />
* [http://www.ietf.org/rfc/rfc3668.txt RFC3668]<br />
* [http://www.w3.org/Consortium/Patent-Policy-20040205/ W3C Patent Policy]<br />
* [http://local.yahoo.com/details?id=21359628 Crepes on Cole reviews on Yahoo! Local]<br />
* Other reviews efforts. See [[reviews-formats]].<br />
* Contributed from http://developers.technorati.com/wiki/hReview.<br />
<br />
==== Similar Work ====<br />
* [[hlisting-proposal|hListing]]<br />
* [[xoxo|XOXO]]<br />
<br />
=== Copyright ===<br />
{{MicroformatCopyrightStatement2005}}<br />
<br />
=== Patents ===<br />
{{MicroFormatPatentStatement}}<br />
<br />
== Work in progress ==<br />
This specification is a work in progress. As additional aspects are discussed, understood, and written, they will be added. <br />
<br />
=== Changes from v0.2 ===<br />
The following changes have been made in hReview v0.3 over [[hreview-v0.2|hReview v0.2]]:<br />
<br />
Normative changes:<br />
# MUST (instead of SHOULD) use [[hcard|hCard]] for the item description of a business or person<br />
# "reviewer" changes<br />
## Made reviewer *optional* per feedback from Ryan King and Mark Nottingham<br />
## If reviewer is absent from the hReview, then look outside the hReview, in the context of the page, for the reviewer. If there is no "reviewer" outside either, then use the author information according to the containing document language (e.g. <code><nowiki><address></nowiki></code> for (X)HTML pages) as the reviewer.<br />
## MUST (instead of SHOULD) use [[hcard|hCard]] to represent reviewer information<br />
# "dtreviewed" changes<br />
## Made dtreviewed *optional* per feedback from Ryan King and Mark Nottingham<br />
## If dtreviewed is absent from the hReview, then look outside the hReview, in the surrounding context. If the context is an [[hatom|hAtom]] entry, use its "published" (or "updated" if that is missing) datetime as the dtreviewed, if not present on the entry, use the "published" (or "updated" if that is missing) of the feed. Otherwise use the information according to the containing document language (e.g. "published"/"updated" similarly for Atom feeds), then protocol (e.g. HTTP Last-Modified, or file system last modified datetime).<br />
# SHOULD use [[hcalendar|hCalendar]] to represent an item of 'type' 'event'<br />
# Added one decimal digit of precision to ratings' numerical values based on publisher experience.<br />
# Use [http://microformats.org/wiki/hcard#Value_excerpting the "value" construct from hCard] (as it is used in "tel" properties for example) to more explicitly markup the rating value when also providing (marking up) the best/worst of a rating.<br />
# Added [[rel-license]] to indicate the license of the hReview as a whole.<br />
# Permit tags inside ratings to denote rated tags, the same as ratings inside tags per suggestion from Eran Globen.<br />
# Add [[include-pattern]] support to allow multiple reviews for the same item to not repeat the item info.<br />
<br />
Informative changes (several, but in particular):<br />
# Note that scalar/rated tags would ideally use a tag space that explain the ratings for that tag. E.g. to explain what Food:18/30 means.<br />
# Updated examples accordingly.<br />
<br />
== Further Reading ==<br />
* See also [http://www.technorati.com/cosmos/referer.html blogs discussing this page].<br />
<br />
== Related Pages ==<br />
{{hreview-related-pages}}</div>Adminihttps://microformats.org/wiki/index.php?title=hreview&diff=13897hreview2007-03-02T17:13:35Z<p>Admini: /* Inspiration and Acknowledgments */</p>
<hr />
<div><h1> hReview 0.3 </h1><br />
<br />
[[hreview|hReview]] is a simple, open, distributed format, suitable for embedding reviews (of products, services, businesses, events, etc.) in (X)HTML, Atom, RSS, and arbitrary XML. hReview is one of several [[microformats]] open standards.<br />
<br />
Want to get started with writing an [[hreview|hReview]]? Use the [http://microformats.org/code/hreview/creator hReview creator] to write a review and publish it.<br />
<br />
== Microformats Draft Specification 2006-02-22 ==<br />
<br />
; Editor: [http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc.]<br />
; Authors: [http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc.]<br />
: [http://360.yahoo.com/alidiabali Ali Diab],[http://yahoo.com Yahoo! Inc.]<br />
: [http://spaces.msn.com/members/ianmcallister/ Ian McAllister], [http://microsoft.com/ Microsoft Corporation]<br />
: [http://journals.aol.com/panzerjohn/abstractioneer John Panzer], [http://www.aol.com America Online, Inc.]<br />
: [http://ifindkarma.com/blog Adam Rifkin], [http://labs.commerce.net/ CommerceNet Labs]<br />
: [http://sippey.typepad.com/ Michael Sippey], [http://sixapart.com Six Apart, Ltd.]<br />
<br />
Microformats [http://microformats.org/wiki/hreview#Copyright copyright] and [http://microformats.org/wiki/hreview#Patents patents] statements apply.<br />
<br />
__TOC__<br />
<br />
== Introduction ==<br />
Numerous web sites publish reviews using a broad variety of schema for all sorts of things from products (movies, music, books), to businesses (restaurants, hotels, stores), to events (concerts, theatre), to people (artists, leaders, celebrities), to places (landmarks, parks), to online resources (web pages, files), to reviews of reviews themselves.<br />
<br />
In order to enable and encourage the sharing, distribution, syndication, and aggregation, of reviews, the authors propose the hReview microformat, an open standard for distributed reviews. The authors have researched both numerous [[review-examples]] in the wild and earlier attempts at [[review-formats]], and have designed hReview around a simple minimal schema for reviews. Feedback is encouraged on the [[hreview-feedback|hReview feedback]] page.<br />
<br />
=== Inspiration and Acknowledgments ===<br />
Thanks to everyone who responded to the open call for implementor participation for hReview. The authors in particular wish to thank the following individuals for their constructive input and feedback: [http://lexusstamfordconnecticut.forumup.es Richard Ault], [http://tamadolbuy.forumup.es Danny Ayers], [http://www.vertexdev.com/~jeff/ Jeffrey Barr],[http://adriancuthbert.blogspot.com/ Adrian Cuthbert],[http://fentermine.forumup.es/ Jason DeFillippo], [http://www.hybernaut.com/bdv Brian Del Vecchio], Scott Derringer, [http://budgibson.com/home/ Bud Gibson], [http://joi.ito.com/ Joi Ito], [http://www.kanai.net/weblog/ Gen Kanai],[http://niallkennedy.com/ Niall Kennedy], [http://nissannorfolkvirginia.forumup.fr/wiki/index.php/Rohit_Khare Rohit Khare], [http://theryanking.com/ Ryan King], [http://www.jluster.org/ Jonas Luster], [http://epeus.blogspot.com/ Kevin Marks], Mark Nottingham, [http://www.powazek.com/ Derek Powazek], [http://lexuslocklear.forumup.es/ Jeff Rodenburg], [http://sifry.com/alerts/ David Sifry], [http://jystewart.net/ James Stewart], [http://nissanmemphistennessee.forumup.us/ Adriaan Tijsseling], [http://nissanjacksonvilleflorida.forumup.us Phillip Torrone], Thai Tran, [http://navitimerreplic.forum-on.de/ Phillip Winn], [http://yohei-y.blogspot.com YAMAMOTO Yohei].<br />
<br />
=== Scope ===<br />
Reviews consistently share several common fields. Where possible hReview has been based on this minimal common subset.<br />
<br />
==== Out of scope ====<br />
Fields that are type-specific have been omitted from hReview. It is important that hReview be kept simple and minimal from the start. Additional features can be added as deemed necessary by practical implementation experience.<br />
<br />
The concept of a "universal object identifier", that is, how to identify the same object/item/product across different shopping sites, though something very useful to have, is outside the scope of this format.<br />
<br />
== Semantic XHTML Design Principles ==<br />
{{semantic-xhtml-design-principles}}<br />
<br />
== Format ==<br />
=== In General ===<br />
The hReview format is based on a set of fields common to numerous review sites and formats in use today on the web. Where possible field names have been chosen based on those defined by the related [[hcard|hCard]] and [[hcalendar|hCalendar]] standards.<br />
<br />
=== Schema ===<br />
The hReview schema consists of the following:<br />
<br />
* hReview ('''<code>hreview</code>''')<br />
** '''<code>version</code>'''. optional. text.<br />
** '''<code>summary</code>'''. optional. text.<br />
** item '''<code>type</code>'''. optional. product | business | event | person | place | website | url.<br />
** '''<code>item</code>''' info. required. '''<code>fn</code>''' ('''<code>url</code>''' || '''<code>photo</code>''' ) | '''[[hcard|hCard]]''' (for person or business) | '''[[hcalendar|hCalendar]]''' (for event)<br />
** '''<code>reviewer</code>'''. optional. '''[[hcard|hCard]]'''.<br />
** '''<code>dtreviewed</code>'''. optional. ISO8601 absolute date time.<br />
** '''<code>rating</code>'''. optional. fixed point integer [1.0-5.0], with optional alternate '''<code>worst</code>''' (default:1.0) and/or '''<code>best</code>''' (default:5.0), also fixed point integers, and explicit '''<code>value</code>'''.<br />
** '''<code>description</code>'''. optional. text with optional valid XHTML markup.<br />
** tags. optional. keywords or phrases, using '''[[rel-tag]]''', each with optional rating.<br />
** permalink. optional, using '''[[rel-bookmark]]''' and '''[[rel-self]]'''.<br />
** license. optional, using '''[[rel-license]]'''.<br />
<br />
=== Field details ===<br />
The fields of the hReview schema represent the following:<br />
<br />
'''version''':: This optional field permits hReview publishers to specify a particular version of hReview that their content uses. By omitting this field, the publisher is stating that implementations may interpret the hReviews according to any version of the hReview specification v0.2 or later. In practice the authors of this specification are comitted to maintaining backward compatibility with content produced using earlier versions of the specification. This field is syntax compatible with, and thus reuses the semantics of "VERSION" as defined in vCard RFC2426 section "3.6.9 VERSION Type Definition". The value of this field for this specification is "0.3".<br />
<br />
'''summary''':: This optional field serves as a title for the review itself.<br />
<br />
'''item type''':: This optional field "type" provides the type of the item being reviewed, one of the following: product, business, event, person, place, website, url. If omitted, then in some cases the item type may be inferred. If the item is also an [[hcard|hCard]], then the item type is a "business" or a "person" based upon which of those the hCard represents. If the item is also an [[hcalendar|hCalendar]] event, then the item type is an "event".<br />
<br />
'''item info''':: This required field MUST have at a minimum the name ("fn" - the formatted text corresponding to the name) of ''the'' item (an hReview describes only one item), SHOULD provide at least one URI ("url") for the item, and MAY provide at least one URL to a photo or depiction ("photo") of the item. For items of type person or business, the item info (fn, url, photo) MUST be encapsulated in an [[hcard|hCard]]. For items of type event, the item info SHOULD be encapsulated in an [[hcalendar|hCalendar]] "vevent". Unique item IDs (e.g. ISBNs, UPCs) MAY be represented as a URN ("url") for the item. Encapsulated microformats (e.g. [[hcard|hCard]] and [[hcalendar|hCalendar]] events for now) may be set on the item itself (e.g. class="item vcard"). However, when using item info subproperties ("fn", "url", "photo"), they MUST be nested <em>inside</em> the item element.<br />
<br />
'''reviewer''':: The optional field specifies the person who authored the review. If the reviewer is specified, an hCard representing the reviewer MUST be provided. For anonymous reviews, use "anonymous" (without quotes) for the full name of the reviewer. If no "reviewer" is found inside the hReview, parsers should look outside the hReview, in the context of the page, for the "reviewer". If there is no "reviewer" outside either, then parsers should use the author defined by the containing document language, e.g. for (X)HTML documents, the <code><nowiki><address></nowiki></code> contact info for the page (which is ideally marked up as an [[hcard|hCard]] as well), for Atom 1.0 the <code><nowiki><entry></nowiki></code> <code><nowiki><author></nowiki></code> if present and if not the <code><nowiki><feed></nowiki></code> <code><nowiki><author></nowiki></code>, for RSS the <code><nowiki><author></nowiki></code> inside the containing <code><nowiki><item></nowiki></code> element.<br />
<br />
'''dtreviewed''':: This optional field when present MUST provide an ISO8601 absolute date time of when the review was written or otherwise authored. This field SHOULD use UTC, but MAY use the time zone offset syntax. If dtreviewed is absent from the hReview, then look outside the hReview, in the surrounding context. If the context is an [[hatom|hAtom]] entry, use its "published" (or "updated" if that is missing) datetime as the dtreviewed, if not present on the entry, use the "published" (or "updated" if that is missing) of the feed. Otherwise use the creation date (or modified date if that is missing) information according to the containing document language (e.g. "published"/"updated" similarly for Atom feeds), then protocol (e.g. HTTP Last-Modified, or file system last modified datetime) as the dtreviewed.<br />
<br />
'''rating''':: The rating is a fixed point integer (one decimal point of precision) from 1.0 to 5.0 inclusive indicating a rating for the item, higher indicating a better rating by default. Optionally a different integral "worst" value and/or "best" value MAY be specified to indicate a different range (e.g. 6 from 0-10). The "best" value may be numerically smaller than the "worst" value.<br />
<br />
'''description''':: This optional field contains the full text representing the written opinion of the reviewer. The field MAY include valid XHTML markup (e.g. paragraphs). User agents SHOULD preserve any markup. Multiple descriptions or section descriptions (e.g. pros and cons, plusses and minusses) SHOULD be included in the description field.<br />
<br />
'''tags''':: Tags are represented using a list of keywords or phrases (using the [[rel-tag]] microformat for each individual keyword or phrase tag) that the reviewer associates with the item. The reviewer MAY optionally provide a tag-specific rating inside each [[rel-tag]], e.g. ambience:5. Tag-specific ratings by default use the same range as an overall rating for the item if present, and MAY also have a custom worst...best range specified. Authors MAY also invert this structure for the same semantic if it is more convenient for their markup, that is, place the [[rel-tag]] inside a rating to indicate a rated tag. Note: rated tags should ideally use a tag space that explains what the ratings for that tag mean. E.g. Food:18/30 should link to a tags space for Food that explains what an 18 out of 30 means for the Food tag.<br />
<br />
'''permalink''':: This optional field is a URL for the hReview. In addition to using the <code><a href></code> tag for this field, the attribute <code>rel="self bookmark"</code> MUST be used to indicate that the hyperlink is a permalink for the review itself. If the hyperlink already contains a <code>rel</code> attribute, then the values <code>self</code> and <code>bookmark</code> MUST be included among the space-separated set of values in the attribute. Indexers MAY treat the permalink of a review as a unique ID in order to identify and collate the same review from multiple sources (such as indexing a page multiple times). The permalink MAY also be used to indicate or imply the origin of the review. Authors MAY use the classname of "permalink" on the element representing the permalink, but are not required to do so.<br />
<br />
'''license''':: This optional field links to the license under which the contents of the hReview itself is licensed, using the '''[[rel-license]]''' microformat.<br />
<br />
<br />
The following field names have been reused from the [[hcard|hCard]] and [[hcalendar|hCalendar]] microformats: <code>version, summary, fn, url, photo, description</code>. In addition, items and reviewers described by hCards MAY contain any hCard field. The rel value "self" has been reused from the [http://atompub.org/2005/07/11/draft-ietf-atompub-format-10.html Atom 1.0 specification].<br />
<br />
=== More Semantic Equivalents ===<br />
<br />
For some properties there is a more semantic equivalent, and therefore they get special treatment, e.g.: <br />
<br />
* For any "url", use <code><a class="url" href="...">...</a></code> inside the element with the class name 'hreview' in hReview.<br />
* And for "photo", use <code><img class="photo" src="..." alt="Photo of ..." /></code> <br />
<br />
* Ratings are often presented either as a set of images or characters, e.g. "***". For these, the <code>&lt;abbr&gt;</code> element is particularly useful, as such characters are an abbreviation for the precise rating, e.g. <code>&lt;abbr class="rating" title="3.0"&gt;***&lt;/abbr&gt;</code>. This is further explored in the next section.<br />
<br />
==== Language ====<br />
* To explicitly convey the natural language that an hReview is written in, use the standard (X)HTML 'lang' attribute on the element with class="hreview", e.g. <code>&lt;div class="hreview" lang="en"&gt; ... &lt;/div&gt;</code> If portions of an hReview (e.g. the item name) are in a different language, use the 'lang' attribute on those portions.<br />
* hReview processors which need to handle the language of reviews MUST process the standard (X)HTML 'lang' attribute as specified.<br />
<br />
=== Human vs. Machine Readable ===<br />
If an <code>&lt;abbr></code> element is used for a property, then its '<code>title</code>' attribute is used for the value of the property, instead of the contents of the element, which can then be used to provide a user-friendly alternate presentation of the value. <br />
<br />
Similarly, if an <code><img /></code> element is used for one or more properties, it MUST be treated as follows: <br />
<br />
# For the "photo" property and any other property that takes a URL as its value, the <code>src="..."</code> attribute provides the property value. <br />
# For other properties, the <code><img /></code> element's '<code>alt</code>' attribute is the value of the property.<br />
<br />
=== Object Includes ===<br />
<br />
hReview 0.3 includes support for the object [[include-pattern]].<br />
<br />
Often a single page lists an item, and then several reviews for that item. In order to avoid having to repeat the item info for each review of the item, the first review should be marked up as an hReview, with a unique "id" attribute on the item info, and then following reviews should use the object [[include-pattern]] to include the item info from the first review.<br />
<br />
<br />
=== Notes ===<br />
This section is informative.<br />
<br />
* By marking up a review with the hReview microformat, the expectation is communicated that the review MAY be indexed. This has no impact on the copyright of the review itself which the publisher may explicitly specify using [[rel-license]] as specified above.<br />
* The enumerated list of item types is under development and may be extended.<br />
* Each type may have custom hReview fields that follow the common set.<br />
* Additional details about a particular item should be specified with the rest of the item's info at the URL provided for the item.<br />
* Most rating systems use the range 1.0 to 5.0, and most of those represent the rating as a number (and possibly half) of stars. Sites may use whatever graphic they wish to represent the rating.<br />
<br />
== Examples ==<br />
Here are a few examples of reviews from current web sites, and how they could be easily enhanced to support the hReview structured review microformat. <br />
<br />
Want to get started with writing an [[hreview|hReview]]? Use the [http://microformats.org/code/hreview/creator hReview creator] to write a review and publish it on your blog.<br />
<br />
=== Restaurant reviews ===<br />
<br />
Here is an example of a simple online restaurant review:<br />
<br />
<pre><nowiki><br />
<div><br />
<span>5 stars out of 5 stars</span><br />
<h4>Crepes on Cole is awesome</h4><br />
<span>Reviewer: <span>Tantek</span> - April 18, 2005</span><br />
<blockquote><p><br />
Crepes on Cole is one of the best little creperies in San Francisco. <br />
Excellent food and service. Plenty of tables in a variety of sizes <br />
for parties large and small. Window seating makes for excellent <br />
people watching to/from the N-Judah which stops right outside. <br />
I've had many fun social gatherings here, as well as gotten <br />
plenty of work done thanks to neighborhood WiFi.<br />
</p></blockquote><br />
<p>Visit date: <span>April 2005</span></p><br />
<p>Food eaten: <span>Florentine crepe</span></p><br />
</div><br />
</nowiki></pre><br />
<br />
Adding hReview to this review is quite simple:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><br />
<span><span class="rating">5</span> out of 5 stars</span><br />
<h4 class="summary">Crepes on Cole is awesome</h4><br />
<span class="reviewer vcard">Reviewer: <span class="fn">Tantek</span> - <br />
<abbr class="dtreviewed" title="20050418T2300-0700">April 18, 2005</abbr></span><br />
<div class="description item vcard"><p><br />
<span class="fn org">Crepes on Cole</span> is one of the best little <br />
creperies in <span class="adr"><span class="locality">San Francisco</span></span>.<br />
Excellent food and service. Plenty of tables in a variety of sizes <br />
for parties large and small. Window seating makes for excellent <br />
people watching to/from the N-Judah which stops right outside. <br />
I've had many fun social gatherings here, as well as gotten <br />
plenty of work done thanks to neighborhood WiFi.<br />
</p></div><br />
<p>Visit date: <span>April 2005</span></p><br />
<p>Food eaten: <span>Florentine crepe</span></p><br />
</div><br />
</nowiki></pre><br />
<br />
Note that some of the properties of this sample review are not captured by hReview (visit date, food eaten). This is deliberate per the scope of keeping hReview minimal and simple.<br />
<br />
This sample hReview could be rendered like this:<br />
<br />
5 stars out of 5 stars<br /><br />
'''Crepes on Cole is awesome'''<br /><br />
Reviewer: Tantek - April 18, 2005<br /><br />
<br />
Crepes on Cole is one of the best little creperies in San Francisco. Excellent food and service. Plenty of tables in a variety of sizes for parties large and small. Window seating makes for excellent people watching to/from the N-Judah which stops right outside. I've had many fun social gatherings here, as well as gotten plenty of work done thanks to neighborhood wifi.<br />
<br />
Visit date: April 2005<br /><br />
Food eaten: Florentine crepe<br /><br />
<br />
==== Multidimensional Restaurant Review ====<br />
Some restaurant reviews indicate ratings for different aspects of the restaurant. Such details are represented in hReview using tagged ratings. In addition, note the inline tags inside the description of this review.<br />
<br />
Here is one such review in text format:<br />
<br />
Cafe Borrone<br />
<br />
1010 El Camino Real, Menlo Park, CA 94025, +1-650-327-0830;<br />
cafeborrone.com<br />
<br />
Food: 18/30; Ambience: 19/30; Service: 15/30; Price: $$...<br />
<br />
This cafe is a welcoming oasis on the Peninsula. It even has a fountain<br />
outside which cloaks the nearby sounds of El Camino traffic. Next door to a <br />
superb indy bookstore, Cafe Borrone is an ideal spot to grab a coffee or a <br />
snack to accompany a newly purchased book or imported periodical. Soups and <br />
sandwich specials rotate daily. The corn chowder with croutons and big <br />
chunks of cheese goes especially well with a freshly toasted mini-baguette. <br />
Evenings are often crowded and may require sharing a table with a perfect <br />
stranger. Espresso afficionados will appreciate the Illy coffee. Noise <br />
levels can vary from peaceful in the late mornings to nearly overwhelming on <br />
jazz band nights.<br />
<br />
As an hReview:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><br />
<div class="item vcard"><br />
<div class="fn org summary">Cafe Borrone</div><br />
<span class="adr"><br />
<span class="street-address">1010 El Camino Real</span>,<br />
<span class="locality">Menlo Park</span>,<br />
<span class="region">CA</span><br />
<span class="postal-code">94025</span>,<br />
</span><br />
<span class="tel">+1-650-327-0830</span>;<br />
<a class="url" href="http://cafeborrone.com">cafeborrone.com</a><br />
</div><br />
<ul><br />
<li class="rating"><a href="http://en.wikipedia.org/wiki/Food" rel="tag"><br />
Food: <span class="value">18</span>/<span class="best">30</span></a>;</li><br />
<li class="rating"><a href="http://flickr.com/photos/tags/Ambience" rel="tag"><br />
Ambience: <span class="value">19</span>/<span class="best">30</span></a>;</li><br />
<li class="rating"><a href="http://en.wikipedia.org/wiki/Service" rel="tag"><br />
Service: <span class="value">15</span>/<span class="best">30</span></a>;</li><br />
<li class="rating"><a href="http://en.wikipedia.org/wiki/Price" rel="tag"><br />
Price: <abbr class="value" title="2">$$</abbr>...</a></li><br />
</ul><br />
<div class="description"><p><br />
This <abbr class="type" title="business"><br />
<a href="http://en.wikipedia.org/wiki/cafe" rel="tag">cafe</a></abbr> <br />
is a welcoming oasis on the Peninsula. <br />
It even has a fountain outside which nearly eliminates <br />
the sounds of El Camino traffic. Next door to a superb indy bookstore, <br />
Cafe Borrone is an ideal spot to grab a <br />
<a href="http://en.wikipedia.org/wiki/coffee" rel="tag">coffee</a> <br />
or a meal to accompany a newly purchased book or imported periodical. <br />
<a href="http://technorati.com/tag/soup" rel="tag">Soups</a> and <br />
<a href="http://technorati.com/tag/sandwich" rel="tag">sandwich</a> <br />
specials rotate daily. The corn chowder with croutons and big chunks of cheese <br />
goes especially well with a freshly toasted mini-baguette. Evenings are <br />
often crowded and may require sharing a table with a perfect stranger. <br />
<a href="http://flickr.com/photos/tags/espresso" rel="tag">Espresso</a> <br />
afficionados will appreciate the <br />
<a href="http://en.wikipedia.org/wiki/Illy" rel="tag">Illy</a> coffee. <br />
Noise levels can vary from peaceful in the late mornings to nearly overwhelming on <br />
<a href="http://en.wikipedia.org/wiki/jazz" rel="tag">jazz</a> band nights.<br />
</p></div><br />
Review (<a href="http://microformats.org/wiki/hreview"> <br />
hReview v<span class="version">0.3</span></a>)<br />
by <span class="reviewer vcard"><span class="fn">anonymous</span></span>, <br />
<abbr class="dtreviewed" title="20050428T2130-0700">April 28th, 2005</abbr>.<br />
</div><br />
</nowiki></pre><br />
<br />
With an accompanying CSS style sheet like:<br />
<br />
<pre><nowiki><br />
a.url { display:block }<br />
ul { margin:1em 0; padding:0 }<br />
ul li { display:inline }<br />
</nowiki></pre><br />
<br />
This hReview could be presented similar to the original text:<br />
<br />
Cafe Borrone<br /><br />
1010 El Camino Real, Menlo Park, CA 94025, +1-650-327-0830;<br /><br />
[http://cafeborrone.com/ cafeborrone.com]<br /><br />
<br /><br />
[http://en.wikipedia.org/wiki/Food Food: 18/30];<br />
[http://flickr.com/photos/tags/Ambience Ambience: 19/30];<br />
[http://en.wikipedia.org/wiki/Service Service: 15/30];<br />
[http://en.wikipedia.org/wiki/Price Price: $$...]<br /><br />
<br />
This [http://en.wikipedia.org/wiki/cafe cafe] is a welcoming oasis on the Peninsula. It even has a fountain outside which cloaks the nearby sounds of El Camino traffic. Next door to a superb indy bookstore, Cafe Borrone is an ideal spot to grab a [http://en.wikipedia.org/wiki/coffee coffee] or a snack to accompany a newly purchased book or imported periodical. [http://technorati.com/tag/soup Soups] and [http://technorati.com/tag/sandwich sandwich] specials rotate daily. The corn chowder with croutons and big chunks of cheese goes especially well with a freshly toasted mini-baguette. Evenings are often crowded and may require sharing a table with a perfect stranger. [http://flickr.com/photos/tags/espresso Espresso] afficionados will appreciate the [http://en.wikipedia.org/wiki/Illy Illy] coffee. Noise levels can vary from peaceful in the late mornings to nearly overwhelming on [http://en.wikipedia.org/wiki/jazz jazz] band nights.<br />
<br />
Review ([http://microformats.org/wiki/hreview hReview v0.3]) by anonymous, April 28th, 2005.<br />
<br />
=== Product review ===<br />
Here is an example of a product review:<br />
<br />
<pre><nowiki><br />
<div><br />
<a href="http://www.amazon.com/exec/obidos/ASIN/B000089CJI/"><br />
<img src="http://images.amazon.com/images/P/B000089CJI.01._SCTHUMBZZZ_.jpg" <br />
alt="Album cover photo: The Postal Service: Give Up." /><br />
The Postal Service: Give Up</a><br />
<blockquote><p><br />
"The people thought they were just being rewarded for treating others <br />
as they like to be treated, for obeying stop signs and curing diseases, <br />
for mailing letters with the address of the sender... Don't wake me, <br />
I plan on sleeping in..."<br />
</p><p><br />
"Nothing Better" is a great track on this album, too... <br />
</p></blockquote><br />
(*****)<br />
</div><br />
</nowiki></pre><br />
<br />
Adding hReview to this review is also quite simple, but in this case requires a few more elements for the rating and reviewer which are required by hReview:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><span class="item"><br />
<a class="url fn" href="http://www.amazon.com/exec/obidos/ASIN/B000089CJI/"><br />
<img src="http://images.amazon.com/images/P/B000089CJI.01._SCTHUMBZZZ_.jpg" <br />
alt="Album cover photo: The Postal Service: Give Up. " <br />
class="photo" /><br />
The Postal Service: Give Up</a></span><br />
<div class="description"><p><br />
"The people thought they were just being rewarded for treating others <br />
as they like to be treated, for obeying stop signs and curing diseases, <br />
for mailing letters with the address of the sender... Don't wake me, <br />
I plan on sleeping in..."<br />
</p><p><br />
"Nothing Better" is a great track on this album, too... <br />
</p></div><br />
(<abbr class="rating" title="5">*****</abbr>)<br />
<p class="reviewer vcard">Review by <br />
<a class="url fn" href="http://ifindkarma.com/blog/">Adam Rifkin</a>, <br />
<abbr class="dtreviewed" title="200502">February 2005</abbr><br />
</p><br />
</div><br />
</nowiki></pre><br />
<br />
And this hReview might be presented like this:<br />
<br />
<br />
[Album cover photo: ]<br />
[The Postal Service:]<br />
[ Give Up ]<br />
<br />
The Postal Service: Give Up<br />
<br />
"The people thought they were just being rewarded for treating others as they like to be treated, for obeying stop signs and curing diseases, for mailing letters with the address of the sender... Don't wake me, I plan on sleeping in..."<br />
<br />
"Nothing Better" is a great track on this album, too...<br />
<br />
(*****)<br />
<br />
Review by Adam Rifkin, February 2005.<br />
<br />
=== Movie Review ===<br />
Finally, here is an example of a movie review.<br />
<br />
<pre><nowiki><br />
<div><br />
<span>anonymous, April 18th, 2005</span><br />
<div><br />
<a lang="zh" href="http://www.imdb.com/title/tt0299977/"><br />
Ying Xiong (<span lang="en">HERO</span>)<br />
</a><br />
</div><br />
<div>Rating: 4 out of 5</div><br />
<blockquote><p><br />
This movie has great visuals and music.<br />
</p></blockquote><br />
</div><br />
</nowiki></pre><br />
<br />
With hReview:<br />
<br />
<pre><nowiki><br />
<div class="hreview"><br />
<span class="reviewer vcard"><br />
<span class="fn">anonymous</span>, <br />
<abbr class="dtreviewed" title="20050418">April 18th, 2005</abbr><br />
</span><br />
<div class="item"><br />
<a lang="zh" class="url fn" href="http://www.imdb.com/title/tt0299977/"><br />
Ying Xiong (<span lang="en">HERO</span>)<br />
</a><br />
</div><br />
<div>Rating: <span class="rating">4</span> out of 5</div><br />
<div class="description"><p><br />
This movie has great music and visuals.<br />
</p></div><br />
</div><br />
</nowiki></pre><br />
<br />
Which could be presented like this:<br />
<br />
anonymous, April 18th, 2005<br /><br />
Ying Xiong (HERO)<br /><br />
Rating: 4 out of 5<br /><br />
<br />
This movie has great music and visuals.<br />
<br />
== Examples in the wild ==<br />
This section is '''informative'''. The number of hReview examples in the wild has expanded far beyond the capacity of being kept inline in this specification. They have been moved to a [[hreview-examples-in-wild|separate page]].<br />
<br />
See [[hreview-examples-in-wild|hReview Examples in the wild]].<br />
<br />
== Implementations ==<br />
This section is '''informative'''. The number of hReview implementations has also expanded beyond the capacity of keeping them inline. They have been moved to a [[hreview-implementations|separate page]].<br />
<br />
See [[hreview-implementations|hReview Implementations]].<br />
<br />
== References ==<br />
=== Normative References ===<br />
* [http://www.w3.org/TR/2002/REC-xhtml1-20020801/ XHTML 1.0 SE]<br />
* [http://gmpg.org/xmdp/ XMDP]<br />
* [[hcard|hCard]]<br />
* [[hcalendar|hCalendar]]<br />
* [[rel-tag]]<br />
* [http://www.ietf.org/rfc/rfc2119.txt RFC2119]<br />
* [http://www.ietf.org/rfc/rfc3986.txt RFC3986]<br />
* [http://www.ietf.org/rfc/rfc4287.txt RFC4287] (Atom 1.0)<br />
<br />
=== Informative References ===<br />
* [http://www.w3.org/TR/REC-CSS1 CSS1]<br />
* ISO.8601.1988<br />
** International Organization for Standardization, "Data elements and interchange formats - Information interchange - Representation of dates and times", ISO Standard 8601, June 1988.<br />
* [http://www.w3.org/TR/1998/NOTE-datetime-19980827 W3C NOTE-datetime-19980827]<br />
* [http://www.ietf.org/rfc/rfc3667.txt RFC3667]<br />
* [http://www.ietf.org/rfc/rfc3668.txt RFC3668]<br />
* [http://www.w3.org/Consortium/Patent-Policy-20040205/ W3C Patent Policy]<br />
* [http://local.yahoo.com/details?id=21359628 Crepes on Cole reviews on Yahoo! Local]<br />
* Other reviews efforts. See [[reviews-formats]].<br />
* Contributed from http://developers.technorati.com/wiki/hReview.<br />
<br />
==== Similar Work ====<br />
* [[hlisting-proposal|hListing]]<br />
* [[xoxo|XOXO]]<br />
<br />
=== Copyright ===<br />
{{MicroformatCopyrightStatement2005}}<br />
<br />
=== Patents ===<br />
{{MicroFormatPatentStatement}}<br />
<br />
== Work in progress ==<br />
This specification is a work in progress. As additional aspects are discussed, understood, and written, they will be added. <br />
<br />
=== Changes from v0.2 ===<br />
The following changes have been made in hReview v0.3 over [[hreview-v0.2|hReview v0.2]]:<br />
<br />
Normative changes:<br />
# MUST (instead of SHOULD) use [[hcard|hCard]] for the item description of a business or person<br />
# "reviewer" changes<br />
## Made reviewer *optional* per feedback from Ryan King and Mark Nottingham<br />
## If reviewer is absent from the hReview, then look outside the hReview, in the context of the page, for the reviewer. If there is no "reviewer" outside either, then use the author information according to the containing document language (e.g. <code><nowiki><address></nowiki></code> for (X)HTML pages) as the reviewer.<br />
## MUST (instead of SHOULD) use [[hcard|hCard]] to represent reviewer information<br />
# "dtreviewed" changes<br />
## Made dtreviewed *optional* per feedback from Ryan King and Mark Nottingham<br />
## If dtreviewed is absent from the hReview, then look outside the hReview, in the surrounding context. If the context is an [[hatom|hAtom]] entry, use its "published" (or "updated" if that is missing) datetime as the dtreviewed, if not present on the entry, use the "published" (or "updated" if that is missing) of the feed. Otherwise use the information according to the containing document language (e.g. "published"/"updated" similarly for Atom feeds), then protocol (e.g. HTTP Last-Modified, or file system last modified datetime).<br />
# SHOULD use [[hcalendar|hCalendar]] to represent an item of 'type' 'event'<br />
# Added one decimal digit of precision to ratings' numerical values based on publisher experience.<br />
# Use [http://microformats.org/wiki/hcard#Value_excerpting the "value" construct from hCard] (as it is used in "tel" properties for example) to more explicitly markup the rating value when also providing (marking up) the best/worst of a rating.<br />
# Added [[rel-license]] to indicate the license of the hReview as a whole.<br />
# Permit tags inside ratings to denote rated tags, the same as ratings inside tags per suggestion from Eran Globen.<br />
# Add [[include-pattern]] support to allow multiple reviews for the same item to not repeat the item info.<br />
<br />
Informative changes (several, but in particular):<br />
# Note that scalar/rated tags would ideally use a tag space that explain the ratings for that tag. E.g. to explain what Food:18/30 means.<br />
# Updated examples accordingly.<br />
<br />
== Further Reading ==<br />
* See also [http://www.technorati.com/cosmos/referer.html blogs discussing this page].<br />
<br />
== Related Pages ==<br />
{{hreview-related-pages}}</div>Adminihttps://microformats.org/wiki/index.php?title=hatom&diff=13702hatom2007-02-23T12:12:17Z<p>Admini: /* Implementations */</p>
<hr />
<div><h1> hAtom 0.1 </h1><br />
<br />
hAtom is a microformat for content that can be syndicated, primarily but not exclusively weblog postings. hAtom is based on a subset of the [http://www.atomenabled.org/ Atom] syndication format. hAtom is one of several [[microformats]] open standards.<br />
<br />
__TOC__<br />
== Draft Specification ==<br />
<br />
=== Editor/Author ===<br />
* [http://blogmatrix.blogmatrix.com/ David Janes], [http://www.blogmatrix.com BlogMatrix, Inc.]<br />
<br />
=== Contributors ===<br />
* [http://members.optusnet.com.au/benjamincarlyle/benjamin/blog/ Benjamin Carlyle]<br />
* [http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc.]<br />
<br />
=== Copyright ===<br />
{{MicroFormatCopyrightStatement2005}}<br />
<br />
=== Patents ===<br />
{{MicroFormatPatentStatement}}<br />
<br />
== Introduction ==<br />
<br />
hAtom is a [[microformat]] for identifying semantic information in weblog posts and practically any other place [http://www.atomenabled.org/ Atom] may be used, such as news articles. hAtom content is easily added to most blogs by simple modifications to the blog's template definitions.<br />
<br />
== Semantic XHTML Design Principles ==<br />
{{semantic-xhtml-design-principles}}<br />
<br />
== Format ==<br />
=== In General ===<br />
The [http://atomenabled.org/developers/syndication/#person Atom Syndication Format] provides the conceptual basis for this microformat, with the following caveats:<br />
<br />
* Atom provides a lot more functionality than we need for a "blog post" microformat, so we've taken the minimal number of elements needed.<br />
* the "logical" model of hAtom is that of Atom. If there is a conflict, Atom should be taken as correct.<br />
* the "physical" model of hAtom -- the actual writing of elements -- is a lot more varied than Atom provides for, due to the variety of ways weblogs are actually produced in the wild. The hAtom microformat provides a number of rules for "bridging the gap"<br />
<br />
=== Schema ===<br />
Schema elements are based on the Atom nomenclature and follow the microformat pattern of prefixing a unique identifier (in this case, '<code>h</code>') on the outermost container elements -- the Feed or Entry. The parts of this microformat are based on analysis of many weblog, bulletin board and media posts and can be read [[blog-post-brainstorming#Discovered_Elements]].<br />
<br />
The hAtom schema consists of the following:<br />
<br />
* hfeed ('''<code>hfeed</code>'''). optional.<br />
* hentry ('''<code>hentry</code>'''). <br />
** '''<code>entry-title</code>'''. required. text.<br />
** '''<code>entry-content</code>'''. optional (see field description). text.<br />
** '''<code>entry-summary</code>'''. optional. text.<br />
** '''<code>updated</code>'''. required using [[datetime-design-pattern]].<br />
** '''<code>published</code>'''. optional using [[datetime-design-pattern]].<br />
** '''<code>author</code>'''. required using '''[[hcard|hCard]]'''.<br />
** '''<code>bookmark</code>''' (permalink). optional, using '''[[rel-bookmark]]'''.<br />
** tags. optional. keywords or phrases, using '''[[rel-tag]]'''.<br />
<br />
Some required elements have defaults if missing, see below.<br />
<br />
=== Field and Element Details ===<br />
<br />
===== Feed =====<br />
* a Feed element is identified by the class name <code>hfeed</code><br />
* a Feed element represents the concept of an [http://www.atomenabled.org/developers/syndication/atom-format-spec.php#rfc.section.4.1.1 Atom feed]<br />
* the Feed element is optional and, if missing, is assumed to be the page<br />
* hAtom documents MAY have multiple Feed elements<br />
<br />
===== Feed Category =====<br />
* a Feed Category element is identified by [[rel-tag]]<br />
* a Feed MAY have a Feed Category<br />
* a Feed Category element represents the concept of an [http://www.atomenabled.org/developers/syndication/atom-format-spec.php#rfc.section.4.2.2 Atom category] inside a [http://www.atomenabled.org/developers/syndication/#optionalFeedElements feed]<br />
* Feed Category elements MUST appear inside a Feed element but not inside an Entry element<br />
* the [[rel-tag]] <code>href</code> encodes the atom <code>category:term</code>; the link text defines the atom <code>category:label</code><br />
<br />
===== Entry =====<br />
* an Entry element is identified by class name <code>hentry</code><br />
* an Entry element represents the concept of an [http://www.atomenabled.org/developers/syndication/atom-format-spec.php#rfc.section.4.1.2 Atom entry]<br />
* any microformat content inside a <code>&lt;blockquote></code> or <code>&lt;q></code> element within the Entry should not be considered part of the Entry.<br />
: ''This allows quoting other microformated data without worry of corrupting the model''<br />
<br />
===== Entry Category =====<br />
* an Entry Category element is identified by [[rel-tag]]<br />
* an Entry MAY have an Entry Category<br />
* an Entry Category element represents the concept of an [http://www.atomenabled.org/developers/syndication/atom-format-spec.php#rfc.section.4.2.2 Atom category] inside an [http://www.atomenabled.org/developers/syndication/#optionalEntryElements entry]<br />
* the [[rel-tag]] <code>href</code> encodes the atom <code>category:term</code>; the link text defines the atom <code>category:label</code><br />
<br />
===== Entry Title =====<br />
* an Entry Title element is identified by the class name <code>entry-title</code><br />
* an Entry SHOULD have an Entry Title<br />
* an Entry Title element represents the concept of an [http://www.atomenabled.org/developers/syndication/atom-format-spec.php#rfc.section.4.2.14 Atom entry title]<br />
* if the Entry Title is missing, use<br />
** the first <code>&lt;h#></code> element in the Entry, or<br />
** the <code>&lt;title></code> of the page, if there is no enclosing Feed element, or<br />
** assume it is the empty string<br />
<br />
===== Entry Content =====<br />
* an Entry Content element is identified by class name <code>entry-content</code><br />
* an Entry SHOULD have Entry Content<br />
* an Entry Content element represents the concept of an [http://www.atomenabled.org/developers/syndication/atom-format-spec.php#atomContent Atom content]<br />
* an Entry MAY have 0 or more Entry Content elements. The "logical Entry Content" of an Entry is the concatenation, in order of appearance, of all the Entry Contents within the Entry<br />
: ''Many weblogs split content into multiple sections with a "Read More" link and javascript tricks. This is also needed in cases where Entry Titles are coded inline and are considered part of the content.''<br />
* if the Entry Content is missing, assume it is the empty string<br />
<br />
===== Entry Summary =====<br />
* an Entry Summary element is identified by class name <code>entry-summary</code><br />
* an Entry Summary element represents the concept of an [http://www.atomenabled.org/developers/syndication/atom-format-spec.php#rfc.section.4.2.13 Atom summary]<br />
* an Entry MAY have 0 or more Entry Summary elements. The "logical Entry Summary" of an Entry is the concatenation, in order of appearance, of all the Entry Summarys within the Entry<br />
<br />
===== Entry Permalink =====<br />
* an Entry Permalink element is identified by [[rel-bookmark]]<br />
* an Entry SHOULD have an Entry Permalink<br />
* an Entry Permalink element represents the concept of an [http://www.atomenabled.org/developers/syndication/atom-format-spec.php#rfc.section.4.2.7 Atom link in an entry]<br />
* if the Entry Permalink is missing, use the URI of the page; if the Entry has an "id" attribute, add that as a fragment to the page URI to distinguish individual entries<br />
<br />
===== Entry Updated =====<br />
* an Entry Updated element is identified by class name <code>updated</code><br />
* an Entry Updated element represents the concept of [http://www.atomenabled.org/developers/syndication/atom-format-spec.php#rfc.section.4.2.15 Atom updated]<br />
* an Entry SHOULD have an Entry Updated element<br />
* use the [[datetime-design-pattern]] to encode the updated datetime<br />
* if there is no Entry Updated element,<br />
** use the Entry Published element, if present<br />
** otherwise the page is invalid hAtom<br />
<br />
===== Entry Published =====<br />
* an Entry Published element is identified by the class name <code>published</code><br />
* an Entry Published element represents the concept of [http://www.atomenabled.org/developers/syndication/atom-format-spec.php#rfc.section.4.2.9 Atom published]<br />
* use the [[datetime-design-pattern]] to encode the published datetime<br />
<br />
===== Entry Author =====<br />
* an Entry Author element is represented by class name <code>author</code><br />
* an Entry Author element represents the concept of an [http://www.atomenabled.org/developers/syndication/atom-format-spec.php#rfc.section.4.2.1 Atom author]<br />
* an Entry Author element MUST be encoded in an [[hcard|hCard]]<br />
* an Entry Author element SHOULD be encoded in an <code>&lt;address></code> element<br />
* an Entry SHOULD have at least one Entry Author element<br />
* an Entry MAY have more than one Entry Author elements<br />
* if the Entry Author is missing<br />
** find the [[algorithm-nearest-in-parent|Nearest In Parent]] <code>&lt;address></code> element(s) with class name <code>author</code> and that is/are a valid [[hcard|hCard]]<br />
** otherwise the entry is invalid hAtom<br />
<br />
=== XMDP Profile ===<br />
<pre><br />
<dl class="profile"><br />
<dt>class</dt><br />
<dd><p><br />
<a rel="help" href="http://www.w3.org/TR/html401/struct/global.html#adef-class"><br />
HTML4 definition of the 'class' attribute.</a><br />
This meta data profile defines some 'class' attribute values (class names) <br />
and their meanings as suggested by a <br />
<a href="http://www.w3.org/TR/WD-htmllink-970328#profile"><br />
draft of "Hypertext Links in HTML"</a>.<br />
<dl><br />
<dt>hfeed</dt><br />
<dd><br />
The concept of atom:feed from <br />
<a href="http://www.atomenabled.org/developers/syndication/atom-format-spec.php">The Atom Syndication Format</a>, <br />
constrained and modified as per the <a href="http://microformats.org/wiki/hatom">hAtom microformat spec</a>.<br />
</dd><br />
<dt>hentry</dt><br />
<dd><br />
The concept of atom:entry from <br />
<a href="http://www.atomenabled.org/developers/syndication/atom-format-spec.php">The Atom Syndication Format</a>, <br />
constrained and modified as per the <a href="http://microformats.org/wiki/hatom">hAtom microformat spec</a>.<br />
</dd><br />
<dt>entry-title</dt><br />
<dd><br />
The concept of atom:title inside of an atom:entry from <br />
<a href="http://www.atomenabled.org/developers/syndication/atom-format-spec.php">The Atom Syndication Format</a>, <br />
constrained and modified as per the <a href="http://microformats.org/wiki/hatom">hAtom microformat spec</a>.<br />
</dd><br />
<dt>entry-content</dt><br />
<dd><br />
The concept of atom:content from <br />
<a href="http://www.atomenabled.org/developers/syndication/atom-format-spec.php">The Atom Syndication Format</a>, <br />
constrained and modified as per the <a href="http://microformats.org/wiki/hatom">hAtom microformat spec</a>.<br />
</dd><br />
<dt>entry-summary</dt><br />
<dd><br />
The concept of atom:summary from <br />
<a href="http://www.atomenabled.org/developers/syndication/atom-format-spec.php">The Atom Syndication Format</a>, <br />
constrained and modified as per the <a href="http://microformats.org/wiki/hatom">hAtom microformat spec</a>.<br />
</dd><br />
<dt>bookmark</dt><br />
<dd><br />
The concept of atom:link (without any "rel") with an atom:entry from <br />
<a href="http://www.atomenabled.org/developers/syndication/atom-format-spec.php">The Atom Syndication Format</a>, <br />
constrained and modified as per the <a href="http://microformats.org/wiki/hatom">hAtom microformat spec</a>.<br />
</dd><br />
<dt>published</dt><br />
<dd><br />
The concept of atom:published from <br />
<a href="http://www.atomenabled.org/developers/syndication/atom-format-spec.php">The Atom Syndication Format</a>, <br />
constrained and modified as per the <a href="http://microformats.org/wiki/hatom">hAtom microformat spec</a>.<br />
</dd><br />
<dt>updated</dt><br />
<dd><br />
The concept of atom:updated from <br />
<a href="http://www.atomenabled.org/developers/syndication/atom-format-spec.php">The Atom Syndication Format</a>, <br />
constrained and modified as per the <a href="http://microformats.org/wiki/hatom">hAtom microformat spec</a>.<br />
</dd><br />
<dt>author</dt><br />
<dd><br />
The concept of atom:author from <br />
<a href="http://www.atomenabled.org/developers/syndication/atom-format-spec.php">The Atom Syndication Format</a>, <br />
constrained and modified as per the <a href="http://microformats.org/wiki/hatom">hAtom microformat spec</a>.<br />
</dd><br />
</dl><br />
</dd><br />
</dl><br />
</pre><br />
<br />
== Examples ==<br />
<br />
See [[hatom-examples]].<br />
<br />
== Examples in the wild ==<br />
This section is '''informative'''.<br />
<br />
The following sites have implemented hAtom , and thus are a great place to start for anyone looking for examples "in the wild" to try parsing, indexing, organizing etc. If your site marked up with hAtom, feel free to add it to the top of this list. Once the list grows too big, we'll make a separate wiki page.<br />
<br />
=== 0.1 hAtom examples===<br />
* [http://www.volume.co.uk Volume] - Main news page is marked up as hAtom 0.1 <br />
* [http://yedda.com Yedda] - Yedda support hAtom on exploration of questions where there is also support for Atom and RSS feeds. ([http://yedda.com/questions/recent/ example])<br />
* The [http://www.westmidlandbirdclub.com/ West Midland Bird Club's] frequently-updated [http://www.westmidlandbirdclub.com/new.htm What's New] page, [http://www.westmidlandbirdclub.com/ladywalk/latest.htm news from its Ladywalk Reserve] and [http://www.westmidlandbirdclub.com/worcs/grimley/latest.htm news from Grimley Pits] &mdash; comments welcome on my talk page [[User:AndyMabbett|Andy Mabbett]]<br />
* [http://pixelsebi.com pixelsebi's repository] uses hAtom 0.1 for blog posts (and hCard, hCalendar, XFN, xFolk and many more) based on manual WordPress template modifications<br />
* [http://www.geekinthepark.co.uk Geek in the Park] uses hAtom for the comments. -- by [[User:Trovster|trovster]]<br />
* [http://www.csarven.ca Sarven Capadisli] uses hAtom for the articles and comments -- by [[User:Csarven|csarven]]<br />
* [http://www.fberriman.com fberriman.com] uses hAtom 0.1 for blog posts (WordPress loop) and hCard throughout -- by [[User:Phae|Frances Berriman]] (Also - [http://www.fberriman.com/?p=86 Implementing hAtom: The Entries Code])<br />
* [http://www.capital.edu Capital University] uses hAtom 0.1 to mark up the feed of latest posts by student bloggers on its home page.<br />
* [http://blog.davidjanes.com Ranting and Roaring] (David Janes)<br />
* [http://ChunkySoup.net/ ChunkySoup.net] has redesigned using hAtom 0.1 and hCards on the entire site -- by [[User:ChrisCasciano|Chris Casciano]]<br />
* [http://sedna.spip.org/sedna/ Sedna RSS] (a feed aggregator based on SPIP, by Fil, IZO and others; GPLd sources are available at [http://zone.spip.org/trac/spip-zone/browser/_squelettes_/sedna SPIP-Zone])<br />
* [http://members.optusnet.com.au/benjamincarlyle/benjamin/blog/ Sound Advice] (Benjamin Carlyle)<br />
* [http://quotedprintable.com/pages/scribbish Scribbish] is a Typo theme which uses hAtom.<br />
* [http://rbach.priv.at/hAtom2Atom/Changelog/ hAtom2Atom.xsl's Changelog] is published as hAtom and Atom.<br />
* [http://federali.st/ federali.st]'s webbed Federalist Papers are each marked up in hAtom.<br />
* [http://www.plaintxt.org/themes/sandbox/ Sandbox] is a theme for [http://wordpress.org/ WordPress] that uses hAtom. <br />
** The theme is also available to accounts on the [http://wordpress.com/ <username>.wordpress.com] hosting service. The [http://blog.coworking.info Coworking] and [http://barcamp.wordpress.com BarCamp] blogs are examples of custom Sandbox themes.<br />
* [http://www.whump.com/dropbox/Strangelove.zip Strangelove] is a modification of the default WordPress theme (Kubrick) with hAtom support. <br />
** It points to the hAtom2Atom proxy service as the link for syndication feeds.<br />
<br />
===Examples with some problems===<br />
<br />
Entries may be moved here if there's a problem with the way hAtom is used on the page concerned. If the page is yours, and you want to improve it, see the [[hatom-faq|hAtom FAQ]], or raise any queries on [[hatom-issues|hAtom Issues]] or [[mailing-lists#microformats-discuss|the mailing list]], where people will be happy to help you. <br />
<br />
* [http://www.joomlamug.com Joomla! Melbourne User Group] uses hAtom combined with hCard for articles. <br />
**No examples on cited page. [[User:AndyMabbett|Andy Mabbett]]<br />
<br />
==== Pre 0.1 hAtom examples====<br />
These pages conform to an older draft standard and need to be updated.<br />
<br />
* [http://www.myelin.co.nz/post/ Second p0st] (Phil Pearson)<br />
<br />
== Implementations ==<br />
<br />
This section is '''informative'''.<br />
<br />
The following implementations have been developed which either generate or parse hAtom links. If you have an hAtom implementation, feel free to add it to the top of this list. Once the list grows too big, we'll make a separate wiki page.<br />
<br />
* [http://dichotomize.com/uf/hatom/creator.html hAtom Creator] modified from the other creators by BenWest.<br />
* the [http://glavmedtop.blogspot.com/extract/ Almost Universal Microformat Parser] can extract hAtom content from webpages ([http://tools.blogmatrix.com/extract/?uri=http%3A%2F%2Fblog.davidjanes.com&microformat=hatom&submit=Submit example])<br />
* the [http://tipatraf.blogspot.com/tools/greasemonkey/microformat-action.user.js microformat-action] [[greasemonkey|Greasemonkey]] script detects hAtom content on webpages and will call the [http://tools.blogmatrix.com/extract/ Almost Universal Microformat Parser]<br />
* [http://rbach.priv.at/hAtom2Atom/ hAtom2Atom.xsl] transforms hAtom to Atom (as the name suggests.)<br />
* There is now an [http://www.lukearno.com/projects/hatom2atom/ hatom2atom proxy] that uses hAtom2Atom.xsl.<br />
* [http://placenamehere.com/article/185/SubscribingTohAtomFeedsWithNetNewsWire Subscribe To hAtom] is a script that provides [http://ranchero.com/netnewswire/ NetNewsWire 2.x] users with the ability to subscribe to hAtom documents as they would any other feed. by [[User:ChrisCasciano|Chris Casciano]].<br />
* [http://boxtheweb.mihopa.net/code/apis/#outlineclasses Outline Classes] - has GPL'ed PHP code for reading hAtom<br />
* [http://boxtheweb.4x2.net/ BoxtheWeb] - supports subscribing to hAtom as a feed format<br />
<br />
== References ==<br />
=== Normative References ===<br />
* [http://www.w3.org/TR/2002/REC-xhtml1-20020801/ XHTML 1.0 SE]<br />
* [http://www.ietf.org/rfc/rfc4287 RFC4287: The Atom Syndication Format]<br />
* [[hcard-parsing]]<br />
<br />
=== Informative References ===<br />
* [http://www.atomenabled.org/ atomenabled.org]<br />
<br />
== Work in progress ==<br />
This specification is a work in progress. As additional aspects are discussed, understood, and written, they will be added. There is a separate document where we are keeping our brainstorms and other explorations relating to hAtom:<br />
<br />
* [[blog-post-brainstorming|blog-post Brainstorming]]<br />
<br />
=== Version 0.1 ===<br />
<br />
Version 0.1 was released 28 February 2006.<br />
<br />
== Discussions ==<br />
<br />
* See [http://www.technorati.com/cosmos/referer.html blogs discussing this page].<br />
<br />
=== Q&A ===<br />
* If you have any questions about hAtom, check the [[hatom-faq|hAtom FAQ]], and if you don't find answers, add your questions!<br />
<br />
=== Issues ===<br />
* Please add any issues with the specification to the separate [[hatom-issues|hAtom issues]] document.<br />
<br />
==See Also==<br />
{{hatom-related-pages}}<br />
* [[rel-enclosure]] - how to semantically reference enclosures (e.g. podcasts) in hAtom<br />
* [[blog-post-brainstorming]]<br />
* [[blog-post-formats]]<br />
* [[blog-post-examples]]<br />
* [[blog-description-format]] - how to describe a blog (as opposed to the individual entries, which is what we're doing here)</div>Adminihttps://microformats.org/wiki/index.php?title=hatom&diff=13700hatom2007-02-23T09:27:37Z<p>Admini: /* Implementations */</p>
<hr />
<div><h1> hAtom 0.1 </h1><br />
<br />
hAtom is a microformat for content that can be syndicated, primarily but not exclusively weblog postings. hAtom is based on a subset of the [http://www.atomenabled.org/ Atom] syndication format. hAtom is one of several [[microformats]] open standards.<br />
<br />
__TOC__<br />
== Draft Specification ==<br />
<br />
=== Editor/Author ===<br />
* [http://blogmatrix.blogmatrix.com/ David Janes], [http://www.blogmatrix.com BlogMatrix, Inc.]<br />
<br />
=== Contributors ===<br />
* [http://members.optusnet.com.au/benjamincarlyle/benjamin/blog/ Benjamin Carlyle]<br />
* [http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc.]<br />
<br />
=== Copyright ===<br />
{{MicroFormatCopyrightStatement2005}}<br />
<br />
=== Patents ===<br />
{{MicroFormatPatentStatement}}<br />
<br />
== Introduction ==<br />
<br />
hAtom is a [[microformat]] for identifying semantic information in weblog posts and practically any other place [http://www.atomenabled.org/ Atom] may be used, such as news articles. hAtom content is easily added to most blogs by simple modifications to the blog's template definitions.<br />
<br />
== Semantic XHTML Design Principles ==<br />
{{semantic-xhtml-design-principles}}<br />
<br />
== Format ==<br />
=== In General ===<br />
The [http://atomenabled.org/developers/syndication/#person Atom Syndication Format] provides the conceptual basis for this microformat, with the following caveats:<br />
<br />
* Atom provides a lot more functionality than we need for a "blog post" microformat, so we've taken the minimal number of elements needed.<br />
* the "logical" model of hAtom is that of Atom. If there is a conflict, Atom should be taken as correct.<br />
* the "physical" model of hAtom -- the actual writing of elements -- is a lot more varied than Atom provides for, due to the variety of ways weblogs are actually produced in the wild. The hAtom microformat provides a number of rules for "bridging the gap"<br />
<br />
=== Schema ===<br />
Schema elements are based on the Atom nomenclature and follow the microformat pattern of prefixing a unique identifier (in this case, '<code>h</code>') on the outermost container elements -- the Feed or Entry. The parts of this microformat are based on analysis of many weblog, bulletin board and media posts and can be read [[blog-post-brainstorming#Discovered_Elements]].<br />
<br />
The hAtom schema consists of the following:<br />
<br />
* hfeed ('''<code>hfeed</code>'''). optional.<br />
* hentry ('''<code>hentry</code>'''). <br />
** '''<code>entry-title</code>'''. required. text.<br />
** '''<code>entry-content</code>'''. optional (see field description). text.<br />
** '''<code>entry-summary</code>'''. optional. text.<br />
** '''<code>updated</code>'''. required using [[datetime-design-pattern]].<br />
** '''<code>published</code>'''. optional using [[datetime-design-pattern]].<br />
** '''<code>author</code>'''. required using '''[[hcard|hCard]]'''.<br />
** '''<code>bookmark</code>''' (permalink). optional, using '''[[rel-bookmark]]'''.<br />
** tags. optional. keywords or phrases, using '''[[rel-tag]]'''.<br />
<br />
Some required elements have defaults if missing, see below.<br />
<br />
=== Field and Element Details ===<br />
<br />
===== Feed =====<br />
* a Feed element is identified by the class name <code>hfeed</code><br />
* a Feed element represents the concept of an [http://www.atomenabled.org/developers/syndication/atom-format-spec.php#rfc.section.4.1.1 Atom feed]<br />
* the Feed element is optional and, if missing, is assumed to be the page<br />
* hAtom documents MAY have multiple Feed elements<br />
<br />
===== Feed Category =====<br />
* a Feed Category element is identified by [[rel-tag]]<br />
* a Feed MAY have a Feed Category<br />
* a Feed Category element represents the concept of an [http://www.atomenabled.org/developers/syndication/atom-format-spec.php#rfc.section.4.2.2 Atom category] inside a [http://www.atomenabled.org/developers/syndication/#optionalFeedElements feed]<br />
* Feed Category elements MUST appear inside a Feed element but not inside an Entry element<br />
* the [[rel-tag]] <code>href</code> encodes the atom <code>category:term</code>; the link text defines the atom <code>category:label</code><br />
<br />
===== Entry =====<br />
* an Entry element is identified by class name <code>hentry</code><br />
* an Entry element represents the concept of an [http://www.atomenabled.org/developers/syndication/atom-format-spec.php#rfc.section.4.1.2 Atom entry]<br />
* any microformat content inside a <code>&lt;blockquote></code> or <code>&lt;q></code> element within the Entry should not be considered part of the Entry.<br />
: ''This allows quoting other microformated data without worry of corrupting the model''<br />
<br />
===== Entry Category =====<br />
* an Entry Category element is identified by [[rel-tag]]<br />
* an Entry MAY have an Entry Category<br />
* an Entry Category element represents the concept of an [http://www.atomenabled.org/developers/syndication/atom-format-spec.php#rfc.section.4.2.2 Atom category] inside an [http://www.atomenabled.org/developers/syndication/#optionalEntryElements entry]<br />
* the [[rel-tag]] <code>href</code> encodes the atom <code>category:term</code>; the link text defines the atom <code>category:label</code><br />
<br />
===== Entry Title =====<br />
* an Entry Title element is identified by the class name <code>entry-title</code><br />
* an Entry SHOULD have an Entry Title<br />
* an Entry Title element represents the concept of an [http://www.atomenabled.org/developers/syndication/atom-format-spec.php#rfc.section.4.2.14 Atom entry title]<br />
* if the Entry Title is missing, use<br />
** the first <code>&lt;h#></code> element in the Entry, or<br />
** the <code>&lt;title></code> of the page, if there is no enclosing Feed element, or<br />
** assume it is the empty string<br />
<br />
===== Entry Content =====<br />
* an Entry Content element is identified by class name <code>entry-content</code><br />
* an Entry SHOULD have Entry Content<br />
* an Entry Content element represents the concept of an [http://www.atomenabled.org/developers/syndication/atom-format-spec.php#atomContent Atom content]<br />
* an Entry MAY have 0 or more Entry Content elements. The "logical Entry Content" of an Entry is the concatenation, in order of appearance, of all the Entry Contents within the Entry<br />
: ''Many weblogs split content into multiple sections with a "Read More" link and javascript tricks. This is also needed in cases where Entry Titles are coded inline and are considered part of the content.''<br />
* if the Entry Content is missing, assume it is the empty string<br />
<br />
===== Entry Summary =====<br />
* an Entry Summary element is identified by class name <code>entry-summary</code><br />
* an Entry Summary element represents the concept of an [http://www.atomenabled.org/developers/syndication/atom-format-spec.php#rfc.section.4.2.13 Atom summary]<br />
* an Entry MAY have 0 or more Entry Summary elements. The "logical Entry Summary" of an Entry is the concatenation, in order of appearance, of all the Entry Summarys within the Entry<br />
<br />
===== Entry Permalink =====<br />
* an Entry Permalink element is identified by [[rel-bookmark]]<br />
* an Entry SHOULD have an Entry Permalink<br />
* an Entry Permalink element represents the concept of an [http://www.atomenabled.org/developers/syndication/atom-format-spec.php#rfc.section.4.2.7 Atom link in an entry]<br />
* if the Entry Permalink is missing, use the URI of the page; if the Entry has an "id" attribute, add that as a fragment to the page URI to distinguish individual entries<br />
<br />
===== Entry Updated =====<br />
* an Entry Updated element is identified by class name <code>updated</code><br />
* an Entry Updated element represents the concept of [http://www.atomenabled.org/developers/syndication/atom-format-spec.php#rfc.section.4.2.15 Atom updated]<br />
* an Entry SHOULD have an Entry Updated element<br />
* use the [[datetime-design-pattern]] to encode the updated datetime<br />
* if there is no Entry Updated element,<br />
** use the Entry Published element, if present<br />
** otherwise the page is invalid hAtom<br />
<br />
===== Entry Published =====<br />
* an Entry Published element is identified by the class name <code>published</code><br />
* an Entry Published element represents the concept of [http://www.atomenabled.org/developers/syndication/atom-format-spec.php#rfc.section.4.2.9 Atom published]<br />
* use the [[datetime-design-pattern]] to encode the published datetime<br />
<br />
===== Entry Author =====<br />
* an Entry Author element is represented by class name <code>author</code><br />
* an Entry Author element represents the concept of an [http://www.atomenabled.org/developers/syndication/atom-format-spec.php#rfc.section.4.2.1 Atom author]<br />
* an Entry Author element MUST be encoded in an [[hcard|hCard]]<br />
* an Entry Author element SHOULD be encoded in an <code>&lt;address></code> element<br />
* an Entry SHOULD have at least one Entry Author element<br />
* an Entry MAY have more than one Entry Author elements<br />
* if the Entry Author is missing<br />
** find the [[algorithm-nearest-in-parent|Nearest In Parent]] <code>&lt;address></code> element(s) with class name <code>author</code> and that is/are a valid [[hcard|hCard]]<br />
** otherwise the entry is invalid hAtom<br />
<br />
=== XMDP Profile ===<br />
<pre><br />
<dl class="profile"><br />
<dt>class</dt><br />
<dd><p><br />
<a rel="help" href="http://www.w3.org/TR/html401/struct/global.html#adef-class"><br />
HTML4 definition of the 'class' attribute.</a><br />
This meta data profile defines some 'class' attribute values (class names) <br />
and their meanings as suggested by a <br />
<a href="http://www.w3.org/TR/WD-htmllink-970328#profile"><br />
draft of "Hypertext Links in HTML"</a>.<br />
<dl><br />
<dt>hfeed</dt><br />
<dd><br />
The concept of atom:feed from <br />
<a href="http://www.atomenabled.org/developers/syndication/atom-format-spec.php">The Atom Syndication Format</a>, <br />
constrained and modified as per the <a href="http://microformats.org/wiki/hatom">hAtom microformat spec</a>.<br />
</dd><br />
<dt>hentry</dt><br />
<dd><br />
The concept of atom:entry from <br />
<a href="http://www.atomenabled.org/developers/syndication/atom-format-spec.php">The Atom Syndication Format</a>, <br />
constrained and modified as per the <a href="http://microformats.org/wiki/hatom">hAtom microformat spec</a>.<br />
</dd><br />
<dt>entry-title</dt><br />
<dd><br />
The concept of atom:title inside of an atom:entry from <br />
<a href="http://www.atomenabled.org/developers/syndication/atom-format-spec.php">The Atom Syndication Format</a>, <br />
constrained and modified as per the <a href="http://microformats.org/wiki/hatom">hAtom microformat spec</a>.<br />
</dd><br />
<dt>entry-content</dt><br />
<dd><br />
The concept of atom:content from <br />
<a href="http://www.atomenabled.org/developers/syndication/atom-format-spec.php">The Atom Syndication Format</a>, <br />
constrained and modified as per the <a href="http://microformats.org/wiki/hatom">hAtom microformat spec</a>.<br />
</dd><br />
<dt>entry-summary</dt><br />
<dd><br />
The concept of atom:summary from <br />
<a href="http://www.atomenabled.org/developers/syndication/atom-format-spec.php">The Atom Syndication Format</a>, <br />
constrained and modified as per the <a href="http://microformats.org/wiki/hatom">hAtom microformat spec</a>.<br />
</dd><br />
<dt>bookmark</dt><br />
<dd><br />
The concept of atom:link (without any "rel") with an atom:entry from <br />
<a href="http://www.atomenabled.org/developers/syndication/atom-format-spec.php">The Atom Syndication Format</a>, <br />
constrained and modified as per the <a href="http://microformats.org/wiki/hatom">hAtom microformat spec</a>.<br />
</dd><br />
<dt>published</dt><br />
<dd><br />
The concept of atom:published from <br />
<a href="http://www.atomenabled.org/developers/syndication/atom-format-spec.php">The Atom Syndication Format</a>, <br />
constrained and modified as per the <a href="http://microformats.org/wiki/hatom">hAtom microformat spec</a>.<br />
</dd><br />
<dt>updated</dt><br />
<dd><br />
The concept of atom:updated from <br />
<a href="http://www.atomenabled.org/developers/syndication/atom-format-spec.php">The Atom Syndication Format</a>, <br />
constrained and modified as per the <a href="http://microformats.org/wiki/hatom">hAtom microformat spec</a>.<br />
</dd><br />
<dt>author</dt><br />
<dd><br />
The concept of atom:author from <br />
<a href="http://www.atomenabled.org/developers/syndication/atom-format-spec.php">The Atom Syndication Format</a>, <br />
constrained and modified as per the <a href="http://microformats.org/wiki/hatom">hAtom microformat spec</a>.<br />
</dd><br />
</dl><br />
</dd><br />
</dl><br />
</pre><br />
<br />
== Examples ==<br />
<br />
See [[hatom-examples]].<br />
<br />
== Examples in the wild ==<br />
This section is '''informative'''.<br />
<br />
The following sites have implemented hAtom , and thus are a great place to start for anyone looking for examples "in the wild" to try parsing, indexing, organizing etc. If your site marked up with hAtom, feel free to add it to the top of this list. Once the list grows too big, we'll make a separate wiki page.<br />
<br />
=== 0.1 hAtom examples===<br />
* [http://www.volume.co.uk Volume] - Main news page is marked up as hAtom 0.1 <br />
* [http://yedda.com Yedda] - Yedda support hAtom on exploration of questions where there is also support for Atom and RSS feeds. ([http://yedda.com/questions/recent/ example])<br />
* The [http://www.westmidlandbirdclub.com/ West Midland Bird Club's] frequently-updated [http://www.westmidlandbirdclub.com/new.htm What's New] page, [http://www.westmidlandbirdclub.com/ladywalk/latest.htm news from its Ladywalk Reserve] and [http://www.westmidlandbirdclub.com/worcs/grimley/latest.htm news from Grimley Pits] &mdash; comments welcome on my talk page [[User:AndyMabbett|Andy Mabbett]]<br />
* [http://pixelsebi.com pixelsebi's repository] uses hAtom 0.1 for blog posts (and hCard, hCalendar, XFN, xFolk and many more) based on manual WordPress template modifications<br />
* [http://www.geekinthepark.co.uk Geek in the Park] uses hAtom for the comments. -- by [[User:Trovster|trovster]]<br />
* [http://www.csarven.ca Sarven Capadisli] uses hAtom for the articles and comments -- by [[User:Csarven|csarven]]<br />
* [http://www.fberriman.com fberriman.com] uses hAtom 0.1 for blog posts (WordPress loop) and hCard throughout -- by [[User:Phae|Frances Berriman]] (Also - [http://www.fberriman.com/?p=86 Implementing hAtom: The Entries Code])<br />
* [http://www.capital.edu Capital University] uses hAtom 0.1 to mark up the feed of latest posts by student bloggers on its home page.<br />
* [http://blog.davidjanes.com Ranting and Roaring] (David Janes)<br />
* [http://ChunkySoup.net/ ChunkySoup.net] has redesigned using hAtom 0.1 and hCards on the entire site -- by [[User:ChrisCasciano|Chris Casciano]]<br />
* [http://sedna.spip.org/sedna/ Sedna RSS] (a feed aggregator based on SPIP, by Fil, IZO and others; GPLd sources are available at [http://zone.spip.org/trac/spip-zone/browser/_squelettes_/sedna SPIP-Zone])<br />
* [http://members.optusnet.com.au/benjamincarlyle/benjamin/blog/ Sound Advice] (Benjamin Carlyle)<br />
* [http://quotedprintable.com/pages/scribbish Scribbish] is a Typo theme which uses hAtom.<br />
* [http://rbach.priv.at/hAtom2Atom/Changelog/ hAtom2Atom.xsl's Changelog] is published as hAtom and Atom.<br />
* [http://federali.st/ federali.st]'s webbed Federalist Papers are each marked up in hAtom.<br />
* [http://www.plaintxt.org/themes/sandbox/ Sandbox] is a theme for [http://wordpress.org/ WordPress] that uses hAtom. <br />
** The theme is also available to accounts on the [http://wordpress.com/ <username>.wordpress.com] hosting service. The [http://blog.coworking.info Coworking] and [http://barcamp.wordpress.com BarCamp] blogs are examples of custom Sandbox themes.<br />
* [http://www.whump.com/dropbox/Strangelove.zip Strangelove] is a modification of the default WordPress theme (Kubrick) with hAtom support. <br />
** It points to the hAtom2Atom proxy service as the link for syndication feeds.<br />
<br />
===Examples with some problems===<br />
<br />
Entries may be moved here if there's a problem with the way hAtom is used on the page concerned. If the page is yours, and you want to improve it, see the [[hatom-faq|hAtom FAQ]], or raise any queries on [[hatom-issues|hAtom Issues]] or [[mailing-lists#microformats-discuss|the mailing list]], where people will be happy to help you. <br />
<br />
* [http://www.joomlamug.com Joomla! Melbourne User Group] uses hAtom combined with hCard for articles. <br />
**No examples on cited page. [[User:AndyMabbett|Andy Mabbett]]<br />
<br />
==== Pre 0.1 hAtom examples====<br />
These pages conform to an older draft standard and need to be updated.<br />
<br />
* [http://www.myelin.co.nz/post/ Second p0st] (Phil Pearson)<br />
<br />
== Implementations ==<br />
<br />
This section is '''informative'''.<br />
<br />
The following implementations have been developed which either generate or parse hAtom links. If you have an hAtom implementation, feel free to add it to the top of this list. Once the list grows too big, we'll make a separate wiki page.<br />
<br />
* [http://glavmedtop.blogspot.com hAtom Creator] modified from the other creators by BenWest.<br />
* the [http://tools.blogmatrix.com/extract/ Almost Universal Microformat Parser] can extract hAtom content from webpages ([http://tools.blogmatrix.com/extract/?uri=http%3A%2F%2Fblog.davidjanes.com&microformat=hatom&submit=Submit example])<br />
* the [http://tipatraf.blogspot.com microformat-action] [[greasemonkey|Greasemonkey]] script detects hAtom content on webpages and will call the [http://tools.blogmatrix.com/extract/ Almost Universal Microformat Parser]<br />
* [http://rbach.priv.at/hAtom2Atom/ hAtom2Atom.xsl] transforms hAtom to Atom (as the name suggests.)<br />
* There is now an [http://www.lukearno.com/projects/hatom2atom/ hatom2atom proxy] that uses hAtom2Atom.xsl.<br />
* [http://placenamehere.com/article/185/SubscribingTohAtomFeedsWithNetNewsWire Subscribe To hAtom] is a script that provides [http://ranchero.com/netnewswire/ NetNewsWire 2.x] users with the ability to subscribe to hAtom documents as they would any other feed. by [[User:ChrisCasciano|Chris Casciano]].<br />
* [http://boxtheweb.mihopa.net/code/apis/#outlineclasses Outline Classes] - has GPL'ed PHP code for reading hAtom<br />
* [http://boxtheweb.4x2.net/ BoxtheWeb] - supports subscribing to hAtom as a feed format<br />
<br />
== References ==<br />
=== Normative References ===<br />
* [http://www.w3.org/TR/2002/REC-xhtml1-20020801/ XHTML 1.0 SE]<br />
* [http://www.ietf.org/rfc/rfc4287 RFC4287: The Atom Syndication Format]<br />
* [[hcard-parsing]]<br />
<br />
=== Informative References ===<br />
* [http://www.atomenabled.org/ atomenabled.org]<br />
<br />
== Work in progress ==<br />
This specification is a work in progress. As additional aspects are discussed, understood, and written, they will be added. There is a separate document where we are keeping our brainstorms and other explorations relating to hAtom:<br />
<br />
* [[blog-post-brainstorming|blog-post Brainstorming]]<br />
<br />
=== Version 0.1 ===<br />
<br />
Version 0.1 was released 28 February 2006.<br />
<br />
== Discussions ==<br />
<br />
* See [http://www.technorati.com/cosmos/referer.html blogs discussing this page].<br />
<br />
=== Q&A ===<br />
* If you have any questions about hAtom, check the [[hatom-faq|hAtom FAQ]], and if you don't find answers, add your questions!<br />
<br />
=== Issues ===<br />
* Please add any issues with the specification to the separate [[hatom-issues|hAtom issues]] document.<br />
<br />
==See Also==<br />
{{hatom-related-pages}}<br />
* [[rel-enclosure]] - how to semantically reference enclosures (e.g. podcasts) in hAtom<br />
* [[blog-post-brainstorming]]<br />
* [[blog-post-formats]]<br />
* [[blog-post-examples]]<br />
* [[blog-description-format]] - how to describe a blog (as opposed to the individual entries, which is what we're doing here)</div>Admini