hReview 0.3

(Difference between revisions)

Jump to: navigation, search
(Movie Review: translated)
(Examples in the wild: translated)
Line 404: Line 404:
== Examples in the wild ==
== 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 [[hreview-examples-in-wild|separate page]].
この説は'''参考情報'''です。この仕様の文中で書かれている可能性をはるかに超えて、実際に hReview を使っている例がたくさんあります。これは [[hreview-examples-in-wild|別ページ]]に移しました。
See [[hreview-examples-in-wild|hReview Examples in the wild]].
[[hreview-examples-in-wild|hReview Examples in the wild]] を参照してください。
== Implementations ==
== Implementations ==

Revision as of 18:55, 12 December 2008

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 Freenode IRC channel to stay up-to-date.

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

hReviewを使い始めてみたいなら、hReview creatorでレビューを書いて、作成したコードをページに貼り付けてみてください。

Microformats Draft Specification 2006-02-22

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




こういったレビューの共有、配布、シンジケーション(配信)、アグリゲーション(集約)を可能にし、促進するため、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


多くのレビューでは、いくつか一般的な項目が共通しています。この最小の共通部分に基いている所では、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



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





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 仕様からの再利用です。



Human vs. Machine Readable

プロパティに <abbr> 要素を使う場合、そのプロパティの値には、要素の内容ではなく 'title' 属性を使います。そうすることで、また別のユーザーフレンドリーな値の表現を提供することができるのです。

同様に、プロパティに <img /> を使う時には、次のように扱わなければなりません(MUST)。

  1. "photo" プロパティや、値として URL を使う他のプロパティには src="..." 属性がその値を決めます。
  2. その他のプロパティには <img /> 要素の 'alt' 属性がプロパティ値になります。

Object Includes

hReview 0.3 はオブジェクトインクルードパターンをサポートしています。

一つのページで一つのアイテムとそのアイテムに関する複数のレビューを並べることがよくあります。そのアイテムの各レビューで item info を繰り返さなければならないということを避けるため、次のようにするべきです。最初のレビューを hReview としてマークアップし、item info では一意な "id" 属性を付けます。それ以降のレビューではオブジェクトインクルードパターンを使って最初のレビューから item info をインクルードします。




以下では現在のウェブサイトからレビューの例をいくつか取り上げて、どれほど簡単にレビューの構造化されたマイクロフォーマットである hReview をサポートするように改良できるかを示します。

すぐに hReview を始めたいという人は、hReview creator を使ってレビューを書き、自分のブログで公表してみてください。

Restaurant reviews


 <h4>Crepes on Cole は最高</h4>
 <span>レビュアー:<span>Tantek</span> - 2005年4月18日
  Crepes on Cole はサンフランシスコの小さなクレープ屋で最高の所の一つだ。
  すぐそこに停まる N-Judah を眺めたり、N-Judah の方から見たりという素晴らしい体験ができる。
  わたしはここで近所の WiFi に助けられながらたくさんの仕事をしているのだが、
 <p>食べたもの:<span>フィレンツェ風クレープ(Florentine crepe)</span></p>

このレビューに hReview を付け加えるのはいい例です。

<div class="hreview">
 <span>星5個中<span class="rating">5</span>個</span>
 <h4 class="summary">Crepes on Cole は最高</h4>
 <span class="reviewer vcard">レビュアー:<span class="fn">Tantek</span> - 
 <abbr class="dtreviewed" title="20050418T2300-0700">2005年4月18日</abbr></span>
 <div class="description item vcard"><p>
  <span class="fn org">Crepes on Cole</span> は  
  <span class="adr"><span class="locality">サンフランシスコ</span></span>の小さなクレープ屋で最高の所の一つだ。
  すぐそこに停まる N-Judah を眺めたり、N-Judah の方から見たりという素晴らしい体験ができる。
  わたしはここで近所の WiFi に助けられながらたくさんの仕事をしているのだが、 
 <p>食べたもの:<span>フィレンツェ風クレープ(Florentine crepe)</span></p>

このレビュー例ではいくつか hReview としては記録されていないプロパティ(訪問日、食べたもの)があることに注意してください。これは hReview を最小で簡単なものにしておくため、敢えてしたことです。

この例の hReview は次のように表現できます。

Crepes on Cole は最高
レビュアー:Tantek - 2005年4月18日

Crepes on Cole はサンフランシスコの小さなクレープ屋で最高の所の一つだ。出す物もサービスも素晴らしい。大きい物から小さい物まで、パーティ用のいろいろな大きさのテーブルがある。窓側の席は、すぐそこに停まる N-Judah を眺めたり、N-Judah の方から見たりという素晴らしい体験ができる。わたしはここで近所の WiFi に助けられながらたくさんの仕事をしているのだが、何度も楽しい集会をしてもいる。

食べたもの:フィレンツェ風クレープ(Florentine crepe)

Multidimensional Restaurant Review

レストランのレビューには、そのレストランの異なる面について格付けをしているものもあります。そういった詳細なレビューは、hReview ではタグのついた格付けを使って表現します。また、そのレビューの説明の中にあるインラインのタグに注意してください。


Cafe Borrone

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


外にある噴水は、近くの El Camino の車の音を打ち消してくれる。
Cafe Borrone は壮麗な個人書店の隣にあって、  

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 class="tel">+1-650-327-0830</span>;
  <a class="url" href=""></a>
  <li class="rating"><a href="" rel="tag">
   食事:<span class="value">18</span>/<span class="best">30</span></a>;</li>
  <li class="rating"><a href="" rel="tag">
   雰囲気:<span class="value">19</span>/<span class="best">30</span></a>;</li>
  <li class="rating"><a href="" rel="tag">
   サービス:<span class="value">15</span>/<span class="best">30</span></a>;</li>
  <li class="rating"><a href="" rel="tag">
   価格:<abbr class="value" title="2">$$</abbr>...</a></li>
 <div class="description"><p>
  この<abbr class="type" title="business">
  <a href="" rel="tag">カフェ</a></abbr> 
  外にある噴水は、近くの El Camino の車の音を打ち消してくれる。
  Cafe Borrone は壮麗な個人書店の隣にあって、 
  <a href="" rel="tag">コーヒー</a> 
  <a href="" rel="tag">スープ</a>と 
  <a href="" rel="tag">サンドイッチ</a> 
  <a href="" rel="tag">エスプレッソ</a> 
  <a href="" rel="tag">イッリ</a>のコーヒーがたまらないだろう。
  <a href="" rel="tag">ジャズ</a>バンドまで、様々だ。 </p></div>
 レビュー(<a href=""> 
  hReview v<span class="version">0.3</span></a>)
 :<span class="reviewer vcard"><span class="fn">匿名</span></span>。 
 <abbr class="dtreviewed" title="20050428T2130-0700">2005年4月18日</abbr>。

次のような CSS のスタイルシートを添えると……

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

この hReview は元のテキストと同じように表示できます。

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

食事:18/30; 雰囲気:19/30; サービス:15/30; 価格:$$...

このカフェはサンフランシスコ半島の素敵なオアシスだ。外にある噴水は、近くの El Camino の車の音を打ち消してくれる。Cafe Borrone は壮麗な個人書店の隣にあって、新たに購入した本や輸入雑誌を広げながらコーヒーや軽食を取るには理想的な場所だ。スープサンドイッチの特別メニューは毎日変わる。温めたばかりのミニバゲットについてくる、クルトン入りのコーンチャウダーとチーズの大きな塊が特にすばらしい。夜は混むことが多く、見知らぬ人と相席になることもある。エスプレッソ愛好家にはイッリのコーヒーがたまらないだろう。賑やかさは遅い朝の静けさから夜の圧倒されるようなジャズバンドまで、様々だ。

レビュー(hReview v0.3):匿名。2005年4月28日。

Product review


 <a href="">
  <img src="" 
              alt="アルバムジャケット写真:The Postal Service:Give Up" />
 The Postal Service:Give Up</a>
   このアルバムでは「Nothing Better」もいい曲だ。 

このレビューに hReview を足すのもとても簡単ですが、この場合は hReview に必須の rating と reviewer 用の要素を加える必要があります。

<div class="hreview"><span class="item">
 <a class="url fn" href="">
  <img src="" 
       alt="アルバムジャケット写真:The Postal Service:Give Up" />" 
       class="photo" />
  The Postal Service: Give Up</a></span>
 <div class="description"><p>
   このアルバムでは「Nothing Better」もいい曲だ。 
 (<abbr class="rating" title="5">★★★★★</abbr>)
 <p class="reviewer vcard">レビュー: 
  <a class="url fn" href="">Adam Rifkin</a>。 
  <abbr class="dtreviewed" title="200502">2005年2月</abbr>。

この hReview は例えばこう表示できます。

[アルバムジャケット写真:] [The Postal Service:] [ Give Up ]

The Postal Service:Give Up


このアルバムでは「Nothing Better」もいい曲だ。


レビュー:Adam Rifkin。2005年2月。

Movie Review


 <span>anonymous, April 18th, 2005</span>
  <a lang="zh" href="">
  Ying Xiong (<span lang="en">HERO</span>)
 <div>評価:5 点満点中 4 点</div>
  この映画は音楽と映像が素晴らしい。 </p></blockquote>

hReview ではこうです。

<div class="hreview">
 <span class="reviewer vcard">
  <span class="fn">anonymous</span>, 
  <abbr class="dtreviewed" title="20050418">April 18th, 2005</abbr>
 <div class="item">
  <a lang="zh" class="url fn" href="">
  Ying Xiong (<span lang="en">HERO</span>)
 <div>Rating: <span class="rating">4</span> out of 5</div>
 <div class="description"><p>
  この映画は音楽と映像が素晴らしい。 </p></div>


Ying Xiong(HERO)
評価:5 点満点中 4 点


Examples in the wild

この説は参考情報です。この仕様の文中で書かれている可能性をはるかに超えて、実際に hReview を使っている例がたくさんあります。これは 別ページに移しました。

hReview Examples in the wild を参照してください。


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.


Normative References

Informative References

Similar Work


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.


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 0.3 was last modified: Wednesday, December 31st, 1969