X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=doc%2Fplugin.txt;h=1e619385a8ba1d8479a12e0a751c1b3aedeb6b6d;hb=99098885816dd4f87294f9e96783332f262addc2;hp=fd81cd2aad0f44fa9a03b5355d9c6b9bb9f6dbaa;hpb=d7d3c4d435ff1820555e557fcccc9a9d52bf9e93;p=squirrelmail.git diff --git a/doc/plugin.txt b/doc/plugin.txt index fd81cd2a..1e619385 100644 --- a/doc/plugin.txt +++ b/doc/plugin.txt @@ -1,3 +1,14 @@ +$Id$ + +It is best if you check out the SquirrelMail development FAQ for more +information. This document may be obsoleted at some point in the future (or +maybe we'll write a script to get the wiki contents and dump them in here +automatically). + +FAQ -> http://www.squirrelmail.org/wiki/wiki.php?DeveloperFAQ +Plugin Hooks -> http://www.squirrelmail.org/wiki/wiki.php?DevelopingPlugins + + A FEW NOTES ON THE PLUGIN ARCHITECTURE ====================================== @@ -74,52 +85,118 @@ in the plugin directory is requested, it must do a chdir("..") before including any of the standard SquirrelMail files. +Hook Data Passed +---------------- +Hooks, when executed, are called with one parameter, an array of data +that is passed to the hook. The first element in the array is the name +of the hook that is being called. Any other elements in the array are +dependant on the type of hook that is being called. + +Some of the information in the array may be changed. By default, the +plugins should never change data unless it is documented otherwise. + + List of hooks ------------- - generic_header functions/page_header.php - menuline functions/page_header.php - compose_button_row src/compose.php - compose_bottom src/compose.php - left_main_before src/left_main.php - left_main_after src/left_main.php - options_save src/options.php (see note on options) - options_link_and_description src/options.php (see note on options) - options_highlight_bottom src/options_highlight.php - options_personal_bottom src/options_personal.php - options_display_bottom src/options_display.php - options_folders_bottom src/options_folders.php - logout src/signout.php - login_before src/webmail.php - login_verified src/webmail.php - loading_prefs src/load_prefs.php - mailbox_index_before functions/mailbox_display.php - mailbox_index_after functions/mailbox_display.php - right_main_after_header src/right_main.php - right_main_bottom src/right_main.php - login_top src/login.php - login_bottom src/login.php - read_body_top src/read_body.php - read_body_bottom src/read_body.php - search_before_form src/search.php - search_after_form src/search.php - search_bottom src/search.php - help_top src/help.php - help_bottom src/help.php - help_chapter src/help.php - abook_html_search_below src/addrbook_search_html.php + generic_header functions/page_header.php + menuline functions/page_header.php + compose_button_row src/compose.php + compose_bottom src/compose.php + compose_form src/compose.php + compose_send src/compose.php + left_main_before src/left_main.php + left_main_after src/left_main.php + * options_save src/options.php (see note on options) + * options_link_and_description src/options.php (see note on options) + * options_highlight_bottom src/options_highlight.php + * options_personal_bottom src/options_personal.php + * options_personal_inside src/options_personal.php + * options_personal_save src/options_personal.php + * options_display_bottom src/options_display.php + * options_display_inside src/options_display.php + * options_display_save src/options_display.php + * options_folders_bottom src/options_folders.php + * options_folders_inside src/options_folders.php + * options_folders_save src/options_folders.php + & options_identities_process src/options_identities.php + & options_identities_top src/options_identities.php + & options_identities_renumber src/options_identities.php (multiple places) + & options_identities_table src/options_identities.php + & options_identities_buttons src/options_identities.php + logout src/signout.php + logout_above_text src/signout.php + login_before src/webmail.php + login_verified src/webmail.php + loading_prefs src/load_prefs.php + mailbox_index_before functions/mailbox_display.php + mailbox_index_after functions/mailbox_display.php + mailbox_form_before functions/mailbox_display.php + subject_link functions/mailbox_display.php + motd src/right_main.php + right_main_after_header src/right_main.php + right_main_bottom src/right_main.php + login_top src/login.php + login_bottom src/login.php + html_top src/read_body.php + read_body_top src/read_body.php + read_body_bottom src/read_body.php + html_bottom src/read_body.php + read_body_header src/read_body.php + read_body_header_right src/read_body.php + search_before_form src/search.php + search_after_form src/search.php + search_bottom src/search.php + help_top src/help.php + help_bottom src/help.php + help_chapter src/help.php + addrbook_html_search_below src/addrbook_search_html.php + addressbook_bottom src/addressbook.php + ^ attachment $type0/$type1 functions/mime.php (see note on attachments) -Options -------- + +(*) Options +----------- +There are two ways to do options for your plugin. First, you can incorporate it +into an existing section of the preferences (Display, Personal, or Folders). +The second way, you create your own section that they can choose from and it +displays its own range of options. + + +First: Integrating into existing options +----------------------------------------- +There are two hooks you need to use for this one: + +1. options_YOUCHOOSE_inside + This is the code that goes inside the table for the section you choose. Since + it is going inside an existing table, it must be in this form: + ------cut here------- +