Plugins
Plugins
Scribe has a reasonable plugin interface for a few of the common things that plugins
are useful for. The main reason that some things come as plugins and are not built
directly into Scribe is that they would increase the size of the main download
significantly. Currently Scribe is quite a small download, and I'd like to keep it that
way, without limiting the functionality too much.
That said, the plugins are not the most stable of things. They will usually only work
with the very latest build of Scribe, so you have to upgrade them every time you
update the main executable file. I don't
increment version numbers until I actually change the functionality of the plugin, but
I do recompile them against the latest Scribe/Lgi and upload them.
I'm working towards a more stable C++ ABI but it's not there yet. Mostly you'll
find that it will break every other version of Scribe rather than EVERY version. By
v2 it should remain stable over many builds.
If your plugin doesn't load, i.e. the plugins window says "not a plugin", then chances
are that you need to grab the latest .dll/.so/.dylib. All your settings remain during this
period so once the plugin is updated, everything will start working again. I'm looking
into an auto update function for downloading the latest build of the plugins being used.
To install a plugin, download the distribution archive from the website and unzip it
into the Scribe directory. Generally they create their own little sub folder to keep
things neat. Then open the plugins window using the File -> Plugins menu. Then click
"Add" and a list of local plugins should be displayed. Pick the new plugin from the list
and a status message will appear.
To uninstall the plugin, open the plugins window, select the plugin and click "Remove".
Then you can delete the plugins sub-directory.
Some plugins have properties that you can edit. To access these just double click the
plugin in the plugins window.
The autozip plugin automatically zips outgoing attachments to email. This saves on network
bandwidth and folder storage requirements. You can specify a set of file types that are
not zipped, typically files that are already heavily compressed, like JPEG, PNG and video
data. The format of this property is a space or colon separated list of file maskes. e.g:
*.zip *.png *.jpgwould make a good default setting. All zipped attachments are stored in the same zip, called "Attachments.zip". These plug-ins integrate GnuPG into Scribe to allow encryption, signing and decryption support. Both these plugins will need to find the location of the gpg executable before they can function. The places that the plugin looks for gpg are:
- [Win32] HKEY_CURRENT_USER\Software\GNU\GNUPG for a key 'gpgProgram'
- The system path
- ../GnuPG relative to Scribe's exe file.