Plugins

Plugin types

There are 3 plugin types:

• PreSave - they are executed before saving a page to the Inquiry database.
• Button - you can execute them by hand, using the Plugins button.
• Load - executed after the page or frame was loaded in a browser.

When the plugin starts working Inquiry executes its functions - MP_PreSave(), MP_Button() and MP_Load() - respectively for each of the plugin types.

If the page saved to disk, then executed MP_PreSaveToDisk() rather than MP_PreSave().

All function names that begin with MP_ are reserved for internal MetaProducts Inquiry usage.

Plugins format

All plugins are in the MetaProducts Inquiry\Plugins folder. They are JavaScript files with the .js extension. Filenames that begin with mp_ prefix are reserved and overwritten when Inquiry installs. You can setup plugins using the Options dialog | Plugins section. The list of plugins will be read when you open the Options dialog.

The very first line of the .js file should be exactly: //MPIQPlugin.

Next lines can be used for the plugin parameters:

• Type - plugin type (Presave, Button and Load). You can specify several types in a line using comma.

Example:
//Type=PreSave, Button
Name - the name of plugin to display in the list.

• Author - author name - displays in the Options dialog.
• Button - only for the Button-type plugins - displays in the submenu when you click the Plugins button on toolbar.

Available objects

Any plugin can use document, window and IQ objects. The first two objects allow you to access the page in the browser. They can be undefined when there is non-HTML file opened (like PDF). Load-type plugins are not executed if document is undefined.

document object represents the current frame, not the top-level page. For example, when you load a page with frames, Load-type plugins will be called several times for each of the frames. Top-level page can be accessed using IQ.TopDocument.