1. ZenTao API development guides
- 1.1 Configuration and FAQ
- 1.2 Examples of the calling SDK
- 1.3. Department interface
- 1.4. User interface
- 1.5. Product interface
- 1.6. Project interface
- 1.7. Task interface
- 1.8. Bug interface
2. ZenTao API documents (V1.0)
- 2.1.1 Get Token
- 2.2. Department
- 2.3. User
- 2.4. Program
- 2.5. Product
2.6. Product plan
- 2.6.1 Get the list of product plans
- 2.6.2 Create plans
- 2.6.3 Get plan details
- 2.6.4 Edit plans
- 2.6.5 Delete plans
- 2.6.6 Link the stories to the product plan
- 2.6.7 Cancel the link between the product plans and stories
- 2.6.8 Link the bugs to the product plan
- 2.6.9 Cancel the link between the product plan and bugs
- 2.7. Release
- 2.8. Story
- 2.9. Project
- 2.10. Build
- 2.11. Execution
- 2.12. Task
- 2.13. Bug
- 2.14. Use case
- 2.15. Test request
- 2.16. Feedback
- 2.1. Token
3. Customized development
- 3.1 Secondary development mechanism
- 3.2 The directory structure of ZenTao
- 3.3 Find your target file to be modified
- 3.4 The database structure of ZenTao
- 3.5 Public module - common
- 3.6 How to register on menu
- 3.7 How to register on permission
- 3.8 Example: how to modify the prompt
- 3.9 Example: priority field setting when creating bugs
- 3.10 The online extension editor
- 3.11 Secondary development editor and translation function restrictions instructions
- 3.12 ZenTao project management software packaging specification (V1.1)
In the secondary development process, good functions can be packaged into plug-ins and shared with everyone. We have sorted out the ZenTao project management software packaging specifications.
1. Expandable elements
|bin||For example, the new command line script program.|
|config||For example, configuration files can be changed.|
|db||The install.sql and uninstall.sql can be stored under the db directory, corresponding to the sql scripts that need to be executed during installation and the sql scripts that need to be executed during uninstallation, respectively.|
|doc||Documentation related to this plugin.|
|lib||It is possible to add a new class or make changes to an existing class.|
|module||It is possible to add a new module or to extend the functionality of an existing module.|
|www||It is possible to publish your own style. Changes can also be made to the js file.|
2. The documents should be in doc Directory
The doc directory contains the configuration information of the plug-in, which is stored according to the language. For example, the English version is saved as en.yaml, and the Chinese zh-cn.yaml
The configuration file of the plug-in adopts yaml format, which contains the basic information of the plug-in and the release information of previous versions.
3. The files under the db directory
The db directory can contain install.sql and uninstall.sql. As the name implies, install.sql is the sql statement to be executed when the plugin is installed, and uninstall.sql is the sql statement to be executed when the plugin is uninstalled. In this way, if your plug-in involves changes to the database, you can put the corresponding sql statement in these two files, and ZenTao's plug-in management program will automatically execute it.
4. The files under module
For the files under the module directory, just deploy the corresponding directory structure according to our plug-in extension mechanism.
5. Extension of the main configuration file
In the actual process, it may be necessary to expand the global configuration file. In this case, the extended configuration file can be placed under zentao/config/ext/.
6. Install and delete hooks
If you need to perform some operations before installation, after installation, before uninstallation, or after uninstallation, you can create a hook directory, and then create preinstall.php, postinstall.php, preuninstall.php, postuninstall.php in it, and put your Just the code you need.
7. Summary: Create your own plug-in
- Determine the English name of the plug-in, such as hello.
- Create the hello directory.
- Create a doc directory under the hello directory.
- Create a configuration file - yaml file under the doc directory.
- If there are changes involving the database, create a db directory under the hello directory, and write install.sql and uninstall.sql respectively.
- If you need hook scripts, create a hook directory and create preinstall.php, postinstall.php, preuninstall.php, postuninstall.php.
- Then deploy the corresponding extension code. Create a module directory under the hello directory, and then put the corresponding module extension code under the module.
- Packaging. Using the zip format to package the entire hello directory into hello.zip, and that's it.