Python plugin: Extend plugin description
authorHolger Berndt <hb@claws-mail.org>
Tue, 11 Jun 2013 21:44:00 +0000 (23:44 +0200)
committerHolger Berndt <hb@claws-mail.org>
Tue, 11 Jun 2013 21:44:00 +0000 (23:44 +0200)
Bring back the information that was previously contained
in the README file of the plugin tarball in form of a
more elaborate plugin description.

src/plugins/python/python_plugin.c

index 4cdba31..6b49860 100644 (file)
@@ -728,14 +728,36 @@ const gchar *plugin_name(void)
 const gchar *plugin_desc(void)
 {
   return _("This plugin provides Python integration features.\n"
-           "\nFor the most up-to-date API documentation, type\n"
-           "\n help(clawsmail)\n"
-           "\nin the interactive Python console under Tools -> Show Python console.\n"
-           "\nThe source distribution of this plugin comes with various example scripts "
-           "in the \"examples\" subdirectory. If you wrote a script that you would be "
-           "interested in sharing, feel free to send it to me to have it considered "
-           "for inclusion in the examples.\n"
-           "\nFeedback to <berndth@gmx.de> is welcome.");
+      "Python code can be entered interactively into an embedded Python console,"
+      " under Tools -> Show Python console, or stored in scripts.\n\n"
+      "These scripts are then available via the menu. You can assign"
+      " keyboard shortcuts to them just like it is done with other menu items."
+      " You can also put buttons for script invokation into the toolbars"
+      " using Claws Mail's builtin toolbar editor.\n\n"
+      "You can provide scripts working on the main window by placing files"
+      " into ~/.claws-mail/python-scripts/main.\n\n"
+      "You can also provide scripts working on an open compose window"
+      " by placing files into ~/.claws-mail/python-scripts/compose.\n\n"
+      "The folder ~/.claws-mail/python-scripts/auto/ may contain some"
+      " scripts that are automatically executed when certain events"
+      " occur. Currently, the following files in this directory"
+      " are recognised:\n\n"
+      "compose_any\n"
+      "Gets executed whenever a compose window is opened, no matter"
+      "if that opening happened as a result of composing a new message,"
+      "replying or forwarding a message.\n\n"
+      "startup\n"
+      "Executed at plugin load\n\n"
+      "shutdown\n"
+      "Executed at plugin unload\n\n"
+      "\nFor the most up-to-date API documentation, type\n"
+      "\n help(clawsmail)\n"
+      "\nin the interactive Python console.\n"
+      "\nThe source distribution of this plugin comes with various example scripts "
+      "in the \"examples\" subdirectory. If you wrote a script that you would be "
+      "interested in sharing, feel free to send it to me to have it considered "
+      "for inclusion in the examples.\n"
+      "\nFeedback to <berndth@gmx.de> is welcome.");
 }
 
 const gchar *plugin_type(void)