wiki-2-ja

From Microformats Wiki
wiki-2-ja /
Revision as of 18:22, 18 November 2008 by KitaitiMakoto (talk | contribs) (translated top of page and 'Summary of Changes')
Jump to navigation Jump to search

<entry-title>Microformats.org Wiki 2.0</entry-title>

Microformats.org は、2005 年に生まれた最初の時以来、ほぼデフォルトの MediaWiki テーマで運営されてきました。数年を経て、wiki で公開される記事の種類は定まり、コミュニティでの編集の慣例もよく分かってきました。‘Wiki 2.0’ プロジェクトは、コミュニティが必要としていることに対応するべく wiki ソフトをアップデートし、これを機会に見た目も良くすることにしました。

変更の概要

  • MediaWiki をバージョン 1.4 からバージョン 1.13.2 にアップデートしました。
  • wiki の見た目を、Dan Cederholm による microformats.rog の最初のデザインをベースにした、完全なカスタムスキンにアップグレードしました。
  • 検索機能の場所をページの右上にしました。ページのずっと下に埋もれているのはばかばかしいことだからです。
  • ヘッダーを microformats サイトの他の大事な所――ブログとメーリングリストのアーカイブ――へのリンクにしました。
  • いくつか拡張機能を付け加えて MediaWiki をインストールしました。
    • HTML の phrase 要素を全てサポートしました。
    • コードの構文強調機能を付けました。
    • ページタイトルでマークアップし直したものがあります(例えば ‘hcard’ を ‘hCard’ にしたり、もっと大掛かりなものもあります)。
  • ‘Talk’ ページは、単に ‘hidden’ にしたのではなく、機能を完全になくしました。
  • wiki の全ページを hAtom 0.1hCalendar でマークアップしました。
  • 記事をもっと体系的にするため、MediaWiki のカテゴリー機能を使っています。
    • Specifications(仕様)カテゴリーのページは、特別な「仕様」スタイルにしました(hCard 1.0 参照)。
    • Draft Specifications(仕様ドラフト)カテゴリーのページは、また別の特別な「仕様」スタイルにしました(hResume 参照)。
    • どちらかの仕様カテゴリーのページには、個別の -issues(~の問題)ページへのリンクを作ります。
  • TOC――table of contents(目次)――はテーマにあったスタイルにしました。もう TOC を右寄せにするのにインラインスタイルを使う必要はありません。
  • インライン表示の issues tracking(問題追跡)とネスト形式の議論一覧表示をサポートしています。以前は、提示された記事から議論が書かれている所を見付け出すのも、スレッドを追いかけるのも難しいことでした。これをもっと適切に表示するマークアップをサポートしました。
  • ブログのコメントと同様、ユーザー名の横に Gravatar が表示されます。
  • 投稿前にもう少し我慢してプレビューを見てもらうため、編集画面の ‘Save’ ボタンと ‘Preview’ ボタンを入れ替えました。

Wiki 2.0 の使い方

The following tries to explain how best to use the new features in Wiki 2.0.

ページタイトル

Between version 1.4 and 1.13 MediaWiki fixed a bug whereby headings marked up with HTML elements were excluded from the generated Table of Contents on pages. We have since used H1 elements to override the headings of pages whilst not offsetting the TOC numbering into 1.1, 1.2, 1.3, etc. Since that bug is fixed, this hack has been replaced with a more robust mechanism.

Rather than use H1 elements to title your pages, instead use the new entry-title element. This is parsed by a MediaWiki extension and overrides the entry title as displayed on the page, whilst excluding it from the TOC. It is so named, because it corresponds to the entry-title element in the underlying hAtom that each entry is now marked up with.

仕様ページの書き方

The new wiki supports special display of specification documents, different from regular pages. The pages are styled more plainly and content spans the full width of the page, akin to documentation from the W3C, WHATWG and other bodies. The sidebar is pushed down into an expanded footer, so all functionality remains.

To enable these views, you must add your page to a particular category.

  • Specifications should be added to the ‘Specifications’ category, by including [[Category:Specifications]] at the base of the document.
  • Draft Specifications should be added to the ‘Draft Specifications’ category, by including [[Category:Draft Specifications]] at the base of the document. You must also include the {{DraftSpecification}} template at the head of your document, to provide textual differentiation of the draft.

Please note that issues pages, brainstorming pages, straw-men and anything else not explicitly a Draft Specification or Specification document should not be added to these categories and should continue to be presented as regular wiki pages.

Categories should be declared at the base of articles, please.

議論と問題

Within documents discussions are often represented through nested lists. They are hard to follow, and hard to differentiate from the actual content of the document. You can now mark them up and have them presented more appropriately, and hopefully more clearly.

  • For discussions: Surround the thread with <div class="discussion"></div>.
  • For raising issues: Surround the thread with <div class="discussion issues"></div>.

The following are examples to show the rendering:

  • I'm not happy with the phrasing of the above. --BenWard 09:50, 17 November 2008 (UTC)
    • I disagree, I think it's fine! --BenWard 09:50, 17 November 2008 (UTC)
  • New wiki does not support declarative creation of animated GIFs on profile pages. This is a big deal for me! --BenWard 09:50, 17 November 2008 (UTC)
    • No. Just… no! --BenWard 09:50, 17 November 2008 (UTC)

Always sign your contributions to discussions using the string --~~~~ at the end of your text.

コードの構文強調

We've installed a Syntax Highlighting extension. This allows you to have nicer highlighting of many languages used in examples and code snippets on the wiki.

  • To use syntax highlighted source blocks, use the new <source> element. E.g.
  <source lang=html4strict>
  <div class="vcard">
    <a class="fn org" href="http://microformats.org">Microformats.org</a>
  </div>
  </source>

Produces:

  <div class="vcard">
    <a class="fn org" href="http://microformats.org">Microformats.org</a>
  </div>

Note that the language name for HTML is html4strict, not just ‘HTML’. You can find the full list of supported languages on the Syntax Highlighter extension page: http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi#Supported_languages

クレジット

The Wiki 2.0 project was implemented by User:BenWard. The visual style is derived from the original microformats.org theme by Dan Cederholm. The wiki also uses the wonderfully useful Fam Fam Silk icons by Mark James.

問題

Please report, bugs issues and requests on the Wiki 2.0 Issues page.