WordPress。org上第一个插件九天没有发货,我已经承诺了代码,标记了发布,用我的新描述观看了列表更新,并告诉人们它已经出局了,下载保持平稳,因为下载按钮正在服务一个空标签文件夹:我的 readme.txt 说 Stable tag: 1.0.1 我实际创建的标签是 1.0.没有什么警告我,目录完全按照我告诉它的去做。
该行是 WordPress 插件中风险最高的字段's readme.txt并且它是悄悄失败而不是大声失败的几个指南之一。本指南涵盖了目录对该文件的每个部分所做的事情,按损坏发生的顺序排列。 WordPress 自读机生成器 使用这些规则构建文件并附加到它们适用的字段。
TL;博士:
Stable tagnames目录实际服务的版本,它是从读取的trunk/readme.txt并且它指向下面的文件夹/tags/that必须存在,并且必须包含发布,如果它命名了一个不在的版本,用户什么也得不到;如果它仍然命名一个旧的,无论你犯了什么,他们都会得到旧的代码。Tested up to控制列表上的兼容性警告,Tags仅索引前五个,并且简短的描述被剪切为 150 个字符。
Stable标签实际控制什么?
目录中的一个插件位于 Subversion 中 trunk/ 对于当前的发展和 tags/<version>/ for release。come 时,有人点击下载,目录就不会发送它们 trunk.它读到 trunk/readme.txt,发现 Stable tag的,而且服务 tags/<that value>/。
3个后果接踵而至, 所有三口真正的释放:
- 决定这是行李箱中的自述。 在标签文件夹中编辑自述内容不会改变任何有关所发货的内容。
- 标签必须存在。 甲
Stable tag命名从未创建的文件夹意味着下载为空或失败。 - Trunk 不是用户接收到的。 您可以承诺整周进行中继;在稳定标签移动之前,释放的代码是旧标签所持有的代码。
的 插件手册 states the rule explanly, 而且值得正确阅读一次, 而不是从另一个插件复制一个自述, 并编辑字段, 值得了解的一个例外: Stable tag: trunk does mean "serve trunk",这是合法的,也是少数插件发布的方式,它也意味着对 trunk 的每个提交都会立即为每个用户实时运行,这就是为什么几乎没有人应该这样做。
Redme完全不控制的发布后半部分,版本在 Stable tag 必须匹配 Version: php 主插件文件中的标头,因为这是已安装站点与之比较来决定是否存在更新的标签。发货一个标签,其插件标头仍然显示前一个号码,并且目录提供一个更新,该更新安装了声称是已经存在的版本的内容。
每个标题行对您的列表的作用
标题块是九行普通的 Key: value 它们中的每一个都会改变一些可见的东西。
| 線 | 它做什么 | 出了什么问题 |
|---|---|---|
Stable tag |
选择所服务的版本 | 错误的价值不影响任何东西,或者影响旧代码 |
Requires at least |
最低 WordPress 版本 | 太高的块安装可以工作 |
Tested up to |
兼容性声明 | 落后显示"未经测试"警告 |
Requires PHP |
最低 PHP 版本 | 太低会导致不兼容的站点安装并失败 |
Tags |
目录关键字 | 只有前五个被索引 |
Contributors |
链接 WordPress.org 配置文件 | 拼写错误默默地表示没有人 |
Donate link |
侧边栏捐赠按钮 | 缺席就好,破碎就不行 |
License / License URI |
许可证 | 必须与 GPL 兼容才能列出 |
Tested up to 是默默下载成本的,当它落后于几个核心版本时,列表显示一个通知告诉访问者该插件未经过他们版本的 WordPress 测试,并且一个看起来被遗弃的插件无论是否工作都会安装更少更新该行是 readme 提交到中继,需要一分钟,这是生态系统中维护成本最便宜的。
Tags indexes five。第六个标签不是错误,不会产生任何警告;它只是你文件中的死文本。选择五个人实际键入。
描述是如何分裂的,为什么这很重要?
readme中有两种描述,它们做不同的工作。
的 简短的描述 是标题行和第一个标题行之间的单个文本块 == Section ==。150个字符封顶,而过去目录在搜索结果和插卡上截断,一般是中句,这是大多数人在决定是否点击之前读的行,这使得150个字符成为文件中最有价值的房地产。
的 长描述 是的 == Description == section,它就成了你的列表页面的正文,它取了 Markdown 的一个子集:标题、粗体、斜体、列表、链接,原始 HTML 被剥离了。表格、带有语法突出显示的围栏代码块,以及更具异国情调的 Markdown 不渲染,因此在 Markdown 预览器中看起来正确的自述程序在 WordPress。org 上仍然可能看起来错误。
其他部分均映射到列表上的选项卡:
== Description == the main body
== Installation == the Installation tab
== Frequently Asked Questions == the FAQ tab, one "= question =" per entry
== Screenshots == numbered captions, matched to files in /assets/
== Changelog == one "= version =" block per release, newest first
== Upgrade Notice == the short line shown inside wp-admin on update
Upgrade Notice 值得比平时更多的关注,它是大多数用户在点击更新之前看到的唯一文本:一两行,在更新提示中,解释为什么这个版本很重要一个安全修复,一个突破性的更改,一个新的PHP要求留空,更新只是一个数字。
横幅和图标住在哪里?
不在 readme.txt。第一次几乎所有人都绊倒了,因为自述内容是其他所有列表内容的来源。
图片生活在一个 /assets/ SVN中的目录,旁边 trunk 並 tags并且它们由文件名匹配:
| 文件 | 目的 | 尺寸 |
|---|---|---|
banner-772x250.png |
列出标头 | 772×250×快播电影大全, 苍井空电影772mm5、 有效工作空间:268×158×150mm6、 可装试样数量:>200冲击试样尺寸 |
banner-1544x500.png |
视网膜头 | 1544×500×快播电影大全800另承接:工业自动化控制与系统设计,电气控制设备,自动化新技术的研究开发及推广,自动化成套设备与非标设备的技术开发与服务,自动化设备改造 |
icon-128x128.png |
搜索结果图标 | 128×128×快播电影大全, 苍井空电影下载128mm5、 有效工作空间:268×158×150mm6、 可装试样数量:>200冲击试样尺寸 |
icon-256x256.png |
视网膜图标 | 256×256×成人电影网, 苍井空电影网256mm5、 有效工作空间:268×158×150mm6、 可装试样数量:>256×150mm6、 可装试样数量:>256×150mm6、 可装试样数量:>256×150mm6、 可装试样数量:>256×256× |
screenshot-1.png |
第一个屏幕截图 | 任何 |
屏幕截图按数字连接回自述器。 screenshot-1.png 由下面第一行描述 == Screenshots ==、 screenshot-2.png by the second,依此类推。没有匹配文件的标题显示什么也没有;没有标题的文件显示一个未标记的图像。
一个好的变更日志是什么样的?
每个版本一个块,顶部最新,每行说明用户的变化's观点:
= 3.2.5 =
* Fixed: admin menu order lost after a role change
* Improved: login customizer previews without saving
= 3.2.4 =
* Added: per-role dashboard widget visibility
"bug修复和改进"什么都不告诉用户,也少告诉审稿人,changelog也是任何人决定是否信任你的插件首先看的地方:特定条目的稳定列表读作维护,两年的空白读作放弃,无论代码是否仍然有效。
长更改日志可以修剪。保留最近的版本 readme.txt 并将其余部分移至 a changelog.txt;目录读取修剪后的,历史记录保留在存储库中。
在发货前检查文件
机械检查很快:确实如此 Stable tag 匹配存在的标签文件夹,是否匹配 Version: 在您的插件标头中,是 Tested up to current,是150个字符以下的简短描述,有五个或更少的标签。
WordPress.org 有一个 官方自述验证器 that 解析文件并报告它无法读取的内容,每个版本值得运行一次。 读取器生成器 采取另一个方向:它从字段构建文件,在其适用的字段旁边说明每个限制,预览文件将生成的列表,并读取现有内容 readme.txt 返回到表单中,以便可以更新旧插件's 文件,而无需重新输入。
如果您正在查看其他人's插件而不是发布您自己的插件 WordPress 插件检测器 列出页面加载的内容,以及 主题探测器 读背后的主题。
