xfolk-ja

From Microformats Wiki
Revision as of 09:47, 1 November 2008 by KitaitiMakoto (talk | contribs) (translated Issues and added link to xfolk-issues-ja)
Jump to navigation Jump to search

xFolk (RC1)

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.

特許

This specification is subject to a royalty free patent policy, e.g. per the W3C Patent Policy, and IETF RFC3667 & RFC3668.

謝辞

Thanks to: David Plaut who introduced me to the idea that items may partially belong to many categories at once. More recently, thanks to: Tantek Celik, Kevin Marks, Steve Mallet, Brian DelVecchio, and Francois Hodierne who have contributed to the development of xFolk with thoughtful critiques and implementations.

はじめに

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

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

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

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

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

フォーマット

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

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

初期の 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>


より多くの例

We have numerous examples to help developers incorporate xFolk into their sites.

実世界での例

These are real live examples of functioning systems that publish bookmarks in xFolk. These are a great place to start for anyone looking for examples "in the wild" to try parsing, indexing, organizing etc. If you publish using xFolk, feel free to add it to the top of this list. Once the list grows too big, we'll make a separate wiki page.

さらなるソーシャルブックマークサービス

This example illustrates how xFolk may be applied to one additional service:

リンクブログ

Social bookmarking services are only the most recent examples of people publishing links. Link blogs have been around almost since the beginning of blogging. They represent somewhat more of a challenge for xFolk because their markup tends to be less semantic from the outset. The following examples illustrate some particular challenges and how they can be overcome.

スパム

Some spammers are adding xFolk tags to their link farms. (It's probably a bad idea to actually link to these sites.) For example,

  • phontron.info

実装

The following implementations have been developed which generate or use xFolk. If you have an xFolk implementation, feel free to add it to the top of this list. Once the list grows too big, we'll make a separate wiki page.

参照

規範的な参考文献

その他の参考文献

関連作業

現在の進行状況

Although this specification has recently begun to stabilize as indicated by the version RC1, it is still a work in progress. If warranted, I am prepared to go through multiple release candidates to achieve the narrow purpose of making bookmark entries more genrally accessible with as with as light weight a format as possible. All changes since the last iteration have been motivated by the implementation experience of developers attempting to achieve this narrow aim. Further changes will also most likely be motivated by implementation concerns. See "future directions" below for additional microformat possibilities.

xFolk 0.4 からの変更点

The class attribute value extended was deprecated in favor description to better conform with other microformat usage and some requests during implementation. The other change has been to allow use of multiple elements of class extended based on some use cases discovered in implementation.

主な方向性

There are several extensions one might imagine for xFolk. Frequently, these extensions are best achieved by combining xFolk with another microformat. For instance, one might want to indicate his or her evaluation of the bookmarked item. This might be achieved by using Vote Links or hReview with xFolk.

One can also imagine extending xFolk to provide data conformant with various social bookmarking service APIs, for instance to provide all bookmarks by tag. These APIs are currently too fluid for specification in any kind of standard. The APIs and the functionality they provide represent one way social bookmarking services and meta services can differentiate themselves.

A companion format called "xFolk definition" is under development. xFolk definition will provide a means of explicitly defining the tags used in social bookmarks.

ブレインストーミング

議論

Q&A

  • If you have any questions about xFolk, check the xFolk FAQ, and if you don't find answers, add your questions!

問題

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

関連ページ

Retrieved from "http://microformats.org/wiki/index.php?title=xfolk-ja&oldid=29938"