Difference between revisions of "Manual/Plugins"

Revision as of 19:01, 22 May 2013

There are no available plugins as of now.

A plugin is described by a JSON file containing the metadata for the given plugin.

The JSON contains an object with the following fields:

name: Recommended, an unique string that identifies the plugin.; If missing is deduced from the file name.
type: Mandatory. Plugin type, see below for valid values.; If missing or with an invalid value the plugin won't be loaded.
description: Recommended. A textual description of the use of the plugin.
author: Suggested, name of the author of the plugin.
version: Suggested, plugin version.
license: Suggested, short identifier of the software license covering the plugin.
icon: Optional, a named icon form the theme or a file name.; How this is used can change depending on the plugin type.
script: Mandatory (Optional if type is "test"). Location of the script file that is to be executed by the plugin. The location is considered relative to the directory containing the JSON file.; See Scripting for a description of the language.

The following fields are added at runtime and will be overwritten if present in the JSON file:

Plugins are searched in the available data directories, the following directories are always searched:

Other directories depend on the system and Qt version. Check Help → About → Plugins for details

@@ Line 23: / Line 23: @@
 : Optional, a named icon form the theme or a file name.
 : How this is used can change depending on the plugin type.
+; script
+: Mandatory (Optional if {{js|type}} is {{js|"test"}}). Location of the script file that is to be executed by the plugin. The location is considered relative to the directory containing the JSON file.
+: See {{rl|Scripting}} for a description of the language.
 The following fields are added at runtime and will be overwritten if present in the JSON file: