From 97ca984f6022b42f5b8f71824b881a9aa7a8dbd6 Mon Sep 17 00:00:00 2001 From: kink Date: Mon, 28 Jan 2002 17:46:07 +0000 Subject: [PATCH] Misc fixes git-svn-id: https://svn.code.sf.net/p/squirrelmail/code/trunk/squirrelmail@2262 7612ce4b-ef26-0410-bec9-ea0150e637f0 --- doc/README.russian_apache | 2 +- doc/mime.txt | 2 +- doc/plugin.txt | 30 +++++++++++--------------- doc/themes.txt | 44 +++++++++++++++++++-------------------- 4 files changed, 36 insertions(+), 42 deletions(-) diff --git a/doc/README.russian_apache b/doc/README.russian_apache index 926bb88c..0898ce69 100644 --- a/doc/README.russian_apache +++ b/doc/README.russian_apache @@ -23,7 +23,7 @@ This is the best solution so far -- others involve so many steps that they are no longer viable. If you have any questions or problems, please address them to -the squirrelmail-list@lists.sourceforge.net to have them +the squirrelmail-users@lists.sourceforge.net to have them promptly answered. ;) -- diff --git a/doc/mime.txt b/doc/mime.txt index 7c5d316a..f5b73954 100644 --- a/doc/mime.txt +++ b/doc/mime.txt @@ -105,4 +105,4 @@ The code in mime.php is pretty well documented, so you might want to poke around there as well to find out more details of how this works. If you have questions about this, please direct them to our mailing list: -squirrelmail-list@sourceforge.net +squirrelmail-users@sourceforge.net diff --git a/doc/plugin.txt b/doc/plugin.txt index 1e619385..dbd6ab52 100644 --- a/doc/plugin.txt +++ b/doc/plugin.txt @@ -12,16 +12,10 @@ Plugin Hooks -> http://www.squirrelmail.org/wiki/wiki.php?DevelopingPlugins A FEW NOTES ON THE PLUGIN ARCHITECTURE ====================================== -The plugin architecture of SquirrelMail is designed to make it -possible to add new features without having to patch SquirrelMail -itself. At the moment the plugin part of SquirrelMail should be -considered "alpha" or "beta" quality code. - -Until the functionality and code is more stable, be prepared for -plugins to suddenly stop working. - -Functionality like password changing, displaying ads and calendars -should be possible to add as plugins. +The plugin architecture of SquirrelMail is designed to make it possible to +add new features without having to patch SquirrelMail itself. Functionality +like password changing, displaying ads and calendars should be possible to +add as plugins. The idea @@ -45,9 +39,9 @@ The implementation In the main SquirrelMail files the file functions/plugin.php. In places where hooks are made available they are executed by calling the -function do_hook("hookname"). +function do_hook('hookname'). -The do_hook traverses the array $squirrelmail_plugin_hooks["hookname"] +The do_hook traverses the array $squirrelmail_plugin_hooks['hookname'] and executes all the functions that are named in that array. A plugin must reside in a subdirectory in the plugins/ directory. The @@ -56,7 +50,7 @@ name of the subdirectory is considered the name of the plugin. To start using a plugin, its name must be added to the $plugins array in config.php like this: - $plugins[0] = "plugin_name"; + $plugins[0] = 'plugin_name'; When a plugin is registered the file plugins/plugin_name/setup.php is included and the function squirrelmail_plugin_init_plugin_name is @@ -75,13 +69,13 @@ initalize a plugin. This function could look something like this: function squirrelmail_plugin_init_demo () { global $squirrelmail_plugin_hooks; - $squirrelmail_plugin_hooks["generic_header"]["demo"] = "plugin_demo_header"; - $squirrelmail_plugin_hooks["menuline"]["demo"] = "plugin_demo_menuline"; + $squirrelmail_plugin_hooks['generic_header']['demo'] = 'plugin_demo_header'; + $squirrelmail_plugin_hooks['menuline']['demo'] = 'plugin_demo_menuline'; } Note that the SquirrelMail files assume that all other SquirrelMail files are available as ../directory/file. This means that if some file -in the plugin directory is requested, it must do a chdir("..") before +in the plugin directory is requested, it must do a chdir('..') before including any of the standard SquirrelMail files. @@ -201,12 +195,12 @@ three hooks you will need to use. ?> - - diff --git a/doc/themes.txt b/doc/themes.txt index 69b5598c..deaa2776 100644 --- a/doc/themes.txt +++ b/doc/themes.txt @@ -8,28 +8,28 @@ description of what the different entries are for. ------ ------ @@ -51,7 +51,7 @@ b 9: Darker version of #0 b 10: Darker version of #9 f 11: Special folders color [Inbox, Trash, Sent] b 12: Alternate color for message list [alters between 4 and this one] -f 13: Color for single-quoted text ("> text") when reading (default: #800000) +f 13: Color for single-quoted text ('> text') when reading (default: #800000) f 14: Color for text with more than one quote (default: #FF0000) f 15: Non-selectable folders in the left frame (defaults to $color[6]) -- 2.25.1
+ YOUR OPTIONS NAME
+ YOUR DESCRIPTION