hreview-fr

From Microformats Wiki
Jump to navigation Jump to search

Ceci est une traduction en cours de hreview seul lien de référence


hReview 0.3

hReview est un microformat simple, ouvert, distribué, adaptable pour l'embarquement de critiques (de produits, services, business, événements, etc.) dans le (X)HTML, Atom, RSS, et le XML arbitraire. hReview est l'un des nombreux microformats-fr ouverts et standards.

Vous voulez démarrer par l'écriture d'un hReview ? Utilisez le hReview creator pour écrire une critique et la publier.

Microformats Spécifications 22 février 2006 Draft

Editeur
Tantek Çelik, Technorati, Inc.
Auteurs
Tantek Çelik, Technorati, Inc.
Ali Diab,Yahoo! Inc.
Ian McAllister, Microsoft Corporation
John Panzer, America Online, Inc.
Adam Rifkin, CommerceNet Labs
Michael Sippey, Six Apart, Ltd.

Les déclarations Microformats pour le copyright et les patents s'appliquent.

Introduction

De nombreux sites web publient des critiques en utilisant une large variété de schémas de toutes sortes pour toutes sortes de produits (films, musique, livres), en passant par les commerces (restaurants, hôtels, magasins), les événements (concerts, théâtre), les personnes (artistes, leaders, célébrités), pour des endroits (parcs, centres de loisirs), des ressources en ligne (pages web, fichiers), jusqu'aux critiques de critiques elles-même.

Afin de permettre et d'encourager le partage, la distribution, la syndication et l'agrégation de critiques, les auteurs proposent le microformat hReview, un standard ouvert pour les critiques distribuées. Les auteurs ont cherché tant de nombreux exemples de critiques dans la nature, ont fait des premiers essais sur review-formats-fr, et ont conçu hReview autour d'un schéma simple et minimal pour les critiques. Le Feedback est encouragé sur la page hReview feedback.

Inspiration et Remerciements

Merci à tous ceux qui ont répondu à l'appel ouvert pour participation à l'implémentation du hReview. Les auteurs souhaitent tout particulièrement remercier les individus suivants pour leurs avis constructifs et leurs feedback : Richard Ault, Danny Ayers, Jeffrey Barr,Adrian Cuthbert, Jason DeFillippo, Brian Del Vecchio, Scott Derringer, Bud Gibson, Joi Ito, Gen Kanai, Niall Kennedy, Rohit Khare, Ryan King, Jonas Luster, Kevin Marks, Mark Nottingham, Derek Powazek, Jeff Rodenburg, David Sifry, James Stewart, Adriaan Tijsseling, Phillip Torrone, Thai Tran, Phillip Winn, YAMAMOTO Yohei.

Etendue

Les critiques partagent de manière cohérente plusieurs champs communs. Le hReview a été basé sur ce sous-ensemble minimal commun.

Hors-sujet

Les champs qui sont spécifiques à un type ont été omis de hReview. Il est important que hReview soit maintenu simple et minimal dès le démarrage. Des fonctionalités supplémentaires peuvent être ajoutées par l'expérience pratique de mise en oeuvre.

Le concept d'un "identifiant universel d'objet", ce qui veut dire, comment identifier le même objet/item/produit à travers différents sites de commerce, même s'il est quelque part très utile d'en disposer, est ici hors du champ d'application de ce format.

Principes De Design XHTML Sémantique

Note : les Principes de Design XHTML Sémantique ont été écrits initialement dans le contexte de développement de hCard et hCalendar, par conséquent il peut être plus facile de comprendre ces principes dans le contexte de la méthodologie de design hCard (ce qui veut dire, lisez ça d'abord). Tantek

XHTML est construit sur du XML, et par conséquent les formats fondés sur XHTML peuvent être utilisés non seulement pour une présentation d'affichage pratique, mais aussi à des fins d'échanges de données. A bien des façons, les formats fondés sur XHTML illustrent le meilleur des mondes tant du HTML que du XML. Néanmoins au moment de construire des formats basés sur XHTML, cela aide d'avoir un ensemble de principes directeurs.

  1. Réutilisez autant que possible le schéma (noms, objets, propriétés, valeurs, types, hiérarchies, contraintes) à partir des standards de référence établis et bien supportés. Evitez de redéclarer les contraintes exprimées dans le standard source. Des mentions à titre d'information peuvent passer.
    1. Pour les types avec plusieurs composants, utilisez des éléments imbriqués avec des noms de classe équivalents aux noms des composants.
    2. Les composants pluriels sont produits au singulier, et par conséquent plusieurs éléments imbriqués sont utilisés pour représenter plusieurs valeurs de texte qui sont délimitées par des virgules.
  2. Utilisez la sémantique XHTML la plus précise pour construire des blocs pour chaque objet, etc.
  3. Autrement utilisez un élément générique structurel (par ex. <span> ou <div>), ou l'élément contextuel approprié (par ex. un <li> dans un <ul> ou <ol>).
  4. Utilisez des noms de classes basés sur des noms extraits du schéma original, à moins que le XHTML sémantique de construction de bloc ne représente précisément cette partie du schéma original. Si les noms dans le schéma original ne sont pas sensibles la casse, alors mettez tout dans un équivalent en bas de casse. Les noms de composants implicites en prose (plutôt qu'explicites dans le schéma défini) devraient aussi utiliser les équivalents bas de casse pour une facilité d'utilisation. Les espaces dans les noms des composants deviennent des caractères tiret '-'.
  5. Pour finir, si le format de la donnée selon le schéma original est trop long et/ou non amical sur le plan humain, utilisez <abbr> au lieu d'un élément générique structurel, et placez les données littérales dans l'attribut 'title' (là où vont les expansions abbr), et l'équivalent le plus bref et le plus lisible humainement dans l'élément lui-même. De plus amples explications de cet usage de <abbr> : Human vs. ISO8601 dates problem solved

Format

En Général

Le format hReview est fondé sur un ensemble de champs communs à de nombreux sites de critiques et formats en usage aujourd'hui sur le web. Là où les noms de champs possibles ont été choisis en se fondant sur ceux définis par les standards apparentés hCard et hCalendar.

Schéma

Le schéma hReview est constitué comme suit :

  • hReview (hreview)
    • version. optionnel. texte.
    • summary. optionnel. texte.
    • item type. optionnel. product | business | event | person | place | website | url.
    • item info. requis. (fn || url || photo ) | hCard (pour personne ou business) | hCalendar (pour événement event)
    • reviewer. optionnel. hCard.
    • dtreviewed. optionnel. ISO8601 absolute date time.
    • rating. optionnel. nombre entier [1.0-5.0], avec alternative optionnelle worst (par défaut:1.0) et/ou best (par défaut:5.0), aussi nombres entiers et value explicite.
    • description. optionnel. texte avec balisage optionnel XHTML valide.
    • tags. optionnel. mots-clés ou phrases, utilisant rel-tag-fr, chacun avec une notation en option.
    • permalink. optionnel, utilisant rel-bookmark-fr et rel-self-fr.
    • license. optionnel, utilisant rel-license-fr.

Détails des Champs

Les champs du schéma hReview représentent ce qui suit :

version:: Ce champ optionnel permet aux auteurs de hReview de spécifier une version particulière du hReview que leur contenu utilise. En omettant ce champ, l'auteur déclare que les implémentations peuvent interpréter les hReviews selon n'importe quelle version de la spécification hReview v0.2 ou suivante. En pratique, les auteurs de cette spécification sont engagés pour maintenir une compatibilité descendante avec le contenu produit par l'utilisation de versions plus anciennes de la spécification. Ce champ est compatible avec la syntaxe, et réutilise de ce fait la sémantique de "VERSION" comme définie dans la vCard RFC2426 section "3.6.9 VERSION Type Definition". La valeur de ce champ pour cette spécification est "0.3".

summary :: Ce champ optionnel sert de titre pour la critique elle-même..

item type :: Ce champ optionnel "type" fournit le type d'item étant critiqué, l'un des suivants : product, business, event, person, place, website, url. S'il est omis, alors dans quelques cas, l'item peut être inféré. Si l'item est aussi un hCard, alors le type d'item est "business" ou "person" basé selon quel est le type de hCard représenté. Si l'item est aussi un événement hCalendar, alors le type d'item est un "event".

item info :: Ceci est un champ requis qui DOIT avoir au minimum le nom ("fn" - le texte formaté correpondant au nom) de l'item (un hReview ne décrit seulement qu'un item), DEVRAIT fournir au moins un URI ("url") pour l'item, et PEUT fournir au moins un URL vers une photo ou depiction ("photo") de l'item. Pour les items de type person ou business, l'info item (fn, url, photo) DOIT être encapsulée dans un hCard. Pour les items de types event, l'info item DEVRAIT être encapsulée dans un hCalendar "vevent". Les items à IDs uniques (par ex. ISBNs, UPCs) PEUVENT être réprésentés comme un URN ("url") pour l'item.

reviewer :: le champ optionnel spécifie la personne qui a écrite la critique. Si l'auteur de la critique est spécifié, un hCard représentant l'auteur de la critique DOIT être fourni. Pour les critiques anonymes, utilisez "anonymous" (sans guillemets) pour le nom propre de la critique. Si aucun "reviewer" n'est trouvé dans le hReview, les parseurs devraient regarder à l'extérieur du hReview, dans le contexte de la page, pour le "reviewer". S'il n'y a pas de "reviewer" à l'extérieur, alors les parseurs devraient utiliser l'auteur défini par le "containing document language", par ex. pour des documents (X)HTML, l'info de contact <address> pour la page (qui est idéalement balisée aussi comme un hCard), pour Atom 1.0 le <entry> <author> si présent et si non <feed> <author>, pour RSS le <author> dans l'élément <item>.

dtreviewed:: Ce champ optionnel quand il est présent DOIT fournir un "date time" absolu ISO8601 du moment où la critique a été écrite ou autrement publiée. Ce champ DEVRAIT utiliser UTC, mais PEUT utiliser la syntaxe du fuseau horaire. Si dtreviewed est absent de hReview, alors regardez en dehors de hReview, dans le contexte environnant. Si le contexte est une entrée hAtom, utilisez son datetime "published" (ou "updated" si celui-ci manque) du fil. Autrement utilisez l'information date de création (ou date modifiée si celle-ci manque) selon la langue du document conteneur (par ex. "published"/"updated" de la même manière pour les fils Atom), puis le protocole (par ex. HTTP Last-Modified, ou "file system last modified datetime") comme dtreviewed.

rating:: L'évaluation est un nombre entier fixé (une décimale pour la précision partant de 1.0 jusqu'à 5.0 inclus indiquant une évaluation pour l'item, la plus haute indiquant une meilleure évaluation par défaut. Optionnellement, une valeur de nombre entier différente "worst" et/ou une valeur "best" PEUVENT être spécifiées (par ex. 6 de 0-10). La valeur "best" peut être numériquement plus petite que la valeur "worst".

description:: Ce champ optionnel contient le texte clair représentant l'opinion écrite du critique. Le champ PEUT inclure un balisage valide XHTML (par ex. des paragraphes). Les agents utilisateur DEVRAIENT empêcher tout balisage. Plusieurs descriptions ou des descriptions de sections (par ex. pours et contres, plus et moins) DEVRAIENT être inclus dans le champ description.

tags:: Les tags sont représentés en utilisant une liste de mots-clés ou phrases (en utilisant le microformat rel-tag-fr pour chaque mot-clé individuel ou tag de phrase) que le critique associera à l'item. Le critique PEUT en option fourinir un tag-spécifique d'évaluation à l'intérieur de chaque rel-tag-fr, par ex. ambience:5. Les évaluations tag-spécifiques par défaut utilisent la même gamme comme une évaluation globale pour l'item si présentes, et PEUVENT avoir aussi une gamme spécifiée allant de worst... à best. Les auteurs PEUVENT aussi inverser cette structure pour la même sémantique si elle est plus commode pour leur balisage, ce qui veut dire placer le rel-tag à l'intérieur d'une évaluation pour indiquer un tag évalué. Note : les tags évalués devraient idéalement utiliser un espace tag qui explique ce que signifient les évaluations pour ce tag. Par ex. Food:18/30 devrait lier vers un espace tags pour Food qui explique ce que veut dire un 18 sur 30 pour le tag Food.

permalink:: Ce champ optionnel est une URL pour le hReview. En plus d'utiliser le tag <a href> pour ce champ, l'attribut rel="self bookmark" DOIT être utilisé pour dire que l'hyperlien est un lien permanent de la critique elle-même. Si l'hyperlien contient déjà un attribut rel, alors les valeurs self et bookmark DOIVENt être incluses parmi l'ensemble espace-séparé de valeurs dans l'attribut. Les indexeurs PEUVENT traiter le permalien d'une critique comme un ID unique afin d'identifier et réunir les même critiques provenant de sources multiples (telles que le fait d'indexer une page plusieurs fois). Le permalien PEUT aussi être utilisé pour indiquer l'origine de la critique. Les auteurs PEUVENT utiliser le nom de classe d'un "permalink" sur l'élément représentant le permalien, mais ne sont pas obligés de faire ainsi.

Les noms de champs suivants ont été réutilisés à partir des microformats hCard et hCalendar : version, summary, fn, url, email, photo, description, categories. En plus, les items et critiques décrits par les hCards PEUVENT contenir n'importe quel champ hCard. La valeur rel "self" a été réutilisée à partir de la spécification Atom 1.0.

license:: Ce champ optionnel fait un lien vers la licence sous laquellle les contenus de la hReview elle-même est licenciée, en utilisant le microformat rel-license.

Plus d'Equivalents Sémantiques

Pour quelques propriétés, il existe un équivalent plus sémantique, et par conséquent elles reçoivent un traitement spécial, par ex :

  • Pour toute "url", utilisez <a class="url" href="...">...</a> à l'intérieur de l'élément avec le nom de classe 'hreview' dans hReview.
  • De la même manière, pour n'importe quel "email", utilisez <a class="email" href="mailto:...">...</a>
  • Et pour une "photo", utilisez <img class="photo" src="..." alt="Photo of ..." />
  • Les évaluations sont souvent présentés comme un ensemble d'images ou caractères, par ex. "***". Pour cela, l'élément <abbr> est particulièrement utile, parce que de tels caractères sont une abréviation pour l'évaluation précise, par ex. <abbr class="rating" title="3">***</abbr>. Ceci est exploré plus à fond dans la section suivante.

Langue

  • Pour porter explicitement la langue naturelle dans laquelle une hReview est écrite, utiliser l'attribut standard (X)HTML 'lang' sur l'élémnet avec class="hreview", par ex. <div class="hreview" lang="fr"> ... </div> Si des portions d'une hReview (par ex. le nom de l'item) sont dans une langue différente, utilisez l'attribut 'lang' sur ces portions.
  • Les processeurs hReview qui ont besoin de gérer la langue des critiques DOIVENT traiter l'attribut standard (X)HTML 'lang' comme spécifié.

Lisible par Human vs. Machine

Si un élément <abbr> est utilisé pour une propriété, alors son attribut 'title' est utilisé pour la valeur de la propriété, au lieu des contenus de l'élément, ce qui peut être ensuite utilisé pour fournir une présentation alternative de la valeur plus sympathique pour l'utilisateur.

De la même façon, si un élément <img /> est utilisé pour une ou plusieurs propriétés, il DOIT être traité comme suit :

  1. Pour la propriété "photo" et toute autre propriété qui prend un URL comme sa valeur, l'attribut src="..." fournit la valeur de la propriété.
  2. Pour d'autres propriétés, l'attribut de l'élément <img /> 'alt' est la valeur de la propriété.

Includes Objet

hReview 0.3 includes support for the object include-pattern.

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.


Notes

This section is informative.

  • 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.
  • The enumerated list of item types is under development and may be extended.
  • Each type may have custom hReview fields that follow the common set.
  • Additional details about a particular item should be specified with the rest of the item's info at the URL provided for the item.
  • 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.

Exemples

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.

Want to get started with writing an hReview? Use the hReview creator to write a review and publish it on your blog.

Critiques Restaurant

Here is an example of a simple online restaurant review: 

<div>
 <span>5 stars out of 5 stars</span>
 <h4>Crepes on Cole is awesome</h4>
 <span>Reviewer: <span>Tantek</span> - April 18, 2005</span>
 <blockquote><p>
  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.
 </p></blockquote>
 <p>Visit date: <span>April 2005</span></p>
 <p>Food eaten: <span>Florentine crepe</span></p>
</div>

Adding hReview to this review is quite simple: 

<div class="hreview">
 <span><span class="rating">5</span> out of 5 stars</span>
 <h4 class="summary">Crepes on Cole is awesome</h4>
 <span class="reviewer vcard">Reviewer: <span class="fn">Tantek</span> - 
 <abbr class="dtreviewed" title="20050418T2300-0700">April 18, 2005</abbr></span>
 <div class="description item vcard"><p>
  <span class="fn org">Crepes on Cole</span> is one of the best little 
  creperies in <span class="adr"><span class="locality">San Francisco</span></span>.
  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.
 </p></div>
 <p>Visit date: <span>April 2005</span></p>
 <p>Food eaten: <span>Florentine crepe</span></p>
</div>

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.

This sample hReview could be rendered like this:

5 stars out of 5 stars
Crepes on Cole is awesome
Reviewer: Tantek - April 18, 2005

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.

Visit date: April 2005
Food eaten: Florentine crepe

Critique Restaurant Multidimensionnnelle

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.

Here is one such review in text format: 

Cafe Borrone

1010 El Camino Real, Menlo Park, CA 94025, +1-650-327-0830;
cafeborrone.com

Food: 18/30; Ambience: 19/30; Service: 15/30; Price: $$...

This 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 coffee or a 
snack to accompany a newly purchased book or imported periodical.  Soups and 
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.  Espresso afficionados will appreciate the Illy coffee.  Noise 
levels can vary from peaceful in the late mornings to nearly overwhelming on 
jazz band nights.

As an hReview: 

<div class="hreview">
 <div class="item vcard">
  <div class="fn org summary">Cafe Borrone</div>
  <span class="adr">
   <span class="street-address">1010 El Camino Real</span>,
   <span class="locality">Menlo Park</span>,
   <span class="region">CA</span>
   <span class="postal-code">94025</span>,
  </span>
  <span class="tel">+1-650-327-0830</span>;
  <a class="url" href="http://cafeborrone.com">cafeborrone.com</a>
 </div>
 <ul class="categories">
  <li class="rating"><a href="http://en.wikipedia.org/wiki/Food" rel="tag">
   Food: <span class="value">18</span>/<span class="best">30</span></a>;</li>
  <li class="rating"><a href="http://flickr.com/photos/tags/Ambience" rel="tag">
   Ambience: <span class="value">19</span>/<span class="best">30</span></a>;</li>
  <li class="rating"><a href="http://en.wikipedia.org/wiki/Service" rel="tag">
   Service: <span class="value">15</span>/<span class="best">30</span></a>;</li>
  <li class="rating"><a href="http://en.wikipedia.org/wiki/Price" rel="tag">
   Price: <abbr class="value" title="2">$$</abbr>...</a></li>
 </ul>
 <div class="description"><p>
  This <abbr class="type" title="business">
  <a href="http://en.wikipedia.org/wiki/cafe" rel="tag">cafe</a></abbr> 
  is a welcoming oasis on the Peninsula.  
  It even has a fountain outside which nearly eliminates 
  the sounds of El Camino traffic.  Next door to a superb indy bookstore, 
  Cafe Borrone is an ideal spot to grab a 
  <a href="http://en.wikipedia.org/wiki/coffee" rel="tag">coffee</a> 
  or a meal to accompany a newly purchased book or imported periodical.  
  <a href="http://technorati.com/tag/soup" rel="tag">Soups</a> and 
  <a href="http://technorati.com/tag/sandwich" rel="tag">sandwich</a> 
  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. 
  <a href="http://flickr.com/photos/tags/espresso" rel="tag">Espresso</a> 
  afficionados will appreciate the 
  <a href="http://en.wikipedia.org/wiki/Illy" rel="tag">Illy</a> coffee.  
  Noise levels can vary from peaceful in the late mornings to nearly overwhelming on 
  <a href="http://en.wikipedia.org/wiki/jazz" rel="tag">jazz</a> band nights.
 </p></div>
 Review (<a href="http://microformats.org/wiki/hreview"> 
  hReview v<span class="version">0.3</span></a>)
 by <span class="reviewer vcard"><span class="fn">anonymous</span></span>, 
 <abbr class="dtreviewed" title="20050428T2130-0700">April 28th, 2005</abbr>.
</div>

With an accompanying CSS style sheet like: 

a.url { display:block }
ul.categories { margin:1em 0; padding:0 }
.categories li { display:inline }

This hReview could be presented similar to the original text:

Cafe Borrone
1010 El Camino Real, Menlo Park, CA 94025, +1-650-327-0830;
cafeborrone.com

Food: 18/30; Ambience: 19/30; Service: 15/30; Price: $$...

This 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 coffee or a snack to accompany a newly purchased book or imported periodical. Soups and 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. Espresso afficionados will appreciate the Illy coffee. Noise levels can vary from peaceful in the late mornings to nearly overwhelming on jazz band nights.

Review (hReview v0.3) by anonymous, April 28th, 2005.

Critique produit

Here is an example of a product review: 

<div>
 <a href="http://www.amazon.com/exec/obidos/ASIN/B000089CJI/">
  <img src="http://images.amazon.com/images/P/B000089CJI.01._SCTHUMBZZZ_.jpg" 
              alt="Album cover photo: The Postal Service: Give Up." />
 The Postal Service: Give Up</a>
 <blockquote><p>
   "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..."
   </p><p>
   "Nothing Better" is a great track on this album, too... 
 </p></blockquote>
 (*****)
</div>

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: 

<div class="hreview">
 <a class="item url" href="http://www.amazon.com/exec/obidos/ASIN/B000089CJI/">
  <img src="http://images.amazon.com/images/P/B000089CJI.01._SCTHUMBZZZ_.jpg" 
       alt="Album cover photo: The Postal Service: Give Up. " 
       class="photo" />
 <span class="fn">The Postal Service: Give Up</span></a>
 <div class="description"><p>
    "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..."
   </p><p>
   "Nothing Better" is a great track on this album, too... 
 </p></div>
 (<abbr class="rating" title="5">*****</abbr>)
 <p class="reviewer vcard">Review by 
  <a class="url fn" href="http://ifindkarma.com/blog/">Adam Rifkin</a>, 
  <abbr class="dtreviewed" title="200502">February 2005</abbr>
 </p>
</div>

And this hReview might be presented like this:


[Album cover photo: ] [The Postal Service:] [ Give Up ]

The Postal Service: Give Up

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

"Nothing Better" is a great track on this album, too...

(*****)

Review by Adam Rifkin, February 2005.

Movie Review

Finally, here is an example of a movie review. 

<div>
 <span>anonymous, April 18th, 2005</span>
 <div>
  <a lang="zh" href="http://www.imdb.com/title/tt0299977/">
  Ying Xiong (<span lang="en">HERO</span>)
  </a>
 </div>
 <div>Rating: 4 out of 5</div>
 <blockquote><p>
  This movie has great visuals and music.
 </p></blockquote>
</div>

With hReview: 

<div class="hreview">
 <span class="reviewer vcard">
  <span class="fn">anonymous</span>, 
  <abbr class="dtreviewed" title="20050418">April 18th, 2005</abbr>
 </span>
 <div class="item">
  <a lang="zh" class="url fn" href="http://www.imdb.com/title/tt0299977/">
  Ying Xiong (<span lang="en">HERO</span>)
  </a>
 </div>
 <div>Rating: <span class="rating">4</span> out of 5</div>
 <div class="description"><p>
  This movie has great music and visuals.
 </p></div>
</div>

Which could be presented like this:

anonymous, April 18th, 2005
Ying Xiong (HERO)
Rating: 4 out of 5

This movie has great music and visuals.

Examples in the wild

This section is informative.

The following sites have published hReviews, and thus are a great place to start for anyone looking for examples "in the wild" to try parsing, indexing, organizing etc. If you publish hReviews on your own page, feel free to add it to the top of this list. Once the list grows too big, we'll make a separate wiki page.

Want to get started with writing an hReview? Use the hReview creator to write a review and publish it on your blog.

Implementations

This section is informative.

The following implementations have been developed which either generate or parse hReviews. If you have an hReview 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.

References

Normative References

Informative References

Similar Work

Copyright

This specification is (C) 2005 by the authors. However, the authors intend to submit (or already have submitted, see details in the spec) this specification to a standards body with a liberal copyright/licensing policy such as the GMPG, IETF, and/or W3C. Anyone wishing to contribute should read their copyright principles, policies and licenses (e.g. the GMPG Principles) and agree to them, including licensing of all contributions under all required licenses (e.g. CC-by 1.0 and later), before contributing.

Patents

This specification is subject to a royalty free patent policy, e.g. per the W3C Patent Policy, and IETF RFC3667 & RFC3668.

Work in progress

This specification is a work in progress. As additional aspects are discussed, understood, and written, they will be added.

Changes from v0.2

The following changes have been made in hReview v0.3 over hReview v0.2:

Normative changes:

  1. MUST (instead of SHOULD) use hCard for the item description of a business or person
  2. "reviewer" changes
    1. Made reviewer *optional* per feedback from Ryan King and Mark Nottingham
    2. 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. <address> for (X)HTML pages) as the reviewer.
    3. MUST (instead of SHOULD) use hCard to represent reviewer information
  3. "dtreviewed" changes
    1. Made dtreviewed *optional* per feedback from Ryan King and Mark Nottingham
    2. If dtreviewed is absent from the hReview, then look outside the hReview, in the surrounding context. If the context is an 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).
  4. SHOULD use hCalendar to represent an item of 'type' 'event'
  5. Added one decimal digit of precision to ratings' numerical values based on publisher experience.
  6. Use 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.
  7. Added rel-license-fr to indicate the license of the hReview as a whole.
  8. Permit tags inside ratings to denote rated tags, the same as ratings inside tags per suggestion from Eran Globen.
  9. Add include-pattern support to allow multiple reviews for the same item to not repeat the item info.

Informative changes (several, but in particular):

  1. 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.
  2. Updated examples accordingly.

Discussions

Q&A

  • If you have any questions about hReview, check the hReview FAQ, and if you don't find answers, add your questions to the end!

Issues

  • Please add any issues with the specification to the separate hReview issues document.
Retrieved from "http://microformats.org/wiki/index.php?title=hreview-fr&oldid=6876"