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
...
To install plugin-specific sql, run the translate5 updater.
Activation
To activate a plugin, include its bootstrap class-name in the "runtimeOptions.plugins.active" configuration.
Therefore add the bootstrap class name to the JSON list in the "value" column of the db-table Zf_configuration where the name is "runtimeOptions.plugins.active".
To enable most of the currently available core-plugins configure this:
/deactivate plug-ins use the translate5 command line tool in the translate5 installation directory:
Code Block |
---|
# 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.["editor_Plugins_LockSegmentsBasedOnConfig_Bootstrap","editor_Plugins_NoMissingTargetTerminology_Bootstrap","editor_Plugins_SegmentStatistics_Bootstrap","editor_Plugins_TermTagger_Bootstrap","editor_Plugins_Transit_Bootstrap","editor_Plugins_ManualStatusCheck_Bootstrap"]