Information about added new decoding charsets.

[squirrelmail.git] / doc / plugin.txt

diff --git a/doc/plugin.txt b/doc/plugin.txt
index dbd6ab52f9601d86d827f947301d78902980335f..2605237ec594adb6bf77c5cd7dfd113a0ff92c70 100644 (file)
--- a/doc/plugin.txt
+++ b/doc/plugin.txt
@@ -1,9 +1,9 @@
 $Id$
 
 It is best if you check out the SquirrelMail development FAQ for more
 $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).
+information.  This document is currently quite out of date.  Help writing
+plugins is easily obtained by posting to the squirrelmail-plugins mailing
+list.  (See details about mailing lists on the website)

 
 FAQ -> http://www.squirrelmail.org/wiki/wiki.php?DeveloperFAQ
 Plugin Hooks -> http://www.squirrelmail.org/wiki/wiki.php?DevelopingPlugins
 
 FAQ -> http://www.squirrelmail.org/wiki/wiki.php?DeveloperFAQ
 Plugin Hooks -> http://www.squirrelmail.org/wiki/wiki.php?DevelopingPlugins


@@ -137,6 +137,7 @@ List of hooks
   html_bottom                     src/read_body.php
   read_body_header                src/read_body.php
   read_body_header_right          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

+  read_body_after_from            src/read_body.php

   search_before_form              src/search.php
   search_after_form               src/search.php
   search_bottom                   src/search.php
   search_before_form              src/search.php
   search_after_form               src/search.php
   search_bottom                   src/search.php


@@ -147,7 +148,6 @@ List of hooks
   addressbook_bottom              src/addressbook.php
   ^ attachment $type0/$type1      functions/mime.php (see note on attachments)
    
   addressbook_bottom              src/addressbook.php
   ^ attachment $type0/$type1      functions/mime.php (see note on attachments)
    

-   

 (*) Options
 -----------
 There are two ways to do options for your plugin.  First, you can incorporate it
 (*) Options
 -----------
 There are two ways to do options for your plugin.  First, you can incorporate it


@@ -185,9 +185,9 @@ It is possible to create your own options sections with plugins.  There are
 three hooks you will need to use.
 
 1.  options_link_and_description
 three hooks you will need to use.
 
 1.  options_link_and_description

-    This creates the link and has a description that are shown on the options
+    This creates the link and has a description that is shown on the options

     page.  This should output HTML that looks like this.  Make sure to read
     page.  This should output HTML that looks like this.  Make sure to read

-    the section on outputting your own pages.
+    the section on outputing your own pages.

 
     -----cut here-----  
       function my_plugin_name_my_function() {
 
     -----cut here-----  
       function my_plugin_name_my_function() {


@@ -277,6 +277,10 @@ To set up links for actions, you assign them like this:
   $Args[1]['your_plugin_name']['href'] = 'URL to link to';
   $Args[1]['your_plugin_name']['text'] = 'What to display';
     
   $Args[1]['your_plugin_name']['href'] = 'URL to link to';
   $Args[1]['your_plugin_name']['text'] = 'What to display';
     

+It's also possible to specify a hook as "attachment type0/*",
+for example "attachment text/*". This hook will be executed whenever there's
+no more specific rule available for that type.
+

 
 Outputting Your Own Pages
 -------------------------
 
 Outputting Your Own Pages
 -------------------------


@@ -299,7 +303,7 @@ of your PHP script should look very similar to this:
     
 The validate.php script will include internationalization support,
 config.php variables, strings.php functions, and also authenticate that the
     
 The validate.php script will include internationalization support,
 config.php variables, strings.php functions, and also authenticate that the

-user is truly logged in.  Validate.php also calls stripslashes() on incoming
+user is truly logged in.  validate.php also calls stripslashes() on incoming

 data (if gpc_magic_quotes() is on).  You should never need to worry about
 that stuff again.  As a warning, this has only really been ironed out in
 1.1.1.  If you create/modify a plugin to follow these rules, you must
 data (if gpc_magic_quotes() is on).  You should never need to worry about
 that stuff again.  As a warning, this has only really been ironed out in
 1.1.1.  If you create/modify a plugin to follow these rules, you must