编辑文章

Codex到Code的引用

例如,让我们比较以下两页添加操作(_A)了解哪些部分被转移到哪些区域:

Codex(档案):
https://codex.wordpress.org/index.php?title=Function_Reference/add_action&oldid=152725

代码参考:
https://developer.wordpress.org/reference/functions/add_action/

顶部

描述、语法、参数和返回

函数中的Description、Syntax、Parameters和Returns应转换为内联文档收割台标题 你网站的标题通常是人们第一次体验到的东西。位于页面顶部的刊头或页眉是网站外观的一部分。它可以影响访问者对您的内容和您/您组织的品牌的看法。它在不同的屏幕尺寸上也可能看起来不同。。这些内联文档将自动转换并添加到代码引用中。

对于我们的示例,请参考此源代码。https://core.trac.wordpress.org/browser/tags/5.2/src/wp-includes/plugin.php#L384如您所见,函数头包括description和@since、@param和@return标记。这些标记构成此函数的描述、语法和参数,并已自动添加到代码引用中。

所有函数都已经有内联文档,但信息级别与Codex不同。在初始函数标头创建期间删除了大量信息。

要添加/更新内联文档,请参阅此页面:
https://make.wordpress.org/docs/handbook/code-reference/inline-documentation/。你需要一些发展技能来营造环境并做出贡献。

注意:内联文档可能没有足够的语法或空间来描述每个详细参数或返回值。在这些情况下,请使用解释字段。

顶部

用法、注释和编程主题

这些应该迁移到解释字段,并显示在“更多信息”部分中。

注意:以下单行用法由于其琐碎性,不需要迁移。

<?php get_post_comments_feed_link($post_id,$feed)?>

添加/编辑解释字段,您的WordPress.org网站WordPress.org网站 用户创建和共享WordPress代码的社区站点。您可以在这里下载WordPress核心、插件和主题的源代码,以及社区对话和组织的中心位置。https://wordpress.org/帐户需要为开发人员参考添加一个或更多编辑角色。要添加,请转到#文档频道打开松弛并询问一位代表团队添加您。

顶部

使用示例

使用示例作为每个页面的用户注释迁移。

有关更多详细信息,请参阅本文档:https://make.wordpress.org/docs/handbook/code-reference/editing-articles/migrating-from-codex/

顶部

入门

我们正在跟踪迁移迁移 将网站的代码、数据库和媒体文件从一台服务器移动到另一台服务器。通常在更换托管公司时进行。本电子表格中的Codex参考代码:
https://docs.google.com/spreadsheets/d/15hpEbbnuWJZ0DJafyCeG3CFRMtSxX1gY-RObrrjzzdw/edit#gid=1679372392

顶部

首先保留要编辑的页面。

  1. 在跟踪电子表格中,使用状态列(H列)搜索“部分完成”行。
  2. 在编辑器列(F列)中输入您的姓名,并将状态列(H列)更改为“正在进行”。如果您没有电子表格的写入权限,请在#docs频道上将您的谷歌帐户DM到@atachibana。

顶部

比较Codex和代码引用

  1. 打开Codex页面和Code Reference页面并进行比较
  2. 如果代码引用包含Codex的完整信息,则确定
  3. 如果代码参考没有某些信息,请参阅上文法典到代码参考并将Codex页面上缺失的信息适当迁移到Code Reference。
    • 创建票证以修改内联文档时,将状态更改为“等待”,并将票证编号保留在“备注”中(第一列)。
    • 如果无法迁移每个部分,请在Notes列(第I列)中留下注释,记下剩下的内容,并将Status更改为“Partially done”。

顶部

将页面从Codex重定向到Code Reference。

迁移完成后,将codex页面重定向到Code Reference。

顶部

当Codex页面具有语言定位器时

  1. 在Codex页面中,单击右侧菜单上的Edit。
  2. 将以下消息置于语言定位器下方,并使用注释掉当前的Codex内容<!---->.
{{语言|{{en|WordPress功能}}{{ja|WordPress功能}}}}此页面已移至https://developer.wordpress.org/reference/functions网站/(函数名)/以上语言定位器除外。
  1. 单击页面底部的“显示预览”并确认更改。
  2. 在摘要框中输入文本“已传输到DevHub”,然后单击保存页面。

顶部

当Codex页面执行此操作时有语言定位器

  1. 在Codex页面中,单击右侧菜单上的Edit。
  2. 将以下标签放在页面顶部,并调整统一资源定位地址统一资源定位地址 互联网上网站或网页的特定网址,例如网站的URL www.wordpress.org.
{{#dotorgredirect:https://developer.wordpress.org/reference/functions(https://developer.wordpress.org/reference/functions)/(函数名)/}}
  1. 在摘要框中输入文本“已传输到DevHub”,然后单击保存页面。

注意:保存页面后,查看页面将重定向到该页面的DevHub版本。如果要修改保存的页面,请添加&action=编辑到URL。
例如https://codex.wordpress.org/index.php?title=Function_Reference/add_action&action=edit

顶部

发布此页面

将“进行中”状态更改为“完成”(H列)。

顶部

进度统计

https://docs.google.com/spreadsheets/d/15hpEbbnuWJZ0DJafyCeG3CFRMtSxX1gY-RObrrjzzdw/edit#gid=1576070270

上次更新时间: