よく使われるマクロ

ここへジャンプ:
  1. リンク
  2. コードのサンプル
  3. サイドバーの生成
  4. 汎用の書式
  5. ステータスと互換性についての表示
  6. バージョン情報を示すためのマクロ
  7. 特別なページで使用するマクロ
  8. MDC時代の記述──カスタムテンプレート
  9. ハイパーリンクの作成
  10. ページをタギングする
  11. 汎用テンプレート
  12. バージョン情報テンプレート
  13. 関連情報
このページには MDN で使うために作られた汎用のマクロがたくさん掲載されています。これらのマクロの使い方については、 マクロの使い方 と リンクを生成するマクロ を見てください。 その他のマクロ には、めったに使われないマクロ、特殊な文脈でのみ使われるマクロ、使用が推奨されないマクロについての情報が書かれています。また、MDNで使用できるマクロの完全な一覧はこちらのページにあります。 

CSS スタイルガイドも見てください。

リンク

単一のハイパーリンクを作成する

一般的に、単なるリンクを作成するためにマクロを使う必要はありません。エディタインターフェイスにある リンク ボタン を使えば、リンクを作成できます。 

  • Glossary マクロは MDN 用語集の中の指定した用語のエントリへのリンクを作成するのに使います。このマクロは、1つの必須パラメータと2つの任意パラメータ:
    1. 用語の名前 (例えば "HTML")
    2. 用語の名前 の代わりに表示するテキスト 下記の例のように、英語の用語を日本語に変換する時などに使われます。 Optional
    3. ここで 0 以外を指定すると、用語集へのリンクに使われるカスタムスタイルが適用されません。Optional

    例:

リファレンス内のページへのリンク

いろいろなマクロがあり、MDN の指定したリファレンスエリア内のページへのリンクを作成することができます。

  • cssxref は CSS リファレンスの中のページへのリンクを作成します。
    例: {{cssxref("cursor")}}, の表示は cursor となります。
  • domxref は DOM リファレンスの中のページへのリンクを生成します。末尾に()を付ければ、テンプレートはそのリンクを関数名として扱い、表示します。例えば、 {{domxref("document.getElementsByName()")}} の表示は document.getElementsByName() となり、{{domxref("Node")}} の表示は Nodeとなります。
  • event は DOM イベントリファレンスの中のページへのリンクを生成します。例えば: {{event("change")}} の表示は changeとなります。
  • HTMLElement は HTML リファレンスの中の HTML 要素 へのリンクを生成します。
  • htmlattrxrefは HTML 属性 へのリンクを生成します。属性の名前のみを指定した場合にはグローバルな属性の記述へのリンクとなり、属性の名前に加えて、関連する要素の名前も指定した場合には、その要素に関連する属性の記述へのリンクとなります。例えば、 {{htmlattrxref("lang")}} は次のようなリンクを生成します: lang   そして {{htmlattrxref("type","input")}} はこのようなリンクとなります: type.
  • jsxref は JavaScript リファレンス内のページへのリンクを生成します。
  • SVGAttr は指定した SVG 属性へのリンクを生成します。例えば、 {{SVGAttr("d")}} は次のリンクを生成します: d
  • SVGElement は SVG リファレンス内の SVG 要素へのリンクを生成します。

バグ、IRC へのリンク

  • バグ
    • bug を使うと、bugzilla.mozilla.org に登録されているバグへのリンクを簡単に作ることができます。文法は: {{Bug(123456)}}です。 このリンクは: バグ 123456となります。
    • WebkitBug は WebKit バグのデータベースへのリンクを挿入します。例えば {{WebkitBug(31277)}} はこうなります。 WebKit bug 31277
  • IRCLink は指定した IRC チャネルへのリンクを挿入します。このリンクは、IRC クライアントが必要であることを表示するツールチップ付きです。

複数のページからなるガイドのためのナビゲーション補助

Previous、Next、PreviousNext は、一連の記事の中でのナビゲーションコントロールを提供します。一方向用のテンプレートでは、 前の または 次の 記事の Wiki 位置を指す1つの引数が必要です。PreviousNext については、前の記事、次の記事を指す 2つの引数を取ります。 最初の引数が前の記事を指し、2番めの引数が次の記事を指します。

コードのサンプル

Live サンプル

  • EmbedLiveSample はコードサンプルの出力をページに埋め込むのに使います。解説は Live サンプルのページにあります。
  • LiveSampleLink はコードサンプルの出力を含むページへのリンクを作成します。解説は Live サンプルのページにあります。

添付されたサンプルファイル

  • Embed_text テンプレートは添付されたテキストファイルを記事の中に埋め込むのに使います。これは、コードスニペットをダウンロードできるようにし、また同時に表示したい場合に役に立ちます。文法ハイライトのために、オプションとして言語を指定することもできます。指定しない場合は、テキストは整形せずに埋め込まれます。最初の引数は埋め込む添付ファイル名で、2番めは、もしあれば、文法ハイライトを適用するための言語となります。例えば "javascript"、"svg"、"cpp" などです。
  • EmbedSVG は添付された XML ファイルを SVG 画像として、ページのその場所に埋め込みます。添付 SVG ファイル名を指定します。Embed_text の直後に使えば、ソースとそのレンダリング結果を並べて表示することができます。

サイドバーの生成

ほぼすべての大きなページの集まりについて、雛形があります。典型的には、リファレンス、ガイド、チュートリアルでメインページに戻るためのリンク（パンくずリストでは、できないことがある）を提供し、記事を適切なカテゴリに配置します。

  • CSSRef は CSS リファレンスページのサイドバーを生成します。
  • HTMLRef は HTML リファレンスページのサイドバーを生成します。
  • APIRef は Web API リファレンスページのサイドバーを生成します。

汎用の書式

API 文書のためのインラインインジケータ

optional_inline と ReadOnlyInline は API 文書の中で通常、オブジェクトのプロパティまたは関数の引数のリストを記述するのに使われます。

用法: {{optional_inline()}} または {{ReadOnlyInline()}}. 例:

isCustomObject 読取専用
もし true ならば、オブジェクトはカスタムのものであることを示します。
parameterX Optional
ごにょごにょごにょ...

仕様表がない理由についての注記

Web について書かれた文書には、 API が規定されている場所を示すために仕様表が掲載されていることがほとんどです。しかしながら、API 用語の中にはなんらかの理由で仕様を持たないものがあります。考えられる理由としては、API が正式な仕様が固まる前のものであるとか、その API があるブラウザに特有のもので、仕様がない場合などがあります。

そのような場合であっても、そのような場合であることを示すことができることが重要であり、仕様表の代わりに説明のための文字列を書いておきます。各種のツールが理解できるように、その部分の文字列を WhyNoSpecStart と WhyNoSpecEnd の組み合わせマクロで、このように囲む必要があります:

{{WhyNoSpecStart}}いかなる仕様の一部でもありません; この API は Firefox OS 特有のものです。

これらのマクロは自動化されたツールのためのガイドであり、レンダリングされたコンテンツには目に見える影響はありません。

ステータスと互換性についての表示

インラインインジケータ （追加パラメータなし）

標準ではないもの

non-standard_inline は、その API が標準化されておらず、また標準化の予定もないことを示すインラインマークを付けます。

文法

{{non-standard_inline}}

例
  • アイコン:

実験的なもの

experimental_inline は、その API が広く実装されておらず、また将来変更される可能性があることを示すインラインマークを付けます。

文法

{{experimental_inline}}

例
  • アイコン:

インラインインジケータ （適用される技術を指定）

これらのマクロにパラメータを指定する場合は、"html", "js", "css", "gecko",のうちの1つにバージョン番号を加えたものとなります。

推奨されないもの

deprecated_inline はインラインの非推奨(deprecated) マークを付け、そのAPI が公式には非推奨であり、使用を控えるべきであることを示します。 注: 非推奨(deprecated) が意味するのは、その項目はもう使用されるべきではないが、まだ機能するものであることです。もう機能しないものを示す用語としては、時代遅れ(obsolete) を使ってください。

ブラウザ特有の記述(HTML, APIs, JS, CSS, …)では、引数を使用しないでください。

文法

{{deprecated_inline}} または {{deprecated_inline("gecko5")}}

例
  • アイコン:
  • バッジ: 非推奨 Gecko 5

時代遅れのもの

obsolete_inline はインラインの廃止(obsolete) マークを付け、例えばその関数、メソッド、またはプロパティ等を使用してはいけないことを示します。 {{ js_obsolete_inline("1.8.5") }} は {{ obsolete_inline("js1.8.5") }} と同じ意味です。また同じことが js_obsolete_header にも言えます。

ブラウザ特有の記述(HTML, APIs, JS, CSS, …)では、引数を使用しないでください。

文法

{{obsolete_inline}} または {{obsolete_inline("js1.8.5")}}

例

テンプレートバッジ

これらのマクロはほとんど WebAPI ページで使われます。Creating new badges に新しいバッジを作成するための情報があります。

特権が必要なもの

PrivilegedBadge は Firefox OS ドキュメンテーションの中で特権が必要な API であることを示すのに使われます。

文法

{{PrivilegedBadge}}

例

Privileged

ページまたはセクションのヘッダを示すインジケータ

これらのテンプレートが示すのは、上記の対応するインラインマークと同じものです。テンプレートはリファレンスページのメインページタイトルの（または、パンくずリストがあるならばその）直下に置きます。ページ内のセクションをマークアップすることもできます。

  • non-standard_header: {{Non-standard_header()}}

    非標準
    この機能は標準ではなく、標準化の予定もありません。公開されているウェブサイトには使用しないでください。ユーザーによっては使用できないことがあります。実装ごとに大きな差があることもあり、将来は振る舞いが変わるかもしれません。

  • SeeCompatTable は "ブラウザ実装状況" セクションがあるページで使用します。 例: {{SeeCompatTable()}}

    これは実験的な機能です。本番で使用する前にブラウザー実装状況をチェックしてください。

  • deprecated_header: {{deprecated_header()}}

    非推奨
    この機能は Web 標準から削除されました。まだサポートしているプラウザーがあるかもしれませんが、ゆくゆくはなくなるものです。新旧にかかわらず、プロジェクトでの使用をやめてください。この機能を使用するページ、Web アプリはいつ動かなくなってもおかしくありません。

  • deprecated_header に引数を付けて使う場合: {{deprecated_header("gecko5")}}

    非推奨 Gecko 5 (Firefox 5 / Thunderbird 5 / SeaMonkey 2.2)
    この機能は Web 標準から削除されました。まだサポートしているプラウザーがあるかもしれませんが、ゆくゆくはなくなるものです。新旧にかかわらず、プロジェクトでの使用をやめてください。この機能を使用するページ、Web アプリはいつ動かなくなってもおかしくありません。

    ブラウザ特有の記述(HTML, APIs, JS, CSS, …)では、引数を使用しないでください。
  • obsolete_header: {{obsolete_header()}}

    廃止
    この機能は廃止されました。まだいくつかのブラウザーで動作するかもしれませんが、いつ削除されてもおかしくないので、使わないようにしましょう。

  • obsolete_header に引数を付けて使う場合: {{obsolete_header("gecko30")}}

    廃止 Gecko 30 (Firefox 30 / Thunderbird 30 / SeaMonkey 2.27 / Firefox OS 1.4)
    この機能は廃止されました。まだいくつかのブラウザーで動作するかもしれませんが、いつ削除されてもおかしくないので、使わないようにしましょう。

    ブラウザ特有の記述(HTML, APIs, JS, CSS, …)では、引数を使用しないでください。

Web Workerで使用できる機能であることを示す

AvailableInWorkers マクロは、その機能が Web worker コンテクストで有効であることを示すためのローカライズされた注記ボックスを挿入するのに使われます。

バージョン情報を示すためのマクロ

これらのマクロは、そのコンテンツがある製品の特定のバージョンでのみ有効であることを示すのに使われます。

特別なページで使用するマクロ

ダウンロードボタン

DownloadButton は、緑色の "ダウンロード" ボタンをページに配置します。 2つの引数を取ります:

  1. ダウンロード元へのリンクとなる URL
  2. ボタンに表示されるテキスト

例えば、{{DownloadButton("http://nightly.mozilla.org/", "Nightly をダウンロード")}} は: Nightly をダウンロード となります。

 

MDC時代の記述──カスタムテンプレート

 

ここから下の部分には、MDC で使うために作られた汎用のテンプレートの一部が掲載されています。一部は MDN にも引き継がれ、文法の下に、使用例が説明どおりに表示されているものについては現在も使用可能です。同じ役割をする MDN のマクロが存在する場合には、そちらを使用してください。

カスタム CSS クラスの一覧も必要に応じて、ご参照ください。

日本語版註： MediaWiki では、言語版毎にテンプレートページが用意されていましたが、DekiWiki では、1 ページで全言語共有、というシステムに変更されました。多言語での共有方法については多言語対応のためのテンプレートの定義方法（日本語版のみの草稿ページ）を参照してください。

Template:anch - アンカーへのリンク

Template:anch はアンカーへのリンクを挿入します。

{{anch("top")}}

<a href="#top">top</a> (実際の表示 : top) を生成します。 このテンプレートではアンカー名と異なるリンク名の記述はできないことに注意してください。なぜなら、ドキュメント内の他のセクションに簡単にリンクを貼るためにこのテンプレートを作ったからです。

Template:bug - bug-org へのリンク

Template:bug の構文を使って bugzilla.mozilla.org の bug へのリンクを簡単に貼ることが可能になります。

{{bug(123456)}}

実際の表示 : バグ 123456.

Template:ifmethod - メソッドへのリンク

Template:ifmethod の構文を使って、インターフェースドキュメントのための標準書式 を用いて作成されたインタフェースの特定へのメソッドへのリンクを張ることができます。

{{ifmethod("nsIAutoCompleteSearch","stopSearch"}}

上記コードは nsIAutoCompleteSearch.stopSearch() として表示されます。

Template:manch - メソッドへのリンク（ページ内）

Template:manch は現在のインターフェース内のメソッドへのリンクを挿入します。 これはインターフェースドキュメントのページでの利用のみを意図しています。

{{manch("foo")}}

foo()

Template:Interwiki

Template:Interwiki は Wiki 内部リンクを生成することを容易にします。現在 Wikipedia と Wikimo へのリンクをサポートしています。最初の引数は Wiki の名前（"wikipedia" もしくは "wikimo"）で、2 番目の引数は記事へのパスです。

{{interwiki("wikipedia", "Firefox")}}

Firefox

このテンプレートはページの言語を自動判定し、Wikipedia の同じ言語版にリンクします。

Template:LXRSearch - LXR 検索の短縮表示

Template:LXRSearch を利用することで (ある程度面倒でない方法で) LXR 検索アドレスの URL を生成できます。構文は、

{{LXRSearch|type|param|search-string|link-text}}

のようになります。

パラメータは、次の意味を表します。

  • type は search (検索語によるソース内検索) 、find (ファイル名検索) もしくは ident (Mozilla ソース内のトークン名検索) の内の 1 つでなくてはなりません。
  • param は string (検索語・ファイル名検索) 、i (トークンによる検索) のいずれかでなくてはなりません。もし、テンプレートシステムに条件分岐命令があれば、これら 2 つ以外のパラメータは却下するでしょうけれど、条件分岐は利用できません。いつものように、拡張機能がここで動作してくれるでしょう。
  • search-string は、検索しようとするときに LXR の検索ボックスで入力する検索語になります。ただし、全ての空白は + に変換されるところが異なります。
  • link-text は作成したリンクを張るのに利用する文章です。

Template:seealso_tag　- タグ付けられた関連ページ

Template:seealso_tag は特定のタグでタグ付けられた記事の箇条書きリストを挿入します。これは "See also" セクションで潜在的に関連する記事を一覧化することを容易にします。

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:source_cvs　- ソースコードリンク（CVS）

Template:Source_cvs works just like Template:source, except it links to the CVS repository instead of the newer mozilla-central one.

Template:taggedsubpages - タグ付けられたサブページ

Template:taggedsubpages テンプレートは特定のタグを持つページのサブページの箇条書きリストを挿入します。

{{taggedsubpages("foo")}}

リファレンスの中のページへのリンク

 

ページをタギングする

これらのテンプレートは、ページの最初に配置するために利用できます（ただし、以下の breadcrumbs は、除きます）。 いくつかのテンプレートは、セクションの最初でも利用できます。

Template:disambig - あいまい性除去

Template:disambig は、あいまい性除去のためのページで利用されています。

Template:outdated and Template:NeedsTechnicalReview - 時代遅れ・技術レビューが必要

このテンプレートは、ひどく時代遅れであるということがわかっている（あるいは、そうかもしれない）ページで利用できます。通常、古いページが mozilla.org から MDC に移行されたときに利用されます。

このテンプレートは、オプションの引数によって詳細を追加できます。

{{outdated("最終更新は、1999 年です。")}} は、以下のように表示されます。

警告: この記事の内容は古くなっている可能性があります。 最終更新は、1999 年です。

Template:LockedPage - ロックされたページ

Template:LockedPage は、ページがロックされた理由の説明を提供する、目立つバーを挿入します。2 つの引数があります:1 番目は、ページがロックされる期間、2 番目は、ロックされた理由です。そのページのノートページへのリンクも囲みの中に含まれます。

{{ lockedPage("permanently", "constant spamming") }}

Template:deprecated_header, non-standard_header, obsolete_header - 非推奨バー・非標準バー・廃止バー

Template:deprecated_header は、ページの内容の利用は非推奨であることを示す、目立つバーをページに表示させます。例えば、公式に非推奨とされている関数、メソッドやプロパティなどです。 非推奨のバーは、通常、メインページタイトルの直下に配置されます（もしくは、パンくずナビゲーションが存在すれば、その直下）。同様に、Template:non-standard_header と Template:obsolete_header は、非標準、あるいは、廃止機能を強調させるために使われます。

{{deprecated_header}}

{{non-standard_header}}

{{obsolete_header}}

非推奨
この機能は Web 標準から削除されました。まだサポートしているプラウザーがあるかもしれませんが、ゆくゆくはなくなるものです。新旧にかかわらず、プロジェクトでの使用をやめてください。この機能を使用するページ、Web アプリはいつ動かなくなってもおかしくありません。

非標準
この機能は標準ではなく、標準化の予定もありません。公開されているウェブサイトには使用しないでください。ユーザーによっては使用できないことがあります。実装ごとに大きな差があることもあり、将来は振る舞いが変わるかもしれません。

廃止
この機能は廃止されました。まだいくつかのブラウザーで動作するかもしれませんが、いつ削除されてもおかしくないので、使わないようにしましょう。

リファレンス/ガイド/チュートリアルにおいてページをタギングするテンプレート

（DOM リファレンス のような）ページの膨大なコレクションのほぼそれぞれに数多くのテンプレートがあります。これらは、普通、リファレンス/ガイド/チュートリアルのメインページに戻るリンクです（これは、頻繁に必要とされます。なぜなら、我々の breadcrumbs はこのように動作しないからです）。また、記事を特定のカテゴリに入れます。

例: Template:DomRef, Template:CSSRef, Template:jsapi ref header, ... (当然、大文字小文字の不一致は、問題となります)

汎用テンプレート

Template:block-title - ブロックのタイトル

Template:block-title は、記事の一部分に対するタイトルを分かりやすく示すために、太字で表示されます。自動生成される内容一覧には現れませんが、他のタイトルと同じようにリンクターゲットとしては振舞うことができます。

{{block-title("タイトル")}}

…のように記述し、タイトル はタイトルをつけた部分へのリンク先として振舞います。Template:block-title は、

{{ anch("Template:sidenote") }}

や表、画像、コードブロックといった、それ自体から離れたところで参照されるような部分にタイトルをつけるときに利用することを想定しています。

Template:Clr - 回り込み解除

Template:Clr は <br style="clear:both;" /> を挿入するテンプレートで、続く文章をフロートしている画像や図の下に配置するために利用します。

{{clr()}}
  • このテンプレートはページ全体のレイアウトにも影響を与える可能性があることに注意してください。たとえば、既定のスキンにおけるナビゲーションパネルは、左側にフロートするように設定されています。このため、 
    {{clr()}}
    より後の全てがナビゲーションパネルより下に配置されることになります。

Template:Note and Template:warning - 注記ブロック・警告ブロック

{{ mediawiki.external('Template:Note') }} は、特別に整形された「注記」ブロックを記事のテキストに挿入します。このテンプレートは、興味深い、もしくは、重要な事実を付記することが目的です。{{ mediawiki.external('MDC:Custom CSS Classes#Notes| \"ノート\" CSS クラス') }} を利用しています。クラスを直接利用する代わりにテンプレートを使用することで、注記の見た目により多くの変更をより簡単に行うことが可能になります。

{{note("これは重要な注記です。")}}

実際の表示:

註: これは重要な注記です。

同様に、Template:warning は特別に整形された「警告」ブロックを挿入します。

{{warning("Danger, Will Robinson!")}}

実際の表示:

警告: Danger, Will Robinson!

見ての通り、警告ブロックは、大きなアイコンを含んでいて、記事の冒頭で現在利用されています(Template:outdated 由来)。 代わりに div class="warning" を利用したくなるかもしれません。

Template:ref and Template:endnote - 参照・ノート (脚注)

Template:ref と Template:endnote は記事についての脚注を記述するために利用します。脚注 "番号" は、

{{ref("something")}}

という形で指定でき、something は脚注がつく部分の適切な説明を入れます。そして、文書の最後に、以下のような脚注の中身が記述された番号付のリストを挿入します。

# {{endnote("something")}} Blah blah,  1 つ目の脚注
# {{endnote("something-else")}}  2 つ目の脚注
# ...

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:unimplemented_inline - 未実装マーク

Template:unimplemented_inline はまだ実装されていない関数やメソッドあるいはプロパティの使用を防ぐために、インラインの "未実装" マークを挿入します。

{{unimplemented_inline()}}

実際の表示:

  • Item 1
  • Item 2 未実装
  • Item 3

Template:Previous, Template:Next, and Template:PreviousNext - 前後の文書

Template:Previous、Template:Next、そして Template:PreviousNext は一連の記事のどこに現在の記事が位置しているかを表現します。片側向きのものについては、必要なパラメータは 1 つで、次もしくは前の記事を指定します。PreviousNext については、 2 つのパラメータが必要で、 1 つ目が前の記事、 2 つ目が次の記事を示します。

バージョン情報テンプレート

関連情報

  • FIXME:

ドキュメントのタグと貢献者

タグ: 
このページの貢献者: SphinxKnight, wbamberg, Uemmra3, Sebastianz, hamasaki, fscholz, teoli, ethertank, Potappo, kohei.yoshino, Amigomr, Yorfeix, Shimono, Morishoji, Okome, Taken
最終更新者: SphinxKnight,