sourcerer-mike/wp-readme-validator

验证README.md和.txt文件是否符合WordPress标准

此包的官方仓库似乎已不存在,因此包已被冻结。

dev-master 2016-11-16 15:10 UTC

This package is not auto-updated.

Last update: 2022-04-25 02:42:50 UTC


README

贡献者:markjaquith, mdawaffe
捐赠链接:http://example.com/
标签:评论,垃圾邮件
最低要求:2.0.2
测试到:2.1
稳定标签:4.3

以下是插件简短描述。不超过150个字符。此处无格式。

描述

这是插件的长描述。没有限制,并且你可以使用Markdown(以及在下述部分中)。

为了与向后兼容性,如果本节缺失,则将使用简短描述的完整长度,并解析Markdown。

关于上述部分的几点说明

  • "贡献者"是一份用逗号分隔的wp.org/wp-plugins.org用户名列表

  • "标签"是一份适用于插件的标签列表

  • "最低要求"是插件能工作的最低版本

  • "测试到"是你成功测试插件的最高版本。请注意,它可能在更高版本上也能工作...这只是你已验证的最高版本。

  • 稳定标签应表示最新稳定版本的Subversion "标签",或者如果你使用/trunk/作为稳定版本,则使用"trunk"。

    请注意,稳定标签的readme.txt被认为是插件的定义性文件,所以如果/trunk/readme.txt文件表示稳定标签是4.3,那么用于显示插件信息的将是/tags/4.3/readme.txt。在这种情况下,从分支readme.txt中仅考虑稳定标签指针。因此,如果你在分支中开发,你可以更新分支readme.txt以反映你的开发版本中的更改,而无需错误地披露当前稳定版本(它缺少这些更改)的信息--只要分支的readme.txt指向正确的稳定标签。

    如果没有提供稳定标签,则假定分支是稳定的,但你应该指定"trunk",如果你把稳定版本放在那里,以消除任何疑问。

安装

本节描述了如何安装插件并使其工作。

例如:

  1. plugin-name.php上传到/wp-content/plugins/目录
  2. 通过WordPress的"插件"菜单激活插件
  3. 在你的模板中放置<?php do_action('plugin_name_hook'); ?>

常见问题

有人可能会提出的问题

对该问题的回答。

关于foo bar怎么办?

对foo bar困境的回答。

屏幕截图

  1. 此截图描述对应于screenshot-1。(png|jpg|jpeg|gif)。请注意,此截图是从稳定版readme.txt目录中拍摄的,因此在这种情况下,/tags/4.3/screenshot-1.png(或jpg、jpeg、gif)
  2. 这是第二个截图

变更日志

1.0

  • 自上一版本以来的更改。
  • 另一个更改。

0.5

  • 从最新版到最旧版按顺序列出版本。

升级通知

1.0

升级通知描述了用户应该升级的原因。不超过300个字符。

0.5

此版本修复了一个与安全相关的漏洞。请立即升级。

任意部分

您可以提供任意部分,格式与上面相同。这可能对需要传达不符合“描述”或“安装”类别的信息的极其复杂的插件很有用。任意部分将显示在上述内置部分下方。

Markdown简例

有序列表

  1. 一些功能
  2. 另一个功能
  3. 有关插件的其他信息

无序列表

  • 某物
  • 另一物
  • 第三件事

这是WordPress的链接,以及一个指向Markdown语法文档的链接。标题是可选的。

Markdown使用电子邮件风格的符号进行引用块,我被告知

星号用于强调。双重使用它以获得粗体

<?php code(); // 放在反引号中 ?>