如何记录 CSS 属性

新的属性随着 CSS 标准的发展而不断添加。MDN Web 文档上的 CSS 参考需要紧跟其发展。本文提供了创建 CSS 属性参考页面的步骤说明。

每个 CSS 属性参考页面都遵循相同的结构。这有助于读者更容易地找到信息,特别是在他们熟悉标准参考页面的格式之后。

步骤 1——确定要记录的属性

首先,你需要找出要记录的 CSS 属性。你可能已经注意到某个页面的缺失,或者你在我们的议题列表中看到了缺失的内容。要了解 CSS 属性的详细信息,你需要找到相关的规范(例如,W3C 规范,或者用于渲染引擎(如 Gecko 或 Blink)的非标准属性的错误报告)。

备注:使用 W3C 规范时,请始终使用编辑草案(Editor's Draft,请注意左侧的红色横幅),而不是已发布的版本(例如,工作草案)。编辑草案总是更接近最终版本!

如果实现和规范不一致,请在实现错误中提及。可能有以下几种情况:

  • 这可能是实现的一个错误(并在内容中提及相关错误)。
  • 这可能是因为新规范的延迟发布。
  • 这可能是规范的一个错误(在这种情况下,值得提及规范错误)。

步骤 2——检查 CSS 属性数据库

CSS 属性的特性(例如其语法以及是否可动)会在多个页面中提及,因此,它们会被存储在一个特定的数据库中。你将在页面中使用的宏需要这些存储的信息,所以,请检查这些信息是否存在

步骤 3——创建 CSS 属性页面

准备工作完成!现在,我们可以添加实际的 CSS 属性页面了。创建新的 CSS 属性页面的最简单的方法是复制现有的 CSS 属性页面的内容,并为将其编辑为新属性的内容。要创建新页面,请参阅我们的如何创建页面指南中的说明。

在创建参考页时,你需要添加示例。为此,请遵循有关运行实例的教程。请注意,你正在创建的属性页面是针对单个属性的,因此,你添加的示例需要显示该属性如何独立工作,而不是整个规范如何使用。因此,list-style-type 属性的示例应该显示使用该属性的不同值的结果,而不是如何将其与其他属性、伪类或伪元素组合以生成漂亮的效果。可以编写教程和指南来展示更多内容。

步骤 4——内容审查

在创建属性页面后,请将其以拉取请求的形式提交。会自动分配我们审查团队的成员来审查你的页面。