From cfcf045a7abb6f05c074539bfc4710547e63800e Mon Sep 17 00:00:00 2001 From: Holger Berndt Date: Tue, 11 Jun 2013 23:44:00 +0200 Subject: [PATCH] Python plugin: Extend plugin description 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 | 38 +++++++++++++++++++++++------- 1 file changed, 30 insertions(+), 8 deletions(-) diff --git a/src/plugins/python/python_plugin.c b/src/plugins/python/python_plugin.c index 4cdba316f..6b49860fc 100644 --- a/src/plugins/python/python_plugin.c +++ b/src/plugins/python/python_plugin.c @@ -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 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 is welcome."); } const gchar *plugin_type(void) -- 2.25.1