如何记录 CSS 属性
随着 CSS 标准的不断发展,新的属性也在不断添加。MDN Web Docs 上的 CSS 参考 需要及时跟进这些发展。本文提供了创建 CSS 属性参考页面的分步说明。
每个 CSS 属性参考页都遵循相同的结构。这有助于读者更轻松地查找信息,尤其是在他们熟悉了标准的参考页格式之后。
第一步 — 确定要编写文档的属性
首先,您需要找出想要编写文档的 CSS 属性。您可能已经注意到某个页面缺失,或者您可能在我们的 问题列表 中看到了缺失内容的报告。有关 CSS 属性的详细信息,您需要找到相关的规范(例如,W3C 规范,或用于 Gecko 或 Blink 等渲染引擎的非标准属性的 bug 报告)。
注意: 使用 W3C 规范时,请务必使用 编辑草案(请注意左侧的红色横幅),而不是已发布的版本(例如,工作草案)。编辑草案始终最接近最终版本!
如果实现与规范不符,请随时在实现 bug 中提及。可能出现以下几种情况之一:
- 这可能是实现中的一个 bug(并且会提交一个后续 bug)。
- 这可能是由于新规范发布延迟所致。
- 这可能是规范中的一个错误(在这种情况下,提交一个规范 bug 是值得的)。
第二步 — 检查 CSS 属性数据库
CSS 属性的几个特征,例如其语法或是否可以进行动画处理,在多个页面中都有提及,因此被存储在一个临时数据库中。您将在页面上使用的宏需要有关该属性存储在那里的信息,因此请首先 检查信息是否存在。
第三步 — 创建 CSS 属性页面
准备工作完成!现在我们可以添加实际的 CSS 属性页面了。创建新的 CSS 属性页面的最简单方法是复制现有 CSS 属性页面的内容并为其新属性进行编辑。要创建新页面,请参阅我们 如何创建页面 指南中的说明。
在创建参考页面时,您需要添加示例。要做到这一点,请遵循有关实时示例的 教程。请记住,您正在创建的属性页面是针对单个属性的,因此您添加的示例需要展示该属性如何独立工作,而不是整个规范如何使用。因此,list-style-type 属性的示例应显示使用该属性的不同值所产生的结果,而不是如何将其与其他属性、伪类或伪元素结合以产生漂亮的效果。教程和指南可以用于展示更多内容。
第四步 — 获取内容审查
创建完属性页面后,将其作为拉取请求提交。我们的审查团队成员将自动被分配来审查您的页面。