General information: a plugin management feature is planned for the future, until then plugins have to be installed and configured by hand as described in this document.

Installation

To install a translate5-plugin, put it into the folder

  /application/modules/editor/Plugins

To install plugin-specific sql, run the translate5 updater.

Activation

To activate/deactivate plug-ins use the translate5 command line tool in the translate5 installation directory:

# list all available plug-ins:
./translate5.sh plugin:list 

# enable the given Plug-ins 
./translate5.sh plugin:enable SpellCheck MatchAnalysis

# for more help call
./translate5.sh list plugin
./translate5.sh help plugin:list
./translate5.sh help plugin:enable
./translate5.sh help plugin:disable

Configuration

The config parameters for a plug-in are listed at its plug-in page. For how to set configuration parameter please look up the information about Database based configuration.

Deactivation / Deinstallation

To deactivate a plugin, remove its bootstrap classname from the above mentioned configuration.

Ensure, that no running processes / workers are using the plugin. Otherwise this could lead to problems.

After deactivation a plugin can be deinstalled by executing the deinstall_*.sql scripts in the plugins database directory, then the whole plugin directory can be removed.