如何使用插件提交文档

时间：2014-01-03 作者：Thought Space Designs

当我向wordpress public repo提交插件时，我应该如何提交文档？什么是标准或良好实践？我是应该在be页面上有插件镜像的所有文档，还是应该包括各种自述文件？我知道在提交给CodeCanyon时，使用插件打包文档是标准的，但只要不使用付费软件就可以查看文件格式，那么使用什么文件格式并不是特别重要。然而，我不知道提交公共回购协议的标准是什么。有人吗？

1 个回复
SO网友:grappler

这是我最流行的插件。Flowplayer HTML5 for WordPress

我确实试着仔细考虑了我的文档等。所有文档都应该在自述中。txt。这是添加到WordPress的最佳位置。org，便于访问。你可以用这个link to validate 您的自述。

并非所有插件都需要任何文档，所以它不是必须的，但可以让用户更容易使用。

另一种方法是在自述文件中添加指向站点的链接，其中包含文档。Polylang 这样做。

您可以更新自述文件。txt，无需更改插件版本，因此更新自述文件中的文档不会比在您的网站上更困难。

下面是WordPress.org guidelines.

结束
标签： plugins   plugin-development   documentation   小码农  

相关推荐

private functions in plugins

我开发了两个插件，其中一个功能相同（相同的名称，相同的功能）。当试图激活两个插件时，Wordpress会抛出一个错误，因为它不允许我以相同的名称定义函数两次。有没有一种方法可以使这个函数只对插件私有，而不使用面向对象编程，也不简单地重命名函数？我不想使用OOP，因为我首先要学习它。此外，我不想重命名该函数，因为我可能也想在其他插件中使用它，而重命名感觉不太合适。