MDN历史
+MDN 历史
-2005年初，一个理想者组成的小团队建立起来并开始为所有的Web开发者提供实时、免费和社区驱动的在线资源.。他们杰出而不寻常的想法逐渐演化成了今天的Mozilla开发者网络——一个领先和全面的开放Web技术资源库。十年后, 我们全球化的社区变得更加的强大, 同时，为了能给广泛的网络技术公司提供技术上的支持，我们还坚持编写文档, 案例代码 以及学习资源 ，其中就包括像 CSS, HTML, JavaScript 以及各种能够使得网络变得更加强大的东西。
+2005 年初，一个理想者组成的小团队建立起来并开始为所有的 Web 开发者提供实时、免费和社区驱动的在线资源.。他们杰出而不寻常的想法逐渐演化成了今天的 Mozilla 开发者网络——一个领先和全面的开放 Web 技术资源库。十年后，我们全球化的社区变得更加的强大，同时，为了能给广泛的网络技术公司提供技术上的支持，我们还坚持编写文档，案例代码 以及学习资源 ，其中就包括像 CSS, HTML, JavaScript 以及各种能够使得网络变得更加强大的东西。
- + -为MDN做出贡献
+为 MDN 做出贡献
-十年来，MDN社区已经几乎给开放网络贡献了无限多的文档，从最小的字符修改到编写整个一系列新的API，对开放网络，社区中的每个人都有贡献，每个人既不会付出太多也不会太少。我们已经有超过90000页的文档或内容被社区中突出的智谋人（Mozillians）编辑或者被翻译。你将会成为我们中的一员。
+十年来，MDN 社区已经几乎给开放网络贡献了无限多的文档，从最小的字符修改到编写整个一系列新的 API，对开放网络，社区中的每个人都有贡献，每个人既不会付出太多也不会太少。我们已经有超过 90000 页的文档或内容被社区中突出的智谋人（Mozillians）编辑或者被翻译。你将会成为我们中的一员。
- +@@ -31,8 +31,8 @@
为MDN做出贡献
子目录
{{MDNSidebar}}
-MDN 文档的问题被报告在 content 仓库的 issues中(也会有一些在 sprints 仓库的遗留问题)。 本文将帮助你，根据你的专业知识和空闲时间来找到最适合解决的问题，并且讲述解决这些问题的主要步骤。
+MDN 文档的问题被报告在 content 仓库的 issues中 (也会有一些在 sprints 仓库的遗留问题)。本文将帮助你，根据你的专业知识和空闲时间来找到最适合解决的问题，并且讲述解决这些问题的主要步骤。
注意
@@ -19,7 +19,7 @@注意
我们需要什么帮助？
-为了帮助你选择要处理的内容问题，我们使用GitHub标签对它们进行了排序。
+为了帮助你选择要处理的内容问题，我们使用 GitHub 标签对它们进行了排序。
下面的标签可以帮助你根据空闲时间来选择任务。
@@ -33,21 +33,21 @@我们需要什么帮助？
- 在 sprints 仓库耗时10分钟的任务
+ 在 sprints 仓库耗时 10 分钟的任务 +
- 在 sprints 仓库耗时30分钟的任务 + 在 content 仓库耗时 30 分钟的任务
+ 在 sprints 仓库耗时 30 分钟的任务
- 在 sprints 仓库耗时1小时的任务 + 在 content 仓库耗时 1 小时的任务
+ 在 sprints 仓库耗时 1 小时的任务
我们需要什么帮助？
我们需要什么帮助？
我们需要什么帮助？
你能获取什么收益？
-
-
- 修复MDN的内容错误是一个深入了解web技术的好方法——当你研究问题并创建所需的内容时，你将对主题有更深入的了解，并提高你的技能。 -
- 随着你更多地参与MDN社区，你将接触到Mozilla的工作人员和其他社区成员。这将为你提供一个宝贵的社交网络，帮助你解决自己的问题并提高你的知名度。 -
- 帮助解决问题在很大程度上回报就是其本身，但它也将作为你对开源贡献的记录，展示你在web技术方面的专业知识，甚至可能帮助你完成课程或获得工作机会。 +
- 修复 MDN 的内容错误是一个深入了解 web 技术的好方法——当你研究问题并创建所需的内容时，你将对主题有更深入的了解，并提高你的技能。 +
- 随着你更多地参与 MDN 社区，你将接触到 Mozilla 的工作人员和其他社区成员。这将为你提供一个宝贵的社交网络，帮助你解决自己的问题并提高你的知名度。 +
- 帮助解决问题在很大程度上回报就是其本身，但它也将作为你对开源贡献的记录，展示你在 web 技术方面的专业知识，甚至可能帮助你完成课程或获得工作机会。
你需要什么技能？
-
-
- 你需要对你选择帮助的主题领域（例如JavaScript、CSS）有一定的了解。 +
- 你需要对你选择帮助的主题领域（例如 JavaScript、CSS）有一定的了解。
- 你要帮助的大多数例子和页面都是用英语写的，所以你应该能够的理解英语。但是如果你的英语不够好，不要担心！我们的团队非常乐意帮助清理任何文字内容。
你要如何帮助？
-
-
- 首先，如果你还没有GitHub帐户，你需要注册一个。你需要通过它来沟通GitHub上的问题。 +
- 首先，如果你还没有GitHub 帐户，你需要注册一个。你需要通过它来沟通 GitHub 上的问题。
- 接下来，选择一个或多个您想帮助的主题领域，并使用上面的列表来帮助您进行选择。如果您不确定什么是好的选择，请在 Matrix 的MDN Web 文档聊天室寻求帮助。
一旦你准备好了
注意
-在选择和处理问题时，您可能还会发现我们的 GitHub最佳实践 和 初识 MDN 非常有用。
+在选择和处理问题时，您可能还会发现我们的 GitHub 最佳实践 和 初识 MDN 非常有用。
如果你有浏览器在兼容Web特性方面的信息 —— 或者有意愿并有能力做一些这方面的研究和/或实验 —— 你可以帮助更新MDN的浏览器兼容性数据库（BCD）。
+如果你有浏览器在兼容 Web 特性方面的信息 —— 或者有意愿并有能力做一些这方面的研究和/或实验 —— 你可以帮助更新 MDN 的浏览器兼容性数据库（BCD）。
- 熟悉使用 Github @@ -15,17 +15,17 @@
- 哪些地方需要做？
-
-
在MDN上你有这几种方法可以帮助改进浏览器兼容性方面的信息：
+在 MDN 上你有这几种方法可以帮助改进浏览器兼容性方面的信息：
-
-
- 添加尚未收录在BCD仓库内的网页特性数据 +
- 添加尚未收录在 BCD 仓库内的网页特性数据
- 依据浏览器新版本的变更内容、现有数据中的更正错误，或者某项技术的特性之最新变更等信息来更新现有数据
- 提交 pull requests 到 BCD issues filed on Github.
- 做这个任务你需要知道哪些知识？
- 做这个任务需要哪些步骤？ -
- 欲了解如何更新在GitHub上的组成BCD仓库的 JSON 文件的详细信息，请参见兼容性表格页面。如要了解我们特别寻求帮助的问题列表，请到 Github issues with the "Help Wanted" tag. +
- 欲了解如何更新在 GitHub 上的组成 BCD 仓库的 JSON 文件的详细信息，请参见兼容性表格页面。如要了解我们特别寻求帮助的问题列表，请到 Github issues with the "Help Wanted" tag.
- 你可以新增段落，删除文本，插入标题，并且执行更多涉及编写和编辑的功能。 -
- 请别人帮你创建。为此，请您提供一份用于提出 bug 的申请书，并且以 "Create page: <页面标题>" 为主题。如果您知道该页面应该放在 MDN 中的什么位置，请确保填写好一个 URL 来描述该位置。您还应该注明您为何需要创建该页面。 @@ -94,29 +94,29 @@
- 确认已登录进 MDN，并且拥有新建页面的权限。（若未登录就点击“缺失页面”链接，会得到一个404（找不到页面）的错误。） -
- 点击“缺失页面”链接。如果你拥有页面创建权限，MDN编辑器界面会自动打开，准备好让你创建缺失的页面。 +
- 确认已登录进 MDN，并且拥有新建页面的权限。（若未登录就点击“缺失页面”链接，会得到一个 404（找不到页面）的错误。） +
- 点击“缺失页面”链接。如果你拥有页面创建权限，MDN 编辑器界面会自动打开，准备好让你创建缺失的页面。
- 编写页面内容，然后保存。
动态的内容对于学习 Web 来说是重要的。 她能让学习的人更加积极主动。 这可以是练习，实例，任务，评价等等。总之，任何有助于学习理解的东西都行。
+动态的内容对于学习 Web 来说是重要的。她能让学习的人更加积极主动。这可以是练习，实例，任务，评价等等。总之，任何有助于学习理解的东西都行。
这儿还没有能够直接创建动态的实例内容。但是一些第三方工具可以帮助你创建（如： JSFiddle，CodePen，Dabblet，等），你可以将其链接放在 MDN 文章中。
diff --git a/files/zh-cn/mdn/contribute/howto/create_and_edit_pages/index.html b/files/zh-cn/mdn/contribute/howto/create_and_edit_pages/index.html index 57f573339d6ed7..e2f3a174661020 100644 --- a/files/zh-cn/mdn/contribute/howto/create_and_edit_pages/index.html +++ b/files/zh-cn/mdn/contribute/howto/create_and_edit_pages/index.html @@ -21,7 +21,7 @@测试页面
通过查看MDN Editor guide里的Editor UI elements获得更多关于MDN内置编辑器的信息。
+通过查看MDN Editor guide里的Editor UI elements获得更多关于 MDN 内置编辑器的信息。
预览修改
@@ -49,11 +49,11 @@标签
需要复核？
-保存之前，为了确保信息的准确性，你可以勾选技术复核（针对代码，API，或技术），编辑复核（针对文章，语法，和内容），或模板复核（针对KumaScript code）的选择框，来让专家或有经验的贡献者复核你的编辑信息。
+保存之前，为了确保信息的准确性，你可以勾选技术复核（针对代码，API，或技术），编辑复核（针对文章，语法，和内容），或模板复核（针对 KumaScript code）的选择框，来让专家或有经验的贡献者复核你的编辑信息。
附件
-如果你想附加某个文件到一个现有的页面中来添加插图或作进一步说明的话，你可以在页面底部输入。当你上传图片时，请确保使用图片优化工具进行优化，以便我们的图片足够小，方便下载。这样便提高了页面加载速度，提升MDN的整体性能。有可能有你钟爱的工具，如果没有的话，我们推荐一款容易上手的Web工具：TinyPNG。
+如果你想附加某个文件到一个现有的页面中来添加插图或作进一步说明的话，你可以在页面底部输入。当你上传图片时，请确保使用图片优化工具进行优化，以便我们的图片足够小，方便下载。这样便提高了页面加载速度，提升 MDN 的整体性能。有可能有你钟爱的工具，如果没有的话，我们推荐一款容易上手的 Web 工具：TinyPNG。
保存，放弃更改，继续编辑
@@ -64,12 +64,12 @@保存，放弃更改，继续编
在版本注释区域点击 Enter 键和点击按钮“发布并继续编辑”具有相同的效果。
注意：当你尝试保存你编辑好的页面时发现你的编辑被视为无效操作而被拒绝了，若你编辑好的内容又确实是适合MDN的，此时你可以向MDN管理团队发送邮件来获得帮助。
+注意：当你尝试保存你编辑好的页面时发现你的编辑被视为无效操作而被拒绝了，若你编辑好的内容又确实是适合 MDN 的，此时你可以向MDN 管理团队发送邮件来获得帮助。
获取新建页面的许可
-出于对安全的考虑，最近创建的MDN账号是没有权限新建页面的。如果你尝试这样做，你将看到一个页面引导你如何创建新页面。有以下两种可选的方式：
+出于对安全的考虑，最近创建的 MDN 账号是没有权限新建页面的。如果你尝试这样做，你将看到一个页面引导你如何创建新页面。有以下两种可选的方式：
新建一个页面
“缺失页面”链接
-和许多维基站点一样，在 MDN 也有可能创建一个链接，它指向一个尚不存在的页面。例如：一个作者可能创建了一个清单页面，该页面涵盖了某个API的所有成员，而这些成员对应的页面还没创建好。在 MDN，指向到缺失页面的链接通常显示为红色。
+和许多维基站点一样，在 MDN 也有可能创建一个链接，它指向一个尚不存在的页面。例如：一个作者可能创建了一个清单页面，该页面涵盖了某个 API 的所有成员，而这些成员对应的页面还没创建好。在 MDN，指向到缺失页面的链接通常显示为红色。
从“缺失页面”链接创建对应的页面需要：
-
-
不需要链接的新页面
-想要创建一个没有链接到其他页面的新页面时，你需要在你的浏览器中键入一个包含新页面名字段的URL。例如，如果你键入以下URL并回车：
+想要创建一个没有链接到其他页面的新页面时，你需要在你的浏览器中键入一个包含新页面名字段的 URL。例如，如果你键入以下 URL 并回车：
https://developer.mozilla.org/en-US/docs/FooBarMDN将创建一个标题为“FooBar”的新页面并且打开编辑器让你能够为新添加的页面添加内容。请参考本文中编辑一个已存在的页面的小节来学习如何使用编辑器模式。
+MDN 将创建一个标题为“FooBar”的新页面并且打开编辑器让你能够为新添加的页面添加内容。请参考本文中编辑一个已存在的页面的小节来学习如何使用编辑器模式。
要创建一个没有链接到其他页面的新页面需要：
-
-
- 确保您已经登陆MDN，并且拥有创建新页面的权限。 -
- 在您的浏览器中输入以下URL并回车。 +
- 确保您已经登陆 MDN，并且拥有创建新页面的权限。 +
- 在您的浏览器中输入以下 URL 并回车。
https://developer.mozilla.org/en-US/docs/new已存在页面的子页面
从现有页面链接到新页面
（也可能是简洁的锁链状）。“更新链接”对话框打开，高亮的文字会被显示在“链接文本”框中。 从现有页面链接到新页面
刷新页面内容 -由于性能上原因，MDN对KumaScript 宏指令和将一个页面嵌入另一个页面中的支持有时候会稍微被页面缓存所妨碍。页面由它们的数据源编译，并且输出会被缓存起来用来将来的页面请求。从那时起，在该页面的任何宏指令（模板）或者嵌入（使用宏Page ）将不会展现由于宏，宏的输出，或者嵌入的原本内容所引起的变化。
由于性能上原因，MDN 对 KumaScript 宏指令和将一个页面嵌入另一个页面中的支持有时候会稍微被页面缓存所妨碍。页面由它们的数据源编译，并且输出会被缓存起来用来将来的页面请求。从那时起，在该页面的任何宏指令（模板）或者嵌入（使用宏Page ）将不会展现由于宏，宏的输出，或者嵌入的原本内容所引起的变化。
-
-
- 当想要手动刷新一个页面时，您可以在浏览器中强制刷新。MDN能够识别这个动作并且触发一个页面的重新编译，拉取一个更新过的宏输出并且传输页面内容。 +
- 当想要手动刷新一个页面时，您可以在浏览器中强制刷新。MDN 能够识别这个动作并且触发一个页面的重新编译，拉取一个更新过的宏输出并且传输页面内容。
- 您也可以配置页面定期的自动重新编译。除非您期望页面需要经常性的更新，否则不应这样做。参考页面重新生成获取更多信息。
文章标签是一个让游客接触到有用内容的重要方式。每一个页面通常都应该有几个标签来保持其内容的组织性。 这一页解释了标记页面的最好方法，以使我们的读者可以找到信息和让我们的页面保持组织有序。
-对于编辑标签的用户界面的帮助, 请看我们的编辑者指南里的标记部分。
+对于编辑标签的用户界面的帮助，请看我们的编辑者指南里的标记部分。
-请根据下面所解释的来合理的使用标签。 如果你没有这么做, 我们的自动化工具将不能正确的生成内容列表，着陆页面和文章的交叉链接。
+请根据下面所解释的来合理的使用标签。如果你没有这么做，我们的自动化工具将不能正确的生成内容列表，着陆页面和文章的交叉链接。
-MDN如何使用标签
+MDN 如何使用标签
-MDN有这么几种方法来使用标签：
+MDN 有这么几种方法来使用标签：
- 文档分类：
- 这个文档是什么类型的？是一篇参考？一篇教程？还是一篇着陆页？我们的游客可以使用这些标签来过滤搜索，所以它们真的很重要！
- 主题识别 -
- 这篇文章是关于什么的？关于API？DOM？图形？重申一遍，这些标签很重要，因为它们可以用来过滤搜索。 +
- 这篇文章是关于什么的？关于 API？DOM？图形？重申一遍，这些标签很重要，因为它们可以用来过滤搜索。
- 技术现状
- 这门技术的现状是什么？它是非标准的？过时的还是已经被弃用了的？还是处于实验性的？
- 技术水平 @@ -40,7 +40,7 @@
{{Tag("Reference")}}
- - 这篇文章包含API、元素、属性、等的参考资料。 +
- 这篇文章包含 API、元素、属性、等的参考资料。
{{Tag("Landing")}}- 这是一个着陆页面。
{{Tag("Guide")}}
@@ -85,19 +85,19 @@ {{Tag("HTML")}}{{Tag("CSS")}}
- {{Tag("JavaScript")}}(注意大写字母 “S”！)
+ {{Tag("JavaScript")}}(注意大写字母“S”！){{Tag("Document")}}{{Tag("DOM")}}{{Tag("API")}}对于每一个接口，方法和属性。
- {{Tag("Method")}}对于API的每一个方法。
- {{Tag("Property")}}对于API的每一个属性。
+ {{Tag("Method")}}对于 API 的每一个方法。
+ {{Tag("Property")}}对于 API 的每一个属性。{{Tag("Graphics")}}{{Tag("Firefox OS")}}{{Tag("Gecko")}}
@@ -113,11 +113,11 @@ - {{Tag("Mozilla")}} @@ -132,11 +132,11 @@
- {{tag("Interface")}} -
- 一个接口的主要文章应该有这样的标签. 例如, {{DOMxRef("RTCPeerConnection")}}. +
- 一个接口的主要文章应该有这样的标签。例如，{{DOMxRef("RTCPeerConnection")}}.
- {{tag("Constructor")}}
- 每个接口最多可以有一个页面标记为“构造函数”（接口的构造函数）。页面应该有和接口一样的名字，如{{DOMxRef("RTCPeerConnection.RTCPeerConnection()","RTCPeerConnection()")}}.
- {{tag("Property")}} @@ -149,7 +149,7 @@
- 接口 {{DOMxRef("RTCPeerConnection")}} -
- 包含标签 "RTCPeerConnection" 以及其他相关标记 （"Interface"，"WebRTC"，"WebRTC API"，"API"，"Reference"等）。 +
- 包含标签 "RTCPeerConnection" 以及其他相关标记（"Interface"，"WebRTC"，"WebRTC API"，"API"，"Reference"等）。
- 方法{{DOMxRef("RTCPeerConnection.createOffer()")}}
- 包括标记 "RTCPeerConnection"和 "createOffer" (注意标记名中没有括号！) 以及其他相关标记，包括 "WebRTC"，"WebRTC API"，"API"，"Reference"等。考虑包含像 "Offer"和 "SDP"这些内容，它们在这里也是相关的。
- 属性{{DOMxRef("RTCPeerConnection.iceConnectionState")}} @@ -174,7 +174,7 @@
-
-
表示页面中描述的技术或应用接口不是标准的一部分，但是在任何实现浏览器中都是稳定的。如果你不使用这个标签，你的读者会认为这是标准的技术。页面上的兼容性表应该说明该技术或API的支持。
+表示页面中描述的技术或应用接口不是标准的一部分，但是在任何实现浏览器中都是稳定的。如果你不使用这个标签，你的读者会认为这是标准的技术。页面上的兼容性表应该说明该技术或 API 的支持。
@@ -182,7 +182,7 @@ -
-
网页上的技术或API被标记为过时的规范，并有可能最终被删除，但一般仍可用在当前版本的浏览器。
+网页上的技术或 API 被标记为过时的规范，并有可能最终被删除，但一般仍可用在当前版本的浏览器。
@@ -190,7 +190,7 @@ -
-
该技术或API已被认为已经过时，并已经在所有或大多数当前浏览器中被删除（或正在积极被删除）。
+该技术或 API 已被认为已经过时，并已经在所有或大多数当前浏览器中被删除（或正在积极被删除）。
@@ -198,7 +198,7 @@ -
-
技术不是规范，而是一个实验性的技术或API，可能会或可能不会成为标准的一部分。它可能在浏览器的实现上被改变。
+技术不是规范，而是一个实验性的技术或 API，可能会或可能不会成为标准的一部分。它可能在浏览器的实现上被改变。
@@ -211,7 +211,7 @@ {{Tag("Certified Only")}}
- - 该API仅适用于认证码。 +
- 该 API 仅适用于认证码。
-
-
内容重要，应该被MDN标记为优先翻译。在本地化状态页上显示了一个额外的优先级表。
+内容重要，应该被 MDN 标记为优先翻译。在本地化状态页上显示了一个额外的优先级表。
@@ -305,27 +305,27 @@ - {{Tag("Navigation")}} -
- 文章包含关于在web上如何搜索的信息。 +
- 文章包含关于在 web 上如何搜索的信息。
- {{Tag("WebMechanics")}} -
- 内容有关于web如何组织和如何工作的信息。 +
- 内容有关于 web 如何组织和如何工作的信息。
- {{Tag("Search")}} -
- 文章解释了如何在web上寻找信息、人和资源。 +
- 文章解释了如何在 web 上寻找信息、人和资源。
- {{Tag("Credibility")}} -
- 文章中的信息帮助读者理解怎样批判性的评估他们在web上找到的信息。 +
- 文章中的信息帮助读者理解怎样批判性的评估他们在 web 上找到的信息。
- {{Tag("Security")}}
- 文章提供有关如何保持系统、身份和内容安全的信息。
- {{Tag("Composing")}} -
- 文档解释如何创建和curate web上的内容。 +
- 文档解释如何创建和 curate web 上的内容。
- {{Tag("Remixing")}} -
- 文章讲授如何修改existing的网络资源来创建新的东西。 +
- 文章讲授如何修改 existing 的网络资源来创建新的东西。
- {{Tag("Design")}}
- 文档解释如何提高视觉和其他用户体验。
- {{Tag("Accessibility")}} -
- 文档描述如何用universally-recognizable的方式交流。 +
- 文档描述如何用 universally-recognizable 的方式交流。
- {{Tag("CodingScripting")}}
- 如何在网络上写代码和（或）创造交互式的用户体验。
- {{Tag("Infrastructure")}} -
- 文档解释Internet's technical stack是如何工作的。 +
- 文档解释 Internet's technical stack 是如何工作的。
- {{Tag("Sharing")}}
- 文章内容包含与他人一起创造资源的方式。
- {{Tag("Collaborating")}} @@ -335,7 +335,7 @@
- {{Tag("Privacy")}}
- 材料帮助检查在网络上分享数据的后果。
- {{Tag("OpenPractices")}} -
- 文章provid=deshow帮助保持人人可以连接网络。 +
- 文章 provid=deshow 帮助保持人人可以连接网络。
- 没有标签 -
- 一般来说文章应该至少有一个 "category" 标签和一个 "topic"标签. 虽然有其他标签也好, 但是如果你能帮我们提供最基本的标签（前文所说的category和topic标签）, 你将会是一名（维护）文档的英雄! +
- 一般来说文章应该至少有一个 "category" 标签和一个 "topic"标签。虽然有其他标签也好，但是如果你能帮我们提供最基本的标签（前文所说的 category 和 topic 标签）, 你将会是一名（维护）文档的英雄！
- 不符合我们
标签标准的标签
- - 请修正一切含有不合标准标签的文档.请注意由于Kuma的一个bug, 一些本地化的标签(比如
Référence) 可能会出现在一些英语页面上. 这些标签还有可能反复出现,即使你已经吧它们删除; 请耐心处理这些问题直到kuma的那个bug被修复.
+ - 请修正一切含有不合标准标签的文档。请注意由于Kuma 的一个 bug, 一些本地化的标签 (比如
Référence) 可能会出现在一些英语页面上。这些标签还有可能反复出现，即使你已经吧它们删除; 请耐心处理这些问题直到 kuma 的那个 bug 被修复。 - 不正确的标签 -
- 如果你正在看一篇关于HTML的文章并且发现它被标上了"JavaScript"的标签, 那很有可能这是一个错误标签! 同理, 如果一篇文章在讨论Mozilla internals 但是有一个"Web"标签, 那也有可能是错误的. 删除这些错误的标签并且如果还没有合适标签的话，加上正确的标签. 同样请更正拼写错误的标签(e.g., 因为标签是大小写敏感的, 所以"Javascript" 仍然匹配, 但是我们还是不要马虎对待!). +
- 如果你正在看一篇关于 HTML 的文章并且发现它被标上了"JavaScript"的标签，那很有可能这是一个错误标签！同理，如果一篇文章在讨论 Mozilla internals 但是有一个"Web"标签，那也有可能是错误的。删除这些错误的标签并且如果还没有合适标签的话，加上正确的标签。同样请更正拼写错误的标签 (e.g., 因为标签是大小写敏感的， 所以"Javascript" 仍然匹配，但是我们还是不要马虎对待 !).
- 缺失的标签 -
- 如果一篇文章有标签但是不全面, 请补全. 比如, 一页JavaScript 的参考文档被(正确) 标签为 "JavaScript" 但是除此之外什么也没有了, 请你就为它标上"参考"的标签! +
- 如果一篇文章有标签但是不全面，请补全。比如，一页 JavaScript 的参考文档被 (正确) 标签为 "JavaScript" 但是除此之外什么也没有了，请你就为它标上"参考"的标签！
- 垃圾标签 -
- 这只潜伏的怪兽是所有标签问题中最让人讨厌的: some Web vermin has deposited its droppings in the page tags (like "Free warez!" or "Hey I was browsing your site and wanted to ask you if you could help me solve this problem I'm having with Flash crashing all the time"). We've got to delete these right away! They're ugly, they're hard to manage if they're allowed to linger too long, and they're terrible for {{Glossary("SEO")}}. +
- 这只潜伏的怪兽是所有标签问题中最让人讨厌的：some Web vermin has deposited its droppings in the page tags (like "Free warez!" or "Hey I was browsing your site and wanted to ask you if you could help me solve this problem I'm having with Flash crashing all the time"). We've got to delete these right away! They're ugly, they're hard to manage if they're allowed to linger too long, and they're terrible for {{Glossary("SEO")}}. -
- 基础知识
- 提供更多一般信息的链接。如：到维基百科的链接是一个很棒的点。
- 技术参考 -
- 链接到更深入的技术信息，在MDN或其他地方。 +
- 链接到更深入的技术信息，在 MDN 或其他地方。
- 学习它
- 链接到教程、练习或任何其他材料，帮助读者学习使用定义术语背后的技术。 @@ -48,7 +48,7 @@
- 该术语的主页面必须是一个包含了
GlossaryDisambiguation宏的消歧页面；
@@ -83,13 +83,13 @@ - 如果一个术语已经链接到MDN的另一部分，这样的情况请不要使用 \{{Glossary}} 宏； -
- 在文章部分（Section）中，对于相同的术语仅使用一次 \{{Glossary}} 宏 （提示：一个部分总是以标题开始的）。 +
- 如果一个术语已经链接到 MDN 的另一部分，这样的情况请不要使用 \{{Glossary}} 宏； +
- 在文章部分（Section）中，对于相同的术语仅使用一次 \{{Glossary}} 宏（提示：一个部分总是以标题开始的）。
- 每个规范在文本中都包含WebIDL：它是一种传达精确定义的非常方便的方法。这些描述了API的语法。虽然是规范参考，但我们必须记住，它们可能与实际实施不同。在MDN上，我们希望实用并记录Web平台的真正含义，而不是理想应该是什么。因此，请仔细检查实现中的内容（如果发现错误，请不要犹豫，立即提交）。 -
- 三个浏览器引擎使用（修改）WebIDL作为其工具链的一部分：Gecko，Chromium / Blink和WebCore / WebKit。Edge在内部使用它，但遗憾的是它们不公开（它会帮助我们很多）。 +
- 每个规范在文本中都包含 WebIDL：它是一种传达精确定义的非常方便的方法。这些描述了 API 的语法。虽然是规范参考，但我们必须记住，它们可能与实际实施不同。在 MDN 上，我们希望实用并记录 Web 平台的真正含义，而不是理想应该是什么。因此，请仔细检查实现中的内容（如果发现错误，请不要犹豫，立即提交）。 +
- 三个浏览器引擎使用（修改）WebIDL 作为其工具链的一部分：Gecko，Chromium / Blink 和 WebCore / WebKit。Edge 在内部使用它，但遗憾的是它们不公开（它会帮助我们很多）。
-
-
- 对于Gecko，所有WebIDL文件都分组在一个目录中：https://dxr.mozilla.org/mozilla-central/source/dom/webidl/ -
- 他们的延伸是
.webidl。*.idlGecko源代码树中还有其他 文件，但它们不是WebIDL，因此您可以忽略它们。旧版本的Gecko有一些WebIDL分散在某些地方，甚至可能使用Mozilla的IDL而不是WebIDL来描述一些Web界面，但这在任何最近的Gecko代码中都不会成为问题。
- - 对于Chromium，它们分散在源代码中，所以你需要多花点功夫：例如http://src.chromium.org/viewvc/blink/trunk/Source/modules/mediastream/MediaStream.idl -
- 同样，WebCore正如预期的那样，因为Chromium是从它分叉出来的，例如https://github.com/WebKit/webkit/blob/master/Source/WebCore/html/DOMTokenList.idl +
- 对于 Gecko，所有 WebIDL 文件都分组在一个目录中：https://dxr.mozilla.org/mozilla-central/source/dom/webidl/ +
- 他们的延伸是
.webidl。*.idlGecko 源代码树中还有其他 文件，但它们不是 WebIDL，因此您可以忽略它们。旧版本的 Gecko 有一些 WebIDL 分散在某些地方，甚至可能使用 Mozilla 的 IDL 而不是 WebIDL 来描述一些 Web 界面，但这在任何最近的 Gecko 代码中都不会成为问题。
+ - 对于 Chromium，它们分散在源代码中，所以你需要多花点功夫：例如http://src.chromium.org/viewvc/blink/trunk/Source/modules/mediastream/MediaStream.idl +
- 同样，WebCore 正如预期的那样，因为 Chromium 是从它分叉出来的，例如https://github.com/WebKit/webkit/blob/master/Source/WebCore/html/DOMTokenList.idl
- 对要修改的内容，你需要对内容涉及到的技术（类似 JavaScript、CSS 等）有一定的了解。 @@ -108,7 +108,7 @@
- 文档的主题（它是讲什么内容的？） @@ -16,18 +16,18 @@
- HTML @@ -39,7 +39,7 @@
- etc.
- Accessibility @@ -50,12 +50,12 @@
- Firefox OS
@@ -86,17 +86,17 @@
Mozilla 产品
- 仅适用于某一非Mozilla浏览器的不开放的Web技术。 -
- 与Web或Mozilla产品无关的技术。 -
- 面向用户的文档；对于Mozilla产品来说，这些文档应属于 Mozilla 技术支持 。 +
- 仅适用于某一非 Mozilla 浏览器的不开放的 Web 技术。 +
- 与 Web 或 Mozilla 产品无关的技术。 +
- 面向用户的文档；对于 Mozilla 产品来说，这些文档应属于 Mozilla 技术支持 。
- JavaScript/手册 - 主目录页 @@ -70,9 +70,9 @@
- 一种情况，然后跟上一个简短的说明。 @@ -586,7 +586,7 @@
-
@@ -622,7 +622,7 @@
Wiki 标记及用法
链接
-链接是 wiki 中最重要的功能元素之一。这里会介绍一些链接的基本内容，在我们的编辑器指南中的在MDN中创建和编辑链接这篇文章中有关于链接的详细介绍。
+链接是 wiki 中最重要的功能元素之一。这里会介绍一些链接的基本内容，在我们的编辑器指南中的在 MDN 中创建和编辑链接这篇文章中有关于链接的详细介绍。
我们鼓励适当的添加一些相关文章的链接，这样可以提高页面导航的效率和内容的易发现性。链接不但可以指向其他 MDN 页面（内部链接），也可以指向其他网站的页面（外部链接）。
@@ -726,7 +726,7 @@创建相关页面的链接列表
-左侧列的顶部是一个
+<h2>标题，用来说明此列的内容是当前主题所包含的文章列表（如”某某的文档和教程“），其下方则是具体的文章列表。该列的标题样式应使用 CSS 类 ”Documentation“，而下方的文章列表是一个<dl>列表，其中的每个<dt>都包含一个文章的链接和位于<dd>中的该目标文章的一两句话的说明。左侧列的顶部是一个
<h2>标题，用来说明此列的内容是当前主题所包含的文章列表（如”某某的文档和教程“），其下方则是具体的文章列表。该列的标题样式应使用 CSS 类”Documentation“，而下方的文章列表是一个<dl>列表，其中的每个<dt>都包含一个文章的链接和位于<dd>中的该目标文章的一两句话的说明。右侧列则包含一或多个小节，各小节按以下顺序排列：
diff --git a/files/zh-cn/mdn/index.html b/files/zh-cn/mdn/index.html index 71a0fea90795c6..d44b7e96c2886f 100644 --- a/files/zh-cn/mdn/index.html +++ b/files/zh-cn/mdn/index.html @@ -12,7 +12,7 @@这是 MDN 项目的着陆页。在这里，您可以找到有关网站如何工作、如何编写文档、遵循哪些准则和惯例以及您如何提供帮助的指南。
-同时，我们邀请任何人来帮忙！如果您有兴趣改进这个重要的 web 开发者资源，欢迎您添加和编辑内容。您不需要是一个程序员或了解很多技术，因为这里有许多不同的从简单的（校对和更正打字错误）到复杂的（编写API文档）任务需要执行。
+同时，我们邀请任何人来帮忙！如果您有兴趣改进这个重要的 web 开发者资源，欢迎您添加和编辑内容。您不需要是一个程序员或了解很多技术，因为这里有许多不同的从简单的（校对和更正打字错误）到复杂的（编写 API 文档）任务需要执行。
如果要了解如何提供帮助，请访问我们的为 MDN 做贡献页面。如果您想与我们交谈并提出问题，请加入Matrix上MDN Web Docs 聊天室进行讨论。
diff --git a/files/zh-cn/mdn/mdn_product_advisory_board/index.html b/files/zh-cn/mdn/mdn_product_advisory_board/index.html index 5407210821a641..28aadd719b6444 100644 --- a/files/zh-cn/mdn/mdn_product_advisory_board/index.html +++ b/files/zh-cn/mdn/mdn_product_advisory_board/index.html @@ -7,11 +7,11 @@ - 产品咨询委员会 translation_of: MDN/MDN_Product_Advisory_Board --- -{{MDNSidebar}}MDN Web Docs是基于wiki技术、也基于开源的Web开发文档平台，是Web开发人员的技术文档的可靠来源，允许几乎任何人编写和编辑内容。
+{{MDNSidebar}}MDN Web Docs 是基于 wiki 技术、也基于开源的 Web 开发文档平台，是 Web 开发人员的技术文档的可靠来源，允许几乎任何人编写和编辑内容。
-Mozilla对MDN产品咨询委员会的愿景是建立协作，帮助MDN社区将MDN作为最全面，完整和值得信赖的参考文献，将文档记录在现代浏览器和Web标准的最重要方面。
+Mozilla 对 MDN 产品咨询委员会的愿景是建立协作，帮助 MDN 社区将 MDN 作为最全面，完整和值得信赖的参考文献，将文档记录在现代浏览器和 Web 标准的最重要方面。
-产品咨询委员会将会从外部领导者提供建议，帮助MDN致力于提供HTML，CSS，JavaScript和Web API的中立、浏览器无关文档，并成为基于标准的Web开发的首要参考。
+产品咨询委员会将会从外部领导者提供建议，帮助 MDN 致力于提供 HTML，CSS，JavaScript 和 Web API 的中立、浏览器无关文档，并成为基于标准的 Web 开发的首要参考。
参见
diff --git a/files/zh-cn/mdn/mdn_product_advisory_board/members/index.html b/files/zh-cn/mdn/mdn_product_advisory_board/members/index.html index ed595cdd727e2b..2e5c2a9c56d630 100644 --- a/files/zh-cn/mdn/mdn_product_advisory_board/members/index.html +++ b/files/zh-cn/mdn/mdn_product_advisory_board/members/index.html @@ -8,7 +8,7 @@ - 会员 translation_of: MDN/MDN_Product_Advisory_Board/Members --- -{{MDNSidebar}}现任MDN产品咨询委员会成员:
+{{MDNSidebar}}现任 MDN 产品咨询委员会成员：
Daniel Appelquist
@@ -47,11 +47,11 @@
Director of Developer Advocacy at Samsung Internet, Co-Chair of W3C's Technical Architecture GroupAli Spivak
-Mozilla开发商生态系统负责人，产品顾问委员会主席。
+Mozilla 开发商生态系统负责人，产品顾问委员会主席。
-
Ali是Mozilla开发商生态系统的负责人，之前在Mozilla负责开发者营销。 她管理MDN超过5年，致力于一个可互操作、跨平台互联网。 在Mozilla之前，她曾经在思科，Edmunds.com和许多创业公司管理Web产品。
+Ali 是 Mozilla 开发商生态系统的负责人，之前在 Mozilla 负责开发者营销。她管理 MDN 超过 5 年，致力于一个可互操作、跨平台互联网。在 Mozilla 之前，她曾经在思科，Edmunds.com 和许多创业公司管理 Web 产品。
Kadir Topal
-Mozilla的MDN Web文档产品经理。
+Mozilla 的 MDN Web 文档产品经理。
diff --git a/files/zh-cn/mdn/structures/compatibility_tables/index.html b/files/zh-cn/mdn/structures/compatibility_tables/index.html index 809ca275bb44da..87a3f1acc0d959 100644 --- a/files/zh-cn/mdn/structures/compatibility_tables/index.html +++ b/files/zh-cn/mdn/structures/compatibility_tables/index.html @@ -10,7 +10,7 @@ ---{{MDNSidebar}}-MDN 为我们的开放网页文档提供了兼容性表格的标准格式; 它是对比所有浏览器之间，包含 DOM，HTML，CSS，JavaScript，SVG 等技术的文档。本文将介绍如何使用我们的功能将兼容性数据添加到MDN页面。
+MDN 为我们的开放网页文档提供了兼容性表格的标准格式; 它是对比所有浏览器之间，包含 DOM，HTML，CSS，JavaScript，SVG 等技术的文档。本文将介绍如何使用我们的功能将兼容性数据添加到 MDN 页面。
重要: 数据的生成方式已经发生了变更。过去，我们的表格直接嵌入在页面中，而且数据是手动填写的。这样效率很低，难以维护，而且使得数据不够灵活，不便更新。所以我们正在把我们的兼容性表格迁移到一个数据 repo 中（https://github.com/mdn/browser-compat-data）并且改为使用程序化的方式生成它。
@@ -19,41 +19,41 @@如何访问 data repo
-数据存储在一个 GitHub repo 中，到 https://github.com/mdn/browser-compat-data 查看。想要访问它，你必须拥有一个 GitHub 账号，fork浏览器兼容数据仓库到你自己的账户，然后克隆你的fork到你的本地机器。
+数据存储在一个 GitHub repo 中，到 https://github.com/mdn/browser-compat-data 查看。想要访问它，你必须拥有一个 GitHub 账号，fork 浏览器兼容数据仓库到你自己的账户，然后克隆你的 fork 到你的本地机器。
选择要贡献的数据类型
-首先，确定一下你想为何种 Web 技术贡献兼容性数据。可以是一个 HTML 元素、CSS 属性、JS 语法或者 JS API 接口。我们鼓励您贡献 API 接口的数据, 因为已经有人在贡献 HTML、JS 和 CSS 的数据了。你可以在表格 Browser Compat Data migration 中查看各个需要添加兼容性数据的 Web 技术的数据状态。
+首先，确定一下你想为何种 Web 技术贡献兼容性数据。可以是一个 HTML 元素、CSS 属性、JS 语法或者 JS API 接口。我们鼓励您贡献 API 接口的数据，因为已经有人在贡献 HTML、JS 和 CSS 的数据了。你可以在表格 Browser Compat Data migration 中查看各个需要添加兼容性数据的 Web 技术的数据状态。
-电子表格的使用步骤如下:
+电子表格的使用步骤如下：
-
-
- 直接挑选一个还未开始或者还未完成数据录入的功能点，在“Who”一栏中填入你的名字, 最好能够和你的MDN用户名保持一致，以便我们在需要联系你的时候能够查找到你的邮件地址. -
- 如果该功能点不在表格上，那么你可以参照现有的格式在合适的位置上加一行。注意要使用同等的粒度（例如，HTML以标签元素为单位、CSS以选择器或者属性值为单位、JS以对象为单位、JS API以特定的接口为单位） +
- 直接挑选一个还未开始或者还未完成数据录入的功能点，在“Who”一栏中填入你的名字，最好能够和你的 MDN 用户名保持一致，以便我们在需要联系你的时候能够查找到你的邮件地址。 +
- 如果该功能点不在表格上，那么你可以参照现有的格式在合适的位置上加一行。注意要使用同等的粒度（例如，HTML 以标签元素为单位、CSS 以选择器或者属性值为单位、JS 以对象为单位、JS API 以特定的接口为单位）
- 当你已经开始录入数据的时候，把对应状态栏的下拉选项置于“In progress”（进行中）状态。
- 一旦添加完数据，并且向主仓库提交了一个拉取请求（pull request），那么把对应状态栏的下拉选项置于“PR done”状态。 -
- 当你的数据已经成功合并到主分支，或者已经添加到npm包里面的时候，请尽量更新对应的状态栏到相应的状态。 +
- 当你的数据已经成功合并到主分支，或者已经添加到 npm 包里面的时候，请尽量更新对应的状态栏到相应的状态。
- 当你更新了你的功能文档页面，并且使用新的脚步命令使其可以在每一个页面都可以动态的生成合适的数据表格的时候，你就需要在电子表格中修改对应功能的状态为“Article updated”（文章已更新）。这意味着你已经完成了这一功能的所有数据录入工作。
准备添加数据
-在添加新数据之前，你应该保证您的 fork 是主 repo 的最新版本（它们应包含相同的内容）。在您的 fork 里添加一个包含您的更改的分支，然后把它pull到您本地的仓库，这样你就可以开始贡献了：
+在添加新数据之前，你应该保证您的 fork 是主 repo 的最新版本（它们应包含相同的内容）。在您的 fork 里添加一个包含您的更改的分支，然后把它 pull 到您本地的仓库，这样你就可以开始贡献了：
下面是更新您的分支的一个简单方法：
将浏览器兼容信息的主 repo 添加到远端服务器列表中
-在您的终端或命令行中进入您的fork的本地仓库，用以下命令将（服务器上的）主 repo 添加到远端服务器列表中（您只需执行以下命令一次）：
+在您的终端或命令行中进入您的 fork 的本地仓库，用以下命令将（服务器上的）主 repo 添加到远端服务器列表中（您只需执行以下命令一次）：
git remote add upstream https://github.com/mdn/browser-compat-data.git
-如果您不确定自己是否做到了这一点， 您可以检查您仓库已经在用的远端服务器列表：
+如果您不确定自己是否做到了这一点，您可以检查您仓库已经在用的远端服务器列表：
git remote -v
@@ -73,7 +73,7 @@让您的分支与服务
git fetch upstream
- -
@@ -86,7 +86,7 @@用rebase将主仓库的内容合并到您的master分支中：
+用 rebase 将主仓库的内容合并到您的 master 分支中：
git rebase upstream/master
让您的分支与服务
创建您用来工作的分支：
-接下来，打开您在服务器上的fork（它的地址可能是
+https://github.com/your-username/browser-compat-data）并且创建一个新分支来存储您的改动。步骤如下：接下来，打开您在服务器上的 fork（它的地址可能是
https://github.com/your-username/browser-compat-data）并且创建一个新分支来存储您的改动。步骤如下：- 点击"Branch: Master"按钮； @@ -94,11 +94,11 @@
创建您用来工作的分支：
点击下方出现的"Create branch name-of-branch from Master"按钮。举个例子，如果您想补充WebVR API的信息，您可以创建一个名为“webvr”的分支.
+举个例子，如果您想补充 WebVR API 的信息，您可以创建一个名为“webvr”的分支。
切换到新分支
-此时，回到您的终端或命令行，用以下命令将您的新分支同步到您本地的fork中：
+此时，回到您的终端或命令行，用以下命令将您的新分支同步到您本地的 fork 中：
git pull
@@ -113,21 +113,21 @@添加数据
为添加新的数据，您需要新建文件以存储您的兼容性数据。对于不同技术的数据，您需要创建的文件也有所不同：
-
-
- HTML：被包含在 browser-compat-data/html/elements 中，每个HTML元素对应一个文件。文件需要以元素的小写的名称命名，例如
div.json。
- - CSS：每个CSS属性或选择器对应一个文件。它们被包含在对应的目录中（请参考 browser-compat-data/css）。文件需要以CSS特性的小写的名称命名，如
background-color.json或者hover.json。
- - JS：被包含在 browser-compat-data/javascript/builtins 中，每个JavaScript对象对应一个文件。文件要以JavaScript对象的准确名称命名，保留其大小写，如
Date.json或InternalError.json。
- - API：API中的每个接口对应一个文件。它们在 browser-compat-data/api 中。每个文件要以接口的准确名称命名，保留其大小写，例如WebVR API的文件为
VRDisplay.json，VRDisplayCapabilities.json，等等。
+ - HTML：被包含在 browser-compat-data/html/elements 中，每个 HTML 元素对应一个文件。文件需要以元素的小写的名称命名，例如
div.json。
+ - CSS：每个 CSS 属性或选择器对应一个文件。它们被包含在对应的目录中（请参考 browser-compat-data/css）。文件需要以 CSS 特性的小写的名称命名，如
background-color.json或者hover.json。
+ - JS：被包含在 browser-compat-data/javascript/builtins 中，每个 JavaScript 对象对应一个文件。文件要以 JavaScript 对象的准确名称命名，保留其大小写，如
Date.json或InternalError.json。
+ - API：API 中的每个接口对应一个文件。它们在 browser-compat-data/api 中。每个文件要以接口的准确名称命名，保留其大小写，例如 WebVR API 的文件为
VRDisplay.json，VRDisplayCapabilities.json，等等。
-注意：您会留意到，该仓库还包含了浏览器拓展和HTTP的数据。These data sets are basically finished as they stand, but more features may need to be added in the future.
你创建的每个文件都需要跟随定义在我们repo的schema中的这些模板的规定。你可以参考详细的模板描述。
+你创建的每个文件都需要跟随定义在我们 repo 的 schema 中的这些模板的规定。你可以参考详细的模板描述。
基本的兼容性数据的结构
-让我们来看一下如下例子。一个CSS属性JSON文件需要以下的结构：
+让我们来看一下如下例子。一个 CSS 属性 JSON 文件需要以下的结构：
{ "css": { @@ -143,25 +143,25 @@基本的兼容性数据的结构
首先有一个css对象，其中包含了一个properties对象。每个您要设定兼容性数据的特性都对应一个properties对象中的成员。而每一个这些成员都有一个__compat成员，__compat成员中则是实际的数据。 -以上的数据能在 browser-width.json 文件中找到——可将这与 MDN上渲染后的浏览器兼容性 相比较。
+以上的数据能在 browser-width.json 文件中找到——可将这与 MDN 上渲染后的浏览器兼容性 相比较。
对于其他类型特性，写法是类似的，但对象的名称不同：
-
-
- 对于CSS选择器，它与CSS属性的写法基本相同，不同之处在于顶级对象结构是是
css.selectors而不是css.properties. 请以 cue.json 作为参考示例。
- - 对于HTML数据，它的写法基本相同，不同之处在于顶级对象结构是
html.elements。请以article.json作为参考示例。
- - JS内置对象对应的顶级结构是
javascript.builtins；请以 Array.json 作为参考示例。
+ - 对于 CSS 选择器，它与 CSS 属性的写法基本相同，不同之处在于顶级对象结构是是
css.selectors而不是css.properties. 请以 cue.json 作为参考示例。
+ - 对于 HTML 数据，它的写法基本相同，不同之处在于顶级对象结构是
html.elements。请以article.json作为参考示例。
+ - JS 内置对象对应的顶级结构是
javascript.builtins；请以 Array.json 作为参考示例。
-在一个HTML、CSS和JS页面中，通常您只需要有一个特性。API则有些不同——它们总是包含多个子特性 （参见下边的 子特性）。
+在一个 HTML、CSS 和 JS 页面中，通常您只需要有一个特性。API 则有些不同——它们总是包含多个子特性（参见下边的 子特性）。
一个特性中的基础结构
在一个特性的
__compat成员中，您需要包含以下成员：-
-
mdn_url: MDN上这个特性的页面的URL。注意，这个URL不可以带上本地化文件夹名称，例如：是/docs/...而不是/docs/en-US/...（或者其他）。本地化文件夹名称会在页面加载时被添加。
+ mdn_url: MDN 上这个特性的页面的 URL。注意，这个 URL 不可以带上本地化文件夹名称，例如：是/docs/...而不是/docs/en-US/...（或者其他）。本地化文件夹名称会在页面加载时被添加。support: 所有不同浏览器对这个特性的浏览器支持的信息。status: Contains members reporting the standards track status of this feature.
一个特性中的基础结构
-
"experimental": 如果这个特性是试验性的，取值为true，否则为false。
- "standard_track": 如果这个特性是个在某些规范里的标准的属性（最常见的是W3C/WHATWG，但有其他规范如Khronos或TC39等），取值为true，否则为false。
+ "standard_track": 如果这个特性是个在某些规范里的标准的属性（最常见的是 W3C/WHATWG，但有其他规范如 Khronos 或 TC39 等），取值为true，否则为false。"deprecated": 如果这个特性已经过时，取值为true，否则为false。
Including a footnote
包含浏览器厂商的前缀
-If a feature is supported behind a vendor prefix in one or more browsers, you'll want to make that clear in the browser compat data. 例如您可能有一个特性在Firefox浏览器中要用
+-moz-前缀才被支持，要在兼容性数据中指明这一点，您需在对应的"firefox"子成员中增加一个"prefix"子成员。它看起来是这样的：If a feature is supported behind a vendor prefix in one or more browsers, you'll want to make that clear in the browser compat data. 例如您可能有一个特性在 Firefox 浏览器中要用
-moz-前缀才被支持，要在兼容性数据中指明这一点，您需在对应的"firefox"子成员中增加一个"prefix"子成员。它看起来是这样的："firefox": { "version_added": true, @@ -457,7 +457,7 @@将变更推送回主仓库
在您添加完您的兼容性数据之后，您应该先用以下命令测试一下：
-
-
npm run lint— 测试所有兼容性数据以确保JSON的格式和书写风格正确，例如正确的缩进和没有遗漏逗号等等。该命令会打印出一个很长的文件名和测试结果的列表；if an error is found, the linter will throw an error on the file it is found in, giving you useful debugging info like line number, error message, etc.
+ npm run lint— 测试所有兼容性数据以确保 JSON 的格式和书写风格正确，例如正确的缩进和没有遗漏逗号等等。该命令会打印出一个很长的文件名和测试结果的列表；if an error is found, the linter will throw an error on the file it is found in, giving you useful debugging info like line number, error message, etc.npm run show-errors— validates the JSON against the data schema, and highlights errors such as invalid browser version numbers being used.npm run render 'dotted.path.to.feature'— allows you to preview the markup for the compat table for a data file in the repo. As an example,npm run render 'css.properties.background'shows the table markup for the {{cssxref("background")}} property.
将变更推送回主仓库
At this point, you just need to wait. A reviewer will review your pull request, and merge it with the main repo, OR request that you make changes. If changes are needed, make the changes and submit again until the PR is accepted.
-将数据插入MDN页
+将数据插入 MDN 页
Once your new data has been included in the main repo, you can start dynamically generating browser compat tables based on that data on MDN pages using the \{{Compat}} macro. This takes a single parameter, the dot notation required to walk down the JSON data and find the object representing the feature you want to generate the compat table for.
@@ -489,5 +489,5 @@将数据插入MDN页
{{Compat("api.VRDisplay.capabilities")}}
-diff --git a/files/zh-cn/mdn/structures/index.html b/files/zh-cn/mdn/structures/index.html index 49d7410a404a1a..c1bd6321660ac3 100644 --- a/files/zh-cn/mdn/structures/index.html +++ b/files/zh-cn/mdn/structures/index.html @@ -11,6 +11,6 @@ ---注意: 文件名通常与给予JSON结构内的接口的标签相匹配，但事实并非总是如此。 当宏调用生成表时，他们遍历所有文件，直到找到相关的JSON使用，所以文件名不是关键。 说到这一点，你应该始终尽可能直观地命名它们。
+注意: 文件名通常与给予 JSON 结构内的接口的标签相匹配，但事实并非总是如此。当宏调用生成表时，他们遍历所有文件，直到找到相关的 JSON 使用，所以文件名不是关键。说到这一点，你应该始终尽可能直观地命名它们。
{{MDNSidebar}}-在MDN里有各式各样的重复使用的文档结构，来使MDN文章中的内容有一致性的表现。这里的文章描述了这些结构。因此作为一名MDN的作者，你可以确认、应用并修改成适合于你写、编辑或翻译的文档。
+在 MDN 里有各式各样的重复使用的文档结构，来使 MDN 文章中的内容有一致性的表现。这里的文章描述了这些结构。因此作为一名 MDN 的作者，你可以确认、应用并修改成适合于你写、编辑或翻译的文档。
{{LandingPageListSubPages()}}
diff --git a/files/zh-cn/mdn/structures/live_samples/index.md b/files/zh-cn/mdn/structures/live_samples/index.md index 14e473a12d0a6c..4d69c7eb15cdd0 100644 --- a/files/zh-cn/mdn/structures/live_samples/index.md +++ b/files/zh-cn/mdn/structures/live_samples/index.md @@ -26,7 +26,7 @@ MDN 支持将文章中的示例代码转化为读者可以实际查看的运行 宏使用一个特殊的 URL 来取得一个分组中的代码示例，例如：`https://yari-demos.prod.mdn.mozit.cloud/en-US/docs/Web/CSS/animation/_sample_.Cylon_Eye.html`。总体结构是 `https://url-of-page/_sample_.group-id.html`，`group-id` 指代码所在标题或者块级元素的 id。 -用来展示运行结果的框架(或页面)会运行在沙盒中，在安全条件下实现任何想在网络上实现的功能。当然，在实践中，代码需要针对于包含它的页面，MDN 上运行的随意的内容会被社区编辑移除。 +用来展示运行结果的框架 (或页面) 会运行在沙盒中，在安全条件下实现任何想在网络上实现的功能。当然，在实践中，代码需要针对于包含它的页面，MDN 上运行的随意的内容会被社区编辑移除。 > **备注：** **必须**使用宏来展示运行实例的输出。 @@ -147,7 +147,7 @@ el.onclick = function() { {{EmbedLiveSample('运行实例演示')}} -这是使用外链宏 `\{{LiveSampleLink('运行实例演示', '运行实例演示链接')}}` 来展示实例运行的结果: +这是使用外链宏 `\{{LiveSampleLink('运行实例演示', '运行实例演示链接')}}` 来展示实例运行的结果： {{LiveSampleLink('运行实例演示', '运行实例演示链接')}} @@ -156,6 +156,6 @@ el.onclick = function() { - 代码块顺序 - : 添加运行实例时，应对代码块进行排序，以便使第一个代码块对应该示例的主要语言（如果有的话）。例如，在 HTML 参考中添加运行实例时，第一个代码块应该是 HTML；在 CSS 参考中添加时，第一个代码块则应该是 CSS；以此类推。 - 标题命名 - - : 在没有歧义的情况下（如，例子位于“示例”部分中），标题应该简明扼要，仅使用相应语言的名称：HTML、CSS、CSS、JavasScript、SVG等（见上文）。不应使用如“HTML 内容”或“JavaScript 内容”等标题。但是，如果这样的短标题无法明确内容，可以使用更具体的标题。 + - : 在没有歧义的情况下（如，例子位于“示例”部分中），标题应该简明扼要，仅使用相应语言的名称：HTML、CSS、CSS、JavasScript、SVG 等（见上文）。不应使用如“HTML 内容”或“JavaScript 内容”等标题。但是，如果这样的短标题无法明确内容，可以使用更具体的标题。 - 使用“结果”块 - : 在不同的代码块之后，请在最后调用 `EmbedLiveSample` 宏之前使用“结果”块（见上文）。这样，示例的语义对于阅读器或其它解析页面的工具（如：屏幕阅读器、网络爬虫）都会变得更加清晰。 diff --git a/files/zh-cn/mdn/structures/macros/commonly-used_macros/index.md b/files/zh-cn/mdn/structures/macros/commonly-used_macros/index.md index e2a8321a75b962..f5e31e46fcbd9c 100644 --- a/files/zh-cn/mdn/structures/macros/commonly-used_macros/index.md +++ b/files/zh-cn/mdn/structures/macros/commonly-used_macros/index.md @@ -163,7 +163,7 @@ original_slug: MDN/Structures/Macros/Custom_macros [`optional_inline`](https://github.com/mdn/yari/blob/main/kumascript/macros/optional_inline.ejs) 和 [`ReadOnlyInline`](https://github.com/mdn/yari/blob/main/kumascript/macros/ReadOnlyInline.ejs) 被用于 API 文档，通常可以用来描述一个对象的属性是只读的或一个函数的参数是可省略的。 -用法: `\{{optional_inline}}` 或 `\{{ReadOnlyInline}}`。示例： +用法：`\{{optional_inline}}` 或 `\{{ReadOnlyInline}}`。示例： - `isCustomObject` {{ReadOnlyInline}} - 如果此项值为 `true`，表明该对象是一个自定义对象。 diff --git a/files/zh-cn/mdn/structures/macros/index.html b/files/zh-cn/mdn/structures/macros/index.html index b0bde78f69d9a0..ed94d97c71e8fd 100644 --- a/files/zh-cn/mdn/structures/macros/index.html +++ b/files/zh-cn/mdn/structures/macros/index.html @@ -31,7 +31,7 @@在文章中使用宏
- 宏的名称区分大小写，但一些常见的大小写错误也可以在执行时被纠正。比如将某个名称中含有大写的宏，全部使用小写字母，或者将某些名字以小写开头的宏大写。
- 参数以逗号分隔。
- 如果没有参数，括号可以省略：
-\{{macroname()}}和\{{macroname}}的作用是相同的。- 数字参数是否放在引号中，一般没有区别。但是，像版本号（如1.2.3）这类可能被识别成小数的参数，则需包含在引号中。
+- 数字参数是否放在引号中，一般没有区别。但是，像版本号（如 1.2.3）这类可能被识别成小数的参数，则需包含在引号中。
- 如果遇到错误，请先仔细检查代码。如果仍然无法弄清楚发生了什么，请参阅排查 KumaScript 中的错误以获取帮助。
标签类型指南
文档类别
-当你使用这些类别中的一个来标记文章的时候, 你帮助了自动化工具更准确的生成着陆页面，内容表，和更多。我们新的搜索系统也可以使用这些来让我们的游客更好的根据他们的意愿来定位参考和指南。
+当你使用这些类别中的一个来标记文章的时候，你帮助了自动化工具更准确的生成着陆页面，内容表，和更多。我们新的搜索系统也可以使用这些来让我们的游客更好的根据他们的意愿来定位参考和指南。
文档类别
主题
虽然在这里有一些灵活的空间可以识别新的主题领域，但我们试着将自己限制在API和技术的名字上，一些有用的例子：
+虽然在这里有一些灵活的空间可以识别新的主题领域，但我们试着将自己限制在 API 和技术的名字上，一些有用的例子：
主题
一般而言，您的主题标识标签应该是一个接口的名称，和相关的页面（如Node，它的各种属性和方法有很多页），或一个整体的技术类型的名称。你可以对图形、WebGL和WebGL设置页面标签，而不仅是一个关于{{HTMLElement("canvas")}} 与HTML、元素，Canvas，和图形。
+一般而言，您的主题标识标签应该是一个接口的名称，和相关的页面（如Node，它的各种属性和方法有很多页），或一个整体的技术类型的名称。你可以对图形、WebGL 和 WebGL 设置页面标签，而不仅是一个关于{{HTMLElement("canvas")}} 与 HTML、元素，Canvas，和图形。
Mozilla 特定内容
-这些标签只用于Mozilla特定内容:
+这些标签只用于 Mozilla 特定内容：
Mozilla 特
API 标识
-
在API引用中, 每篇文章都应该标明它覆盖了哪部分API:
+在 API 引用中，每篇文章都应该标明它覆盖了哪部分 API:
API 标识
技术状况
技术状况
技术状况
技术状况
技术状况
这些标签没有理由离开你文章中的 兼容性表 ！
@@ -293,7 +293,7 @@文档元数据
Web Literacy Map
Web Literacy Map
把它们放到一起
@@ -522,15 +522,15 @@你可以修改的标签的错误
如果你发现了以上问题, 请登录MDN点击MDN窗口右上方的 EDIT按钮. 等编辑器载入完成后, 到页面底部, 你就会看到标签. 想了解标签操作界面的更多信息, 请参看 "The tags box" in the MDN editor guide.
+如果你发现了以上问题， 请登录 MDN点击 MDN 窗口右上方的 EDIT 按钮。等编辑器载入完成后，到页面底部，你就会看到标签。想了解标签操作界面的更多信息，请参看 "The tags box" in the MDN editor guide.
diff --git a/files/zh-cn/mdn/contribute/howto/write_a_new_entry_in_the_glossary/index.html b/files/zh-cn/mdn/contribute/howto/write_a_new_entry_in_the_glossary/index.html index 8a89ca2042956d..db7d2de15abdea 100644 --- a/files/zh-cn/mdn/contribute/howto/write_a_new_entry_in_the_glossary/index.html +++ b/files/zh-cn/mdn/contribute/howto/write_a_new_entry_in_the_glossary/index.html @@ -5,7 +5,7 @@ ---MDN 术语表 是一个定义所有被用于文档和编码的术语、行话和缩写的地方。对词汇表做出贡献是使Web更易于理解的简单方法。您不需要高水平的技术技能来编写词汇表条目，因为它们应该保持简单直接。
+MDN 术语表 是一个定义所有被用于文档和编码的术语、行话和缩写的地方。对词汇表做出贡献是使 Web 更易于理解的简单方法。您不需要高水平的技术技能来编写词汇表条目，因为它们应该保持简单直接。
如何写一个条目
@@ -15,19 +15,19 @@如何写一个条目
-第一步: 写概要
+第一步：写概要
-任何词汇表页面的第一段是对该术语的简单和简短描述（最好不超过两个句子）。 确保阅读说明的人能够立即了解定义的术语。
+任何词汇表页面的第一段是对该术语的简单和简短描述（最好不超过两个句子）。确保阅读说明的人能够立即了解定义的术语。
注意: 请不要直接从其他地方复制和粘贴定义（尤其是维基百科，因为许可证版本范围较小，因此与MDN不兼容）。确保条目内容简单易懂是很重要的。值得花一些时间来撰写定义，而不是简单盲目地窃取其他地方的内容。 这个词汇表应该是有用的新内容，而不是和别处重复的。
+注意： 请不要直接从其他地方复制和粘贴定义（尤其是维基百科，因为许可证版本范围较小，因此与 MDN 不兼容）。确保条目内容简单易懂是很重要的。值得花一些时间来撰写定义，而不是简单盲目地窃取其他地方的内容。这个词汇表应该是有用的新内容，而不是和别处重复的。
使用“链接到词汇表条目”工具可以方便读者直接看到词汇条目中的定义，不需要读者跳转到词汇条目的页面。（更多内容请浏览如何使用 \{{Glossary}} 宏插入词汇表条目的链接。）
如果需要的话，你可以添加少量额外的段落，但是这很容易导致你写了一整篇文章的情况发生。写一个完整的文章很棒，但是请不要把它们整个放在词汇表中。如果你不确定这里是否适合放你的文章，你就要随时在这里讨论。
-第二步: 扩展链接
+第二步：扩展链接
最后，一个词汇表的条目应该总是有“了解更多”这个部分。这个部分应该包含帮助读者看得更深入的链接：探索发现更多细节、学习使用相关技术等。
@@ -37,7 +37,7 @@第二步: 扩展链接
小建议
消除歧义
-有时，根据上下文，术语有几个含义。 要解决歧义，您必须遵循以下准则：
+有时，根据上下文，术语有几个含义。要解决歧义，您必须遵循以下准则：
如何使用 \{{Glossary}} 宏
1 作为可选的第三个参数，将链接显示为常规链接，而不是单纯的提示文本的样式如何使用 \{{Glossary}} 宏
使用方针
-在许多情况下，在MDN上的任何地方使用该宏是非常安全的。 但是，您应该谨慎处理的几种情况：
+在许多情况下，在 MDN 上的任何地方使用该宏是非常安全的。但是，您应该谨慎处理的几种情况：
-
-
{{MDNSidebar}}
-在编写有关API的文档时，信息来源很多：规范描述了应该实现的内容以及模型，实现描述了实际放在浏览器中的内容。WebIDL文件是一种非常简洁的方式，可以提供很多（但不是全部）有关API的信息。本文档提供了有助于理解WebIDL语法的参考。
+在编写有关 API 的文档时，信息来源很多：规范描述了应该实现的内容以及模型，实现描述了实际放在浏览器中的内容。WebIDL 文件是一种非常简洁的方式，可以提供很多（但不是全部）有关 API 的信息。本文档提供了有助于理解 WebIDL 语法的参考。
-IDL代表接口定义语言，它用于描述API。在更广泛的计算领域，有几种IDL。在浏览器领域，我们使用的IDL称为WebIDL。有两种WebIDL可用：WebIDL规范中给出的一种，以及在浏览器中实现的一种。规范是规范引用，浏览器WebIDL描述了在特定浏览器中实际实现的内容，并包含其他内容，例如注释和有关非标准元素的信息。
+IDL 代表接口定义语言，它用于描述 API。在更广泛的计算领域，有几种 IDL。在浏览器领域，我们使用的 IDL 称为WebIDL。有两种 WebIDL 可用：WebIDL 规范中给出的一种，以及在浏览器中实现的一种。规范是规范引用，浏览器 WebIDL 描述了在特定浏览器中实际实现的内容，并包含其他内容，例如注释和有关非标准元素的信息。
-
在哪里可以找到WebIDL文件
+在哪里可以找到 WebIDL 文件
-WebIDL可以在多个位置找到：
+WebIDL 可以在多个位置找到：
-
-
本指南涵盖了我们对内容的基础要求、推荐和实践参考，以确保搜索引擎可以更好的对我们的内容进行分类和索引，同时确保用户可以轻松地获取到所需的内容。
简介
-MDN写作的首要目标是向开发者们阐明和指导开放的Web技术，以便他们能够快速找到他们想要的东西，或者为了优化自己的代码而寻找需要的细节，因此我们在MDN提供的内容可以被更容易的搜索到就非常重要了。
+MDN 写作的首要目标是向开发者们阐明和指导开放的 Web 技术，以便他们能够快速找到他们想要的东西，或者为了优化自己的代码而寻找需要的细节，因此我们在 MDN 提供的内容可以被更容易的搜索到就非常重要了。
-由于绝大部分读者是通过搜索引擎搜索找到MDN的内容的，那么作为作者，我们就要始终记得内容对搜索引擎的友好程度这件事。为了对搜索引擎友好，我们撰写了SEO指引的内容以帮助MDN的作者和编辑们能够确保MDN上的每篇内容的设计、撰写和标记方式都符合SEO规范，以获得搜索引擎更好的收录索引和展现。
+由于绝大部分读者是通过搜索引擎搜索找到 MDN 的内容的，那么作为作者，我们就要始终记得内容对搜索引擎的友好程度这件事。为了对搜索引擎友好，我们撰写了 SEO 指引的内容以帮助 MDN 的作者和编辑们能够确保 MDN 上的每篇内容的设计、撰写和标记方式都符合 SEO 规范，以获得搜索引擎更好的收录索引和展现。
本文档的状态
-目前我们刚开始了改进MDN文档在搜索引擎优化({{Glossary("SEO")}}) 的长期项目的初期阶段。 我们最近完成了一系列小规模实验来测试能提升SEO的方法，并确定哪些内容能够作为SEO指南提供给我们的贡献者们。
+目前我们刚开始了改进 MDN 文档在搜索引擎优化 ({{Glossary("SEO")}}) 的长期项目的初期阶段。我们最近完成了一系列小规模实验来测试能提升 SEO 的方法，并确定哪些内容能够作为 SEO 指南提供给我们的贡献者们。
我们仍在编辑并更新本文，同时将其他贡献者提供的参考纳入到我们的发现中。
diff --git a/files/zh-cn/mdn/contribute/index.html b/files/zh-cn/mdn/contribute/index.html index db1164311cd33d..349e9e8e0fe5ad 100644 --- a/files/zh-cn/mdn/contribute/index.html +++ b/files/zh-cn/mdn/contribute/index.html @@ -49,7 +49,7 @@需要优先解决的任务
其他类型的任务
注意：如果你在使用 MDN 时发现了一些错误，却不知道怎么改正，你可以提交一个 issue。记得写个合适的标题（你可以在 issue 列表里参考一下别人的格式），并简单描述一下问题的位置和涉及到的内容，这样可以方便别人确定问题到底出在哪。如果你发现的问题属于翻译上的错误，向 Translated-content Repo提交一个 issue 会更加合适。
+注意：如果你在使用 MDN 时发现了一些错误，却不知道怎么改正，你可以提交一个 issue。记得写个合适的标题（你可以在 issue 列表里参考一下别人的格式），并简单描述一下问题的位置和涉及到的内容，这样可以方便别人确定问题到底出在哪。如果你发现的问题属于翻译上的错误，向 Translated-content Repo 提交一个 issue 会更加合适。
相关链接
diff --git a/files/zh-cn/mdn/contribute/localize/index.md b/files/zh-cn/mdn/contribute/localize/index.md index 5fc39ee0d2806b..fdc4fd8492ca16 100644 --- a/files/zh-cn/mdn/contribute/localize/index.md +++ b/files/zh-cn/mdn/contribute/localize/index.md @@ -8,13 +8,13 @@ tags: --- {{MDNSidebar}} -2020年12月14日开始，MDN 将运行在基于 Github 的 [Yari 平台](https://github.com/mdn/yari)上。新的平台也使 MDN 在许多方面发生了改变，这些变化基本上都对我们的工作有不同程度的改进，不过，在内容本地化的工作方面，变化可能看起来会更激进一些。许多的英语区域外的内容本地化工作被中止了，其中的内容长久未更新或活跃人数太少都是可能的原因。在将来，我们希望有更好的机制，来管理这些内容的本地化工作。 +2020 年 12 月 14 日开始，MDN 将运行在基于 Github 的 [Yari 平台](https://github.com/mdn/yari)上。新的平台也使 MDN 在许多方面发生了改变，这些变化基本上都对我们的工作有不同程度的改进，不过，在内容本地化的工作方面，变化可能看起来会更激进一些。许多的英语区域外的内容本地化工作被中止了，其中的内容长久未更新或活跃人数太少都是可能的原因。在将来，我们希望有更好的机制，来管理这些内容的本地化工作。 除了下面列出的地区，所有区域的内容本地化工作都被冻结了，也就意味着这些内容暂时不会开放编辑。所有可接受本地化编辑的内容，都由各自对应的志愿者小组负责管理。 ## 活跃语言 -> **备注：** 如果你有意向加入某语言的内容本地化工作，请联系下面这些小组中的成员，也可[尝试寻求帮助](/zh-CN/docs/MDN/Contribute/Getting_started#step_4_ask_for_help)。语言名称后的标识与 [Translated-content Repo](https://github.com/mdn/translated-content) 目录是对应的。 +> **备注：** 如果你有意向加入某语言的内容本地化工作，请联系下面这些小组中的成员，也可 [尝试寻求帮助](/zh-CN/docs/MDN/Contribute/Getting_started#step_4_ask_for_help)。语言名称后的标识与 [Translated-content Repo](https://github.com/mdn/translated-content) 目录是对应的。 ### 巴西葡萄牙语（pt-BR） @@ -51,7 +51,7 @@ tags: - 讨论组：[Matrix (#mdn-l10n-es channel)](https://chat.mozilla.org/#/room/#mdn-l10n-es:mozilla.org) - 目前的志愿者：[@JuanVqz](https://github.com/JuanVqz)、[@dacalderonp](https://github.com/dacalderonp)、[@lasr21](https://github.com/lasr21)、[@tuxxy](https://github.com/tuxxy) -> **备注：** 如果你想解冻某个语言的内容本地化工作，请先了解[解冻所需要的准备工作](https://github.com/mdn/translated-content/blob/main/PEERS_GUIDELINES.md#activating-a-locale)。 +> **备注：** 如果你想解冻某个语言的内容本地化工作，请先了解 [解冻所需要的准备工作](https://github.com/mdn/translated-content/blob/main/PEERS_GUIDELINES.md#activating-a-locale)。 ## 参见 diff --git a/files/zh-cn/mdn/contribute/markdown_in_mdn/index.md b/files/zh-cn/mdn/contribute/markdown_in_mdn/index.md index 9b84a864e5e0f6..90cb72eedd4925 100644 --- a/files/zh-cn/mdn/contribute/markdown_in_mdn/index.md +++ b/files/zh-cn/mdn/contribute/markdown_in_mdn/index.md @@ -351,7 +351,7 @@ const greeting = "I'm a bad example"; 在 GFM（而不是 CommonMark）中，有一个关于表格的语法：如果你正准备记录什么信息，你可能想知道是否要将这些信息放入MDN。 更进一步地，你可能想在你的源代码中维护文档，并将文档写入Mozilla wiki，或者写入某Git仓库的readme文件中。 本文的目的是帮助你确认你的内容是否适合MDN。
+如果你正准备记录什么信息，你可能想知道是否要将这些信息放入 MDN。更进一步地，你可能想在你的源代码中维护文档，并将文档写入Mozilla wiki，或者写入某 Git 仓库的 readme 文件中。 本文的目的是帮助你确认你的内容是否适合 MDN。
-文档是否应放入MDN主要取决于两点：
+文档是否应放入 MDN 主要取决于两点：
注意Mozilla的 Websites & Communications Terms of Use 所声明的条例在你使用MDN或对其做贡献时是生效的。检查这个文档，确保你知道在Mozilla的网站上什么是能发表的，什么是不能发表的。
+注意 Mozilla 的 Websites & Communications Terms of Use 所声明的条例在你使用 MDN 或对其做贡献时是生效的。检查这个文档，确保你知道在 Mozilla 的网站上什么是能发表的，什么是不能发表的。
哪些话题在MDN的范畴内？
+哪些话题在 MDN 的范畴内？
-MDN涉及了惊人的各种材料。总的来说，如果它是开放的面向Web的技术，或者是Mozilla的产品，我们就把它收录到MDN。但也有一小部分东西完全不属于MDN。这一节会告诉你如何确认你的文档是否属于MDN。
+MDN 涉及了惊人的各种材料。总的来说，如果它是开放的面向 Web 的技术，或者是 Mozilla 的产品，我们就把它收录到 MDN。但也有一小部分东西完全不属于 MDN。这一节会告诉你如何确认你的文档是否属于 MDN。
这里有一些我们涉及的事物；虽然这不是一个完整的列表，但是可以给你一个大致的印象。
-开放的Web标准与技术
+开放的 Web 标准与技术
-现在Web标准文档中受关注的是那些可以被Web开发者用于创建网站与App这些大众应用的功能。这指的是那些被众多浏览器所实现，要么是被标准接受，要么是正在向标准化发展的技术。即主要关注前端Web技术。后端的技术常常在别处有它们自己的文档，MDN不会去尝试取代它们。
+现在 Web 标准文档中受关注的是那些可以被 Web 开发者用于创建网站与 App 这些大众应用的功能。这指的是那些被众多浏览器所实现，要么是被标准接受，要么是正在向标准化发展的技术。即主要关注前端 Web 技术。后端的技术常常在别处有它们自己的文档，MDN 不会去尝试取代它们。
开放的Web标准与技术
同时欢迎关注与Web开发有关的交互技术话题，比如：
+同时欢迎关注与 Web 开发有关的交互技术话题，比如：
开放的Web标准与技术
注意： MDN 涉及了非Mozilla但对Web开放的技术；举个例子，我们有关于WebKit格式的CSS属性的文档。
+注意： MDN 涉及了非 Mozilla 但对 Web 开放的技术；举个例子，我们有关于 WebKit 格式的 CSS 属性的文档。
Mozilla 产品
-这个分类的文档包括如何作为开发者使用Mozilla的产品，以及如何向这些开源项目贡献。
+这个分类的文档包括如何作为开发者使用 Mozilla 的产品，以及如何向这些开源项目贡献。
哪些话题不属于MDN？
+哪些话题不属于 MDN？
-举一些不适合MDN的话题：
+举一些不适合 MDN 的话题：
-
-
哪些类型在MDN的范畴内？
+哪些类型在 MDN 的范畴内？
In general, MDN is for product documentation, not for project or process documentation (except about MDN itself). So, if the document is about "how to use a thing" or "how a thing works" (where the "thing" is in one of the topic categories mentioned above), then it can go on MDN. But if it about "who's working on developing a thing" or "plans for developing a thing", then it shouldn't go on MDN. In that case, if the thing is being developed under the umbrella of Mozilla, then the Mozilla project wiki may be a good place for it.
diff --git a/files/zh-cn/mdn/guidelines/index.html b/files/zh-cn/mdn/guidelines/index.html index 1d8e75146c91eb..9a63127ba28f81 100644 --- a/files/zh-cn/mdn/guidelines/index.html +++ b/files/zh-cn/mdn/guidelines/index.html @@ -1,5 +1,5 @@ --- -title: MDN内容和样式指南 +title: MDN 内容和样式指南 slug: MDN/Guidelines tags: - Documentation diff --git a/files/zh-cn/mdn/guidelines/writing_style_guide/index.html b/files/zh-cn/mdn/guidelines/writing_style_guide/index.html index a61d9ba9530075..7a62b09321cf72 100644 --- a/files/zh-cn/mdn/guidelines/writing_style_guide/index.html +++ b/files/zh-cn/mdn/guidelines/writing_style_guide/index.html @@ -20,13 +20,13 @@如果你正在寻找一个特定类型的页面应该如何构建的相关细节，请参阅MDN Web 文档页面布局规范。
-本规范主要适用于英文文档。 其他语言可能也有（也欢迎创建）相应的规范。 这些应该作为子页面发布在各个本地化小组的页面中。
+本规范主要适用于英文文档。其他语言可能也有（也欢迎创建）相应的规范。这些应该作为子页面发布在各个本地化小组的页面中。
译注：本文的写作规范虽说是针对英文所写，但是其中的不少内容也适用于中文，可花点时间阅读一下。另外，中文翻译时的规范请参见《翻译术语表和翻译规范》。
对于那些为MDN以外的站点内容所编写的规范，请参考 Mozilla 统一规范。
+对于那些为 MDN 以外的站点内容所编写的规范，请参考 Mozilla 统一规范。
基础部分
@@ -34,7 +34,7 @@基础部分
页面标题
-页面标题不仅会在搜索时用到，在页面顶部的面包屑路径中也会被用来表示文档的层级结构。页面标题（就是显示在页面顶部以及搜索结果中标题的部分）可以与页面URL“<locale>/docs/”之后的“铭牌（slug）”部分不同.
+页面标题不仅会在搜索时用到，在页面顶部的面包屑路径中也会被用来表示文档的层级结构。页面标题（就是显示在页面顶部以及搜索结果中标题的部分）可以与页面 URL“<locale>/docs/”之后的“铭牌（slug）”部分不同。
文章标题和段落标题的大写规则
@@ -57,7 +57,7 @@创建新的子目录
当你要给某个新的主题或主体添加文章时，你通常需要创建一个引导页，然后再把要添加的文章作为子页面添加进去。引导页开篇应当用一两段话来描述一下当前主题或技术，然后添加一个子页面的目录列表，并简要描述每个页面的内容。你可以使用一些我们已经编写好的宏把相关的子页面自动插入到目录列表中。
-例如，JavaScript手册,其结构如下：
+例如，JavaScript手册，其结构如下：
创建新的子目录
文章内容的通用原则
-在写任何文档时，知道该写多少是很重要的。如果你写的长篇大论，文章读起来就会冗长无味,更不会有人愿意使用它。保持文章内容适量很重要,原因有很多。这其中的原因就有：为了确保读者能够找到他们真正想要的信息，以及为搜索引擎提供足够的优质素材来对文章进行分析和排名。我们将在这里讨论前者（提供读者可能需要的信息）。如果想了解如何让文章更好地被搜索引擎分类和排名，查阅文章How to write for SEO on MDN。
+在写任何文档时，知道该写多少是很重要的。如果你写的长篇大论，文章读起来就会冗长无味，更不会有人愿意使用它。保持文章内容适量很重要，原因有很多。这其中的原因就有：为了确保读者能够找到他们真正想要的信息，以及为搜索引擎提供足够的优质素材来对文章进行分析和排名。我们将在这里讨论前者（提供读者可能需要的信息）。如果想了解如何让文章更好地被搜索引擎分类和排名，查阅文章How to write for SEO on MDN。
-我们的目标是在页面中包含读者可能需要的所有信息，但又不至于太过冗长。为了实现这个目标,我们给出了一些建议。
+我们的目标是在页面中包含读者可能需要的所有信息，但又不至于太过冗长。为了实现这个目标，我们给出了一些建议。
为读者着想
@@ -157,7 +157,7 @@无序列表
下面是一个结构良好的无序列表的例子：
在这个例子中需要包括:
+在这个例子中需要包括：
术语
HTML 元素
-请使用”元素“来表示 HTML 和 XML 元素，不要使用”标记“。另外，请在元素名称两边使用尖括号 ”<>“ 括起来，并使用 {{HTMLElement("code")}} 样式。当文章中第一次出现某个元素的时候，应该用 HTMLElement 宏创建一个指向该元素文档的链接（除非你正在撰写的恰好是该元素的文档页面）。
请使用”元素“来表示 HTML 和 XML 元素，不要使用”标记“。另外，请在元素名称两边使用尖括号”<>“括起来，并使用 {{HTMLElement("code")}} 样式。当文章中第一次出现某个元素的时候，应该用 HTMLElement 宏创建一个指向该元素文档的链接（除非你正在撰写的恰好是该元素的文档页面）。