hReview 0.3

From Microformats Wiki
Jump to navigation Jump to search

この文書は microformat のドラフト仕様です。ドラフトなので開発段階においてはいくらかは完成していますが、この文書の安定性は保証できません。なので開発者は将来の発展と変化に対応できるよう準備しておく必要があります。最新の情報を得るには、この wiki ページを見るか microformats-new mailing list の議論から学んで下さい。

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

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

Microformats Draft Specification 2006-02-22

Authors
Tantek Çelik (affiliations above)
Ali Diab (Yahoo! Inc.)
Ian McAllister (Amazon.com)
John Panzer (America Online, Inc.)
Adam Rifkin (CommerceNet Labs)
Michael Sippey (Six Apart, Ltd)

copyright and patents statements apply.

Status

hReview 0.3 は microformats.org の仕様ドラフトです。hreview-feedback、irc.freenode.net 上の #microformats、マイクロフォーマット議論メーリングリスト で hReview に関する公開の議論が行われています。

Available languages

この仕様の英語版が唯一もととなるバージョンです。この文書の翻訳については #Translations の節をご覧ください。

Errata and Updates

この仕様での機知の間違いと問題は考慮済み解決済み問題ページで修正されています。問題を報告する前にここを確認してください。

hReview 0.4 へのアップデートは、value-class パターン同様開発中で、機知の訂正事項も含んでいます。

Introduction

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

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

この文書内の語句 "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" は、RFC 2119 で記述される解釈で使われます。

Scope

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

Out of scope

hReview ではレビューの特定の項目に特化したプロパティは除外されています。初めからシンプルかつ最小であり続けることが重要なのです。機能の追加は実装上必要だと認められた時に行われます。

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

Format

一般

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

Schema

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

  • hReview (hreview)
    • version. 任意。テキスト。
    • summary. 任意。テキスト
    • item type. 任意。 product | business | event | person | place | website | url.
    • item info. 必須。fn (url || photo ) | hCard (人物または企業の場合) | hCalendar (イベントの場合)
    • reviewer. 任意。hCard
    • dtreviewed. 任意。 ISO8601 絶対日時(absolute date time)
    • rating. 任意。固定小数点数 [1.0-5.0]。あるいは、任意の worst (デフォルト:1.0) または best(デフォルト:5.0)またはその両方を持つ固定小数点数で、この場合も厳密な value を持つ。
    • description. 任意。任意の妥当な HTML でマークアップされたテキスト。
    • tags. 任意。キーワードやフレーズ。rel-tagを使い、それぞれ任意の rating を持つ。
    • permalink. 任意。rel-bookmarkrel-selfを使う。
    • license. 任意。rel-licenseを使う。

プロパティの詳細

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

いくつかのプロパティでは、より多くの意味を持つこともあります。ですから、それについては特殊な扱いをしなければなりません。例:

  • 全ての "url" は、hReview の中の 'hreview' という class 名を持つ要素の内側で <a class="url" href="...">...</a> を使う
  • また、"photo" については <img class="photo" src="..." alt="...の写真" /> を使う
  • rating は画像や「☆☆☆」といった文字として表現されることも多い。そういった文字はこれについては明確な格付けの略記なので、<abbr> 要素が特に使いやすい。例:<abbr class="rating" title="3.0">☆☆☆</abbr>。これは次の節でもさらに検討される。

Language

  • hReview が書かれている自然言語を明確に伝えるため、class="hreview" を持つ要素で HTML 標準の 'lang' 属性を使ってください。例:<div class="hreview" lang="en"> ... </div>。(item 名などの)hReview の一部が異なる言語で書かれている場合は、その部分に 'lang' 属性を使ってください。
  • レビューの言語を扱う必要のある hReview 処理プログラムは、HTML 標準の 'lang' を仕様に従って処理しなければなりません(MUST)。

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 をインクルードします。

Notes

この節は参考用です。

  • レビューを hReview マイクロフォーマットでマークアップすることで、レビューが索引化できるようになるでしょう。これはレビュー自体の著作権には影響しません。レビューの著作権は、上の仕様で述べられているように、公開する人が rel-license を使って厳密に記述できます。
  • 列挙された item type の項目は開発中で、拡張されるかもしれません。
  • 特定のアイテムに関するより詳しい情報は、残りの情報と一緒に、そのアイテムの URL で記述されているべきです。
  • 多くの格付けシステムが 1.0 から 5.0 の範囲を使い、そのほとんどが格付けを星の数(半分も可)で表現します。望むなら、サイトで格付けを表現するのに何らかの画像を使うこともできます。

Examples

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

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

Restaurant reviews

次はレストランの簡単なオンラインレビューです。

<div>
 <span>星5個中5個</span>
 <h4>Crepes on Cole は最高</h4>
 <span>レビュアー:<span>Tantek</span> - 2005年4月18日
 <blockquote><p>
  Crepes on Cole はサンフランシスコの小さなクレープ屋で最高の所の一つだ。
  出す物もサービスも素晴らしい。大きい物から小さい物まで、
  パーティ用のいろいろな大きさのテーブルがある。窓側の席は、
  すぐそこに停まる N-Judah を眺めたり、N-Judah の方から見たりという素晴らしい体験ができる。
  わたしはここで近所の WiFi に助けられながらたくさんの仕事をしているのだが、
  何度も楽しい集会をしてもいる。
</p></blockquote>
 <p>訪問日:<span>2005年4月</span></p>
 <p>食べたもの:<span>フィレンツェ風クレープ(Florentine crepe)</span></p>
</div>

このレビューに 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></div>
 <p>訪問日:<span>2005年4月</span></p>
 <p>食べたもの:<span>フィレンツェ風クレープ(Florentine crepe)</span></p>
</div>

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

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

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

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

訪問日:2005年4月
食べたもの:フィレンツェ風クレープ(Florentine crepe)

Multidimensional Restaurant Review

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

次はそのようなレビューをテキスト形式で表した例です。

Cafe Borrone

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

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

このカフェはサンフランシスコ半島の素敵なオアシスだ。
外にある噴水は、近くの 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>
  <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">
   食事:<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">
   雰囲気:<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">
   サービス:<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">
   価格:<abbr class="value" title="2">$$</abbr>...</a></li>
 </ul>
 <div class="description"><p>
  この<abbr class="type" title="business">
  <a href="http://en.wikipedia.org/wiki/cafe" rel="tag">カフェ</a></abbr> 
  はサンフランシスコ半島の素敵なオアシスだ。
  外にある噴水は、近くの El Camino の車の音を打ち消してくれる。
  Cafe Borrone は壮麗な個人書店の隣にあって、 
  新たに購入した本や輸入雑誌を広げながら 
  <a href="http://en.wikipedia.org/wiki/coffee" rel="tag">コーヒー</a> 
  や軽食を取るには理想的な場所だ。
  <a href="http://technorati.com/tag/soup" rel="tag">スープ</a>と 
  <a href="http://technorati.com/tag/sandwich" rel="tag">サンドイッチ</a> 
  の特別メニューは毎日変わる。
  温めたばかりのミニバゲットについてくる、 
  クルトン入りのコーンチャウダーとチーズの大きな塊が特にすばらしい。
  夜は混むことが多く、見知らぬ人と相席になることもある。
  <a href="http://flickr.com/photos/tags/espresso" rel="tag">エスプレッソ</a> 
  愛好家には
  <a href="http://en.wikipedia.org/wiki/Illy" rel="tag">イッリ</a>のコーヒーがたまらないだろう。
  遅い朝の静けさから夜の圧倒されるような 
  <a href="http://en.wikipedia.org/wiki/jazz" rel="tag">ジャズ</a>バンドまで、様々だ。 </p></div>
 レビュー(<a href="http://microformats.org/wiki/hreview"> 
  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>。
</div>

次のような 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;
cafeborrone.com

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

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

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

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="アルバムジャケット写真:The Postal Service:Give Up" />
 The Postal Service:Give Up</a>
 <blockquote><p>
   「相手の望み通りに接してあげる、 
    停止信号を守る、病気を治す……
    人はそういったことで褒められるべきだと思ってる。
    眠るから起こさないで……」
   </p><p>
   このアルバムでは「Nothing Better」もいい曲だ。 
 </p></blockquote>
 (★★★★★)
</div>

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

<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="アルバムジャケット写真:The Postal Service:Give Up" />" 
       class="photo" />
  The Postal Service: Give Up</a></span>
 <div class="description"><p>
    「相手の望み通りに接してあげる、 
     停止信号を守る、病気を治す……
     人はそういったことで褒められるべきだと思ってる。
     眠るから起こさないで……」
   </p><p>
   このアルバムでは「Nothing Better」もいい曲だ。 
 </p></div>
 (<abbr class="rating" title="5">★★★★★</abbr>)
 <p class="reviewer vcard">レビュー: 
  <a class="url fn" href="http://ifindkarma.com/blog/">Adam Rifkin</a>。 
  <abbr class="dtreviewed" title="200502">2005年2月</abbr>。
 </p>
</div>

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


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

The Postal Service:Give Up

「相手の望み通りに接してあげる、停止信号を守る、病気を治す、送り主の住所を書いて手紙を送る……人はそういったことで褒められるべきだと思ってる。眠るから起こさないで……」

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

(★★★★★)

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

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>評価:5 点満点中 4 点</div>
 <blockquote><p>
  この映画は音楽と映像が素晴らしい。 </p></blockquote>
</div>

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>評価:5 点満点中 <span class="rating">4</span> 点</div>
 <div class="description"><p>
  この映画は音楽と映像が素晴らしい。 </p></div>
</div>

このように表示できます。

匿名。2005年4月18日。
Ying Xiong(HERO)
評価:5 点満点中 4 点

この映画は音楽と映像が素晴らしい。

Examples in the wild

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

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

Implementations

この節は参考情報です。hReview の実装も、この文中で書かれている可能性以上にあります。別ページに移しました。

hReview Implementations を参照してください。

Design Principles

This section is informative. hReview was designed using design principles similar to those that went into hCard and thus this overview is included for informational purposes.


注:セマンティック XHTML デザイン指針は、始め hCardhCalendar 開発の文脈で書かれました。そのため、この指針は hCard デザインの方法論の文脈において理解しやすくなるでしょう(つまり、そちらをまず読んでください)。Tantek

XHTML は XML に基づいて作られており、そのため XHTML に基づいたフォーマットは、表示に便利なだけでなく一般的なデータ交換目的にも使えます。XHTML に基づいたフォーマットは、多くの点で HTML と XML の世界双方の最もよい所を体現しています。とは言え、XHTML に基づいたフォーマットを作成する時、指針を集めたものがあると役立ちます。

  1. 可能な限り、言及している、既存の確立されてよくサポートされている標準からスキーマ(名前、オブジェクト、プロパティ、値、種類、階層、制約)を再利用する。元の標準で表現されている制約を再宣言することは避ける。参考情報のために言及するのはよい。
    1. 複数の構成要素からなる種類のものには、その構成要素の名前に相当する class 名を持った要素を入れ子にして使う。
    2. 複数の構成要素は一つずつにする。そのため、カンマ区切りの複数のテキスト値を表すには、複数の要素を埋め込んで使う。
  2. 各オブジェクトなどのブロックを構成するのに一番適した意味的な XHTML を使う。
  3. そういったものが無ければ、構造を作る一般的な要素(例えば <span><div>)か文脈に適した要素(例えば <ul><ol> 中の <li>)を使う。
  4. 元のスキーマのその部分を的確に表現する XHTML の構成ブロックが無ければ、元のスキーマ由来の名前に基づいた class 名を使う。元のスキーマ中の名前が大文字と小文字を区別しないならば、相当するものを全て小文字にして使う。構成要素の(明確に定義されたスキーマではなく)日常語風の暗黙的な名前も、使いやすさのために、相当するものを全て小文字にして使うべきである。構成要素名中のスペースはダッシュ '-' 文字になる。
  5. 最後に、元のスキーマに従ったデータの形式があまりに長かったり人間に馴染まない場合、構造を作る一般的な要素の代わりに <abbr> を使い、忠実に従ったデータを(表現を記述する属性である)'title' 属性の中へ、相当するより簡潔で人間に読みやすいものを要素自体の中へ置く。<abbr> のこの使い方に関する説明のより多くの情報:Human vs. ISO8601 dates problem solved(人間 vs ISO8601 日付問題の解決)

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

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

この仕様はロイヤリティーフリーの特許方針に帰属するものです。特許方針に関してはW3C Patent PolicyRFC3667RFC3668をご覧下さい。

Work in progress

この仕様は現在進行中です。更なる特徴が議論され、理解され、書かれた時には追加されるでしょう。

Changes from v0.2

hReview v0.3 では hReview v0.2 から以下の変更がなされました。

規範的な変更:

  1. 企業と人物の item の description には hCard を(使うべき(SHOULD)ではなく)使わなければなりません(MUST)
  2. "reviewer" が変更されました
    1. Ryan King と Mark Nottingham のフィードバックにより、reviewer が *任意* になりました
    2. hReview に reviewer が無い場合には、そのページの中の hReview の外側を見て、レビュアーを見つけてください。外側にも "reviewer" が無い場合は、文書の言語に含まれている著者情報(HTML ページの <address> など)を reviewer として使ってください。
    3. レビュアー情報の表現には hCard を(使うべき(SHOULD)ではなく)使わなければなりません(MUST)
  3. "dtreviewed" が変更されました
    1. Ryan King と Mark Nottingham のフォードバックにより、dtreviewed が *任意* になりました
    2. hReview に dtreviewed が無い場合は、外部の、hReview 取り囲む文脈中を見てください。その文脈が hAtom エントリーだった場合、dtreviewed として "published"(見つからなければ "updated")を使ってください。もしエントリー中に無ければ、フィードの "published"(見つからなければ "updated")を使ってください。それも無ければ、文書の言語に含まれている情報(例えば Atom フィードの"published"/"updated" のような物)を、その次にプロトコルの情報(例えば HTTP Last-Modified やファイルシステムの最終更新日時)を使ってください。
  4. 'type' が 'event' の item の表現には hCalendar を使うべき(SHOULD)です
  5. 出版会の知識に基づいて、rating の値の桁を 10 進数で一桁加えました
  6. rating の best/worst を提示(マークアップ)する時に、より厳密に rating の値をマークアップするため hCard の "value" の構造(例では "tel" プロパティの中で使われているような)を使ってください。
  7. その hReview 全体のライセンスを示すため rel-license を追加しました
  8. Eran Globen の提案により、関連する tag を提供するのに、tag の中に rating を入れるのと同じようにして、rating の中に tag を入れられるようにしました。
  9. item info を繰り返さずに同じ item に複数のレビューを書けるよう include-pattern のサポートを加えました。

参考すべき変更(いくつかあるが中でも特別な物):

  1. 基準や関連項目のタグにはそのタグの格付けを説明しているタグスペースを使うのが理想であることに注意してください。例えば食事:18/30 が何を意味するか説明しているなど。
  2. 例は適宜更新されます。

Further Reading

Related Pages

Translations

更に別の言語で hReview の仕様ドラフトを読んでみましょう。