Difference between revisions of "wiki-2-ja"

From Microformats Wiki
wiki-2-ja
Jump to navigation Jump to search
(→‎Wiki 2.0 の使い方: translated the top of the section and "Page Title")
Line 37: Line 37:
 
===仕様ページの書き方===
 
===仕様ページの書き方===
  
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.
+
新しい wiki では仕様文書を普通のページとは違う特別な表示にする機能をサポートしています。仕様ページは、W3C や WHATWG、その他の団体の文書のように、よりプレーンな外見になって、幅がページいっぱいに広がっています。ページのフッターを拡張してサイドバーはそこに配置したので、機能は全部残っています。
  
To enable these views, you must add your page to a particular category.
+
表示をこのようにするには、ページに特定のカテゴリーを付け加える必要があります。
  
* Specifications should be added to the ‘Specifications’ category, by including <nowiki>[[Category:Specifications]]</nowiki> at the base of the document.
+
* 仕様には <nowiki>[[Category:Specifications]]</nowiki> を付け加えて、‘Specifications’ カテゴリーに追加します。
* Draft Specifications should be added to the ‘Draft Specifications’ category, by including <nowiki>[[Category:Draft Specifications]]</nowiki> at the base of the document. You '''must''' also include the <nowiki>{{DraftSpecification}}</nowiki> template at the head of your document, to provide textual differentiation of the draft.
+
* 仕様ドラフトには<nowiki>[[Category:Draft Specifications]]</nowiki>を付け加えて、‘Draft Specifications’ カテゴリーに追加します。また、ドラフトは、仕様と区別する文章を載せるために <nowiki>{{DraftSpecification}}</nowiki> テンプレートを文書の冒頭に付け加え'''なければなりません'''。
  
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.
+
問題ページ、ブレインストーミングページやたたき台その他のページは、厳密には仕様ドラフトや仕様ではないので、それらのカテゴリーには追加せず、普通の wiki ページとして表示しておくべきだということに注意してください。
  
Categories should be declared at the base of articles, please.
+
カテゴリーは記事の一番下で宣言するようにしてください。
  
 
===議論と問題===
 
===議論と問題===

Revision as of 16:29, 20 November 2008

<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 の使い方

以下で Wiki 2.0 の新機能をうまく使う方法を説明したいと思います。

ページタイトル

MediaWiki がバージョン 1.4 から 1.13 になって、heading(見出し)としてマークアップされた HTML 要素がページの Table of Contents(目次)生成から排除されるというバグが修正されました。今までは H1 要素を使っても目次の番号が1.1、1.2、1.3、etc と小さくはならなかったので、ページの見出しを上書きするにはこれを使ってきました。このバグは修正されたので、上のようなハックはもっときちんとしたメカニズムに置き換わりました。

ページにタイトルを付けるには、H1 要素を使うのではなく、代わりに entry-title 要素を使ってください。これを MediaWiki の追加機能が解析して、ページ上部に表示されるエントリーのタイトルを目次には含めずに上書きします。この要素を使うのは、それが各ページをマークアップして土台を作っている hAtom の entory-title 要素に相当するからです。

仕様ページの書き方

新しい wiki では仕様文書を普通のページとは違う特別な表示にする機能をサポートしています。仕様ページは、W3C や WHATWG、その他の団体の文書のように、よりプレーンな外見になって、幅がページいっぱいに広がっています。ページのフッターを拡張してサイドバーはそこに配置したので、機能は全部残っています。

表示をこのようにするには、ページに特定のカテゴリーを付け加える必要があります。

  • 仕様には [[Category:Specifications]] を付け加えて、‘Specifications’ カテゴリーに追加します。
  • 仕様ドラフトには[[Category:Draft Specifications]]を付け加えて、‘Draft Specifications’ カテゴリーに追加します。また、ドラフトは、仕様と区別する文章を載せるために {{DraftSpecification}} テンプレートを文書の冒頭に付け加えなければなりません

問題ページ、ブレインストーミングページやたたき台その他のページは、厳密には仕様ドラフトや仕様ではないので、それらのカテゴリーには追加せず、普通の wiki ページとして表示しておくべきだということに注意してください。

カテゴリーは記事の一番下で宣言するようにしてください。

議論と問題

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 Fam Silk icons by Mark James.

問題

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