横幅和通知

横幅和通知会显示在某些页面上,尤其是在 API 参考页面上,目的是突出显示会影响内容使用方式的重要因素。例如,横幅用于指出某个接口、方法或属性何时已被弃用,不应在生产代码中使用,或者只能在安全上下文中进行使用。

横幅是使用页面内容中的宏渲染的。有些横幅宏会自动添加到页面中,而另一些则是手动添加的。

本文介绍了更重要的横幅以及它们的添加方式。

横幅宏在哪里添加

横幅是使用宏添加的,通常插在页面元数据下方,与页面侧边栏宏并列。例如,在下面的块中,{{SecureContext_Header}} 宏用于指示 AudioDecoder 接口仅在 安全上下文 中可用,{{AvailableInWorkers}} 宏用于指示 AudioDecoder 接口仅在 窗口上下文专用工作线程上下文 中可用,而 {{SeeCompatTable}} 的添加则用于指示该接口是实验性的。

md
---
title: AudioDecoder
slug: Web/API/AudioDecoder
page-type: web-api-interface
status:
  - experimental
browser-compat: api.AudioDecoder
---

{{APIRef("WebCodecs API")}} {{SeeCompatTable}} {{SecureContext_Header}} {{AvailableInWorkers("window_and_dedicated")}}

必须手动添加的横幅

您需要手动添加以下宏

  • {{SecureContext_Header}} — 此宏会生成一个“安全上下文”横幅,指示该技术仅在 安全上下文 中可用。
  • {{AvailableInWorkers}} — 此宏会生成一个“在工作线程中可用”的通知,指示该技术可在 工作线程上下文 中使用。

自动添加的横幅

为了匹配 browser compat data 存储库中的状态,以下宏会自动添加到内容中。

  • {{SeeCompatTable}} — 生成一个“这是一项实验性技术”的横幅,指示该技术是 实验性 的。
  • {{Deprecated_Header}} — 生成一个“已弃用”的横幅,指示使用该技术是 不推荐 的。
  • {{Non-standard_Header}} — 生成一个“非标准”的横幅,指示该技术的使用不属于正式规范,即使它在多个浏览器中都有实现。

更新 browser-compat-data 存储库中的功能状态 以更改这些值。

注意:虽然您可以手动添加/更新内容中的这些宏,但与浏览器兼容性数据不匹配的值将被替换/删除。

注意:带有 {{SeeCompatTable}}{{Deprecated_Header}}{{Non-standard_Header}} 横幅的页面,其页面元数据中也会包含相应的 experimentaldeprecatednon-standard 状态值。元数据会在标题更新的同时自动更新。横幅宏不依赖于此状态元数据(但未来可能会从中生成)。

实验性:“标准立场”横幅

偶尔,浏览器供应商对一项功能的开发方式有不同意见,有些可能会反对其当前形式。在特殊情况下,MDN 会记录处于此状态的技术,以鼓励 Web 社区进行实验、提供反馈并帮助浏览器供应商达成共识。

重要的是要向读者阐明这些功能当前的标准化状态。虽然表示此信息的长期解决方案尚未最终确定,但对于一些备受瞩目的技术,我们正在采取以下措施以避免混淆:

  • 在此功能的着陆页(而非每个子页面)上添加此横幅。

    md
    > [!WARNING]
    > This feature is currently opposed by <number> browser vendor(s). See the [Standards positions](#standards_positions) section below for details of opposition.
    
    • <number> 替换为反对该功能的浏览器供应商数量。
    • 根据情况使用 vendorvendors
  • 在上述横幅的同一页面上添加一个“标准立场”部分,作为“规范”标准部分的子部分。

注意:请参阅 相关网站集,了解“标准立场”部分的示例及其应包含的内容,以及着陆页横幅。