Appendix B. Troubleshooting during plugin development

So you have read all the documentation, did everything right, and still cannot get it to work? Do not worry, we will work it out. First thing to do is: Activate RKWard Debug Messages - window (available from the Windows - menu, or right click on one of the tool bars), and then start your plugin, again. As a general rule of thumb, you should not see any output in the messages window when your plugin gets invoked, or at any other time. If there is one, it is likely related to your plugin. See if it helps you.

If everything seems fine on the console, try to increase the debug-level (from the command line, using rkward --debug-level 3, or by setting debug level to 3 in SettingsConfigure RKWardDebug). Not all messages shown at higher debug levels necessarily indicate a problem, but chance are, your problem shows up somewhere between the messages.

If you still cannot find out what is wrong, do not despair. We know this is complicated stuff, and - after all - possibly you have also come across a bug in RKWard, and RKWard needs to be fixed. Just write to the development mailing list, and tell us about the problem. We will be happy to help you.

Finally, even if you found out how to do it on your own, but found the documentation to be not-so-helpful or even wrong in some respects, please tell us on the mailing list as well, so we can fix/improve the documentation.