hreview-ja

(Difference between revisions)

Jump to: navigation, search
(Schema: translated rest items)
(フィールドの詳細: item info, dtreviewed and below)
Line 73: Line 73:
'''item type''':: この"type"という任意のフィールドはレビューされるitemのタイプを示し、それらは、product、business、event、person、place, website、urlのいずれか一つです。省略されている場合は、そのitemのタイプを導出してよい場合があります。もしitemが[[hcard-ja|hCard]]でもある場合は、そのitemのタイプはhCardの内容に基づいて"business"または"person"になります。もしitemが[[hcalendar-ja|hCalendar]]のeventでもある場合は、itemのタイプは"event"です。
'''item type''':: この"type"という任意のフィールドはレビューされるitemのタイプを示し、それらは、product、business、event、person、place, website、urlのいずれか一つです。省略されている場合は、そのitemのタイプを導出してよい場合があります。もしitemが[[hcard-ja|hCard]]でもある場合は、そのitemのタイプはhCardの内容に基づいて"business"または"person"になります。もしitemが[[hcalendar-ja|hCalendar]]のeventでもある場合は、itemのタイプは"event"です。
-
'''item info''':: この必須フィールドは少なくとも''その''item(1つのhReviewは、ただ1つのitemについて説明します)の名前("fn" - その名前に対応する整形済み文字列,except for an event item which {{must}} have the "summary" property inside the respective hCalendar "vevent")を持たなければなりません({{must}})。そして、そのitemに対応する少なくとも1つのURI ("url")を持つべきです({{should}})。さらに、そのitemの写真または絵("photo")のURLを含めることができます({{may}})。  
+
'''item info''':: この必須フィールドは少なくとも''その''item(1つのhReviewは、ただ1つのitemについて説明します)の名前("fn" - その名前に対応する整形済み文字列。ただし、イベントの item を除きます。イベントの場合は hCalendar の各 "vevent" の中に "summary" プロパティがなければなりません({{must}}))を持たなければなりません({{must}})。そして、そのitemに対応する少なくとも1つのURI ("url")を持つべきです({{should}})。さらに、そのitemの写真または絵("photo")のURLを含めることができます({{may}})。  
itemのタイプが"person"または"business"の場合は、そのitem info (fn, url, photo)は[[hcard-ja|hCard]]の中に囲まれている必要があります({{must}})。
itemのタイプが"person"または"business"の場合は、そのitem info (fn, url, photo)は[[hcard-ja|hCard]]の中に囲まれている必要があります({{must}})。
itemのタイプが"event"の場合は、そのitem infoは[[hcalendar-ja|hCalendar]] veventの中に囲まれているべきです({{should}})。
itemのタイプが"event"の場合は、そのitem infoは[[hcalendar-ja|hCalendar]] veventの中に囲まれているべきです({{should}})。
Line 85: Line 85:
すなわち、HTMLドキュメントの場合、 <code><nowiki><address></nowiki></code>で示されているそのページについての連絡先(これは [[hcard|hCard]]で同様にマークアップされているのが理想的です)、Atom 1.0では、<code><nowiki><entry></nowiki></code> <code><nowiki><author></nowiki></code>、または、それがなければ<code><nowiki><feed></nowiki></code> <code><nowiki><author></nowiki></code>、RSSでは<code><nowiki><item></nowiki></code>要素の内側にある<code><nowiki><author></nowiki></code>となります。
すなわち、HTMLドキュメントの場合、 <code><nowiki><address></nowiki></code>で示されているそのページについての連絡先(これは [[hcard|hCard]]で同様にマークアップされているのが理想的です)、Atom 1.0では、<code><nowiki><entry></nowiki></code> <code><nowiki><author></nowiki></code>、または、それがなければ<code><nowiki><feed></nowiki></code> <code><nowiki><author></nowiki></code>、RSSでは<code><nowiki><item></nowiki></code>要素の内側にある<code><nowiki><author></nowiki></code>となります。
-
'''dtreviewed''':: This optional field when present {{must}} provide an [[ISO-8601|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.
+
'''dtreviewed''':: 公開した時点に関するこの任意のフィールドは、レビューが書かれたか生み出された時点の [[ISO-8601|ISO8601]] 絶対日時(absolute date time)を提供''しなければなりません''({{must}})。このフィールドは UTC を使う''べき''({{should}})ですが、タイムゾーンオフセット構文を使うことも''できます''({{may}})。hReview に dtreviewed が無い場合は、外部の、hReview を取り囲む文脈中を見ます。その文脈が [[hatom|hAtom]] エントリーだった場合、フィードの "published"(見つからなければ "updated")の日時を使います。それ以外の場合、dtreviewed として hReview を含む文書の(訳注:XML としての)言語(例えば Atom フィードの "published"/"updated" のような物)を参照して作成日時(見つからなければ更新日時)の情報を使い、それも無ければプロトコル(例えば HTTP Last-Modified や ファイルシステムの最終更新日時)を使います。
-
'''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.
+
'''rating''':: rating(格付け)は、項目の評価を含んだ 1.0 から 5.0 までの(精度が 10 進小数点以下一桁の)固定小数点数で、デフォルトでは高い値が良い評価を表します。任意で、別の "worst" または "best" またはその両方の数値を定義して違った範囲(例えば 0-10 の 6)を設定することも''できます''({{may}})。"best" の値を "worst" よりも小さい数にしてもかまいません。
-
'''description''':: This optional field contains the full text representing the written opinion of the reviewer.  The field {{may}} include valid HTML 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.
+
'''description''':: この任意のフィールドにはレビュアーの意見を書いたテキスト全文が入ります。このフィールドには妥当な HTML マークアップが含まれていても''かまいません''({{may}})。ユーザーエージェントは全てのマークアップを保持する''べきです''({{should}})。多角的な記述や節をまたぐ記述(例えば賛否や長短)は description フィールドに含まれる''べきです''({{should}})。
-
'''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.
+
'''tags''':: タグはレビュアーが item と結びつけたキーワードやフレーズ(ここのキーワードやフレーズのタグには [[rel-tag-ja|rel-tag]] マイクロフォーマットを使います)のリストを使って表現されます。レビュアーは任意で、そのタグに関する rating を各 [[rel-tag-ja|rel-tag]] の中で提供することが''できます''({{may}})。例:ambience:5。あるタグのデフォルトの rating は、もしあれば item 全体の rating 範囲を使います。worst~best を設定し直して使うことも''できます''({{may}})。レビュー著者は、その方が使いやすければ、同じ意味を保持しながらこの構造を逆転させることも''できます''({{may}})。つまり、評価付きのタグを表すのに rating の中に [[rel-tag-ja|rel-tag]] を入れることもできるのです。注:評価付きのタグは、理想としては、そのタグが意味する物を説明しているタグスペース使う''べきです''({{should}})。例えば Food:18/30 というのは、Food タグとして 30 点中 18 点が何を意味しているのか説明している Food のタグスペースにリンクしている''べきです''({{should}})。
-
'''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.
+
'''permalink''':: この任意のフィールドは hReview の URL です。あるハイパーリンクがレビュー自身の固定リンクだと示すには、このフィールドの <code><a href></code> タグに加えて、<code>rel="self bookmark"</code> を使''わなければなりません''({{must}})。ハイパーリンクに既に <code>rel</code> が含まれている場合は、この属性の中に空白で区切って <code>self</code> <code>bookmark</code> という値を含め''なければなりません''({{must}})。索引作成者/プログラムは、(一つのページから何度も索引を作るなど)複数の情報源から同じレビューを特定して照合するための一意の ID として、レビューの固定リンクを使うことが''できます''({{may}})。レビュー著者は固定リンクだと示すために、要素に "permalink" というクラス名を使うことができますが、必須ではありません。
-
'''license''':: This optional field links to the license under which the contents of the hReview itself is licensed, using the '''[[rel-license]]''' microformat.
+
'''license''':: この任意のフィールドは、hReview の記事自身が基づいているライセンスへのリンクを表します。'''[[rel-license-ja|rel-license]]''' マイクロフォーマットを使います。
-
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].
+
次のフィールド名は [[hcard-ja|hCard]] [[hcalendar-ja|hCalendar]] マイクロフォーマットからの再利用です: <code>version, summary, fn, url, photo, description</code>。さらに、hCard で記された item とレビュアーには hCard のどのフィールドが含まれていても''かまいません''({{may}})。rel 属性の "self" という値は [http://atompub.org/2005/07/11/draft-ietf-atompub-format-10.html Atom 1.0 仕様]からの再利用です。
=== More Semantic Equivalents ===
=== More Semantic Equivalents ===

Revision as of 19:31, 1 November 2008

hReview 0.3

hReview はHTMLやXHTML, Atom, RSS, 任意のXMLなどにレビュー(商品、サービス、ビジネス、イベントなど)を埋め込むのに適したシンプルかつオープンで分散型のフォーマットです。hReviewはオープンスタンダードなmicroformatsの一つです。

hReviewを使い始めてみたいなら、hReview creatorでレビューを書いて、作成したコードをページに貼り付けてみてください。(注記:hReview creatorは現在正常に機能していないようです。)

Microformats Draft Specification 2006-02-22

Editor
Tantek Çelik (Technorati, Inc.)
Authors
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)

Microformats copyright and patents statements apply.

Contents


Introduction

非常に多くのウェブサイトが、製品(映画、音楽、本)から企業(レストラン、ホテル、店)、イベント(コンサート、演劇)、人物(歌手、指導者、有名人)、場所(歴史的建造物、公園)、オンラインリソース(ウェブページ、ファイル)やレビューのレビューにいたるまで、あらゆる種類の事物に関する幅広い形式のレビューを公開しています。

こういったレビューの共有、配布、シンジケーション(配信)、アグリゲーション(集約)を可能にし、促進するため、hReview マイクロフォーマットを提案します。これはレビュー配布のオープンスタンダードです。既存の色々なレビューの例や、レビュー形式についての先人の試みを調べ、レビューのおおよそ最小のスキーマとして hReview を設計しました。フィードバックは hReview フィードバックページにお願いします。

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.

Inspiration and Acknowledgments

hReview 開発参加のオープンな呼び掛けに応えてくれた皆さんに感謝します。特に次の人たちに、建設的な意見とフィードバックを頂いたことに謝意を示したいと思います。Richard AultDanny AyersJeffrey BarrAdrian CuthbertJason DeFillippoBrian Del Vecchio、Scott Derringer、Bud GibsonJoi ItoGen KanaiNiall KennedyRohit KhareRyan KingJonas LusterKevin Marks、Mark Nottingham、Derek PowazekJeff RodenburgDavid SifryJames StewartAdriaan TijsselingPhillip Torrone、Thai Tran、Phillip WinnYAMAMOTO Yohei

Scope

多くのレビューでは、いくつか一般的な項目が共通しています。この最小の共通部分に基いている所では、hReview が使えます。

Out of scope

hReview ではレビューの種類固有のフィールドは除外されています。初めからシンプルかつ最小であり続けることが重要なのです。機能の追加は実装上必要だと認められた時に行われます。

「universal object identifier(統一物品識別子)」の概念――異なるショッピングサイトからいかにして同じ物品・項目・製品を特定するか――は、とても役に立つものもありますが、このフォーマットの範囲外です。

Semantic XHTML Design Principles

Note: the Semantic XHTML Design Principles were written primarily within the context of developing hCard and hCalendar, thus it may be easier to understand these principles in the context of the hCard design methodology (i.e. read that first). Tantek

XHTML is built on XML, and thus XHTML based formats can be used not only for convenient display presentation, but also for general purpose data exchange. In many ways, XHTML based formats exemplify the best of both HTML and XML worlds. However, when building XHTML based formats, it helps to have a guiding set of principles.

  1. Reuse the schema (names, objects, properties, values, types, hierarchies, constraints) as much as possible from pre-existing, established, well-supported standards by reference. Avoid restating constraints expressed in the source standard. Informative mentions are ok.
    1. For types with multiple components, use nested elements with class names equivalent to the names of the components.
    2. Plural components are made singular, and thus multiple nested elements are used to represent multiple text values that are comma-delimited.
  2. Use the most accurately precise semantic XHTML building block for each object etc.
  3. Otherwise use a generic structural element (e.g. <span> or <div>), or the appropriate contextual element (e.g. an <li> inside a <ul> or <ol>).
  4. Use class names based on names from the original schema, unless the semantic XHTML building block precisely represents that part of the original schema. If names in the source schema are case-insensitive, then use an all lowercase equivalent. Components names implicit in prose (rather than explicit in the defined schema) should also use lowercase equivalents for ease of use. Spaces in component names become dash '-' characters.
  5. Finally, if the format of the data according to the original schema is too long and/or not human-friendly, use <abbr> instead of a generic structural element, and place the literal data into the 'title' attribute (where abbr expansions go), and the more brief and human readable equivalent into the element itself. Further informative explanation of this use of <abbr>: Human vs. ISO8601 dates problem solved

Format

一般

hReviewフォーマットは、現在ウェブ上にたくさんあるレビューサイトとフォーマットに共通して使われているフィールドに基づいています。 使用できるフィールド名は、hCardhCalendar標準仕様に関連して定義されているものを元にして選ばれています。

Schema

hReviewのスキーマは以下の通りです:

フィールドの詳細

hReviewの各フィールドは以下の内容を表します。

version:: この任意のフィールドには、コンテンツ中で使用しているhReviewのバージョンを指定することができます。このフィールドを省略すると、hReview仕様のv2.0またはそれ以降の任意のバージョンによって解釈をしていいと宣言したことになります。 実際には、この仕様の著者たちは、初期のバージョンの仕様によって生成されたコンテンツに対する後方互換性を維持することにコミットしています。 このフィールドはvCard RFC2426 section "3.6.9 VERSION Type Definition"で定義されている"VERSION"の文法と互換性があり、 結果としてそれを再利用したものになっています。 本仕様に対するこのフィールドの値は"0.3"です。

summary:: この任意のフィールドは、レビュー自体のタイトルを表します。

item type:: この"type"という任意のフィールドはレビューされるitemのタイプを示し、それらは、product、business、event、person、place, website、urlのいずれか一つです。省略されている場合は、そのitemのタイプを導出してよい場合があります。もしitemがhCardでもある場合は、そのitemのタイプはhCardの内容に基づいて"business"または"person"になります。もしitemがhCalendarのeventでもある場合は、itemのタイプは"event"です。

item info:: この必須フィールドは少なくともそのitem(1つのhReviewは、ただ1つのitemについて説明します)の名前("fn" - その名前に対応する整形済み文字列。ただし、イベントの item を除きます。イベントの場合は hCalendar の各 "vevent" の中に "summary" プロパティがなければなりません(MUST))を持たなければなりません(MUST)。そして、そのitemに対応する少なくとも1つのURI ("url")を持つべきです(SHOULD)。さらに、そのitemの写真または絵("photo")のURLを含めることができます(MAY)。 itemのタイプが"person"または"business"の場合は、そのitem info (fn, url, photo)はhCardの中に囲まれている必要があります(MUST)。 itemのタイプが"event"の場合は、そのitem infoはhCalendar veventの中に囲まれているべきです(SHOULD)。 itemのURLではないユニークな識別子(e.g. ISBN、UPC など)は、そのitemのURN ("url")として表現することができます(MAY)。 itemの内側に含まれるmicroformats (現在はhCardhCalendar event)は、item自体にセットすることができます。(e.g. class="item vcard") しかし、item infoの下位プロパティ("fn"、"url"、"photo")を使用する場合は、それらはitemの要素の内側になければなりません(MUST)。

reviewer:: この任意のフィールドはレビューを書いた人を示します。 もしもreviewerが指定されている場合、そのreviewerを表現するhCardが必要です(MUST)。匿名のレビューにするには、"anonymous"(引用符を除く)をその"reviewer"のフルネームとしてください。 "reviewer"がhReviewの内側にない場合、パーザーはそのページのhReviewの外側を探すべきです。 "reviewer"がhReviewの外側にもない場合、 パーザーは、そのドキュメントが使用している言語の中で定義されている著者を使うべきです。 すなわち、HTMLドキュメントの場合、 <address>で示されているそのページについての連絡先(これは hCardで同様にマークアップされているのが理想的です)、Atom 1.0では、<entry> <author>、または、それがなければ<feed> <author>、RSSでは<item>要素の内側にある<author>となります。

dtreviewed:: 公開した時点に関するこの任意のフィールドは、レビューが書かれたか生み出された時点の ISO8601 絶対日時(absolute date time)を提供しなければなりませんMUST)。このフィールドは UTC を使うべきSHOULD)ですが、タイムゾーンオフセット構文を使うこともできますMAY)。hReview に dtreviewed が無い場合は、外部の、hReview を取り囲む文脈中を見ます。その文脈が hAtom エントリーだった場合、フィードの "published"(見つからなければ "updated")の日時を使います。それ以外の場合、dtreviewed として hReview を含む文書の(訳注:XML としての)言語(例えば Atom フィードの "published"/"updated" のような物)を参照して作成日時(見つからなければ更新日時)の情報を使い、それも無ければプロトコル(例えば HTTP Last-Modified や ファイルシステムの最終更新日時)を使います。

rating:: rating(格付け)は、項目の評価を含んだ 1.0 から 5.0 までの(精度が 10 進小数点以下一桁の)固定小数点数で、デフォルトでは高い値が良い評価を表します。任意で、別の "worst" または "best" またはその両方の数値を定義して違った範囲(例えば 0-10 の 6)を設定することもできますMAY)。"best" の値を "worst" よりも小さい数にしてもかまいません。

description:: この任意のフィールドにはレビュアーの意見を書いたテキスト全文が入ります。このフィールドには妥当な HTML マークアップが含まれていてもかまいませんMAY)。ユーザーエージェントは全てのマークアップを保持するべきですSHOULD)。多角的な記述や節をまたぐ記述(例えば賛否や長短)は description フィールドに含まれるべきですSHOULD)。

tags:: タグはレビュアーが item と結びつけたキーワードやフレーズ(ここのキーワードやフレーズのタグには rel-tag マイクロフォーマットを使います)のリストを使って表現されます。レビュアーは任意で、そのタグに関する rating を各 rel-tag の中で提供することができますMAY)。例:ambience:5。あるタグのデフォルトの rating は、もしあれば item 全体の rating 範囲を使います。worst~best を設定し直して使うこともできますMAY)。レビュー著者は、その方が使いやすければ、同じ意味を保持しながらこの構造を逆転させることもできますMAY)。つまり、評価付きのタグを表すのに rating の中に rel-tag を入れることもできるのです。注:評価付きのタグは、理想としては、そのタグが意味する物を説明しているタグスペース使うべきですSHOULD)。例えば Food:18/30 というのは、Food タグとして 30 点中 18 点が何を意味しているのか説明している Food のタグスペースにリンクしているべきですSHOULD)。

permalink:: この任意のフィールドは hReview の URL です。あるハイパーリンクがレビュー自身の固定リンクだと示すには、このフィールドの <a href> タグに加えて、rel="self bookmark" を使わなければなりませんMUST)。ハイパーリンクに既に rel が含まれている場合は、この属性の中に空白で区切って selfbookmark という値を含めなければなりませんMUST)。索引作成者/プログラムは、(一つのページから何度も索引を作るなど)複数の情報源から同じレビューを特定して照合するための一意の ID として、レビューの固定リンクを使うことができますMAY)。レビュー著者は固定リンクだと示すために、要素に "permalink" というクラス名を使うことができますが、必須ではありません。

license:: この任意のフィールドは、hReview の記事自身が基づいているライセンスへのリンクを表します。rel-license マイクロフォーマットを使います。


次のフィールド名は hCardhCalendar マイクロフォーマットからの再利用です: version, summary, fn, url, photo, description。さらに、hCard で記された item とレビュアーには hCard のどのフィールドが含まれていてもかまいませんMAY)。rel 属性の "self" という値は Atom 1.0 仕様からの再利用です。

More Semantic Equivalents

For some properties there is a more semantic equivalent, and therefore they get special treatment, e.g.:

Language

Human vs. Machine Readable

If an <abbr> element is used for a property, then its 'title' 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.

Similarly, if an <img /> element is used for one or more properties, it MUST be treated as follows:

  1. For the "photo" property and any other property that takes a URL as its value, the src="..." attribute provides the property value.
  2. For other properties, the <img /> element's 'alt' attribute is the value of the property.

Object Includes

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.

Examples

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.

Restaurant reviews

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

Multidimensional Restaurant Review

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>
  <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 { margin:1em 0; padding:0 }
ul 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.

Product review

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"><span class="item">
 <a class="url fn" 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" />
  The Postal Service: Give Up</a></span>
 <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 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 separate page.

See hReview Examples in the wild.

Implementations

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 separate page.

See hReview Implementations.

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

Further Reading

Related Pages

hreview-ja was last modified: Wednesday, December 31st, 1969

Views