xFolk RC1

From Microformats Wiki
Revision as of 16:35, 18 July 2020 by Aaronpk (talk | contribs) (Replace <entry-title> with {{DISPLAYTITLE:}})
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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

xFolk("xFolksonomy"に由来)は、ブックマークのコレクションを公開するための簡単でオープンなフォーマットです。これによって、サービスがウェブベースのブックマークソフトウェアでのユーザー体験の向上とデータの共有をよりうまくできるようになります。xFolk は HTML または XHTML、Atom、RSS、任意の XML に埋め込むことができます。これはオープンなマイクロフォーマット標準の一つです。

仕様ドラフト

編者/作者

Bud Gibson (The Community Engine)

著作権

This specification is (C) 2005-2024 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.

特許

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

謝辞

各項目が、部分的に、一度にたくさんのカテゴリーに属していてもかまわないというアイディアをもたらしてくれた David Plaut に感謝します。また、より最近ですが、思慮深い批評と推進で xFolk の開発に貢献してくれた Tantek CelikKevin MarksSteve MalletBrian DelVecchioFrancois Hodierneに感謝します。

はじめに

ソーシャルブックマークサービスでは、ユーザーはブックマークを保存し、タグを付け、ほかのユーザーと共有します。ここ数年でこういったサービスの数は20を超え、その中にはdel.icio.usfurlde.lirio.us(訳注:現在は Simpy に引き継がれたようです)、jots(訳注:現在はサービス終了)、blogmarksという人気サービス例も含まれます。

相互運用可能なデータのオープンスタンダードがないことは、ソーシャルブックマークサービスを使う上での大きな問題です。オープンスタンダードがあればソーシャルブックマークデータを簡単に集めて再構築し、gataga(訳注:現在はサービス終了)による実験的なブックマーク検索エンジンのような方向性の、新しいサービスを発明することが可能になるのです。また、目下は del.icio.us で行われているような、サービスをまたがって機能する JavaScript を書いてユーザー体験を全面的に向上させることもできるようになります。

xFolk は両方の利点を持つことを目標にした、ソーシャルブックマークのオープンスタンダードです。xFolk を取り入れたソーシャルブックマークサービスは、データサービスの一歩先を歩くことになるでしょう。ですが、データ自体はサードパーティのスクリプトが操作したり、共有したりすることが簡単な物になります。その結果、ブックマークサービスは低コストでユーザーに幅広い選択肢を提供し、本質的な差別化に力を注ぐことができるようになります。独立したブックマーク保管サービスを運営する個人やグループは、自分で作れる以上の幅広い機能を選べるようになります。

セマンティック XHTML デザイン指針

注:セマンティック 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 日付問題の解決)

フォーマット

ソーシャルブックマークサービス、リンクブログ(訳注:リンクとそれに対するコメントからなるブログ)、他所でのリポートを幅広く分析した結果、ブックマークサービスとたくさんの異なるリンクブログで公開されているデータは暗黙的に次のスキーマに従って書かれていることが分かりました。

  • ブックマークしたりタグを付けるリンク
  • エントリーの題名
  • リンクに付けるタグ
  • リンクの追加説明や概要

初期の xFolk 標準が繰り返し使われたおかげで、この一般的なスキーマは次のようにしてマークアップへと変換できることが実証されています。

  1. 各エントリーに xfolkentry という class を持つコンテナ要素を作る
  2. ブックマークしたりタグを付けるリンクには taggedlink という class を持つ <a> 要素を使う
  3. エントリーの題名には、もしあれば <a> 要素の title 属性を、なければその値を使う
  4. タグには rel-tag を使う
  5. 追加説明や概要には、description という class を持つコンテナ要素(<p> など)を使う

xFolk エントリーでは、題名を伴ったタグを付けるリンクが必須で、他の要素は全て省略できます。エントリーには複数のタグあってもかまいませんし、description class の要素が複数あってもかまいません。description class を持つ複数の要素の順序は、文書に現れるままの順です。xFolk エントリー内の意味的な要素は任意の深さにネストできます。

たくさんのソーシャルブックマークシステムが存在して、それぞれが独自のマークアップの慣例を持っています。さらに、たくさんの人が既に個人のリンクブログを公表しています。xFolk の第一の目標は、こうした現在の慣例に適合させるのが簡単であるようデザインすることなので、xFolk エントリーで使う要素の種類には厳密な前提条件がほとんどありません。意味を決める機能は、要素よりも class 属性や(rel-tag の場合は)rel 属性の値に与えられるのです。

開発者は XPath か相当する文法を使って xFolk エントリーの要素にアクセスすることが期待されます。XPath を使うための条件は、HTML 文書が整形式であることです。妥当な文書ではなくてもかまいません。このため、最善ではないかもしれませんが、妥当性検証をしていない HTML 文書の中で xFolk が使えるようになるのです。

XMDP プロファイル

xFolk の XMDP プロファイルは、xFolk profile を参照してください。

下に del.icio.us の標準マークアップに見られるブックマークの例を示します。要素の class 属性の値を変更して xFolk に適合させる必要のある場所は、行の末尾にコメントで印を付けています。

<div class="post"> <!--変更する箇所-->
  <div>
    <a class="delLink" href="http://www.sifry.com/alerts/archives/000306.html"> <!--変更する箇所-->
      Sifry's Alerts: Technorati launches Related Tags
    </a> 
  </div>
  <div class="extended"> <!--変更する箇所-->
    Ever wanted to see what posts are related to other posts, what tags 
    are related to others? Now you can! Just check under the Tag 
    description on most tag pages, like this one, or this one, and you'll
    see the patterns. Can you smell the emergence?
    どの投稿がどの投稿と関係あるのか、どのタグがどのタグと関係あるのか、
    分かるようになってほしいとずっと思ってた。ようやくなった!
    こことかこことか、ほとんどのタグページでタグを記述した部分の下をチェックしてほしい。
    何かが起きそうなにおいがするだろ?
    (訳注:『Emergence』は書名。邦題は『創発―蟻・脳・都市・ソフトウェアの自己組織化ネットワーク』。
     個の局所的な働きが全体の組織だった働きを生むという現象を解説)
  </div>
  <div class="meta">
    to
    <a class="delNav" href="/fpgibson/folksonomy">folksonomy</a> <!--変更する箇所-->
    <a class="delNav" href="/fpgibson/technorati">technorati</a> <!--変更する箇所-->
    ... <a class="delNav" href="/url/cbcabf7de070fdb46598ee679367be49">
    and 1 other person
    </a>
    ... on 2005-04-09
  </div>
</div>

これに相当する xFolk は以下の通りです。class 属性の変更が必要だった行の末尾にコメントを付けています。

<div class="xfolkentry"> <!-- 変更した箇所 -->
  <div>
    <a class="taggedlink" href="http://www.sifry.com/alerts/archives/000306.html"> <!-- 変更した箇所 -->
      Sifry's Alerts: Technorati launches Related Tags
    </a> 
  </div>
  <div class="description"> <!-- 変更した箇所 -->
    Ever wanted to see what posts are related to other posts, what tags 
    are related to others? Now you can! Just check under the Tag 
    description on most tag pages, like this one, or this one, and you'll
    see the patterns. Can you smell the emergence?
    どの投稿がどの投稿と関係あるのか、どのタグがどのタグと関係あるのか、
    分かるようになってほしいとずっと思ってた。ようやくなった!
    こことかこことか、ほとんどのタグページでタグを記述した部分の下をチェックしてほしい。
    何かが起きそうなにおいがするだろ?
  </div>
  <div class="meta">
    to
    <a rel="tag" href="/fpgibson/folksonomy">folksonomy</a> <!-- 変更した箇所 -->
    <a rel="tag" href="/fpgibson/technorati">technorati</a> <!-- 変更した箇所 -->
    ... <a class="delNav" href="/url/cbcabf7de070fdb46598ee679367be49">
    and 1 other person
    </a>
    ... on 2005-04-09
  </div>
</div>

マークアップを xFolk に従う物に変換するのは、ほとんどの場合簡単です。xFolk の長所は、 全てのサービスやリンクブログにまたがって、精度を失うことの無いまま使い回せる class 属性のセットを提供していることです。 次の節ではこの点を説明する例をさらに多く提示します。

下は(リストのマークアップを使った)別の簡単な例です。


<ul><!--xFolk はブックマークの *コレクション* に関する物なのです-->
  <li>
    <ul class="xfolkentry"> 
      <li><a class="taggedlink" href="http://microformats.org/wiki/Main_Page">microformats wiki</a></li>
      <li class="description">マイクロフォーマットを勉強して実践する主な場所で……</li>
      <li class="description">コミュニティ駆動の Wiki</li>
      <li class="meta">
	Tags :
	<a rel="tag" href="http://del.icio.us/tag/microformats">microformats</a>
	<a rel="tag" href="http://del.icio.us/tag/websocial">websocial</a>
	<a rel="tag" href="http://del.icio.us/tag/semantics">semantics</a>
      </li>
    </ul>
  </li>
	
  <li>
   <!--上と同様の xfolkentryなど……-->
  </li>

</ul>


より多くの例

開発者がサイトに xFolk を取り入れるのに役立つ例がたくさんあります。

実世界での例

実際に機能中の、xFolk でブックマークを公開しているシステムの例です。パース、索引作成、整理などを試せる「実際に利用されている」例を探し始めるには絶好でしょう。自分が xFolk を使ってブックマークを公表しているなら、遠慮せずそのサイトをこのリストの一番上に加えてください。リストが大きくなり過ぎたら、別の Wiki ページを作ります。

  • Greenvoice はユーザーが作る環境ニュースのリンクリストで、xFolk でマークアップされています。
  • Idoneos.com はコンセプトごとに繋がった情報ページ(多くはスペイン語)のコレクションで、xFolk を使ってブックマークにタグ付けしています。
  • Ashaszin - SPIP を使って運営されている小さなブログ。xFolk でタグ付けした del.icio.us リンクとウェブフィードがあります。
  • Rolands Umbrovskis - blog ブログの記事は全て xFolk でマークアップされています。
  • BBC World Service Bangladesh River Journey はソーシャルネットワークマッシュアップで、hAtom エントリーのブックマークに、基本的な xFolk を使っています。Dharmafly のブログでの議論 を参照。
  • waferbaby の Hussy は、現在 xFolk を使ってリンクを公開しています(訳注:2008 年 11 月現在、確認できません)。
  • Smarking は、現在 xFolk を使って(検索結果を含む)共有リンクを公開しています。
  • unalog は、現在 xFolk を使って(検索結果を含む)共有リンクを公開しています(訳注:現在終了)。
  • de.lirio.us は、現在 xFolk を使ってブックマークを公開しています(description の代わりに、廃止予定の extended という class 属性を使っています。XMDP を参照)(訳注:現在は Simpy に引き継がれ、そちらでは xFolk は使用されていないようです)。
  • blogmarks は現在、ブログへのブックマークを xFolk でエクスポートします(訳注:アカウント未所持のため、未確認。通常ページでは xFolk を使用しています)。
  • The Community Engine は、メインエントリー公開ブックマークで xFolk を使っています(description の代わりに、廃止予定の extended という class 属性を使っています。XMDP を参照)。
  • Groovy Links は xFolk でマークアップされているリンクブログです(訳注:現在はこのページは無く、ホームページが対応)。
  • Tom Morris - 日々の del.icio.us リンクが xFolk、hCardVote Links でマークアップされています。

ソーシャルブックマークサービスへの付加

次の例では、一つのサービスに、どのようにして xFolk を適用できるのかが説明されています(訳注:現在の scuttle 0.7.4 では xFolk を使ってリンクがマークアップされています)。

リンクブログ

ソーシャルブックマークサービスは、人々がリンクを公開する最近の例と言うに過ぎません。リンクブログは、ほとんどブログの初期の頃からありました。これはその発端から、あまり意味的でないマークアップをされる傾向があったため、xFolk にするにはもう少し労力を使う必要があります。次の例は、個別の作業説明し、それぞれがどのようにしてうまくいくのかを描いています。

スパム

スパム業者には、リンクファームにタグを付けるのに xFolk を利用している所もあります。(恐らく、実際にそのサイトにリンクさせるには、悪いアイディアでしょう。)例えば、

  • phontron.info

実装

次の実装は、xFolk を作ったり使ったりして開発されました。もし xFolk の実装を持っていたらこのリストの一番上に自由に加えてください。リストが大きくなり過ぎた時には、別の Wiki ページを作ります。

  • SemanticScuttle は自分で扱えるソーシャルブックマークソフトウェアで、xFolk をネイティブサポートしています。
  • Buzkaはソーシャルブックマークサービスで、現在は xFolk をサポートしています(訳注:2008年11月現在はサポートされていないようです)。
  • Blip.tvは動画ホスティングサイトで、現在は xFolk をサポートしています(訳注:2008年11月現在はサポートされていないようです)。
  • Serendipity は PHP によるフレキシブルなブログ/CMS アプリケーションです。現在、xFolk をサポートするソーシャルブックマークプラグイン(ダウンロードは Serendipity の Plugin/Template ページからできます)があります。
  • claimID は各人のリンクを xFolk で実装しています。
  • ma.gnolia は、現在 xFolk をサポートしています。
  • Smarking.com(ソーシャルブックマークサービス)はタグ付けされたリンクを xFolk でマークアップしています!豆知識:3spots: Social + bookMARKING = Smarking。このページ自体は hReview です。
  • Flocktails - Tails エクステンションの Flock 0.5.12 移植版。hCard、hCalendar、xFolk、hReview を探して便利なツールバーに表示します(訳注:現在のバージョンの Flock には未対応のため、未確認)。
  • Tails は、ウェブページにマイクロフォーマット(hCardhCalendarhReviewxFolk)ががあれば教えてくれる Firefox エクステンションです(訳注:Firefox 2 では動作しますが、Firefox 3 ではインストールできません)。
  • Bud Gibson と Mike Migurski は、xFolk reblog ツールでありサービスである veg-o-matic書きました
  • Martin RehfeldDavid Janes の仕事を改良して、xFolk を含む多くのマイクロフォーマット要素を見つけてポップアップメニューによって提供する Greasemonkey スクリプト を作りました。これは現在、Firefox 1.5+/Greasemonkey 0.6.4+ で動作します。
  • net.nemein.bookmarksMidgard CMS 中のブックマーク管理プログラムで、書き出しのネイティブフォーマットとして xFolk を使用します。 参照(2008年11月現在、確認できません)。
  • de.lirio.us は現在、xFolk 0.4(説明箇所で extended class 属性を使用)を使ってブックマークを公表しています(訳注:現在は Simpy に引き継がれ、そちらでは xFolk は使われていないようです)。
  • blogmarks は現在、ブックマークをブログへ xFolk 0.4 を使ってエクスポートします(ページを下へスクロールしてのエクスポート例を見てください。description の代わりに extended class 属性を使っています)。
  • Sivitols は Java のマイクロフォーマット用ライブラリです(現在リンク切れ)。現在は xFolk RC1 標準しか実装されていませんが、より多くのマイクロフォーマットのサポートが予定されています。(出典は [1]
  • Bildu は xFolk(rel-tag も)をサポートするバスク語のソーシャルブックマークサービスです(訳注:サービスというより、使っているオープンソースソフトウェア scuttle が xFolk をサポート)。
  • Excite Bookmarks は xFolk と rel-tag をサポートするソーシャルブックマークサービスです(訳注:2008年11月現在、rel-tag のみサポート)。

参照

規範的な参考文献

その他の参考文献

関連作業

現在の進行状況

この仕様は最近バージョン RC1 のように安定し始めましたが、いまだ現在進行中です。望まれれば、ブックマークエントリーをできるだけ軽量にしてもっと広くアクセスできるようにするという目標のためには、リリース候補(release candidate)のバージョンを重ねる準備があります。前のバージョンからの変更は、開発者がこの狙いに限定して実装した経験を動機として行いました。以降の変更もおおむね実装上の関心を動機として行われるでしょう。このマイクロフォーマットの更なる可能性については下の「今後の方向性」をご覧ください。

xFolk 0.4 からの変更点

もっと他のマイクロフォーマットの使用法と実装中に出てきたいくらかの要請に沿うため、class 属性の extended という値は廃止予定となり、description が推奨されています。また、実装上の使用例で見受けられたため、複数の要素で extended class を使ってもよいという変更もされました。

今後の方向性

xFolk の拡張はいくつか考えられます。そういった拡張には、たいていの場合 xFolk を他のマイクロフォーマットと組み合わせるのが一番の方法です。たとえば、ブックマークしたアイテムに関する自分の評価を表したいと思うかもしれません。これは xFolk と一緒に Vote Links hReview を使うことでできます。

また、全てのブックマークをタグ付きで提供するなど、xFolk を拡張して整合データに様々なソーシャルブックマークサービスの API を付けて提供することを考えるかもしれません。現在、どの標準でもこういった API の仕様はあまりに流動的です。API とそれが提供する機能は、ソーシャルブックマークサービスとメタサービスが自分を差別化する一つの方法を表しています。

"xFolk definition" という関係の深いフォーマットが開発中です。xFolk definition ではソーシャルブックマークで使われるタグを厳密に定義する手段を提供することになるでしょう。

ブレインストーミング

議論

Q&A

  • xFolk に関する疑問がある時には、xFolk FAQ をチェックしてください。もし答えが見つからなければ、質問してください!

問題

  • この仕様の問題提起は、別ページの xFolk issues の文書に追加してください。

関連ページ