SparkPlug API Reference

Introduction

SparkPlug allows you, potential plugin developer to easily create powerful InputManager-like plugins for Cocoa applications. The API provided by SparkPlug is minimal, yet it will greatly increase the speed that you can develop your plugins. SparkPlug makes it very easy to create and provide preference control and help to your users. This API reference is currently very bare-bones. Expect more information and sample code to come eventually.

Your Application's Info.plist file

To take advantage of most of SparkPlug's features, all you need to do is add some extra entries to your bundle's Info.plist file or the localized InfoPlist.strings file. A summary of the different items you can add to the file is below.

SPAbout
The SPAbout entry will be displayed on the "General" tab and can be used to provide a short note to help describe the plugin's purpose (in case your users forget). If this field is left blank, the "CFBundleGetInfoString" tag will be displayed instead.

SPByline
The SPByline tag controls what is displayed directly below the plugin's name. If this tag is a URL, the user will be able to click it and the URL will be followed. Currently only http: and mailto: links are supported. If this field is left blank, the version number will be displayed here instead.

More forthcoming...