1. MDN Web 文档
  2. 写作指南
  3. 页面结构
  4. 使用宏
  5. 常用宏

常用宏

此页面列出了 MDN 中创建的许多通用宏。有关在 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/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 位置。第一个参数是前一篇，第二个参数是后一篇。

代码示例

实时示例

通用格式化

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

    安全上下文： 此功能仅在安全上下文（HTTPS）中可用，且支持此功能的浏览器数量有限。

指示某个功能在 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 定义的浏览器兼容性数据中列出的规范中，包含该功能（或功能集）的规范表。

另见

帮助改进 MDN

了解如何贡献

此页面最后一次修改于 ，由 MDN 贡献者 修改。

在 GitHub 上查看此页面 • 报告此内容的问题
© . Content available under a Creative Commons license.