hReview-aggregate 0.2

From Microformats Wiki
Jump to navigation Jump to search

Ce document est une spécification microformat draft. Bien que les "drafts" soient en quelque sorte mâtures dans le processus de développement, la stabilité de ce document ne peut être garantie, et les implémenteurs doivent être prêts à rester informés des futurs développements et modifications. Suivez cette page wiki, ou suivez les discussions sur la liste de discussion microformats-new pour rester informé.

hReview-aggregate est un format pour embarquer l'information d'avis (sur des produits, services, entreprises, etc.). Alors que hReview est destiné à une critique individuelle, hReview-aggregate est conçu pour l'information résumée d'un ensemble d'avis critiques d'utilisateurs à propos d'un item. hReview-aggregate est l'un des nombreux microformats standards ouverts pour embarquement dans le HTML, XHTML, Atom, RSS, le XML arbitraire.

Microformats Draft Specification 2009-11-10

Editeur
Kavi Goel, Google
Auteurs/Contributeurs (ordre alphabétique)
Tantek Çelik
Othar Hansson, Google
Jay Myers, Best Buy, Co., Inc.
Traduction
Christophe Ducamp

Introduction

Beaucoup de sites web publient des avis en utilisant toute une variété de schémas d'organisation. hReview-aggregate et le microformat similaire hReview ont été conçus pour permettre le partage de l'information de critiques.

hReview, créé en 2006, est bien adapté pour marquer les avis produits par des utilisateurs individuels sur leurs propres sites web ou pour les avis des éditeurs sur un nouveau produit ou service. Néanmoins, durant les dernières années, il y a eu un nombre croissant de sites qui agrègent leurs critiques d'utilisateurs, soit en acceptant des propositions de critiques sur leurs sites web ou en assemblant ces critiques d'utilisateurs provenant de partout sur le web. Dans ces cas là, il est souvent intéressant de partager non seulement les critiques individuelles affichées sur la page web, mais l'opinion consensuelle provenant de ces critiques individuelles.

hReview-aggregate a été créé pour répondre à ce besoin. hReview-aggregate est un standard qui peut être utilisé pour partager le nombre d'avis, la note moyenne et l'opinion consensuelle pour un produit ou service particulier. Il est conçu pour compléter hReview et réutiliser les propriétés de hReview à chaque fois que possible. La recherche et la discussion qui ont nourri la conception de hReview-aggregate peut être trouvée sur la page wiki aggregate review brainstorming.

Les mots-clés "DOIT", "NE DOIT PAS", "OBLIGATOIRE", "DEVRA", "NE DEVRA PAS", "DEVRAIT", "NE DEVRAIT PAS", "RECOMMANDÉ", "PEUT" et "OPTIONNELLE" dans ce document doivent être interprétés comme décrits dans la RFC 2119.

Etendue

Les collections d'avis partagent de façon cohérente plusieurs aspects communs. Chaque fois que cela est possible, hReview-aggregate a été fondé sur ce sous-ensemble commun.

Hors Sujet

Les portions de critiques qui sont spécifiques à des formes particulières d'items ont été omises de hReview-aggregate.

Format

Schéma

Le schéma hReview-aggregate contient ce qui suit :

  • hReview-aggregate (hreview-aggregate)
    • item info. requis. fn (url || photo ) | hCard (pour une personne ou organisation) | hCalendar (pour événement) | hProduct (pour un produit)
    • rating. requis. nombre entier avec une décimale [1.0-5.0], avec alternative optionnelle worst (par défaut :1.0) et/ou best (par défaut :5.0), aussi nombre entier avec une décimale, et average explicite.
    • count. optionnel. nombre entier non négatif.
    • votes. optionnel. nombre entier non négatif. Remarquez que bien que count et votes sont tous deux marqués comme optionnels, au moins l'un des deux champs doit être spécifié.
    • summary. optionnel. texte.

Détails de propriété

Détails des propriétés de hReview-aggregate :

item :: Cette propriété obligatoire DOIT avoir au minimum le nom de l'entité étant critiquée (en utilisant la sous-propriété "fn"), ou alternativement avoir un microformat encapsulé (c'est à dire hCard pour une entreprise ou une personne, hProduct pour un produit, ou hCalendar pour un événement). Si un microformat encapsulé n'est pas utilisé, un URI ("url") pour l'item et une photo ou vignette ("photo") PEUT aussi être fournie. Les IDs d'items uniques non-url (par ex. ISBNs, UPCs) PEUVENT être représentées sous une URN ("url") pour l'item. Les microformats encapsulés doivent être réglés sur l'item lui-même (par ex. class="item vcard"). Néanmoins, au moment d'utiliser les sous-propriétés d'info de l'item ("fn", "url", "photo"), elles doivent être encapsulées à l'intérieur de l'élément item.

rating :: Le "rating" est un nombre entier à une décimale (un point décimale de précision) allant de 1.0 à 5.0 inclus indiquant la note moyenne pour l'item sur toutes les critiques, la plus haute indiquant une meilleure note par défaut. En option, une valeur intégrale différente "worst" et/ou "best" peut être spécifiée pour indiquer une échelle différente (par ex. 6 de 0-10).

count :: Cette propriété est utilisée pour spécifier le nombre total de critiques pour le produit ou service.

'votes ':: Cette propriété est utilisée pour spécifier le nombre total d'utilisateurs qui ont évalué le produit ou service, contribuant à la note moyenne. Pour certains sites, le nombre de votes est égal au nombre de critiques, aussi count peut être utilisé et cette propriété omise.

summary :: Cette propriété obligatoire peut être le titre pour la collection d'avis ou un très bref résumé de l'opinion consensuelle provenant de la collection.

Les propriétés item, rating et summary sont réutilisées à partir de hReview.

Exemples

Exemple basique

Voici un exemple montrant quelque information d'avis agrégé pour un restaurant :

<div>
 <h3>
  <span>Le Chéri Bibi</span>
 </h3>
 <span>Au pied du Sacré-Coeur, voilà un restaurant où l'on va pour la déco, entre vide-grenier et brocante design, 
 pour l'ambiance, branchée sans façon, et pour l'assiette, bien inspirée, dans un style traditionnel. 
 A tester, donc, la salade de lentilles, le mijoté de boeuf à la coriandre, l'onctueuse purée maison, le riz au lait ou le tiramisu à l'amaretto. 
 Aussi une jolie sélection de vins, dont certains au verre.</span>
 <span>4.1 sur 5 basé sur 36 critiques</span> de bobos.
</div>

En ajoutant un marquage hReview-aggregate ceci donne :

<div class="hreview-aggregate">
 <h3 class="item">
  <span class="fn">Le Chéri Bibi</span>
 </h3>
 <span class="summary">Au pied du Sacré-Coeur, voilà un restaurant où l'on va pour la déco, entre vide-grenier et brocante design, 
 pour l'ambiance, branchée sans façon, et pour l'assiette, bien inspirée, dans un style traditionnel. 
 A tester, donc, la salade de lentilles, le mijoté de boeuf à la coriandre, l'onctueuse purée maison, le riz au lait ou le tiramisu à l'amaretto. 
 Aussi une jolie sélection de vins, dont certains au verre.</span>
 <span><span class="rating">4.1</span> sur 5 
 basé sur <span class="count">36</span> critiques</span> de bobos.
</div>

Microformat embarqué, échelle de notation 10-points

Souvent, il y a plus d'information sur une page concernant l'item critiqué que le titre. Voici un autre exemple de critique de restaurant, mais avec la présence de l'information adresse.

<div>
 <div>
  <h3>Le Chéri Bibi</h3>
  <span>15 rue André del Sarte</span>
  <span>Paris 18</span>
  <span>+33 1 42 54 88 96</span>
 </div> 
 <span>Au pied du Sacré-Coeur, voilà un restaurant où l'on va pour la déco, entre vide-grenier et brocante design, 
 pour l'ambiance, branchée sans façon, et pour l'assiette, bien inspirée, dans un style traditionnel. 
 A tester, donc, la salade de lentilles, le mijoté de boeuf à la coriandre, l'onctueuse purée maison, le riz au lait ou le tiramisu à l'amaretto. 
 Aussi une jolie sélection de vins, dont certains au verre.</span>
 <span>8.2 sur 10 basée sur 36 avis</span>
</div>

Et voici ce que cela donne avec le marquage hReview-aggregate, avec une hCard embarquée pour décrire l'information adresse et téléphone du restaurant :

<div class="hreview-aggregate">
 <div class="item vcard">
  <h3 class="fn">Le Chéri Bibi</h3>
  <span class="adr">
   <span class="street-address">15 rue André del Sarte</span>
   <span class="postal-code">75018</span> <span class="locality">Paris</span> (<span class="country-name">France</span>)
  </span>
   <span class="tel">+33 1 42 54 88 96</span>
 
 </div> 
 <span class="summary">Au pied du Sacré-Coeur, voilà un restaurant où l'on va pour la déco, entre vide-grenier et brocante design,
 pour l'ambiance, branchée sans façon, et pour l'assiette, bien inspirée, dans un style traditionnel. A tester, donc, la salade de lentilles, 
 le mijoté de boeuf à la coriandre, l'onctueuse purée maison, le riz au lait ou le tiramisu à l'amaretto. 
 Aussi une jolie sélection de vins, dont certains au verre.</span>
 <span class="rating"><span class="average">8.2</span> sur <span class="best">10</span> 
 basé sur <span class="count">36</span> avis</span>
</div>

Remarquez que l'item et la vcard sont placés côte à côte dans le même attribut de classe afin de montrer que l'item critiqué est décrit par la hCard embarquée.


Count vs votes

Dans les exemple à ce stade, la propriété count a été utilisée mais pas votes. votes est utile quand les utilisateurs ont voté un item sans écrire de critiques correspondantes. Leurs votes ont contribué à l'évaluation moyenne mais pas sur le nombre de critiques disponibles.

Considérez cet exemple :

<div>
 <h3>
  <span>Le Chéri Bibi</span>
 </h3>
 <span>Au pied du Sacré-Coeur, voilà un restaurant où l'on va pour la déco, entre vide-grenier et brocante design,
 pour l'ambiance, branchée sans façon, et pour l'assiette, bien inspirée, dans un style traditionnel. A tester, donc, la salade de lentilles, 
 le mijoté de boeuf à la coriandre, l'onctueuse purée maison, le riz au lait ou le tiramisu à l'amaretto. 
 Aussi une jolie sélection de vins, dont certains au verre.</span>
 <span>4.5 sur 5 basé sur 24 notes.</span>
 <span>5 avis de clients :</span>
 ...
</div>

Voici l'exemple à nouveau, avec à la fois count et votes spécifiés chaque fois que c'est pertinent.

<div class="hreview-aggregate">
 <h3 class="item">
  <span class="fn">Le Chéri Bibi</span>
 </h3>
 <span class="summary">Au pied du Sacré-Coeur, voilà un restaurant où l'on va pour la déco, entre vide-grenier et brocante design,
 pour l'ambiance, branchée sans façon, et pour l'assiette, bien inspirée, dans un style traditionnel. A tester, donc, la salade de lentilles, 
 le mijoté de boeuf à la coriandre, l'onctueuse purée maison, le riz au lait ou le tiramisu à l'amaretto. 
 Aussi une jolie sélection de vins, dont certains au verre.</span>
 <span><span class="rating">4.5</span> sur 5 
 based on <span class="votes">24</span> notes.</span>
 <span><span class="count">5</span> avis de clients :</span>
 ...
</div>

exemples dans la jungle

Cette section est informative.

Les sites suivants ont implémenté hReview-aggregate, et sont par conséquent un endroit génial pour quiconque chercherait des exemples "dans la jungle" afin d'essayer de parser, d'indexer, d'organiser, etc. Si votre site est marqué avec hReview aggregate, sentez-vous à l'aise pour l'ajouter en haut de cette liste. Une fois que la liste sera trop grosse, nous produirons une page wiki séparée comme hreview-aggregate-exemples-dans-la-jungle.

Pages en Rapport