昨日の ADC OnAir では、Brackets の機能の一つとして、Cmd/Ctrl - K を押すと、関連する CSS の仕様のドキュメントが、エディタ内にインラインで表示されるというデモがありました。(41 分 30 秒過ぎあたり)
この Brackets に表示されるドキュメントは、ローカルにインストールされたものではなく、webplatform.org というサイトから取得して表示しているものです。
WebPlatform.org の特徴
WebPlatform.org は、以下の 3 つの大きな特徴を持っています。
- W3C により召集された主要ベンダーがサポートするコミュニティ活動であること
- 最も包括的で。かつ信頼できる Web テクノロジー情報を集める試みであること
- MediaWiki のプラットフォームを使用していること
サポートを表明している主な企業は、Adobe, Apple, Facebook, Google, HP, Microsoft, Mozilla, Nokia, Opera などおなじみの面々です。
Web 関連の技術は、標準仕様、実行環境、共に急速に変化や進化を続けています。
そのような状況下では、Web テクノロジーに関する信頼できる情報を、探したり、古くなっていないか確認したり、といった作業を確実に行うことが、より重要に、しかし、より困難になっています。
そこで、現在は、個人や個別のコミュニティに頼っている情報発信を、一箇所に集約できる仕組みをつくろう!というのが、WebPlatform.org の基本的な目的です。扱う情報な情報としては、以下のようなものが含まれています。
- API 仕様書
- ブラウザ互換性に関する情報
- サンプル
- 仕様の標準化の状況
現在は、まだアルファ版と位置づけられています。サイトを見るとすでにそれなりの情報が揃っている印象ですが、目指す先は高いということなのでしょう。
コミュニティ活動であること
WebPlatform.org は、Wikipedia と同じプラットフォームを使用したオープンな試みなので、誰でも参加が可能です。
メンバー登録ページや編集の方法の説明などはこちらのページにあります。目下のゴールは CSS 属性の情報をベータの状態まで持っていくことのようなので、得意な方は登録してみてはどうでしょうか?
先日東京で開催された Test the Web Forward は、コミュニティ活動として Web 標準に関わるテストケースを作成するという試みでしたが、WebPlatform.org はこれのドキュメント版と考えることができそうです。
実際、WebPlatform.org も各地で同様のイベントが行われています。残念ながら、当面、日本でのイベントは予定されていないようです。 (Upcoming Event)
MediaWiki であること
さて、記事の冒頭に書いたように、Brackets にインライン表示されるコンテンツは、WebPlatfrom.org から取得したものです。
WebPlatfrom.org からは MediaWiki をベースにした API を使ってコンテンツを取得できます。例えば、以下のようにリクエストを送れば box-shadow の記事を取得できます。
http://docs.webplatform.org/w/api.php?action=parse&page=css/properties/box-shadow
最後に &format=json を足すと、JSON オブジェクトとして結果が返されます。それを Brackets ではインライン表示しているということです。
実際には、Brackets にあわせて API が若干修正されたとのことで、まだ、どのツールからも同じように利用できるわけでは無いようです。
将来的には、API のドキュメントも公開して、特定のライセンスの下に利用できるようになるようです。
すでに日本語のページも
まだごく一部ですが、既に日本語化されたページも公開されています。
コメントする