Added 'trailing text' for options that SM builds, which is placed after a text input...

[squirrelmail.git] / doc / plugin.txt

diff --git a/doc/plugin.txt b/doc/plugin.txt
index f3308d4891cd2e63e58845aa924deccca42fd29a..938edb21295fadbdfa7d4e045377d3b139484a02 100644 (file)
--- a/doc/plugin.txt
+++ b/doc/plugin.txt
@@ -308,10 +308,8 @@ but may be out of date soon thereafter.  You never know.  ;-)
   read_body_menu_top             src/read_body.php               hook_func
   read_body_menu_bottom          src/read_body.php               do_hook
   read_body_header_right         src/read_body.php               do_hook
-  html_top                       src/read_body.php               do_hook
   read_body_top                  src/read_body.php               do_hook
   read_body_bottom               src/read_body.php               do_hook
-  html_bottom                    src/read_body.php               do_hook
   login_before                   src/redirect.php                do_hook
   login_verified                 src/redirect.php                do_hook
   generic_header                 src/right_main.php              do_hook
@@ -324,12 +322,14 @@ but may be out of date soon thereafter.  You never know.  ;-)
   webmail_top                    src/webmail.php                 do_hook
   webmail_bottom                 src/webmail.php                 concat_hook
   logout_above_text              src/signout.php                 concat_hook
+  O info_bottom                  plugins/info/options.php        do_hook
    
 % = This hook is used in multiple places in the given file
 # = Called with hook type (see below)
 & = Special identity hooks (see below)
 ^ = Special attachments hook (see below)
 * = Special options hooks (see below)
+O = optional hook used by plugin
 
 
 (#) Called With
@@ -598,6 +598,9 @@ for you.  This is the preferred method of building options lists going forward.
                         setting in the user's preferences
          caption        The text that prefaces this setting on the preferences
                         page
+         trailing_text  Text that follows a text input or select list input on
+                        the preferences page (useful for indicating units,
+                        meanings of special values, etc.)
          type           The type of INPUT element, which should be one of:
                            SMOPT_TYPE_STRING     String/text input
                            SMOPT_TYPE_STRLIST    Select list input