编辑“ZenTaoPMS/打包规范1.0版”

{{ZenTaoPMS top}}

为了让大家更好的管理使用[[插件]]，整理了[[禅道]]项目管理[[软件]]打包规范。需要说明的是，这个规范需要不断地来完善，使用过程中可能会有些不足。

==可以扩展的元素==

[[文件:ZenTaoPMS33.jpg]]

==doc目录应当包含的文档==

*doc目录下面应当包含下面的文档：
<pre>
    changelog.txt 修改记录文档。
    copyright.txt  版权说明文档。
    install.txt       安装文档，用来手工安装使用。
    license.txt     授权协议。  
    readme.txt    插件的介绍。
</pre>

*其中copyright.txt以ini格式存储，采用key=valuye的形式。
<pre>
    name=插件的名称，比如hello world extension.
    code=插件的英文名，英文字母和数字的组合。比如叫做hello
    version=插件的版本号。比如1.0
    author=插件的作者，可以是多个，比如wwccss, wwccss2
    site=插件的官方网站，比如http://www.zentao.net
    zentaoversion=适用的禅道版本，比如：1.2,1.3,1.4,1.5
    desc=插件的描述信息，注意只能一行。
</pre>

==db目录下面包含的文件==

*db目录下面可以包含install.[[sql]]和uninstall.sql。顾名思义,install.sql是当安装插件的时候执行的sql语句

*而uninstall.sql则是当卸载插件的时候需要执行的sql语句。这样如果你的插件涉及到[[数据库]]的改动，可以将相应的sql语句放在这两个文件中，禅道的插件管理程序会自动来执行。

==module下面的文件==

module目录下面的文件，就按照我们的插件扩展机制 部署相应的目录结构就可以了。

==小结：创建自己的插件==

*确定插件的英文名，比如叫做hello。
*创建hello目录。
*在hello目录下面创建doc目录。
*在doc目录下面创建copyright.txt文件：
<pre>
    name=hello
    code=hello
    version=1.0
    author=my name
    site=http://www.google.com
    zentaoversion=1.1,1.2,1.3,1.4
    desc=This is a extension of zentao.  
</pre>
*在doc目录下面创建其他的文件：readme.txt, changelog.txt, license.txt, readme.txt（可选）
*如果有涉及到[[数据库]]的改动，在hello目录下面创建db目录，分别写好install.sql和uninstall.sql
*然后部署相应的扩展代码。在hello目录下面创建一个module目录，然后将相应的模块扩展代码放在module下面。
*打包，使用[[zip]]格式将整个hello目录打包成hello.zip，就可以了。

==参考来源==
*http://www.zentao.net/help-book-zentaopmshelp.html

[[category:ZenTaoPMS|Z]]

{{ZenTaoPMS}}