常用宏

此页面列出了许多为 MDN 创建的通用宏。有关使用这些宏的更多操作信息，请参见 使用宏.

有关很少使用、仅在特定上下文中使用或已弃用的宏的信息，请参见 其他宏.

链接

MDN 提供了许多链接宏，以方便创建指向参考页面、词汇表条目和其他主题的链接。

建议使用链接宏而不是普通 Markdown 链接，因为它们简洁且易于翻译。例如，使用宏创建的词汇表或参考链接无需翻译：在其他语言环境中，它会自动链接到文件的正确版本。

Glossary 宏创建指向 MDN 词汇表 中指定词条的条目链接。此宏接受一个必需参数和一个可选参数

  1. 词条的名称（例如，“HTML”）：{{Glossary("HTML")}} 生成 HTML
  2. 可选：在文章中显示的文本，而不是词条名称：{{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/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 为文章提供导航控件，这些文章是序列的一部分。对于单向模板，唯一需要的参数是序列中前一篇文章或下一篇文章的维基位置。对于 PreviousNext，需要的两个参数是相应文章的维基位置。第一个参数用于前一篇文章，第二个参数用于下一篇文章。

代码示例

实时示例

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

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

    非标准：此功能是非标准的，并且不在标准轨道上。不要在面向 Web 的生产网站上使用它：它不会对每个用户都起作用。实现之间也可能存在很大的兼容性问题，并且行为在将来可能会发生变化。

  • SeeCompatTable 用于记录实验性功能的页面。例如：{{SeeCompatTable}}

    实验性：这是一种实验性技术
    在生产环境中使用此功能之前，请仔细查看浏览器兼容性表。

  • deprecated_header: {{Deprecated_Header}}

    已弃用：此功能不再推荐使用。尽管一些浏览器可能仍然支持它，但它可能已经从相关的 Web 标准中删除，可能正在被放弃，或者可能只是为了兼容性而保留。避免使用它，并尽可能更新现有代码；请查看此页面底部的兼容性表，以指导您的决策。请注意，此功能可能随时停止工作。

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

    安全上下文：此功能仅在安全上下文（HTTPS）中可用，在支持的浏览器中部分或全部可用。

指示某个功能在 Web 工作线程中可用

AvailableInWorkers 宏插入一个本地化的提示框，指示某个功能在Web 工作线程 上下文中可用。您可以使用参数 window_and_worker_except_service 来指示某个功能在除了服务工作线程之外的所有 Web 工作线程中都能正常工作。

语法
{{AvailableInWorkers}}
{{AvailableInWorkers("window_and_worker_except_service")}}
示例

注意：此功能在Web 工作线程中可用。

注意：此功能在Web 工作线程中可用，但服务工作线程除外。

浏览器兼容性和规范宏

以下宏包含在所有参考页面上，但也受所有页面类型支持

{{Compat}} / {{Compat(<feature>)}} / {{Compat(<feature>, <depth>)}}

为作为参数传递的功能生成兼容性表。如果没有包含参数，则默认使用前文中的 browser-compat 定义的功能。可选的深度参数设置将子功能添加到表的深度。深度如果省略，则默认为 1，这意味着仅包含来自 BCD 的第一级子功能数据。

{{Specifications}} / {{Specifications(<feature>)}}

包含参数中指定的功能规范。如果未传递参数，则列出的规范由前文中的 spec_urls 值（如果存在）定义，或由前文中的 browser-compat 定义的浏览器兼容性数据中列出的规范定义。该规范将呈现为外部链接。

另请参阅