bbPress Codex电视台

食品法典委员会标准和指南

为Codex撰稿

如果你正在考虑为codex做贡献，这个简单的指南可以帮助你设置页面的格式以及遵循的标准和约定，以保持页面的固定外观。

如果你不确定一篇文章的状态，可以前往论坛发布一个主题并添加主题标签，Codex由bbPress社区策划法典，如果你想跟随codex开发讨论，你可以访问链接或订阅编码RSS提要.

请注意：Codex的所有条目都包含在通用公共许可证所有条目都可以由其他贡献者编辑或修改。

如何创建新的Codex文章

1. 使用WordPress用户名和密码登录。
2. 单击侧栏中的“创建新页面”链接。
3. 您还可以从此复制示例模板布局模板更快地开始。
4. 添加文章的标题。
5. 添加文章meta:版本、组件、类型和上下文。元框位于屏幕的右侧边栏。请注意，尽量使这些内容泛化，例如，将版本设置为“2.5”是为了包含2.5以及所有增量版本，如2.5.1、2.5.2等。
6. 在Context框下的Page Attributes元框中的相应codex部分中添加文章。如果你不确定应该在手册的上方添加文章标题目录获取指南或前往论坛，用法典主题标签，我们将努力为您的文章找到最佳位置。
7. 添加文章内容。检查它是否遵循下面发布的Codex通用指南、Codex惯例和格式指南，供您参考。
8. 完成后，单击“发布”按钮。

如何编辑/更新Codex中的文章

1. 使用WordPress用户名和密码登录。
2. 导航到要编辑/更新的页面。
3. 单击侧栏中的“编辑此页面”链接。该链接将为具有文章编辑访问权限的用户显示。
4. 完成编辑/更新后，请仔细检查版本、组件、类型和上下文是否正确并已更新，再次尝试广泛关注这些内容，以便轻松发现。
5. 单击发布元框中的“更新”按钮。

一般指南

bbPress Codex写作指南

• 写文章时，请用第二人称的观点向读者讲话。例如“现在导航到你的“而不是”现在导航到我们的“.
• 撰写技术文章（功能、动作等）时，请使用您将找到的草稿模板在仪表板中，将其正文轮廓标记复制并粘贴到新帖子中。
• 请将样式保持在最低限度，避免元素的内联样式，除非在认为有必要进一步强调文本时提供颜色突出显示之类的内容，例如红色警告的样式确保已备份数据库。请谨慎使用元素<b>，<i>是排版惯例，用于为外来和科学词汇/短语添加文字和斜体<strong>、<em>是指赋予单词或短语权重或重要性，即“em”不仅仅用于以斜体显示文本的视觉样式。
• 链接：外部资源链接：文章框架底部提供了一个链接到外部资源的部分，请使用此部分链接到有帮助的资源进一步的然而，请确保这些链接是额外的资源，并且您的文章不依赖于它们来完成文章的全部或任何部分解释，这里的理由是外部链接不一定总是可用的，如果文章依赖于它们并且它们关闭了，那么文章对用户来说实际上是无用的。要避免与文章内容没有直接关系的链接，如果找到，将删除链接。
• 图像：在文章中添加图片有助于说明你的观点或解释，没有什么比bbPress、BuddyPress或WordPress屏幕的及时图形截图更有助于说明事情，有助于显示读者布局。与链接一样，请避免调用远程图像，始终上传到媒体库并嵌入。如果上传图片，请确保您有权这样做，并且不侵犯任何可能存在的版权。任何被认为是或受版权保护的图像都将从页面中删除。
• 创建页面：创建页面时，请确保选择合适的“版本”标记，并可选择可用的“组件”标记和“类型”。请仅从可用的父部分中选择父类别，我们要求作者请勿创建新页面作为其文章的父页面，这是为了确保codex结构的完整性，然而，如果认为有益的话，可以扩展结构，但请向codex策展团队成员之一提出请求以供考虑。

Codex惯例

• 网站示例名称：在任何需要说明域作为示例的地方，请始终使用example.com、example.org或example.net。这是根据RFC 2606。例如，双关语的结账http://example.com，这些是用于此特定目的的保留域名，不链接到任何特定主机或adfarm。
• 管理员：WordPress站点的主要管理员用户始终具有登录管理员。（例如，在活动站点上登录admin会产生负面的安全影响。）。
• 在示例中使用人名：当普通、非管理员用户或个人需要名字时，使用Harriet作为名字，Smith作为姓氏。
• 管理面板：WordPress界面称为管理面板，而不是管理面板或仪表板。仪表板是管理面板中的特定面板。单个面板也称为管理屏幕。
• WordPress的拼写是：WordPress由两个大写字母拼写：W公司字P（P）女主角。
• bbPress拼写为bbPress：bbPress的拼写只有一个大写的P dangit字母：bbP（P）女主角。
• BuddyPress的拼写为BuddyPress：BuddyPress用两个大写字母拼写：B乌迪P（P）女主角。

格式指南

如果编写技术指南，请使用本文档草稿中提供的模板格式（复制粘贴到新页面）Codex模板–技术示例布局

1.标题标签：

当您使用h2作为标题标记时，将自动为您创建内容侧栏和链接中的一个部分。使用h3–h6作为h2下章节的副标题。

2.代码示例：用适当的短代码包围代码

[php（电话）]您的PHP代码[/php（电话）]
[html格式]您的HTML代码[/html格式]
还可以使用bash、shell、css、diff、patch、js、javascript、plain、text、sql和xml，它们的格式与前面的示例相同。
添加代码示例时，请使用数字/小数实体转义尖括号<>，而不是“命名实体”，因此请使用<和>。

3.列表：在适当的地方使用无序、有序和分隔的列表。

4.文件名：用代码标签

<代码>索引.php</代码>

5.技术指南的结构

标记文章–添加文章标题消息

页面正文中可能标记有两个“注释”

1/此页面是一个遗留文档，例如，在页面顶部，如果一个页面被认为过时或被bbPress版本或更改所取代，则它可能会被标记为此代码块，并且该页面将被重新分配到父部分“遗留”下

2/此页面需要更新

页面被视为不完整或需要验证详细信息。

---