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 ea62502e68872811ae7ecc4af35be6c2cd0aec62..257c9f31b00c34ec0d1b910995d7119b966bcc6e 100644 (file)
--- a/plugins/README.plugins
+++ b/plugins/README.plugins
@@ -16,12 +16,41 @@ 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, 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).

 
 

-  4.  Go to the config directory and run conf.pl
+        $ cd myplugin/
+        $ more README
+
+  5.  Go to the config directory and run conf.pl

 
         $ cd ../../config/
         $ ./conf.pl
 
 
         $ cd ../../config/
         $ ./conf.pl
 

-  5.  Choose option 8 and proceed to add the new plugin following
+  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 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