我们在《JPWRT插件开发基础》一文里面使用系统自带的一个插件“notice”来介绍了JPWRT插件开发的一些基础知识,我们也提到了插件目录里面的“readme.txt”文件是该插件的说明文件,这一篇我们来详细介绍这个说明文件。
从前面的教程里面我们知道,“readme.txt”文件是存放在插件目录里面的,如下图所示:
上面的图示,我们还是使用“notice”插件来进行说明,我们打开这个说明文件“readme.txt”,可以看到如下的内容:
Plugin Name: Notice
Plugin URL: http://www.jpwrt.com/plugins/notice/
Author: Alfred Johnson
Author URL: http://www.jpwrt.com/
Description: You can display a notice at the top of the homepage.
Requires at least: 1.0.0
Requires PHP: 5.6
Version: 1.0
License: Apache-2.0
License URL: http://www.apache.org/licenses/LICENSE-2.0
Text Domain: jpwrt
Tags: notice, homepage
以上的内容是完全照抄“notice”插件的说明文件的,下面我们对每个项进行介绍。看下面的说明:
Plugin Name: 插件名
Plugin URL: 插件地址
Author: 作者
Author URL: 作者网址
Description: 插件描述
Requires at least: 要求的最低JPWRT版本
Requires PHP: 要求的最低PHP版本
Version: 插件版本
License: 使用的许可
License URL: 许可网址
Text Domain: 文本域
Tags: 描述这个插件的标签
通过上面的说明文字,您应该很清楚了,插件的说明内容的格式就是像上面这样的。
说明里面每一行的冒号前面部分的英文字符必须照抄原样的,冒号后面的详细内容您根据实际情况填写。
这里说明一下,插件名、插件的描述以及标签是支持多语言的,也就是说,您可以使用插件的语言包来实现多语言。