From 32f6202e560b8842ead3f787ffdbe209da5468bc Mon Sep 17 00:00:00 2001 From: tonio Date: Wed, 19 Jan 2011 15:05:03 +0100 Subject: [PATCH] Documentation update: simpler introduction. --- doc/plugin_api.rst | 25 +++++++------------------ 1 file changed, 7 insertions(+), 18 deletions(-) diff --git a/doc/plugin_api.rst b/doc/plugin_api.rst index 197a39e5f..bea9c69d5 100644 --- a/doc/plugin_api.rst +++ b/doc/plugin_api.rst @@ -4,26 +4,15 @@ Extending Modoboa Introduction ------------ -Modoboa tries to be modular. In other words, Modoboa is a collection -of different applications that work with each other, sharing the same -interface. For now, you can see Modoboa as a placeholder for your -plugin. +Modoboa offers a plugin API to expand its capabilities. The current +implementation provides the following possibilities: -In a perfect world, adding a feature to Modoboa results in adding a -new plugin. This is currently the case (almost...) and should continue -like this. + * Expand navigation by adding entry points to your plugin inside the GUI + * Access and modify administrative objects (domains, mailboxes, etc.) + * Register callback actions for specific events -The current API is really simple. You have the possibility to: - * Create entry points to your plugin inside the GUI, - * Modify administration objects (domains, mailboxes, etc.), - * Be notified of specific events. - -With that, you can develop pretty advanced applications but we know -(Modoboa's team) it is not enough. For example, you can't create a -*Contacts* plugin that will work with the *Webmail* one. - -The API needs to be improved and it will be done with future releases -so stay tuned :-). +The following subsections describe plugin architecture and explain +how you can create your own plugin. How Modoboa and plugins communicate together --------------------------------------------