連結
MDN 提供了許多連結宏,用於輕鬆建立指向參考頁面、術語表條目和其他主題的連結。
建議使用連結宏而不是普通的 Markdown 連結,因為它們更簡潔且對翻譯友好。例如,使用宏建立的術語表或參考連結無需翻譯:在其他地區,它會自動連結到正確的檔案版本。
術語錶鏈接
Glossary 宏會建立指向 MDN 術語表中特定術語條目的連結。此宏接受一個必需引數和一個可選引數。
- 術語的名稱(例如“HTML”):
{{Glossary("HTML")}}生成 HTML - 可選:文章中顯示的文字,而不是術語名稱:
{{Glossary("CSS", "Cascading Style Sheets")}}生成 Cascading Style Sheets
連結到參考資料中的頁面
存在用於獨立於區域設定連結到 MDN 特定參考區域(JavaScript、CSS、HTML 元素、SVG 等)中頁面的宏。
宏易於使用。最少,您需要做的就是在第一個引數中指定要連結的專案名稱。大多數宏還會接受第二個引數,允許您更改顯示的文字(文件可以在下表中靠左的連結中找到)。
| 宏 | 連結到下面的頁面 | 示例 |
|---|---|---|
| CSSxRef | CSS 參考 (/Web/CSS/Reference) |
{{CSSxRef("cursor")}} 生成 cursor。 |
| DOMxRef | DOM 參考 (/Web/API) |
{{DOMxRef("Document")}} 或 {{DOMxRef("document")}} 生成 Document,{{DOMxRef("document.getElementsByName()")}} 生成 document.getElementsByName(){{DOMxRef("Node")}} 生成 Node。您可以使用第二個引數更改顯示的文字: {{DOMxRef("document.getElementsByName()","getElementsByName()")}} 生成 getElementsByName()。 |
| HTMLElement | HTML 元素參考 (/Web/HTML/Reference/Elements) |
{{HTMLElement("select")}} 生成 <select> |
| JSxRef | JavaScript 參考 (/Web/JavaScript/Reference)。 |
{{JSxRef("Promise")}} 生成 Promise |
| SVGAttr | SVG 屬性參考 (/Web/SVG/Reference/Attribute)。 |
{{SVGAttr("d")}} 生成 d |
| SVGElement | SVG 元素參考 (/Web/SVG/Reference/Element)。 |
{{SVGElement("view")}} 生成 <view> |
HTTPHeader
|
HTTP 標頭 (/Web/HTTP/Reference/Headers)。 |
{{HTTPHeader("ACCEPT")}} 生成 ACCEPT |
| HTTPMethod | HTTP 請求方法 (/Web/HTTP/Reference/Methods)。 |
{{HTTPMethod("HEAD")}} 生成 HEAD |
| HTTPStatus | HTTP 響應狀態碼 (/Web/HTTP/Reference/Status) |
{{HTTPStatus("404")}} 生成 404 |
多頁指南的導航輔助
Previous、Next 和 PreviousNext 為構成序列的文章提供導航控制元件。對於單向模板,唯一需要的引數是序列中前一篇或後一篇的文章的 wiki 位置。對於 PreviousNext,需要的兩個引數是相應文章的 wiki 位置。第一個引數是前一篇,第二個引數是後一篇。
程式碼示例
即時示例
EmbedLiveSample允許您在頁面上嵌入程式碼示例的輸出,如 即時示例中所述。LiveSampleLink建立一個指向包含頁面上程式碼示例輸出的頁面的連結,如 即時示例中所述。EmbedGHLiveSample允許嵌入來自 GitHub 頁面的即時示例。您可以在 GitHub 即時示例中獲取更多資訊。
通用格式化
API 文件的內聯指示器
Optional_Inline 和 ReadOnlyInline 用於 API 文件,通常在描述物件屬性列表或函式引數時使用。
用法:{{Optional_Inline}} 或 {{ReadOnlyInline}}。示例
isCustomObject只讀-
指示(如果為 true)該物件是自定義物件。
parameterX可選-
啦啦啦……
狀態和相容性指示器
不帶額外引數的內聯指示器
非標準
Non-standard_Inline 插入一個內聯標記,指示 API 未標準化,不在標準軌道上。
語法
{{Non-standard_Inline}}
示例
- 圖示: 非標準
實驗性
Experimental_Inline 插入一個內聯標記,指示 API 未得到廣泛實現,並且可能會在將來發生更改。有關“實驗性”的定義,請參閱 實驗性、已棄用和已廢棄文件。
語法
{{Experimental_Inline}}
示例
- 圖示: 實驗性
支援指定技術的內聯指示器
已棄用
Deprecated_Inline 插入一個內聯的已棄用標記( 已棄用 ),以勸阻使用已正式棄用(或已刪除)的 API。有關“已棄用”的定義,請參閱 實驗性、已棄用和已廢棄文件。
語法
{{Deprecated_Inline}}
示例
- 圖示: 已棄用
頁面或章節標題指示器
這些模板具有與上述內聯對應模板相同的語義。這些模板應直接放置在參考頁面的主頁面標題(或可用的麵包屑導航)下方。它們也可以用於標記頁面上的某個部分。
Non-standard_Header:{{Non-standard_Header}}非標準:此特性未標準化。我們不建議在生產環境中使用非標準特性,因為它們瀏覽器支援有限,並且可能會更改或被移除。但是,在沒有標準選項的特定情況下,它們可以是合適的替代方案。
SeeCompatTable用於記錄 實驗性功能的頁面。示例:{{SeeCompatTable}}Deprecated_Header:{{Deprecated_Header}}已棄用:此特性不再推薦。雖然某些瀏覽器可能仍然支援它,但它可能已經從相關的網路標準中刪除,可能正在刪除過程中,或者可能僅為相容性目的而保留。請避免使用它,如果可能,請更新現有程式碼;請參閱本頁底部的相容性表格以指導您的決策。請注意,此特性可能隨時停止工作。
SecureContext_Header。應在主頁面(如介面頁面、API 概述頁面和 API 入口點(例如navigator.xyz))上使用,但通常不應在子頁面(如方法和屬性頁面)上使用。示例:{{SecureContext_Header}}
指示某個功能在 Web Worker 中可用
AvailableInWorkers 宏插入一個本地化的註釋框,指示某個功能在 Worker 上下文中可用。您還可以傳遞一些引數來指示某個功能在指定的 Worker 上下文中有效。
語法
{{AvailableInWorkers}}
{{AvailableInWorkers("window_and_worker_except_service")}}
示例
注意:此功能在 Web Workers 中可用,但 Service Workers 除外。
注意:此功能在 Web Workers 中可用。
瀏覽器相容性和規範宏
以下宏包含在所有參考頁面上,但也被所有頁面型別支援
{{Compat}}-
為 frontmatter 中
browser-compat定義的功能生成相容性表。 {{Specifications}}-
如果 frontmatter 中
spec-urls定義了規範,或者從 frontmatter 中browser-compat定義的瀏覽器相容性資料中列出的規範中,包含該功能(或功能集)的規範表。