Use <plugin>_info() function if at all possible instead of <plugin>_version()

[squirrelmail.git] / plugins / README.plugins

diff --git a/plugins/README.plugins b/plugins/README.plugins
index a1d6e0acf45f310d41b409983fa1cec2038ebed4..257c9f31b00c34ec0d1b910995d7119b966bcc6e 100644 (file)
--- a/plugins/README.plugins
+++ b/plugins/README.plugins
@@ -17,9 +17,12 @@ install plugins.
   3.  Note the directory that the plugin was created into.  For this
       example, we will assume it was put in the directory: myplugin/.
   
   3.  Note the directory that the plugin was created into.  For this
       example, we will assume it was put in the directory: myplugin/.
   

-  4.  Read the README or other documentation in your new plugin.  Follow
-      any important configuration instructions inside (usually there are
-      none).
+  4.  Read the README, INSTALL or other documentation in your new plugin.  
+      Follow any important configuration instructions inside (about half
+      the time there are none, sometimes they are extensive).
+
+        $ cd myplugin/
+        $ more README

 
   5.  Go to the config directory and run conf.pl
 
 
   5.  Go to the config directory and run conf.pl
 


@@ -29,3 +32,25 @@ install plugins.
   6.  Choose option 8 and proceed to add the new plugin following
       the instructions there.  Save and exit, and your plugin should
       be in place.
   6.  Choose option 8 and proceed to add the new plugin following
       the instructions there.  Save and exit, and your plugin should
       be in place.

+
+The following plugins are "core" plugins; that is, plugins shipped with
+the SquirrelMail distribution.  Unless you are a developer and know what
+you are doing, you should not replace these plugins with other versions.
+
+- abook_take
+- administrator
+- bug_report
+- calendar
+- change_password
+- filters
+- fortune
+- info
+- listcommands
+- mail_fetch
+- message_details
+- newmail
+- plist
+- sent_subfolders
+- spamcop
+- squirrelspell
+- translate