hreview-aggregate: Difference between revisions
m (Reverted edits by Projectiro (Talk) to last version by Aspire24) |
Projectiro (talk | contribs) |
||
| Line 128: | Line 128: | ||
Note that the <code>item</code> and <code>vcard</code> are put next to each other in the same class attribute in order to show that the item being reviewed is described by the embedded hCard. | Note that the <code>item</code> and <code>vcard</code> are put next to each other in the same class attribute in order to show that the item being reviewed is described by the embedded hCard. | ||
=== | === Hitung vs penilaian === | ||
Dalam contoh sejauh ini, jumlah <code> </ | |||
code> properti telah digunakan tapi | |||
tidak <code> penilaian </ code>. | |||
Consider | <code> penilaian </ code> berguna | ||
ketika pengguna telah dinilai item tanpa menulis ulasan yang sesuai | |||
<pre><nowiki> | penuh. Suara mereka memberikan | ||
<div> | kontribusi terhadap nilai rata-rata | ||
tetapi tidak terhadap jumlah tinjauan | |||
available.Consider contoh ini: <pre> | |||
<nowiki> <div> <h3> <span> Wraps Mediterania </ span> </ h3> | |||
Pelanggan <span> kawanan .. ke | |||
restoran ini kecil untuk falafel mereka | |||
lezat dan membungkus shawerma | |||
dan ramah staf </ span> <span> 4.5 | |||
dari 5 berdasarkan 24 peringkat </ span> <span> 5 ulasan pengguna: </ | |||
</div> | span> ... < / div> </ Nowiki> </ pre> | ||
</ | Berikut contoh lagi, dengan kedua | ||
hitung <code> </ code> dan <code> | |||
penilaian </ code> ditentukan mana | |||
yang sesuai. <pre> <nowiki> <div class = "hReview-agregat"> <h3 | |||
<pre><nowiki> | class="item"> <span class="fn"> | ||
<div class=" | Mediterania Wraps </ span> </ h3> | ||
<span class="summary"> Pelanggan | |||
berduyun-duyun ke restoran ini kecil | |||
untuk falafel mereka lezat dan membungkus shawerma dan ramah | |||
staf </ span> <span> <span | |||
class="rating"> 4.5 </ span> dari 5 | |||
berdasarkan <span class="votes"> 24 | |||
</ span> </ span peringkat.. > | |||
<span> <span class="count"> 5 </ span> ulasan pengguna: </ span> ... | |||
</ div> </ Nowiki> </ pre> | |||
</div> | |||
</ | |||
== examples in the wild == | == examples in the wild == | ||
Revision as of 23:20, 22 May 2013
<entry-title>hReview-aggregate 0.2</entry-title> This document represents a draft microformat specification. Although drafts are somewhat mature in the development process, the stability of this document cannot be guaranteed, and implementers should be prepared to keep abreast of future developments and changes. Watch this wiki page, or follow discussions on the #microformats IRC channel to stay up-to-date.
hReview-aggregate is a format for embedding review information (of products, services, businesses, etc). Whereas hReview is intended for an individual review, hReview-aggregate is meant for summary information about a collection of user or critic reviews about an item. hReview-aggregate is one of several microformats open standards suitable for embedding in HTML, XHTML, Atom, RSS, and arbitrary XML.
Microformats Draft Specification 2009-11-10
- Editor
- Kavi Goel, Google
- Authors/Contributers (alphabetical)
- Tantek Çelik
- Othar Hansson, Google
- Jay Myers, Best Buy, Co., Inc.
Introduction
Many websites publish reviews using a variety of organization schemes. hReview-aggregate and the similar microformat hReview were designed to enable sharing of review information.
hReview, created in 2006, is well suited to mark up reviews done by individuals on their own websites or for editor's reviews for a new product or service. However, in recent years, there has been an increasing number of sites who aggregate user reviews, either by accepting reviews submitted to their website or by collecting those user reviews from across the web. In these cases, it is often valuable to share not just the individual reviews shown on the webpage, but the consensus opinion derived from those individual reviews.
hReview-aggregate was created to address this need. hReview-aggregate is a standard that can be used to share the number of reviews, average rating, and consensus opinion for a particular product or service. It is meant to complement hReview and reuses hReview properties wherever appropriate. Research and discussion that fed into the design of hReview-aggregate can be found on the aggregate review brainstorming wiki page.
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.
Scope
Collections of reviews consistently share several common aspects. Where possible hReview-aggregate has been based on this common subset.
Out of scope
Portions of reviews that are specific to particular kinds of items have been omitted from hReview-aggregate.
Format
Schema
The hReview-aggregate schema consists of the following:
- hReview-aggregate (
hreview-aggregate)iteminfo. required.fn(url||photo) | hCard (for person or business) | hCalendar (for event) | hProduct (for product)rating. required. fixed point integer [1.0-5.0], with optional alternateworst(default:1.0) and/orbest(default:5.0), also fixed point integers, and explicitaverage.count. optional. non-negative integer.votes. optional. non-negative integer. Note that whilecountandvotesare both marked optional, at least one of the two fields must be specified.summary. optional. text.
Property details
Details of the hReview-aggregate properties:
item:: This required property MUST have at a minimum the name of the entity being reviewed (using the subproperty "fn"), or alternatively have an encapsulated microformat (i.e. hCard for a business or person, hProduct for a product, or hCalendar for an event). If an encapsulated microformat is not used, a URI ("url") for the item and a photo or depiction ("photo") MAY also be provided. Non-URL unique item IDs (e.g. ISBNs, UPCs) MAY be represented as a URN ("url") for the item. Encapsulated microformats must be set on the item itself (e.g. class="item vcard"). However, when using item info subproperties ("fn", "url", "photo"), they must be nested inside the item element.
rating:: The rating is a fixed point integer (one decimal point of precision) from 1.0 to 5.0 inclusive indicating the average rating for the item across all reviews, 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).
count:: This property is used to specify the total number of reviews for the product or service.
votes:: This property is used to specify the total number of users who have rated the product or service, contributing to the average rating. For some sites, the number of votes is equal to the number of reviews, so count may be used and this property omitted.
summary:: This optional property can be the title for the review collection or a very short summary of the consensus opinion from the collection.
The item, rating, and summary properties are reused from hReview.
Examples
Basic example
Here is an example showing aggregate review information for a restaurant:
<div> <h3> <span>Mediterranean Wraps</span> </h3> <span>Customers flock to this small restaurant for their tasty falafel and shawerma wraps and welcoming staff.</span> <span>4.5 out of 5 based on 17 reviews</span> </div>
Adding hReview-aggregate markup to this is straightforward:
<div class="hreview-aggregate"> <h3 class="item"> <span class="fn">Mediterranean Wraps</span> </h3> <span class="summary">Customers flock to this small restaurant for their tasty falafel and shawerma wraps and welcoming staff.</span> <span><span class="rating">4.5</span> out of 5 based on <span class="count">17</span> reviews</span> </div>
Embedded microformat, 10-point rating scale
Often, there is more information available on a page about the item being reviewed than the title. Here is another example of a restaurant review, but with address information present.
<div> <div> <h3>Mediterranean Wraps</h3> <span>433 S California Ave</span> <span>Palo Alto, CA <span>(650) 321-8189</span> </div> <span>Customers flock to this small restaurant for their tasty falafel and shawerma wraps and welcoming staff.</span> <span>9.2 out of 10 based on 17 reviews</span> </div>
And here it is with hReview-aggregate markup, along with an embedded hCard to describe the address and phone information for the restaurant:
<div class="hreview-aggregate"> <div class="item vcard"> <h3 class="fn">Mediterranean Wraps</h3> <span class="adr"> <span class="street-address">433 S California Ave</span> <span><span class="locality">Palo Alto</span>, <span class="region">CA</span></span> <span class="tel">(650) 321-8189</span> </span> </div> <span class="summary">Customers flock to this small restaurant for their tasty falafel and shawerma wraps and welcoming staff.</span> <span class="rating"><span class="average">9.2</span> out of <span class="best">10</span> based on <span class="count">17</span> reviews</span> </div>
Note that the item and vcard are put next to each other in the same class attribute in order to show that the item being reviewed is described by the embedded hCard.
Hitung vs penilaian
Dalam contoh sejauh ini, jumlah </
code> properti telah digunakan tapi
tidak penilaian </ code>.
penilaian </ code> berguna
ketika pengguna telah dinilai item tanpa menulis ulasan yang sesuai
penuh. Suara mereka memberikan
kontribusi terhadap nilai rata-rata
tetapi tidak terhadap jumlah tinjauan
available.Consider contoh ini:
<nowiki> Wraps Mediterania </ span> </ h3>
Pelanggan kawanan .. ke
restoran ini kecil untuk falafel mereka
lezat dan membungkus shawerma
dan ramah staf </ span> 4.5
dari 5 berdasarkan 24 peringkat </ span> 5 ulasan pengguna: </
span> ... < / div> </ Nowiki> </ pre>
Berikut contoh lagi, dengan kedua
hitung </ code> dan
penilaian </ code> ditentukan mana
yang sesuai. <nowiki>
Mediterania Wraps </ span> </ h3>
Pelanggan
berduyun-duyun ke restoran ini kecil
untuk falafel mereka lezat dan membungkus shawerma dan ramah
staf </ span>