常用的宏

本页列举了一些 MDN 中的常用宏命令。对于使用这些宏的入门信息，请阅读使用宏这篇文章。

还有一些不常用或只在特定上下文中使用的，以及一些弃用的宏的信息，参见其他宏。

链接

MDN 提供了许多链接宏，用于简化参考页、术语表条目和其他主题的链接的创建。

我们推荐使用宏而不是普通的 Markdown 链接来创建这些常见的链接，这样不但简洁，而且对翻译工作也很友好。例如，使用宏创建的术语和技术参考的链接不需要再做翻译处理：在其他本地环境中，它将自动链接到文件的正确版本。

链接到术语库

Glossary 宏可用于创建指向 MDN 术语表内一个具体词条的链接。调用这个宏时，有一个必需的参数和一个可选参数：

  1. 术语的名字（比如“HTML”）：{{Glossary("HTML")}} 会生成 HTML。
  2. 可选参数：使用参数中的文本内容，替代术语的名字显示在页面中：{{Glossary("CSS", "层叠样式表")}} 会生成层叠样式表。

链接到参考页

下面列出的宏可链接到 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/Element） {{HTMLElement("select")}} 会生成 <select>。
JSxRef JavaScript 参考（/Web/JavaScript/Reference） {{JSxRef("Promise")}} 会生成 Promise。
SVGAttr SVG 属性参考（/Web/SVG/Attribute） {{SVGAttr("d")}} 会生成 d。
SVGElement SVG 元素参考（/Web/SVG/Element） {{SVGElement("view")}} 会生成 <view>。
HTTPHeader HTTP 标头（/Web/HTTP/Headers） {{HTTPHeader("ACCEPT")}} 会生成 ACCEPT。
HTTPMethod HTTP 请求方法（/Web/HTTP/Methods） {{HTTPMethod("HEAD")}} 会生成 HEAD。
HTTPStatus HTTP 响应状态码（/Web/HTTP/Status） {{HTTPStatus("404")}} 会生成 404。

多页面间的导航栏

Previous、Next 和 PreviousNext 为序列中的文章提供导航控件。对于单向的模板，唯一需要的参数是序列中的上一篇或下一篇文章的 wiki 位置。对于 PreviousNext，需要的两个参数是相应文章的 wiki 位置。第一个参数用于上一篇文章，第二个参数用于下一篇文章。

代码示例

运行实例

侧边栏生成

几乎每个大型页面集合都有模板。它们通常会链接回参考/指南/教程的主页（这通常是需要的，因为我们的面包屑有时无法做到这一点）并将文章放入适当的类别中。

  • CSSRef 生成 CSS 参考页的侧边栏。
  • HTMLSidebar 生成 HTML 参考页的侧边栏。
  • APIRef 生成 Web API 参考页的侧边栏。

通用的文章格式化工具

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}}

    已弃用: 不再推荐使用该特性。虽然一些浏览器仍然支持它，但也许已从相关的 web 标准中移除，也许正准备移除或出于兼容性而保留。请尽量不要使用该特性，并更新现有的代码；参见本页面底部的兼容性表格以指导你作出决定。请注意，该特性随时可能无法正常工作。

  • secureContext_header：应该用于接口页面、API 概览页面和 API 入口点（例如 navigator.xyz）等主要页面，但通常不在方法和属性页面等子页面上使用。示例：{{SecureContext_Header}}

    安全上下文: 此项功能仅在一些支持的浏览器的安全上下文（HTTPS）中可用。

表明某个特性在 Web Worker 中可用的指示器

AvailableInWorkers 宏插入一个本地化的注释框，表明一个特性在 Web worker 上下文中可用。它还有一个可选参数，当带有 notservice 时，表示该特性在 Web Worker 中可用但在 Servcie Worker 中不可用。

语法

{{AvailableInWorkers}}
{{AvailableInWorkers("notservice")}}

示例

备注： 此特性在 Web Worker 中可用。

备注： 此特性在 Web Worker 中可用。