skypress / wp-readme-parser
WordPress 插件 Readme 解析器
Requires
- php: ^7.0
This package is auto-updated.
Last update: 2024-09-29 05:55:30 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
(或 jpg,jpeg,gif)来显示有关插件的信息。在这种情况下,从分支readme.txt
考虑的唯一内容是稳定标签指针。因此,如果您在分支中开发,您可以更新分支readme.txt
以反映您的开发版本中的更改,而无需错误地披露有关当前稳定版本的更改信息——只要分支的readme.txt
指向正确的稳定标签。如果没有提供稳定标签,则假定分支是稳定的,但您应该指定 "trunk",如果您将稳定版本放在那里,以消除任何疑问。
安装
本节描述了如何安装插件并使其工作。
例如。
- 将
plugin-name.php
上传到/wp-content/plugins/
目录 - 通过 WordPress 中的 "插件" 菜单激活插件
- 在您的模板中放置
<?php do_action('plugin_name_hook'); ?>
常见问题解答
某人可能会有的问题。
对该问题的回答。
关于 foo bar 呢?
foo bar 困境的答案。
屏幕截图
- 此屏幕截图描述对应于 screenshot-1.(png|jpg|jpeg|gif)。请注意,屏幕截图是从稳定 readme.txt 的目录中拍摄的,因此在这种情况下,
/tags/4.3/screenshot-1.png
(或 jpg,jpeg,gif) - 这是第二个屏幕截图
变更日志
1.0
- 自上一个版本以来的更改。
- 另一个更改。
0.5
- 从最新版本列表顶部到底部列出旧版本。
升级通知
1.0
升级通知描述了用户应升级的原因。不超过300个字符。
0.5
此版本修复了一个安全相关的问题。请立即升级。
任意部分
您可以提供任意章节,格式与上面相同。这可能在需要传达更多不适用于“描述”或“安装”类别的信息的非常复杂的插件中很有用。任意章节将显示在上述内置章节下方。
Markdown简例
有序列表
- 一些功能
- 另一个功能
- 关于该插件的其他事项
无序列表
- 某物
- 另一物
- 第三件事
这里是到WordPress的链接,以及到Markdown语法文档的链接。标题是可选的。
Markdown使用电子邮件风格的符号用于引用块,我被告知
星号用于强调。双重星号用于加粗。
<?php code(); // 放入反引号 ?>