Formatting and minor wording fix

[squirrelmail.git] / doc / plugin.txt

diff --git a/doc/plugin.txt b/doc/plugin.txt
index 5aa907a8c074a0fbb3659a9730cef999e5a4a35c..ebfd5eae59d793b87304cdd21facf2fcd59b1699 100644 (file)
--- a/doc/plugin.txt
+++ b/doc/plugin.txt
@@ -188,7 +188,7 @@ version is not listed, files are included from v.1.3.2.):
       9.2. $prefs_backend (from 1.4.3rc1 and 1.5.0)
            functions/db_prefs.php
            functions/file_prefs.php
-         9.2.1. functions/display_messages.php 
+         9.2.1. functions/display_messages.php
                 (loaded only by file_prefs.php)
 
 Hook Types:  Parameters and Return Values
@@ -280,7 +280,7 @@ but may be out of date soon thereafter.  You never know.  ;-)
   get_pref_override              functions/file_prefs.php        hook_func
   get_pref                       functions/file_prefs.php        hook_func
   special_mailbox                functions/imap_mailbox.php      hook_func
-  % rename_or_delete_folder      functions/imap_mailbox.php      hook_func
+% rename_or_delete_folder        functions/imap_mailbox.php      hook_func
   mailbox_index_before           functions/mailbox_display.php   do_hook
   mailbox_form_before            functions/mailbox_display.php   do_hook
   mailbox_index_after            functions/mailbox_display.php   do_hook
@@ -289,12 +289,12 @@ but may be out of date soon thereafter.  You never know.  ;-)
   mailbox_display_buttons        functions/mailbox_display.php   do_hook
   mailbox_display_button_action  functions/mailbox_display.php   hook_func
   message_body                   functions/mime.php              do_hook
-  ^ attachment $type0/$type1     functions/mime.php              do_hook
+^ attachment $type0/$type1       functions/mime.php              do_hook
   attachments_bottom             functions/mime.php              hook_func
   decode_body                    functions/mime.php              hook_func
   generic_header                 functions/page_header.php       do_hook
   menuline                       functions/page_header.php       do_hook
-  internal_link                  functions/page_header.php       hook_func
+  prefs_backend                  functions/prefs.php             hook_func
   loading_prefs                  include/load_prefs.php          do_hook
   addrbook_html_search_below     src/addrbook_search_html.php    do_hook
   addressbook_bottom             src/addressbook.php             do_hook
@@ -313,34 +313,34 @@ but may be out of date soon thereafter.  You never know.  ;-)
   login_top                      src/login.php                   do_hook
   login_form                     src/login.php                   do_hook
   login_bottom                   src/login.php                   do_hook
-  * optpage_set_loadinfo         src/options.php                 do_hook
-  * optpage_loadhook_personal    src/options.php                 do_hook
-  * optpage_loadhook_display     src/options.php                 do_hook
-  * optpage_loadhook_highlight   src/options.php                 do_hook
-  * optpage_loadhook_folder      src/options.php                 do_hook
-  * optpage_loadhook_order       src/options.php                 do_hook
-  * options_personal_save        src/options.php                 do_hook
-  * options_display_save         src/options.php                 do_hook
-  * options_folder_save          src/options.php                 do_hook
-  * options_save                 src/options.php                 do_hook
-  * optpage_register_block       src/options.php                 do_hook
-  * options_link_and_description src/options.php                 do_hook
-  * options_personal_inside      src/options.php                 do_hook
-  * options_display_inside       src/options.php                 do_hook
-  * options_highlight_inside     src/options.php                 do_hook
-  * options_folder_inside        src/options.php                 do_hook
-  * options_order_inside         src/options.php                 do_hook
-  * options_personal_bottom      src/options.php                 do_hook
-  * options_display_bottom       src/options.php                 do_hook
-  * options_highlight_bottom     src/options.php                 do_hook
-  * options_folder_bottom        src/options.php                 do_hook
-  * options_order_bottom         src/options.php                 do_hook
-  * options_highlight_bottom     src/options_highlight.php       do_hook
-  & options_identities_process   src/options_identities.php      do_hook
-  & options_identities_top       src/options_identities.php      do_hook
-  &% options_identities_renumber src/options_identities.php      do_hook
-  & options_identities_table     src/options_identities.php      concat_hook
-  & options_identities_buttons   src/options_identities.php      concat_hook
+* optpage_set_loadinfo           src/options.php                 do_hook
+* optpage_loadhook_personal      src/options.php                 do_hook
+* optpage_loadhook_display       src/options.php                 do_hook
+* optpage_loadhook_highlight     src/options.php                 do_hook
+* optpage_loadhook_folder        src/options.php                 do_hook
+* optpage_loadhook_order         src/options.php                 do_hook
+* options_personal_save          src/options.php                 do_hook
+* options_display_save           src/options.php                 do_hook
+* options_folder_save            src/options.php                 do_hook
+* options_save                   src/options.php                 do_hook
+* optpage_register_block         src/options.php                 do_hook
+* options_link_and_description   src/options.php                 do_hook
+* options_personal_inside        src/options.php                 do_hook
+* options_display_inside         src/options.php                 do_hook
+* options_highlight_inside       src/options.php                 do_hook
+* options_folder_inside          src/options.php                 do_hook
+* options_order_inside           src/options.php                 do_hook
+* options_personal_bottom        src/options.php                 do_hook
+* options_display_bottom         src/options.php                 do_hook
+* options_highlight_bottom       src/options.php                 do_hook
+* options_folder_bottom          src/options.php                 do_hook
+* options_order_bottom           src/options.php                 do_hook
+* options_highlight_bottom       src/options_highlight.php       do_hook
+& options_identities_process     src/options_identities.php      do_hook
+& options_identities_top         src/options_identities.php      do_hook
+&% options_identities_renumber   src/options_identities.php      do_hook
+& options_identities_table       src/options_identities.php      concat_hook
+& options_identities_buttons     src/options_identities.php      concat_hook
   message_body                   src/printer_friendly_bottom.php do_hook
   read_body_header               src/read_body.php               do_hook
   read_body_menu_top             src/read_body.php               hook_func
@@ -360,14 +360,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
+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
+O = Optional hook provided by a particular plugin
 
 
 (#) Called With
@@ -1139,7 +1139,7 @@ files.
 
       You should change the header to look something more like:
 
-         # Copyright (c) 1999-2003 The Squirrelmail Development Team
+         # Copyright (c) 1999-2005 The SquirrelMail Project Team
          # Roland Bauerschmidt <rb@debian.org>, 1999.
          # $Id$
          msgid ""
@@ -1148,7 +1148,7 @@ files.
          "POT-Creation-Date: 2003-01-21 19:21+0100\n"
          "PO-Revision-Date: 2003-01-21 21:01+0100\n"
          "Last-Translator: Juergen Edner <juergen.edner@epost.de>\n"
-         "Language-Team: German <squirrelmail-i18n@lists.squirrelmail.net>\n"
+         "Language-Team: German <squirrelmail-i18n@lists.sourceforge.net>\n"
          "MIME-Version: 1.0\n"
          "Content-Type: text/plain; charset=ISO-8859-1\n"
          "Content-Transfer-Encoding: 8bit\n"
@@ -1183,16 +1183,16 @@ Documenting the Code (Optional)
 If you wish, you can use phpdoc (Javadoc-style) comments, when documenting your
 code.
 
-If you follow the standards that are followed between Squirrelmail core &
+If you follow the standards that are followed between SquirrelMail core &
 plugin developers, the resulted documentation can be included with the rest of
-the Squirrelmail code & API documentation. Specifically, in the page-level
+the SquirrelMail code & API documentation. Specifically, in the page-level
 docblock, declare the package to be 'plugins', and the subpackage to be the
 name of your plugin. For instance:
 
 /**
  * demo.php
  *
- * Copyright (c) 2003 My Name <my-email-address>
+ * Copyright (c) 2005 My Name <my-email-address>
  * Licensed under the GNU GPL. For full terms see the file COPYING.
  *
  * @package plugins
@@ -1202,7 +1202,7 @@ name of your plugin. For instance:
 The rest is up to you. Try to follow some common sense and document what is
 really needed. Documenting the code properly can be a big help not only to
 yourself, but to those who will take a look at your code, fix the bugs and even
-improve it, in the true open-source spirit that Squirrelmail was built upon.
+improve it, in the true open-source spirit that SquirrelMail was built upon.
 
 For more information about phpdocumentor and how to write proper-tagged
 comments, you are directed at: