リンクマクロ

リンクの一覧

MDN はリンクのリストを作成するマクロを提供しています。

{{SubpagesWithSummaries}}

現在のページのサブページの定義リスト (<dl>) を挿入し、各ページのタイトルを <dt> の項、最初の段落を <dd> の項に入れます。

{{ListSubpagesForSidebar()}}

引数なしで記載された場合、現在のページのサブページへのリンクの順序付きリストを挿入します。このマクロはサイドバー（マクロの名前の由来）内で使用することが多く、箇条書きは表示されません。最初の引数はリンクツリーの親ページのスラッグです。リンクテキストはコードとして表示されます。 2 つ目の引数に true または 1 を設定するには、リンクをプレーンテキストに変換します。 3 つ目の引数に true または 1 を設定すると、リストの一番上にあるスラッグ（親）ページへのリンクを "Overview" というリンクテキストで追加します。

{{QuickLinksWithSubpages()}}

現在のページ （または指定したページ） の子を出力先として使用するクイックリンクのセットを作成します。これは 2 階層までの階層リストを作成します。ページのタイトルはリンクテキストとして、概要はツールチップとして使用します。

リンクリストの例

このページとその兄弟ページを含むリンクの順序リストを記載するには、以下のように書いてください。

{{ListSubpagesForSidebar("/ja/docs/MDN/Writing_guidelines/Page_structures/Macros", 1)}}

これは次のように表示されます。

その他のマクロよく使われるマクロ

相互参照リンク

一部のマクロは、属性、要素、プロパティ、データ型、API を含む CSS、JavaScript、SVG、HTML 機能を相互参照する単一のリンクを作成します。単一のリンクを作成するマクロは、参照する機能を少なくとも 1 つの引数として要求されます。

次のマクロがあります。

• {{CSSxRef("")}}
• {{DOMxRef("")}}
• {{HTMLElement("")}}
• {{glossary("")}}
• {{JSxRef("")}}
• {{SVGAttr("")}}
• {{SVGElement("")}}
• {{HTTPMethod("")}}
• {{HTTPStatus("")}}

これらのマクロの最初の引数には、参照する文書のスラッグの最後の部分を指定します。例えば、 HTML 要素の場合は {{HTMLElement("")}} を記載し、スラッグの Web/HTML/Element/ の後に来る部分を最初の引数にします。 {{CSSxRef("")}} では、スラッグの Web/CSS/ の後に来る部分を追加します。リンク先はこのページになります。

既定では、 {{HTMLElement()}} の場合、表示されるテキストは最初の引数に書かれたリンク先のリソースになります。これは望み通りではないかもしれません。例えば、範囲入力型のスラッグは Web/HTML/Element/input/range です。 {{HTMLElement("input/range")}} と記載すると、 "<input/range>" が生成されます。これは望み通りではありませんね。マクロはすべて追加の引数を受け入れるので、表示したいテキストを提供することができます。

2 つ目の引数が存在する場合は、リンクテキストを提供します。範囲入力型の場合、 {{HTMLElement("input/range", "<code>&lt;input type=&quot;range&quot;&gt;</code>")}} と書くと、 "<input type="range">" となります。この具体的なマクロは、 2 つ目の引数に空白が含まれている場合、 <code>と山括弧が除去されるので、山括弧とコードタグを追加しました。

マクロによって異なります。

HTML コードの意味づけと CSS コードをコーディングスタイルにしないために、一部の相互参照マクロは "nocode" という引数を記載して、このスタイル設定を無効にしています。

例えば、{{CSSxRef("background-color")}} はコードリンク "background-color" を作成し、 {{domxref("CSS.supports_static", "check support", "", "nocode")}} はプレーンテキストリンク "check support" を作成します。

使用するマクロがどのように動作するのか、また様々な引数を理解するために、必ずソースコードを見てください。引数は一般的に文書化されていますが、 {{HTMLElement("")}} マクロで見た「2 つ目の引数に空白が含まれる場合はコードとしてレンダリングしない」というような例外は、コード内にはありますが、それ以外で文書化されていません。

各マクロがどの引数に対応しているか、また各マクロの引数の順序を知るには、上にリンクしたマクロのソースファイルにドキュメントがあります。よく使用するマクロのリストがあり、それぞれページの本文コンテンツ領域にリンクが出力されています。

関連情報

• マクロの使用
• よく使われるマクロ、 BCD マクロ ({{Compat}}, {{Compat(<feature>)}}, {{Compat(<feature>, <depth>)}}) や仕様書マクロ ({{Specifications}} / {{Specifications(<feature>)}})
• バナーと通知のガイド、{{SeeCompatTable}}, {{Deprecated_Header}}, {{SecureContext_Header}} などのマクロ。