pike > FinScribe > Plugins

Plugins

Created by hww3. Last updated by hww3, 19 years ago. Version #1.

FinScribe supports the dynamic addition of new functionality without modifying core application code through the use of plugins. Located within the application directory is a directory called plugins. During startup, FinScribe scans this directory for plugin bundles, queries them for their capabilities and (depending on the configuration) loads and starts them.

There are a number of "extension points", or types of addition you can make to FinScribe using a plugin. A single plugin can provide any combination of extension points, even depending on the configuration of the application. It is expected that additional extension points will be identified and implimented in the future, however currently, FinScribe supports the following:

• macro extensions (new macros available to any content renderer, though the exact syntax that these follow will vary)
• content renderer extensions (display rendering as well as content input renderering, such as a rich text wysiwyg editor for HTML content)
• event responders (such code is triggered when certain events occur, such as onSaveComplete)
• path extensions, which can register one or more extension points in the virtual filesystem

A plugin can provide a set of preferences which will be used to co. Additionally, there is an installer interface which is used to prepare the FinScribe installation for the plugin to be activated, and a set of plugin lifecycle functions which are used to enable, start and stop a module.

Not categorized | RSS Feed | BackLinks