这篇文章需要文法复核。如何帮忙。
几乎所有的MDN贡献者都会做的两件事,也是MDN上两个最基本的工作,编辑已有页面或者新建一个页面。这篇文章会介绍这两个最基本的功能。
编辑一个已存在的页面
编辑页面很简单:
- 只需要点击页面右上角的 Edit(编辑)按钮。
- 页面会重新加载各种选项,你可以直接在页面新增或者删除内容。
- 你可以新增段落,删除文本,插入标题,完成各种编写和编辑的功能。
预览修改
查看你修改的内容:
- 点击文章标题上方的"Preview changes"(“预览修改”)按钮(在编辑模式下)。
- 在新窗口或新标签页打开一个修改过的预览页。
- 每次点击按钮,会刷新到最新的状态。
注意!预览页面并不会保存你的修改内容,所以记住不要关闭你的编辑页。
版本注释
当你预览更改之后,需要保存你的修改版本。保存之前,查看页面文章下方的版本注释栏,留下一些注释信息告诉其它贡献者为什么修改它。例如,你可能新增一个部分,修改一些文字使术语更加一致,重构一个段落使其语言更加本地化,或者删除一些冗余信息。
标签Tags
你可以新增或删除编辑区域下面的一些描述页面内容或者功能的标签。查看 如何正确标记页面 来了解 标签 如何如何提供信息。
审核是必须的吗?
保存之前,想要确保信息的准确性,你可以勾选技术审核(针对代码,API的,或技术),编辑审查(针对文章,语法,和内容),或模板审查(针对KumaScript code),来让专家或有经验的贡献者要审核你的编辑信息。
附件
如果你想将某个文件附加到现有的页面,以添加一个插图或进一步说明,它可以在页面底部输入。{ { optimizeimagesnote(1)} }
保存,放弃更改,继续编辑
当你完成编辑,并很开心的预览修改后,你可以点击标题右边的绿色按钮“保存修改”来保存你的工作和注释。如果你改变主意,也可以点击页面右侧的红色按钮“放弃更改”放弃你的编辑。
版本注释区域点击 Enter 键和点击「保存并继续修改」具有相同效果。
新建一个页面
找不到在哪里新建一个页面?别担心!你可以在任何地方新建一个页面,如果是有意义的内容,我们会找到它,并把它归档或者合并到合适的类别下。你也不用过多担心它不够完美,我们有快乐的精灵助手来帮你打理,让你的文章保持干净美观。
下面是一些新建页面的方法:
- 缺省页链接 "Missing page" link
- 缺省链接的新页面 New page without link
- 在现有页面下新增子页面 Subpage of an existing page
- 复制已存在的页面 Clone of an existing page
- 从已存在页面创建链接 Link from an existing page
缺省页链接"Missing page" link
和大多数的wiki类似,在MDN上也可以通过新建一个不存在页面的链接。就好比一个作者在编写每个API之前,先创建了一个API列表。在MDN上,链接到不存在的页面通常显示在红色。
为缺省页链接新建页面:
- 确保你已经登录到MDN。(如果没有登录,访问一个缺省页链接会显示404(页面不存在)错误。)
- 点击你的缺省页链接。 MDN 编辑指南 将会打开,确保你可以新建页面。
- 编写页面内容并保存。
缺省链接的新页面New page without link
为了建立一个New page without link的新页面,在您的浏览器的网址栏中输入一个独一无二的网页地址。例如,如果你输入:
https://developer.mozilla.org/en-US/docs/FooBar
MDN 会新建一个页面标题是“Foobar”,并且打开编辑页,你可以添加内容。参考这篇文章的 编辑已存在页面 来学习如何使用编辑模式。
在现有页面下新增子页面Subpage of an existing page
为现有页面架构下建立一个子页面:
- 在“父级页面”,点击 Advanced menu(工具栏上的齿轮图标),然后点击 New sub-page。一个编辑页面打开来新建文档。
- 在文档的标题区域键入一个标题。Type a title for the document in the Title field.
- 如有需要,改变Slug区域(例如,当你的标题特别长并且你需要一个短一点的URL)。这个区域是编辑器自动填充的,规则是在标题中以下划线代替空格。这种情况下你只能改变URL的最后一部分。
- 在 TOC 区域,选择你希望被自动显示在该页面目录中的标题等级,或者如果页面不需要目录,显示"No table of contents" 。
- 在编辑区域编写页面内容,并保存修改。参考这篇文章的 编辑已存在页面 来学习如何使用编辑模式。
复制已存在的页面Clone of an existing page
如果你想在你的新页面里使用一个已存在页面的样式,你可以复制那个页面,然后改变其中的内容。
- 在原始页面,点击 Advanced menu(工具栏上的齿轮图标),点击 Clone this page。打开一个新的编辑页面,原始文件为样本。
- 根据你的页面内容来修改页面的一个合适的标题。Slug 区域会根据你的新标题自动改变。
- 如有必要将新文档放在文档层次结构中的不同部分,可以修改 Slug 区域的路径。(大多数情况下是非必须的,因为复制的页面和原始页面有相似的内容,因此应该被放在类似的地方)
- 在 TOC 区域,选择你希望被自动显示在该页面目录中的标题等级,或者如果页面不需要目录,显示"No table of contents" 。
- 在编辑区域编写页面内容,并保存修改。参考这篇文章的 编辑已存在页面 来学习如何使用编辑模式。
从已存在页面创建链接Link from an existing page
这种方法是一种混合。你可以创建在一个页面里创建一个链接,然后点击你刚才插入的链接来新建页面。
- 在一个已存在页面的文本区的任何地方(这很重要)输入一个新页面的名称在页面的。
- 让名称高亮,点击编辑器工具栏中的链接图标() ,会出现"Update Link"(更新链接)对话框,在“链接到”字段中高亮显示的文本。
- "/en-US/docs/" 会被自动插入URL的开头。在 "/en-US/docs/" 之后输入页面的名称。(页面名称不能和link text相同)
- 点击 “确定” 来新增或者插入一个链接。
如果页面还不存在,链接就会显示为红色。如果页面已经存在,链接会显示为蓝色。如果你希望新建一个页面,但是页面的标题已经被使用,首先检查一下是否可以帮助编辑和改进已经存在的页面。否则,为你的新页面起一个不同的名字并创建链接。参考 页面命名指南 做为指导。
为你的新页面新增内容,可以点击红色链接(在保存并关闭编辑模式之后)。新页面就会以编辑模式打开,你可以开始编写。参考这篇文章的 编辑已存在页面 来学习如何使用编辑模式。
刷新页面内容
MDN支持kumascript的宏和从一个页面的内容嵌入包含到另一个,某些时候由于性能方面的原因会对生成的页面缓存需要稍加阻碍。页面是源于它们的源代码,并且输出为将来的请求缓存。之后,任何宏(模板)或嵌入包含(使用页面宏观上页将不会反映到宏观,宏的输出变化,或内容的被引用的材料。
- 要手动更新页面,您可以在浏览器中进行强制刷新。MDN检测到这种请求并触发一个页面重建,拉动宏观产出和被引用的页面内容更新
- 您还可以配置页面,定期进行重建。这是必须的,除非该页面需要频繁更新。更多细节请参考 Page regeneration。