alieninternet/ais_txpplugin_packager

Textpattern 插件打包工具

dev-main 2024-02-16 23:26 UTC

This package is auto-updated.

Last update: 2024-09-17 00:46:52 UTC


README

此工具将生成一个打包、gzip 压缩、base64 编码的插件包,类似于 zem_tpl 和其他工具提供的包,兼容 Textpattern 4.8.x。

这既不是 Textpattern 的插件,也不是构建插件的模板。相反,其目的是允许使用独立的包文件而不是单个文件来开发 Textpattern 插件,例如 zem 插件模板风格。

原因在于,单一文件不适合版本控制,这使得与不同文件类型一起工作变得困难,并增加了复杂插件的维护复杂度。

如何使用

  1. 为插件创建一个文件夹,具有以下文件结构
    plugin_name/
        plugin_name.php       - Your plugin code (required)
        manifest.json         - Plugin manifest file (required)
        textpack.txp          - Textpack file (optional)
        help.textile          - Textile formatted help (optional, recommended)
        help.help             - HTML formatted help (optional)
        data.txp              - Included resources (optional)
  1. 编写您的插件!

  2. 执行打包工具,指定插件路径;它将输出一个适当编码的文本文件,基于清单中的插件名称和版本。如果需要,您可以指定输出文件名和位置

   php ais_txpplugin_packager.php <plugin_path> [<output_file>]

例如

   php ais_txpplugin_packager.php /var/www/txp/sites/dev/admin/plugins/xxx_plugin_name
  1. 在测试环境中测试您的包,以确保它可以正确打包和解包

  2. 发布您的插件!