Codex规范
导航: 上一页 | 首页 | WordPress中文论坛 | WordPress主机 | CMS程序 | 论坛程序 | ECShop | ShopNC | PowerEasy
欢迎光临! 本篇文章简要介绍了对Codex编辑者和志愿者的建议规范。如果你有更好的改进建议,欢迎到WordPress文档邮件列表上留言。
Meta(元数据)规则[ ]
- 正确拼写WordPress——WordPress
- 保持友好态度 - 禁止进行个人攻击或其它粗鲁行为。请保持专业,礼貌和耐心。
- 保证发布内容正确,及时且要经常更新。
- 尽情编辑,合理编辑。
- 如果有疑问,请提出来解决,不要保持沉默。
- 玩得开心! :)
标准规范[ ]
新页面[ ]
我们鼓励并欢迎大家创建新的文章和页面。同时,请大家遵循以下规范。
- 非注册用户,请首先查看以下说明:协助开发Codex
- 文章编辑完成后,若需要把它作为新页面发布,请查看:创建新页面
- 如果文章还有待进一步编辑,可把它作为用户页面的子页面,请查看:创建用户页面
- 请遵循Codex格式,详情请查看:Codex样式和编辑帮助
以下是协助开发Codex需要遵循的规范:
- 如果Codex中存在和你想编辑内容类似的文章,请直接修改已有文章。
- 请在沙盒 页面进行编辑试验。
- 请在创建的新页面上添加Codex其它文章链接。
- 请确保所创建的文章是完整的,其中的链接是含有有效内容的。
- 文章编辑完成后,发布到Codex文档时,请给文章添加分目录和其它相关文章链接。确保自己知道具体应该给哪部分文字添加分目录链接。另外,只有在得到文档团队的#允许后才能把链接放在文档的主页面。
使用以下 "stubs"以指明文章的状态:
- { {Stub}} : Stub 表明文章不完整,有待进一步编辑和扩展。
- { {Draft}}:确保把这个标记放在页面顶端。由于搜索引擎会搜索所有添加页面,Draft 标记会提醒其它用户这篇文章正在编辑中,其中的信息可能并不正确,同时也能提醒他人在你编辑完成前不要插手编辑。
- [ [Category:New page created]]:用来指明页面是新建页面,它能吸引编辑者。但除非你已准备编辑或把它从用户页面移到文档中,否则请不要使用这个标记。
- { {Copyedit}}:Copyedit 表明文章已大体完成,但需要再次审核一下。对尚未完成的文章,请使用{ {Stub}}。
标题[ ]
Ruby
所有标题都应该使用标题字体。例如,对于标题,应该使用"Using the Links Manager", 而非"Using the links manager" 。而且,标题应该完整,不要缩写,如,应使用"Introduction to Blogs",而非"IntroToBlogs"。
关于大小写,还需要遵循 Dr. Grammar规则,"标题应大写第一个单词,最后一个单词,及中间除冠词(a, an, 和the),五个字母以下的介词(in, of, to)和连词(and, but)之外的所有单词。这个规则适用于所有标题。 (Anson, Schwegler, and Muth. The Longman Writer's Companion 240)
- 标题应以行为或任务为导向,它也是用户查询信息时可能会使用的搜索关键词,因此,"Using the Links Manager"比"The Links Manager"更能说明文章内容。
- 在标题的开头或结尾部分,在单词之间不要使用不必要的空格。尽量避免使用"-", "#", "?" 和 "+"等类似符号。
- 标题越短越好。
- 尽量避免在标题中使用介词。
- Codex是关于WordPress的wiki,因此,标题中应尽量包含"WordPress" 。
- 若不确信标题是否合适,可发邮件给文档团队以征询意见。
- 标题不要使用CamelCase(骆驼拼写法):Codex不使用CamelCase。所有的页面标题和标题链接都使用常规的标题字体。例如,关于Codex的页面标题应为"About Codex", 它的链接格式为:[ [About Codex]],而不是CamelCase [ [AboutCodex]].
子页面[ ]
在没有和wp文档团队讨论之前,请不要创建子页面(用户页面除外)。常用函数页面可以自主创建子页面(每个子页面描述了一种函数。)。
讨论[ ]
使用 "Talk" 页面[ ]
如果发现不正确或表达清晰的内容,可使用DISCUSSION提交留言。请不要在文章页面直接添加评论。在每个页面都有一个DISCUSSION tab,你可以在此评论,提出建议或留言。谢谢合作!
- 给文章留言: 可点击文章的Discussion标签,在上面留言然后署名提交。
- 给用户留言: 可编辑 用户:谈论页面 ,并署名。用户下次登陆时就会收到留言提示。
- 分离评论: 在讨论页面,请在评论之间使用四个破折号---- 以把它和其它内容区分开。如果你准备讨论新话题,可点击编辑旁的"+"链接以创建新内容。
- 记得署名: 留言或评论后,请记得署名,并在评论末尾添加四个~。这会显示你的用户名,用户页面链接和时间戳——这对讨论页面非常有用。还可以点击编辑窗口顶端的署名图标,即右侧第二个图标。
Codex声音,格式和读者[ ]
WordPress Codex的"voice"是权威的声音,同时也是一种友好的交流。 Codex的格式提供了简单,易于使用的说明和技术建议来指导大家编辑。
Codex的文章主要是写给读者阅读的,因此编辑过程中应站在读者的角度编辑。代词”I“应少用,而要使用”你可以点击这里“或”你应该打开模板文件“。Codex是用来帮助用户解决问题的手册,所以我们应该告诉他们如何操作才能使WordPress网站正常运行,而非谈论自己或帮助你使用WordPress的用户是如何操作成功的。
应使用圆形符号和列表以强调操作步骤,使其更加清晰明了。比较复杂的步骤应该分为多个小步骤,以方便新手或高级用户快速解决所遇到的问题。
由于Codex文档读者对HTML, XHTML, CSS, 和 PHP的掌握程度参差不齐,我们也据此编写了不同等级的文章。进阶课题和开发人员文档中的文章主要适用于高级用户;而WordPress使用则适用于新手,其中的语言应该简单明了,给人以技术支持人员就坐在用户旁边手把手给其指导的感觉;其它文章适用于中等水平的用户,必要时应该链接WordPress词汇汇编中的词条。
惯用名称[ ]
- 网站名称: 需要使用域名举例时,请使用 example.com, example.org 或example.net。这是根据 RFC2606所设的。
- Admin: 主要的管理用户通常有登陆admin.
- 人名: 编辑过程中需要使用普通人名(非管理人员名字)举例时,使用"Harriet"作为名,"Smith"作为姓。
- Administration Panels: WordPress界面称为Administration Panels(管理面板),而非admin panels或dashboard(控制台)。 Dashboard(控制台)是Administration Panels(管理面板)上的其中一个面板。
- WordPress应拼写为WordPress: WordPress有两个大写字母: WordPress。