WordPress:Codex:Guidelines

来自站长百科
Fludlen（讨论 | 贡献）2008年5月31日 (六) 16:56的版本
跳转至： 导航、​ 搜索
可打印版不再被支持且可能有渲染错误。请更新您的浏览器书签并改用浏览器默认的打印功能。

导航: 上一级 | WordPress | 首页 | WordPress中文论坛 | WordPress主机 | CMS程序 | 论坛程序 | ECShop | ShopNC | PowerEasy

Welcome!
This page seeks to outline recommended practices for editors and volunteers at the Codex. Should you have a suggestion for improvement, please post a note on the WordPress Documentation mailing list.

；欢迎！；这个网页是要略述推荐给Codex上的编辑人员和志愿者的做法。你有一个建议来改善Codex吗,请在WordPress 文件邮件列表中粘贴一个建议的内容。

Meta Rules

Meta 规则

  1. Spell WordPress using the proper case. WordPress
  2. Be Nice - No personal attacks or rude behavior. Please be professional, polite and patient.
  3. Release accurately, early and often.
  4. Edit mercilessly.
  5. If in doubt, ASK.
  6. Have fun. :)


  1. 使用合适的语法来拼写WordPress 。 WordPress
  2. 要友好 – 没有个人的言论袭击或者粗鲁的行为。请礼貌，耐心，专业。
  3. 正确地发行，早一点发行并且经常发行。
  4. 毫不留情地编辑。
  5. 如果有疑问，就要问。
  6. 玩得开心。 :)


Standard Practices

通常练习

New Pages

新的网页

New articles and pages are welcome. There is a process, though.

欢迎新的文章和网页。但是，要有一个过程。

If you are not a registered user, following these instructions: Contributing: First Things First.

如果你不是一名注册的用户，遵循这些指导： 贡献: 重要的事情先来。

If the article is fairly complete, you may add it as a new page. See: Creating a New Page.

如果文章刚好完成了，你可以添加这篇文章到Codex，作为一个新的网页。看看: 创建一个新的网页。


If the article is incomplete and a rough draft, you may add it as a subpage of your user page. See Creating a User Page.

如果文章还没有完成，而且是一个粗略描述的草稿，你可能将这篇文章添加到你的用户网页上，作为一个子网页。看看 创建一个用户网页。


Please follow the Codex Styles for articles established here: Codex Styles.

请为这儿创建的文章遵循Codex样式: Codex样式。


The following are guidelines for contributing new work to the Codex:

以下是一些方针用来为Codex奉献一些新的作品：

  1. If there is an article that resembles your article, improve the existing page.
  1. 如果有一篇文章与你的文章相似，改善当前存在的网页。
  1. Use the Sandbox page for practice styling.
  1. 使用Sandbox网页来练习样式。
  1. Add a link from another article to your article to develop interconnections between articles. Do not create "dead-end pages". These are pages without links to other Codex pages.
  1. 将来自另一篇文章的链接添加到你的文章上，在文章之间形成内部链接。不要创建那些"没有页面的网页"。这些页面没有链接到其它的Codex网页的链接。
  1. Once pages are created, they are live, and any links to them will work. When a user clicks their way to an empty page, they have wasted their time. Only create pages when you have fairly complete and accurate content to put into them.
  1. 一旦网页创建好了，这些网页就可以运行了，而且任何链接连接到这些网页都可以运行。当一个用户点击到了一个空白的网页的时候，他们浪费了时间。当你有非常完整而正确的内容的时候，再创建网页。
  1. Once completed and moved out into the documentation from your user page, links must be made from the "sub" Table of Contents and other related documents to the new article. Ask if you are not sure of where to create a link from the sub-Table of Contents. Do not put a link on the WordPress:Main Page without permission from the WordPress:Documentation team.
  1. 链接一旦完成了并且移到了来自你的用户网页的文件中，链接必须制作在内容的"子"表格和新的文章上的其它的相关文件中。想一下你自己是不是不确定可以在内容子表格的哪里创建一个链接。在没有文件小组的允许下，不要将一个链接放到主页中。

Use the following "stubs", categories which designate the state an article is in:

使用以下的"stubs",类别，这些指定了一篇文章所处的状态：

{{Stub}}
The Stub categorizes the page as incomplete and in need of editing and expansion.
{{Stub}}
Stub将网页归类为未完成的，需要编辑和扩充。
{{Draft}}
Put this at the top of the page. All pages added are scanned by search engines. The Draft notice at the top of every page will warn others that this is a work in progress, that the information may be incorrect, and may also warn others not to edit it until you are finished working on it.
{{草稿}
将这个放到网页的顶上方。所有添加的网页都会被搜索引擎仔细检查。网页的顶上方的草稿，会提醒他人这个网页正在进展之中，网页上的信息可能是不正确的，而且还会警醒他人在你完成这个网页之前，不要编辑这个网页。
[[WordPress:Category:New page created]]
Defines a page as new and will attract the attention of editors. Do not use until you are ready for editing and/or moving the article out into the general documentation from your user page.
[[WordPress:Category:New page created|类别：创建的新的网页]]
将一个网页定义为新的，会引起编辑的注意。不要将网页定义为新的，除非你已经开始编辑了和/或者将文章从你的用户网页的总文件中移除出去了。
{{Copyedit}}
Copyedit designates this article as in need of work, usually general overview and editing. It marks it as fairly complete but needing review. Use {{Stub}} for incomplete articles.
{{副本编辑}}
副本编辑指出了这篇文章需要操作，通常是需要大致的浏览和编辑。指出了文章已经完成了但是需要进一步处理。对于未完成的文章，使用{{Stub}}。

Titles

标题

The titles for new pages should be in Title Case.

新的网页的标题应该位于标题Case中。


All headings must also be in Title Case. For example, use "Using the Links Manager" not "Using the links manager". These should be full titles. Not "IntroToBlogs" but "Introduction to Blogs".

所有的标题都必须在Title Case中。例如，使用"Using the Links Manager" 而不是"Using the links manager"（注：前后意思都是使用链接管理器，但是格式不同）。这些应该是完整的标题。不是Not "IntroToBlogs" 而是 "Introduction to Blogs"（注:意思相同，都是博客介绍说明，只是后者的格式应用于标题之中）

They should also follow the Dr. Grammar rules regarding capitalization thus:"In titles, capitalize the first word, the last word, and all words in between except articles (a, an, and the), prepositions under five letters (in, of, to), and coordinating conjunctions (and, but). These rules apply to titles of long, short, and partial works as well as your own papers" (Anson, Schwegler, and Muth. The Longman Writer's Companion 240)

他们也应该遵循Dr. Grammar关于大写的规则："在标题中，要大写第一个单词，最后一个单词，以及中间的所有单词，除了冠词 (a, an, and the), 少于五个字母的介词 (in, of, to), 和并列连词 (and, but)。这些规则适用于长的标题，短的标题，部分标题以及你自己的文章。 " (Anson, Schwegler, 和Muth. The Longman Writer's Companion 240)

  1. Titles are action or task oriented whenever possible. So, "Using the Links Manager" is preferred to "The Links Manager" for example. What search words will a user use when looking for the information?
  1. 标题是任何时候可能的情况下，导向的活动或者任务。因此，例如，"使用链接管理器" 比 "链接管理器"作为一个标题，更好。当用户查找信息的时候，他会使用什么样的搜素词？
  1. Titles shall not have leading or trailing spaces, or unnecessary spaces in between words. Try to avoiding using symbols such as "-", "#", "?" and "+"
  1. 标题不应该有开头的或者拖尾的空格，或者标题的单词之间也不应该有不必要的空格。试着避免使用符号像"-", "#", "?" and "+"
  1. Shorter titles are better
  1. 标题越短越好
  1. Please avoid using prepositions in titles, as far as possible.
  1. 请尽量在标题中避免使用介词。
  1. The Codex is a wiki entirely dedicated to WordPress, so it is natural to have "WordPress" in titles.
  1. Codex是完全给WordPress专用的一个wiki，因此Codex的标题中含有"WordPress"很正常。
  1. In case of doubt regarding the suitability of a name, mail the wp-docs list asking for suggestions
  1. 当对标题名称的合适性有疑问的时候，给wp-docs 列表写邮件，寻求建议
  1. Do not use CamelCase for page titles: The Codex does not use CamelCase like some other wikis do. All page titles and therefore links should be of normal title case. For example, the page about Codex should have the title "About Codex", with the link formatted as: [[WordPress:About Codex]] and not the CamelCase [[WordPress:AboutCodex]].
  1. 不要为网页标题使用CamelCase：Codex并不像其它的wikis那样，使用CamelCase。所有的网页标题和链接都应该是通常的标题case。例如，关于Codex的网页的标题应该是"关于Codex",链接的形式是：[[WordPress:About Codex|关于Codex]] 而不是 CamelCase [[WordPress:AboutCodex| AboutCodex]].

SubPages

子网页

Do not create sub-pages of a page, other than from your own User page, without discussing first on the wp-docs mailing list.

不要创建一个网页的子网页，除非这个网页是来自你自己的用户网页，而且没有首先在wp-docs邮件列表上讨论过。

Discussions

讨论

Using the "Talk" pages

使用 "谈话"网页


Do you see something that is perhaps incorrect, or needs clarification? The best way to make mention of any issues is to use the DISCUSSION function. Please refrain from adding your comments directly onto the ARTICLE page. At the top of every page is a DISCUSSION tab. This is the place to make your comments, suggestions, and such. Thank you!

你是不是看到了一些内容，这些内容可能是不正确的，或者需要澄清？提及任何问题的最好方法是使用讨论功能。

  1. Leaving Messages About the Article: To leave a message regarding the article, click the Discussion tab of that article and post your message and sign it.
  1. 留下关于文章的信息:要留下关于文章的信息，点击那篇文章的讨论标签，发送你的信息并且署名。
  1. Leaving Messages for Users: Leave a message for a user by editing the User:Talk page associated with the user. Sign it. The user will receive a visual prompt the next time they visit the Codex and Login.
  1. 给用户留下信息:通过编辑用户：与用户联合的谈论网页来给用户留下一个信息。并且署名。用户下一次访问Codex并且登录的时候，就会收到一个可以看到的提示。
  1. Separate Comments: Please create a horizontal rule between comments on the discussion page by using four dashes ---- between entries. If you are starting a new thread of conversation, consider using the "+" link next to edit, which lets you create a new section.
  1. 分开评论:通过在文章中使用四个破折号----，在讨论网页的评论之间创建一个水平方向的破折号。如果你开始了一个新的谈话主题，考虑在编辑后面使用"+"链接，这会使你创建一个新的部分。
  1. Always Sign Your Comments: To add your "signature" to a comment, add four ~s (tildes) at the end of your comment. This will list your User Name and a link to your User Page and add a time-stamp. This is very useful for discussion pages. An alternative method is to click on the signature icon at the top of the edit window...it's the second one from the right.
  1. 经常给你的评论签名:要将你的"署名"添加到一个评论上，在你的评论的后面添加上四个~s (tildes)。这个会列出你的用户名和一个链接连接到你的用户网页并且添加一个时间标记。这对讨论网页非常地有用。另一种方法是点击编辑窗口顶上方的署名图标…这是从右开始数的第二个图标。

Codex Voice, Style, and Audience

Codex 声音, 样式, 和听众

The "voice" of the WordPress Codex is one of authority, but also a friendly conversational voice. The style of the Codex is to educate by providing simple and easy-to-use explanations when possible, and technical advice when necessary.

WordPress Codex的"声音"是权威的一种，但也是一个有好的谈话。Codex的样式是要在有可能的情况下，提供简单的而且便于使用的解释，在需要的情况下，提供技术建议，通过这样做来起到培训的作用。

In general, articles are written to the reader, taking the reader through the process. The pronoun "I" is rarely used, focusing on "you click here" and "you open the template file". It is not about what you, the author, did, the story behind your decisions, or all the people who helped you succeed. It is about what the user needs to do in order to get their WordPress site up and functioning fast.

一般来说，文章是写给读者的，带着读者经历一个阅读的过程。人称代词"我"很少用到，突出于"你点击这儿" 和 "你打开模板文件"。.这并不是关于你，这个作者，在这个决定之后做了什么，也不是关于那些帮你成功的人。这是关于用户需要做什么来使他们的WordPress站点发展并且更加快速地运行。

Bullets and lists are used to highlight the steps necessary to outline and streamline the process. Complicated tasks are broken down into small steps, guiding the novice or advanced user quickly to the solution.

Bullets符号和列表是用来突出那些需要略述和列出那个过程的步骤。复杂的任务被分解为一些小的步骤，来指导新手和高级用户迅速地得到解决方案。

The audience is extremely varied in ability and skill in HMTL, XHTML, CSS, and PHP. Articles found within the WordPress:Advanced Topics and WordPress:Developer Documentation are targeted for the experienced user. WordPress:WordPress Lessons are designed for the novice, using language as if the author was the technical support volunteer sitting down next to the user at the computer, guiding them through the process. The rest of the Codex is targetted towards the beginner to intermediate level user and should contain simple language with links to definitions within the WordPress:Glossary when necessary.

观众的能力和掌握HMTL, XHTML, CSS, 和PHP的技术差别很大。高级主题 和开发者文件是针对有经验的用户的。WordPress课程是针对新手的，作者使用的语言描述，让人读起来感觉作者就是一个技术支持志愿者，和用户一起坐在电脑的旁边，指导用户这个过程。Codex的其余部分是针对初学者到中等级别的用户，应该包含简单的语言，如果需要的话，有链接到术语表中的术语定义。

Conventions

惯例

  1. Website Example Names: Always use example.com, example.org or example.net wherever you need to state a domain as an example. This is per RFC2606
  1. 网站例子名称:当你想将一个域作为一个例子的时候，你通过可以使用example.com, example.org or example.net。这是经RFC2606。
  1. Admin: The main admin user always has the login admin.
  1. 管理:主要的管理用户通常有登录管理。
  1. Using People's Names in Examples: When a name is needed for an ordinary, non-admin user, or a person, use "Harriet" as the first name, "Smith" as the last name.
  1. 在例子中使用人们的名字:当一个普通的，非管理员的用户或者一个人，需要一个姓名的时候，将"Harriet"用作名，"Smith"用作姓。


  1. Administration Panels: The WordPress interface is called the Administration Panels not admin panels or dashboard. Dashboard is a panel on the Administration Panels.
  1. 管理 面板:WordPress界面称作管理面板:并不是admin 面板或者 dashboard。Dashboard是管理面板上的一个面板。
  1. WordPress is Spelled WordPress: WordPress is spelled with TWO capital letters: WordPress.
  1. WordPress被拼写为 WordPress: WordPress的拼写有两个大写字母：WordPress。

Related

相关的

取自“https://www.zzbaike.com/wiki/index.php?title=WordPress:Codex:Guidelines&oldid=3526”