User Tools

  • Logged in as: anonymous (anonymous)
  • Log Out

Site Tools


mantisbt:plugins_overview

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
mantisbt:plugins_overview [2008/02/08 11:45]
jreese
mantisbt:plugins_overview [2011/12/30 10:35] (current)
tandler
Line 91: Line 91:
   * ''​version''​ - Your plugin'​s version string. ​ **Required value.**   * ''​version''​ - Your plugin'​s version string. ​ **Required value.**
   * ''​requires''​ - An array of key/value pairs of basename/​version plugin dependencies. ​ Prefixing a version with '''<'''​ will allow your plugin to specify a maximum version (non-inclusive) for a dependency.   * ''​requires''​ - An array of key/value pairs of basename/​version plugin dependencies. ​ Prefixing a version with '''<'''​ will allow your plugin to specify a maximum version (non-inclusive) for a dependency.
 +  * ''​uses''​ - Similar to '​requires',​ but soft dependencies;​ only fails if the soft dependency is registered, but not yet initialized
   * ''​author''​ - Your name, or an array of names.   * ''​author''​ - Your name, or an array of names.
   * ''​contact''​ - An email address where you can be contacted.   * ''​contact''​ - An email address where you can be contacted.
Line 381: Line 382:
  
 This callback is executed after the normal uninstallation process, and should handle such operations as reverting database schemas, removing unnecessary data, etc.  This callback should be used only if Mantis would break when this plugin is uninstalled without any other actions taken, as users may not want to lose data, or be able to re-install the plugin later. This callback is executed after the normal uninstallation process, and should handle such operations as reverting database schemas, removing unnecessary data, etc.  This callback should be used only if Mantis would break when this plugin is uninstalled without any other actions taken, as users may not want to lose data, or be able to re-install the plugin later.
- 
- 
- 
-===== THIS DOES NOT BELONG HERE ===== 
- 
-====== Plugin Events Reference ====== 
- 
-This document is a reference for all events declared by the core Mantis plugin API.  It should contain the event name, type, a description of where and when it is triggered, and any special parameters it may expect to receive. 
- 
-**//​NOTE: ​ The event list has not yet been finalized. ​ You should not rely on this reference until events have been fully implemented.//​** 
- 
-===== Plugin API Events ===== 
- 
-  * **''​EVENT_PLUGIN_INIT''​** ( Execute ) - This event is triggered by the Mantis core immediately after all plugins have been registered. ​ All of the core API's will have already been loaded. ​ It should **always** be the first event triggered for any page load.  This event should be used for setting up configuration variables or any other per-instance setting. 
- 
-===== Output Modifying Events ===== 
- 
- 
-==== Layout Events ==== 
- 
-These events will be called on every page load, and are defined with relation to the overall style and layout of Mantis. They allow plugins to add content to the overall Mantis layout and theme. 
- 
-  * **''​EVENT_LAYOUT_RESOURCES''​** ( Output ) - This event is triggered before the end of the ''<​head>''​ tag, after the standard Javascript and CSS resources have been included. ​ This should be used for linking to plugin-specific Javascript or CSS resources. 
-  * **''​EVENT_LAYOUT_PAGE_HEADER''​** ( Output ) - This event is triggered after the site title and Mantis logo have been displayed, but before the login information and menu. 
-  * **''​EVENT_LAYOUT_CONTENT_BEGIN''​** ( Output ) - This event is triggered after the Mantis menu has been displayed, at the beginning of the content section. 
-  * **''​EVENT_LAYOUT_CONTENT_END''​** ( Output ) - This event is triggered after the content section has been displayed, but before the footer section. 
-  * **''​EVENT_LAYOUT_PAGE_FOOTER''​** ( Output ) - This event is triggered after the normal Mantis footer has been displayed, and any output from this event should be the last elements displayed on the page. 
- 
- 
-==== Display Events ==== 
- 
-These events are called whenever certain content is displayed, allowing plugins to modify the displayed content for formatting or other reasons. 
- 
-  * **''​EVENT_DISPLAY_TEXT''​** ( Chain ) 
-  * **''​EVENT_DISPLAY_FORMATTED''​** ( Chain ) 
-  * **''​EVENT_DISPLAY_RSS''​** ( Chain ) 
- 
-===== Content Adding Events ===== 
- 
-==== Menu Events ==== 
- 
-These events allow plugins to hook menu events in order to add new menu items in various places. 
- 
-  * **''​EVENT_MENU_MAIN''​** ( Default ) 
-  * **''​EVENT_MENU_MANAGE''​** ( Default ) 
-  * **''​EVENT_MENU_MANAGE_CONFIG''​** ( Default ) 
-  * **''​EVENT_MENU_SUMMARY''​** ( Default ) 
-  * **''​EVENT_MENU_DOCS''​** ( Default ) 
-  * **''​EVENT_MENU_ACCOUNT''​** ( Default ) 
- 
-==== View Events ==== 
- 
-These events allow plugins to add new content to individual view pages in various locations.  ​ 
- 
-  * **''​EVENT_VIEW_BUG_AFTER_DETAILS''​** ( Output ) 
-  * **''​EVENT_VIEW_BUG_AFTER_RELATIONSHIP''​** ( Output ) 
-  * **''​EVENT_VIEW_BUG_AFTER_UPLOAD''​** ( Output ) 
-  * **''​EVENT_VIEW_BUG_AFTER_USERS''​** ( Output ) 
-  * **''​EVENT_VIEW_BUG_AFTER_NOTES''​** ( Output ) 
- 
-==== Update Events ==== 
- 
-These events allow plugins to add new forms or form elements to an update page in various locations. 
- 
-  * **''​EVENT_UPDATE_BUG_AFTER_DETAILS''​** ( Output ) 
-  * **''​EVENT_UPDATE_BUG_AFTER_FORM''​** ( Output ) 
-  * **''​EVENT_UPDATE_BUG_AFTER_NOTES''​** ( Output ) 
- 
-==== Form Events ==== 
- 
-These events allow plugins to process form data submitted from update pages. 
- 
-  * **''​EVENT_FORM_BUG_BEFORE''​** ( Execute ) 
-  * **''​EVENT_FORM_BUG_AFTER''​** ( Execute ) 
- 
-===== Other ===== 
- 
-==== Filter Events ==== 
- 
-  * **''​EVENT_FILTER_MY_VIEW''​** ( Chain ) - This event allows plugins to modify the list of filters shown by the My View page. 
-  * **''​EVENT_FILTER_QUERY''​** ( Chain ) - This event allows plugins to modify the database query used for bugs matching a filter. 
- 
-==== Bug Events ==== 
- 
-  * **''​EVENT_BUG_REPORTED''​** ( Execute ) - Triggered when a new bug has been reported. 
-  * **''​EVENT_BUG_UPDATED''​** ( Execute ) - Triggered when a bug has been updated. 
-  * **''​EVENT_BUG_RESOLVED''​** ( Execute ) - Triggered when a bug is resolved. 
-  * **''​EVENT_BUG_CLOSED''​** ( Execute ) - Triggered when a bug has been closed 
-  * **''​EVENT_BUG_NOTE_ADDED''​** ( Execute ) - Triggered when a bugnote has been added to a bug.  //Is this superfluous because of EVENT_BUG_UPDATED?//​ 
- 
  
mantisbt/plugins_overview.1202489115.txt.gz ยท Last modified: 2008/10/29 04:31 (external edit)