横幅和通知

横幅和通知显示在某些页面中,特别是 API 参考中,以便突出显示会影响所描述内容使用方式的重要因素。例如,横幅用于突出显示某个特定接口、方法或属性何时已弃用,并且不应在生产代码中使用,或者只能在安全上下文中使用。

横幅使用页面内容中的宏呈现。一些横幅宏会自动添加到页面中,而另一些则需要手动添加。

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

横幅宏在哪里添加

横幅是使用宏添加的,这些宏通常插入到页面元数据下方,以及页面侧边栏宏旁边。例如,在下面的代码块中,{{SecureContext_Header}} 宏用于指示 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}}

必须手动添加的横幅

您需要手动添加以下宏

  • {{SecureContext_Header}} — 这将生成一个 **安全上下文** 横幅,指示该技术仅在 安全上下文 中可用。
  • {{AvailableInWorkers}} — 这将生成一个说明该技术在 Web Worker 中可用的注释。

自动添加的横幅

以下宏会自动添加到内容中,以匹配浏览器兼容性数据存储库中存储的状态

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

更新浏览器兼容性数据存储库中的功能状态 以更改这些值。

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

**注意:**具有 {{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
  • 在与上述横幅相同的页面中,作为标准“规范”部分的子部分,添加“标准位置”部分。

**注意:**请参阅 相关网站集,了解“标准位置”部分及其应包含的内容以及登录页面横幅的示例。