連結宏

連結列表

MDN 提供了建立連結列表的宏

{{SubpagesWithSummaries}}

插入當前頁面的子頁面的定義列表（<dl>），其中每個頁面的標題作為 <dt> 條目，其第一個段落作為 <dd> 條目。

{{ListSubpagesForSidebar()}}

當不帶引數包含時，將插入指向當前頁面子頁面的有序列表。第一個引數是連結樹父頁面的 slug。連結文字顯示為程式碼。將第二個引數設定為 true 或 1 會將連結轉換為純文字。將第三個引數設定為 true 或 1 會在列表頂部新增指向 slug（父）頁面的連結，連結文字為“Overview”。

{{QuickLinksWithSubpages()}}

建立一個快速連結集，使用當前頁面（或指定頁面）的子頁面作為目標。這會建立最多兩層的分層列表。頁面的標題用作連結文字，其摘要用作工具提示。

示例連結列表

要包含一個有序的連結列表，其中包含此頁面及其同級頁面，請編寫以下內容

{{ListSubpagesForSidebar("/en-US/docs/MDN/Writing_guidelines/Page_structures/Macros", 1)}}

交叉引用連結

一些宏會建立單個連結來交叉引用 CSS、JavaScript、SVG 或 HTML 功能，包括屬性、元素、資料型別和 API。建立單個連結的宏至少需要一個引數：所引用的功能。

這些宏是

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

這些宏的第一個引數是所引用文件 slug 的最後一部分。例如，對於 HTML 元素，使用 {{HTMLElement("")}} 並將 slug 中 Web/HTML/Reference/Elements/ 之後的 `slug` 部分作為第一個引數。對於 {{CSSxRef("")}}，請在 slug 中新增 Web/CSS/ 之後的 `slug` 部分。連結將指向該頁面。

預設情況下，顯示的文字是第一個引數中寫入的連結資源，對於 {{HTMLElement()}}，則用尖括號括起來。這可能不是您想要的。例如，range 輸入型別的 slug 是 Web/HTML/Reference/Elements/input/range。包含 {{HTMLElement("input/range")}} 會生成“<input/range>”。這不是您想要的。所有宏都接受其他引數，因此您可以提供您想要顯示的文字。

第二個引數（如果存在）提供連結文字。在 input range 的情況下，我們將編寫 {{HTMLElement("input/range", "<code>&lt;input type=&quot;range&quot;&gt;</code>")}}，它會生成“<input type="range">”。此特定宏會在第二個引數包含空格時刪除 <code> 和尖括號，因此我們添加了括號和程式碼標籤。

每個宏都不同！

為了防止 HTML 程式碼語義和 CSS 程式碼樣式，一些交叉引用宏包含一個帶有 "nocode" 的引數來停用此樣式。

例如，{{CSSxRef("background-color")}} 建立了程式碼連結“background-color”，而 {{domxref("CSS.supports_static", "check support", "", "nocode")}} 建立了純文字連結“check support”。

請務必檢視原始碼以瞭解您正在使用的宏的工作原理以及各種引數；雖然引數通常記錄良好，但像我們在 {{HTMLElement("")}} 宏中看到的“如果第二個引數包含空格則不渲染為程式碼”這樣的例外情況存在於程式碼中，但未在其他地方記錄。

要了解每個宏支援哪些引數以及每個宏的引數順序，宏的原始檔（上面已連結）包含文件。有一個常用宏列表，其中每個宏都會在頁面主內容區域生成連結。

另見

• 使用宏
• 常用宏，包括 BCD 宏（{{Compat}}）和規範宏（{{Specifications}}）。
• 橫幅和通知指南，包括 {{SeeCompatTable}}、{{Deprecated_Header}} 和 {{SecureContext_Header}} 宏。