规范表格
MDN 上的每一个参考页面都应该提供有关该 API 或技术定义的一个或多个规范的信息。这篇文章展示了这些表格的样子,并解释了如何添加这些表格。
规范部分的定义与兼容性表格的定义相似,通常从同一数据源生成,并且通常出现在页面中紧接在后者之前的位置。
标准规范表格
标准规范部分应该是这样的:
md
## 规范
{{Specifications}}
{{Specifications}}
宏根据页面元数据信息的值生成了规范表格。
默认情况下,使用 browser-compat
键中的值。每个值都引用了 browser-compat-data 仓库中的一个特定特性及其相关的兼容性和规范信息。例如,text-align
页有以下键,它用来获取相关的规范信息。
yaml
browser-compat: css.property.text-align
有些特性不在上述仓库中维护。在这些情况下,可以使用 spec-urls
键将规范信息添加到页面元数据中。例如,aria-atomic
属性拥有以下页面元数据:
yaml
spec-urls: https://w3c.github.io/aria/#aria-atomic
css.property.text-align
的规范表格被呈现在一个表格中,如下所示:
规范
Specification |
---|
CSS Logical Properties and Values Level 1 # text-align |
CSS Text Module Level 3 # text-align-property |
非标准特性
当撰写非标准特性(特别是一个不再被标准追踪特性)的文档时,不要调用 {{Specifications}}
宏。
相反,尽量提供有关标准化状况和可能的替代方案的信息。举例说明:
- 这个方法已经不再由任何标准追踪。保留它是为了兼容的目的。请使用这个其他方法代替。
- 这个方法最初属于 DOM Level 2 Traversal and Range 规范,但其不属于目前的 DOM 规范。此特性不再有望成为标准。
- 这个事件处理器属于旧的 WebVR API 规范(已经被 WebXR Device API 所取代)。它已不再有望成为标准。