MDC:Custom Templates
出典: MDC
- How to help: 目次
- (MDC各言語共通)
- 一覧
- Documentation wishlist
- 編集/レビューが必要な項目一覧
- 移設リスト
- ガイド
- はじめるには
- 記述者ガイド (英語版の訳)
- Writing interface reference documentation
- ページ命名ガイド
- あいまい性除去のページ
- MDCの新しいローカライズをはじめる
- 著作権とライセンス
- リファレンス
- Wiki マークアップリファレンス
- カスタム CSS クラス
- カスタムテンプレート
- MediaWiki 拡張
- 外部リダイレクト
- リダイレクトが必要なページ
- MDC日本語版
- 日本語版
- 翻訳
- 井戸端会議
- 通信
このページには MDC で使うために作られた汎用の MediaWiki テンプレート の一部が掲載されています。完全な一覧は Special:Allpages から名前空間 Template だけをフィルタリングすることで 見ること が可能です。 それらすべての一覧はここにありません。
Wiki マークアップリファレンス と カスタム CSS クラスの一覧も見てください。
[編集] 翻訳用テンプレート (日本語版独自)
[編集] Template:訳語
これは訳した際に当てた日本語と元の英単語を対応させるテンプレートです。原語と訳語を積極的に対比させたい場合には Template:原語併記 を使ってください。使いかた : {{訳語|日本語|元の言語}}。実際の表示 :
要素 を 活性化 する
今のところ、このテンプレートを元にした訳語の自動抽出などは行われていません。どの訳語を当てるかについてはMozilla 訳語決定会 が参考になります。MDC 日本語版で使われている訳語(を含んだページ)は Template:訳語を利用しているページ を参照してください。
[編集] Template:原語併記
これは訳した際に当てた日本語と元の言語とを積極的に対比するためのテンプレートです。原語と訳語を関連づけたいだけなら Template:訳語 を使ってください。使いかた : {{原語併記|日本語|元の言語}}。実際の表示 :
ここで使われる XML は 妥当 (valid) である必要があります。
今のところ、このテンプレートを元にした訳語の自動抽出などは行われていません。どの訳語を当てるかについては Mozilla訳語決定会が参考になります。MDC 日本語版で使われている訳語(を含んだページ)は Template:原語併記を利用しているページ を参照してください。
[編集] Template:訳注
これは原文にない情報を補足するためのテンプレートです。訳者が補足としてコメントを残したい場合には Template:訳語 を使ってください。使いかた : {{訳注|補足内容}}。実際の表示 :
Firefox は米国 Mozilla Foundation 【訳注: 日本支部は Mozilla japan】 の登録商標です。
[編集] ハイパーリンクの作成
[編集] Template:anch - アンカーへのリンク
Template:anch はアンカーへのリンクを挿入します。 {{anch|top}} は <a href="#top">top</a> (実際の表示 : top) を生成します。 このテンプレートではアンカー名と異なるリンク名の記述はできないことに注意してください。なぜなら、ドキュメント内の他のセクションに簡単にリンクを貼るためにこのテンプレートを作ったからです。
[編集] Template:bug - bug-org へのリンク
Template:bug の構文を使って bugzilla.mozilla.org の bug へのリンクを簡単に貼ることが可能になります: {{bug|123456}}. 実際の表示 : bug 123456.
[編集] Template:enter-bug - bug-org のバグ登録画面へのリンク
Template:enter-bug の構文を使って bugzilla.mozilla.org の特定のプロダクト・コンポーネントのバグ新規登録画面へのリンクを張ることができます。
たとえば、{{enter-bug|Core|Testing}} は次のように表示されます : Core:Testing
[編集] Template:ifmethod - メソッドへのリンク
Template:ifmethod の構文を使って、インターフェースドキュメントのための標準書式 を用いて作成されたインタフェースの特定へのメソッドへのリンクを張ることができます。例えば、 {{ifmethod|nsIAutoCompleteSearch|stopSearch}} は stopSearch() として表示されます。
[編集] Template:LXRSearch - LXR 検索の短縮表示
Template:LXRSearch を利用することで (ある程度面倒でない方法で) LXR 検索アドレスの URL を生成できます。構文は、{{LXRSearch|type|param|search-string|link-text}} のようになります。
パラメータは、次の意味を表します。
- type は search (検索語によるソース内検索) 、find (ファイル名検索) もしくは ident (Mozilla ソース内のトークン名検索) の内の一つでなくてはなりません。
- param は string (検索語・ファイル名検索) 、i (トークンによる検索) のいずれかでなくてはなりません。もし、テンプレートシステムに条件分岐命令があれば、これら二つ以外のパラメータは却下するでしょうけれど、条件分岐は利用できません。いつものように、拡張機能がここで動作してくれるでしょう。
- search-string は、検索しようとするときに LXR の検索ボックスで入力する検索語になります。ただし、全ての空白は + に変換されるところが異なります。
- link-text は作成したリンクを張るのに利用する文章です。
[編集] Template:source - ソースコードリンク
Template:source は、長い LXR の URL を入力することなく Mozilla のソースコードへのリンクを作成できます。たとえば、
{{source|browser/Makefile.in}} のように。
このように記述することで、browser/Makefile.in と表示されます。
リンクで表示されるテキストは与えられたパスそのものになります。テキストに何か他の物を表示したい場合は、2 番目の引数を指定してください。{{source|browser/Makefile.in|the browser/ Makefile.in}} のようにすると、the browser/ Makefile.in と表示されます。
[編集] リファレンスの中のページへのリンク
- Template:jsapixref は JSAPI リファレンス のページへリンクするために使うことができます。
- 同様に Template:cssxref は CSS リファレンス のページへリンクするために使うことができます。
- Template:npapi は Gecko プラグイン API リファレンス のページへリンクするために利用できます。
- Template:funcref は、最上位ページで文書化されている グローバル関数(通常は C++)のページへリンクするために利用できます。このテンプレートは、関数名を <code> タグで囲み、名前の後に丸括弧を追加します。オプションの 2 番目の引数にその関数に与える引数を指定することもできます。例は、テンプレートページを参照してください。
- Template:interface と Template:named-interface は、インターフェースのページにリンクするときに利用できます。例:{{interface|nsIIOService}} -
nsIIOService. - Template:interface-method は、対象のインターフェースが現在のガイドラインに従って文書化されている場合、インターフェースのメソッドのページにリンクするために利用できます。例: {{interface-method|nsIFeedResult|registerExtensionPrefix}} -
nsIFeedResult.registerExtensionPrefix().
使いかた: {{cssxref|color}} と入力すると次のように表示されます。 color
このテンプレートは普通のパイプリンクを打つ手間を省いてくれます : [[CSS:color|color]]
[編集] ページをタギングする
これらのテンプレートは、ページの最初に配置するために利用できます(ただし、以下の breadcrumbs は、除きます)。 いくつかのテンプレートは、セクションの最初でも利用できます。
[編集] Template:disambig - あいまい性除去
Template:disambig は、あいまい性除去のためのページで利用されています。
[編集] Template:outdated and Template:NeedsTechnicalReview - 時代遅れ・技術レビューが必要
このテンプレートは、ひどく時代遅れであるということがわかっている(あるいは、そうかもしれない)ページで利用できます。通常、古いページが mozilla.org から MDC に移行されたときに利用されます。
このテンプレートは、オプションの引数によって詳細を追加できます。例:{{outdated|最終更新は、1999 年です。}} は、以下のように表示されます。
同様のテンプレートの、Template:NeedsTechnicalReview は、筆者または編集者が読んだものや書いたものが技術的に正しいかどうか確証を持てず、どうしようもない場合に利用できます。
{{NeedsTechnicalReview}} の結果は次にようになります。:
このページは編集者または閲覧者により、技術レビューの必要があると判断されました。
全体のレビューが終わるまで、不正確あるいは誤った情報を含む可能性があります。
[編集] Template:LockedPage - ロックされたページ
Template:LockedPage は、ページがロックされた理由の説明を提供する、目立つバーを挿入します。2 つの引数があります:1 番目は、ページがロックされる期間、2 番目は、ロックされた理由です。そのページのノートページへのリンクも囲みの中に含まれます。 Template:LockedPage
[編集] Template:deprecated_header, non-standard_header, obsolete_header - 非推奨バー・非標準バー・廃止バー
Template:deprecated_header は、ページの内容の利用は非推奨であることを示す、目立つバーをページに表示させます。例えば、公式に非推奨とされている関数、メソッドやプロパティなどです。 非推奨のバーは、通常、メインページタイトルの直下に配置されます(もしくは、パンくずナビゲーションが存在すれば、その直下)。使い方: {{deprecated_header}}. 実際の表示:
非推奨
同様に、Template:non-standard_header と Template:obsolete_header は、非標準、あるいは、廃止機能を強調させるために使われます。 使い方: {{non-standard_header}} または {{obsolete_header}}。実際の表示:
非標準
廃止
[編集] リファレンス/ガイド/チュートリアルにおいてページをタギングするテンプレート
(DOM リファレンス のような)ページの膨大なコレクションのほぼそれぞれに数多くのテンプレートがあります。これらは、普通、リファレンス/ガイド/チュートリアルのメインページに戻るリンクです(これは、頻繁に必要とされます。なぜなら、我々の breadcrumbs はこのように動作しないからです)。また、記事を特定のカテゴリに入れます。
例: Template:DomRef, Template:CSSRef, Template:jsapi ref header, ... (当然、大文字小文字の不一致は、問題となります)
[編集] 汎用テンプレート
[編集] Template:block-title - ブロックのタイトル
Template:block-title は、記事の一部分に対するタイトルを分かりやすく示すために、太字で表示されます。自動生成される内容一覧には現れませんが、他のタイトルと同じようにリンクターゲットとしては振舞うことができます。{{block-title|タイトル}} のように記述し、タイトル はタイトルをつけた部分へのリンク先として振舞います。Template:block-title は、Template:sidenote や表、画像、コードブロックといった、それ自体から離れたところで参照されるような部分にタイトルをつけるときに利用することを想定しています。
[編集] Template:Clr - 回り込み解除
Template:Clr は <br style="clear:both;" /> を挿入するテンプレートで、続く文章をフロートしている画像や図の下に配置するために利用します。利用方法は {{Clr}} です。
- このテンプレートはページ全体のレイアウトにも影響を与える可能性があることに注意してください。たとえば、既定のスキンにおけるナビゲーションパネルは、左側にフロートするように設定されています。このため、
{{Clr}}より後の全てがナビゲーションパネルより下に配置されることになります。
[編集] Template:Note and Template:warning - 注記ブロック・警告ブロック
[Template:Note]] は、特別に整形された「注記」ブロックを記事のテキストに挿入します。このテンプレートは、興味深い、もしくは、重要な事実を付記することが目的です。[MDC:Custom CSS Classes#Notes| "ノート" CSS クラス]] を利用しています。クラスを直接利用する代わりにテンプレートを使用することで、注記の見た目により多くの変更をより簡単に行うことが可能になります。使い方: {{Note|これは重要な注記です。}}. 実際の表示:
同様に、Template:warning 特別に整形された「警告」ブロックを挿入します。{{warning|Danger, Will Robinson!}} 実際の表示:
見ての通り、警告ブロックは、大きなアイコンを含んでいて、記事の冒頭で現在利用されています(Template:outdated 由来)。 代わりに div class="warning" を利用したくなるかもしれません。
[編集] Template:ref and Template:note - 参照・ノート (脚注)
Template:ref と Template:note は記事についての脚注を記述するために利用します。脚注 "番号" は、{{ref|何か}} という形で指定でき、何か は脚注がつく部分の適切な説明を入れます。そして、文書の最後に、以下のような脚注の中身が記述された番号付のリストを挿入します。
# {{note|何か}} Blah blah, 一つ目の脚注
# {{note|それ以外の何か}} 二つ目の脚注
# ...
[編集] Template:deprecated_inline - 非推奨マーク
Template:deprecated_inline は公式には非推奨となっている、関数やメソッドあるいはプロパティなどの使用を防ぐためにインラインの非推奨であることを示すマークを挿入します。
使いかた : {{deprecated_inline}}。
実際の表示 :
- 項目 1
- 項目 2 非推奨
- 項目 3
[編集] Template:non-standard_inline - 非標準マーク
Template:non-standard_inline は標準化されていない関数やメソッド、プロパティあるいは属性などの使用を防ぐために、インラインの非標準であることを示すマークを挿入します。使いかた : {{non-standard_inline}}。実際の表示 :
- アイテム 1
- アイテム 2 非標準
- アイテム 3
[編集] Template:obsolete_inline - 廃止マーク
Template:obsolete_inline は公式に廃止されている関数やメソッドあるいはプロパティなどの使用を防ぐために、インラインの廃止されていることを示すマークを挿入します。使いかた : {{obsolete_inline}}。実際の表示 :
- 項目 1
- 項目 2 廃止
- 項目 3
[編集] Template:Previous, Template:Next, and Template:PreviousNext - 前後の文書
Template:Previous、Template:Next、そして Template:PreviousNext は一連の記事のどこに現在の記事が位置しているかを表現します。片側向きのものについては、必要なパラメータは一つで、次もしくは前の記事を指定します。PreviousNext については、二つのパラメータが必要で、一つ目が前の記事、二つ目が次の記事を示します。
[編集] バージョン情報テンプレート
- Template:fx minversion header
- Template:fx minversion inline
- Template:fx_minversion_note
- Template:js minversion header
- Template:js minversion inline
- Template:js_minversion_note
- Template:gecko minversion inline
- Template:gecko minversion header
- Template:dom_level
[編集] 削除予定
[編集] Template:sidenote - サイドノート
MediaWiki で利用可能なテンプレートの制限、つまりテンプレートのネスト (たとえば、{{sidenote|left|{{bug|123456}} も参照}} のようなもので、内側のテンプレートの終了マークが外側の終了と解釈される) ができないことから、このテンプレートは利用されなくなりました。
替わりに、次の形式を利用してください。
<div class="side-note-left">...</div> <!-- 左にフロートするサイドバー --> <div class="side-note-right">...</div> <!-- 右にフロートするサイドバー -->
