wiki-2-ja: Difference between revisions

From Microformats Wiki
Jump to navigation Jump to search
m (sync: english: 2008-11-19T02:33:59)
m (Replace <entry-title> with {{DISPLAYTITLE:}})
 
(9 intermediate revisions by one other user not shown)
Line 1: Line 1:
{{DISPLAYTITLE:Microformats.org Wiki 2.0}}
<!-- english: 2008-11-19T02:33:59 -->
<!-- english: 2008-11-19T02:33:59 -->
<entry-title>Microformats.org Wiki 2.0</entry-title>
<p class="entry-summary">Microformats.org は、2005 年に生まれた最初の時以来、ほぼデフォルトの MediaWiki テーマで運営されてきました。数年を経て、wiki で公開される記事の種類は定まり、コミュニティでの編集の慣例もよく分かってきました。‘Wiki 2.0’ プロジェクトは、コミュニティが必要としていることに対応するべく wiki ソフトをアップデートし、これを機会に見た目も良くすることにしました。</p>
<p class="entry-summary">Microformats.org は、2005 年に生まれた最初の時以来、ほぼデフォルトの MediaWiki テーマで運営されてきました。数年を経て、wiki で公開される記事の種類は定まり、コミュニティでの編集の慣例もよく分かってきました。‘Wiki 2.0’ プロジェクトは、コミュニティが必要としていることに対応するべく wiki ソフトをアップデートし、これを機会に見た目も良くすることにしました。</p>
__TOC__
__TOC__
Line 7: Line 7:


* MediaWiki をバージョン 1.4 からバージョン 1.13.2 にアップデートしました。
* MediaWiki をバージョン 1.4 からバージョン 1.13.2 にアップデートしました。
* wiki の見た目を、Dan Cederholm による microformats.rog の最初のデザインをベースにした、完全なカスタムスキンにアップグレードしました。
* wiki の見た目を、Dan Cederholm による microformats.org の最初のデザインをベースにした、完全なカスタムスキンにアップグレードしました。
* 検索機能の場所をページの右上にしました。ページのずっと下に埋もれているのはばかばかしいことだからです。
* 検索機能の場所をページの右上にしました。ページのずっと下に埋もれているのはばかばかしいことだからです。
* ヘッダーを microformats サイトの他の大事な所――ブログとメーリングリストのアーカイブ――へのリンクにしました。
* ヘッダーを microformats サイトの他の大事な所――ブログとメーリングリストのアーカイブ――へのリンクにしました。
Line 27: Line 27:
==Wiki 2.0 の使い方==
==Wiki 2.0 の使い方==


The following tries to explain how best to use the new features in Wiki 2.0.
以下で 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 <code>H1</code> 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.
MediaWiki がバージョン 1.4 から 1.13 になって、heading(見出し)としてマークアップされた HTML 要素がページの Table of Contents(目次)生成から排除されるというバグが修正されました。今までは <code>H1</code> 要素を使っても目次の番号が1.1、1.2、1.3、etc と小さくはならなかったので、ページの見出しを上書きするにはこれを使ってきました。このバグは修正されたので、上のようなハックはもっときちんとしたメカニズムに置き換わりました。


<em>Rather than use <code>H1</code> elements to title your pages, instead use the new <code>entry-title</code> element</em>. 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.
ページにタイトルを付けるには、<code>H1</code> 要素を使うのではなく、代わりに <code>entry-title</code> 要素を使ってください。これを MediaWiki の追加機能が解析して、ページ上部に表示されるエントリーのタイトルを目次には含めずに上書きします。この要素を使うのは、それが各ページをマークアップして土台を作っている hAtom の entory-title 要素に相当するからです。


===仕様ページの書き方===
===仕様ページの書き方===


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.
カテゴリーは記事の一番下で宣言するようにしてください。


===議論と問題===
===議論と問題===


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 <em>discussions</em>: Surround the thread with <code>&lt;div class="discussion">&lt;/div></code>.
* <em>議論</em> <code>&lt;div class="discussion">&lt;/div></code>で囲む。
* For raising <em>issues</em>: Surround the thread with <code>&lt;div class="discussion issues">&lt;/div></code>.
* <em>問題</em>提起 : <code>&lt;div class="discussion issues">&lt;/div></code>で囲む。


The following are examples to show the rendering:
下は表示例です。


<div class="discussion">
<div class="discussion">
* I'm not happy with the phrasing of the above. --[[User:BenWard|BenWard]] 09:50, 17 November 2008 (UTC)
* 上の表現には不満です。--[[User:BenWard|BenWard]] 09:50, 17 November 2008 (UTC)
** I disagree, I think it's fine! --[[User:BenWard|BenWard]] 09:50, 17 November 2008 (UTC)
** そうかな。いいと思いますよ。--[[User:BenWard|BenWard]] 09:50, 17 November 2008 (UTC)
</div>
</div>


<div class="discussion issues">
<div class="discussion issues">
* '''New wiki does not support declarative creation of animated GIFs on profile pages'''. This is a big deal for me! --[[User:BenWard|BenWard]] 09:50, 17 November 2008 (UTC)
* '''新しい wiki ではプロフィールページでのアニメーション GIF の宣言による作成機能(declarative creation。訳注:未確認)をサポートしていない。'''これはおおごとだ!--[[User:BenWard|BenWard]] 09:50, 17 November 2008 (UTC)
** No. Just… no! --[[User:BenWard|BenWard]] 09:50, 17 November 2008 (UTC)
** いや。ええと……とにかく違う!--[[User:BenWard|BenWard]] 09:50, 17 November 2008 (UTC)
</div>
</div>


'''Always''' sign your contributions to discussions using the string <nowiki>--~~~~</nowiki> at the end of your text.
議論への書き込みには、'''常に'''、文章の終わりで<nowiki>--~~~~</nowiki>を使って署名を入れてください。


===コードの構文強調===
===コードの構文強調===


We've installed a [http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi Syntax Highlighting extension]. This allows you to have nicer highlighting of many languages used in examples and code snippets on the wiki.
[http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi/ja 構文強調の拡張機能]をインストールしました。これで、例とコードの抜粋で使われているたくさんの言語の構文を強調して見やすくすることができます。


* To use syntax highlighted source blocks, use the new <code>&lt;source></code> element. E.g.
* ソースのブロックに構文強調を適用するには、新たな <code>&lt;source></code> という要素を使ってください。例:


<pre><nowiki>
<pre><nowiki>
Line 83: Line 83:
</nowiki></pre>
</nowiki></pre>
   
   
Produces:
表示結果:


   <source lang=html4strict>
   <source lang=html4strict>
Line 91: Line 91:
   </source>
   </source>


Note that the language name for HTML is <code>html4strict</code>, 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
HTML 用の言語名はただの ‘HTML’ ではなくて<code>html4strict</code> になることに注意してください。サポートされている全言語の一覧は構文強調拡張機能ページで見ることができます: http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi/ja#.E3.82.B5.E3.83.9D.E3.83.BC.E3.83.88.E3.81.95.E3.82.8C.E3.82.8B.E8.A8.80.E8.AA.9E]


==クレジット==
==クレジット==


The Wiki 2.0 project was implemented by [[User:BenWard]]. The visual style is derived from the original microformats.org theme by [http://simplebits.com Dan Cederholm]. The wiki also uses the wonderfully useful [http://famfamfam.com/lab/icons/silk/ Fam Fam Fam Silk icons] by Mark James.
Wiki 2.0 プロジェクトは [[User:BenWard]] が遂行しました。見た目は [http://simplebits.com Dan Cederholm] による最初の microformats.org のテーマを引き継ぎました。また、Mark James による素晴らしく使いやすい  [http://famfamfam.com/lab/icons/silk/ Fam Fam Fam Silk icon] を使っています。


==問題==
==問題==


Please report, bugs issues and requests on the [[wiki-2-issues]] page.
バグの問題やリクエストは [[wiki-2-issues]] ページで報告してください。


[[Category:Microformats.org]]
[[Category:Microformats.org]]
[[Category:Wiki]]
[[Category:Wiki]]

Latest revision as of 16:35, 18 July 2020

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

変更の概要

  • MediaWiki をバージョン 1.4 からバージョン 1.13.2 にアップデートしました。
  • wiki の見た目を、Dan Cederholm による microformats.org の最初のデザインをベースにした、完全なカスタムスキンにアップグレードしました。
  • 検索機能の場所をページの右上にしました。ページのずっと下に埋もれているのはばかばかしいことだからです。
  • ヘッダーを microformats サイトの他の大事な所――ブログとメーリングリストのアーカイブ――へのリンクにしました。
  • いくつか拡張機能を付け加えて MediaWiki をインストールしました。
    • HTML の phrase 要素を全てサポートしました。
    • コードの構文強調機能を付けました。
    • ページタイトルでマークアップし直したものがあります(例えば ‘hcard’ を ‘hCard’ にしたり、もっと大掛かりなものもあります)。
  • ‘Talk’ ページは、単に ‘hidden’ にしたのではなく、機能を完全になくしました。
  • wiki の全ページを hAtomhCalendar でマークアップしました。
  • 記事をもっと体系的にするため、MediaWiki のカテゴリー機能を使っています。
    • Specifications(仕様)カテゴリーのページは、特別な「仕様」スタイルにしました(hCard 参照)。
    • 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 ページとして表示しておくべきだということに注意してください。

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

議論と問題

議論はよく、文書中にネストされた一覧として表示されますが、それだと議論を追い、文書の動きのある部分を見分けるのが難しくなります。今度はもっと適切に、そして願わくばもっとはっきりと表示されるようにマークアップできます。

  • 議論<div class="discussion"></div>で囲む。
  • 問題提起 : <div class="discussion issues"></div>で囲む。

下は表示例です。

  • 上の表現には不満です。--BenWard 09:50, 17 November 2008 (UTC)
    • そうかな。いいと思いますよ。--BenWard 09:50, 17 November 2008 (UTC)
  • 新しい wiki ではプロフィールページでのアニメーション GIF の宣言による作成機能(declarative creation。訳注:未確認)をサポートしていない。これはおおごとだ!--BenWard 09:50, 17 November 2008 (UTC)
    • いや。ええと……とにかく違う!--BenWard 09:50, 17 November 2008 (UTC)

議論への書き込みには、常に、文章の終わりで--~~~~を使って署名を入れてください。

コードの構文強調

構文強調の拡張機能をインストールしました。これで、例とコードの抜粋で使われているたくさんの言語の構文を強調して見やすくすることができます。

  • ソースのブロックに構文強調を適用するには、新たな <source> という要素を使ってください。例:
  <source lang=html4strict>
  <div class="vcard">
    <a class="fn org" href="http://microformats.org">Microformats.org</a>
  </div>
  </source>

表示結果:

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

HTML 用の言語名はただの ‘HTML’ ではなくてhtml4strict になることに注意してください。サポートされている全言語の一覧は構文強調拡張機能ページで見ることができます: http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi/ja#.E3.82.B5.E3.83.9D.E3.83.BC.E3.83.88.E3.81.95.E3.82.8C.E3.82.8B.E8.A8.80.E8.AA.9E]

クレジット

Wiki 2.0 プロジェクトは User:BenWard が遂行しました。見た目は Dan Cederholm による最初の microformats.org のテーマを引き継ぎました。また、Mark James による素晴らしく使いやすい Fam Fam Fam の Silk icon を使っています。

問題

バグの問題やリクエストは wiki-2-issues ページで報告してください。