Product SiteDocumentation Site

MantisBT 2.0

Developers Guide

Reference for developers and community members

MantisBT Development Team


Legal Notice

Copyright © 2016 MantisBT team. This material may only be distributed subject to the terms and conditions set forth in the GNU Free Documentation License (GFDL), V1.2 or later (the latest version is presently available at http://www.gnu.org/licenses/fdl.txt).
Abstract
This book is targeted at MantisBT developers, contributors and plugin authors. It documents the development process and provides reference information regarding the MantisBT core, including the database schema as well as the plugin system including an events reference.

1. Contributing to MantisBT
1.1. Initial Setup
1.2. Cloning the Repository
1.2.1. Determining the Clone URL
1.2.2. Initializing the Clone
1.2.3. Adding remotes
1.2.4. Checking out branches
1.3. Maintaining Tracking Branches
1.4. Preparing Feature Branches
1.4.1. Private Branches
1.4.2. Public Branches
1.5. Running PHPUnit tests
1.5.1. Running the SOAP tests
1.6. Submitting Changes
1.6.1. Before you submit
1.6.2. Submission Via Github Pull Requests
1.6.3. Submission Via Formatted Patches
1.6.4. Submission Via Public Repository
2. Database Schema Management
2.1. The MantisBT schema
2.2. Schema Definition
2.3. Installation / Upgrade Process
3. Event System
3.1. General Concepts
3.2. API Usage
3.3. Event Types
4. Plugin System
4.1. General Concepts
4.2. Building a Plugin
4.2.1. Plugin Structure
4.2.2. Properties
4.2.3. Pages and Files
4.2.4. Events
4.2.5. Configuration
4.2.6. Language and Localization
4.3. Example Plugin Source Listing
4.3.1. Example/Example.php
4.3.2. Example/files/foo.css
4.3.3. Example/lang/strings_english.txt
4.3.4. Example/page/config_page.php
4.3.5. Example/pages/config_update.php
4.3.6. Example/page/foo.php
4.4. API Usage
5. Events Reference
5.1. Introduction
5.2. System Events
5.3. Output Modifier Events
5.3.1. String Display
5.3.2. Menu Items
5.3.3. Page Layout
5.4. Bug Filter Events
5.4.1. Custom Filters and Columns
5.5. Bug and Bugnote Events
5.5.1. Bug View
5.5.2. Bug Actions
5.5.3. Bugnote View
5.5.4. Bugnote Actions
5.6. Notification Events
5.6.1. Recipient Selection
5.7. User Account Events
5.7.1. Account Preferences
5.8. Management Events
5.8.1. Projects and Versions
6. Integrating with MantisBT
6.1. Java integration
6.1.1. Prebuilt SOAP stubs using Axis
6.1.2. Usage in OSGi environments
6.2. Compatibility between releases
6.3. Support
7. Appendix
7.1. Git References
A. Revision History