QGIS has been designed with a plugin architecture. This allows new features/functions to be easily added to the application. Many of the features in QGIS are actually implemented as core or external plugins.
- Core Plugins are maintained by the QGIS Development Team and are automatically part of every QGIS distribution. They are written in one of two languages: C++ or Python. More information about core plugins are provided in Section sec:core_plugins.
- External Plugins are currently all written in Python. They are stored in external repositories and maintained by the individual authors. They can be added to QGIS using the Plugin Installer. More information about external plugins are provided in Section sec:external_plugins.
Managing plugins in general means loading or unloading them using the Plugin Manager. External plugins first need to be installed using the Plugin Installer.
Loading a QGIS Core Plugin
Loading a QGIS Core Plugin is done from the main menu> .
The Plugin Manager lists all the available plugins and their status (loaded or unloaded), including all core plugins and all external plugins that have been added using the Plugin Installer (see Section sec:external_plugins). Those plugins that are already loaded have a check mark to the left of their name. Figure 40 shows the Plugin Manager dialog.
To enable a particular plugin, click on the checkbox to the left of the plugin name, and click. When you exit the application, a list of loaded plugins is retained, and the next time you run QGIS these plugins are automatically loaded.
Tip 41 Crashing Plugins
If you find that QGIS crashes on startup, a plugin may be at fault. You can stop all plugins from loading by editing your stored settings file (see subsec:gui_options for location). Locate the plugins settings and change all the plugin values to false to prevent them from loading. For example, to prevent the Delimited text plugin from loading, the entry in $HOME/.config/QuantumGIS/qgis.conf on Linux should look like this:Add Delimited Text Layer=false. Do this for each plugin in the [Plugins] section. You can then start QGIS and add the plugins one at a time from the Plugin Manager to determine which plugin is causing the problem.
Loading an external QGIS Plugin
There are two steps required to integrate external plugins into QGIS:
- Download an external plugin from a repository using the Plugin Installer (Section sec:python_plugin_installer). The new external plugin will be added to the list of available plugins in the Plugin Manager.
- Load the plugin using the Plugin Manager.
Using the QGIS Python Plugin Installer
In order to download and install an external Python plugin, click the menu fig:plugininstaller) with the tab , containing a list of all locally installed Python plugins, as well as plugins available in remote repositories. Each plugin can be either:> . The Plugin Installer window will appear (figure
- not installed - this means the plugin is available in the repository, but is not installed yet. In order to install it, select the plugin from the list and click the button.
- new - this means that the plugin is newly available in the repository.
- installed - this indicates that the plugin is already installed. If it is also available in any repository the button will be enabled. If the available version is older than the installed version, the button will appear instead.
- upgradeable - this means that the plugin is installed, but there is an updated version available. In this case, the button will be enabled.
- invalid - this means that the plugin is installed, but is unavailable or broken. The reason will be explained in the plugin description field.
To install a plugin, select it from the list and click thebutton. The plugin is installed in its own directory.
- Linux and other unices:
- Mac OS X:
C:\Documents and Settings\$USERNAME\.qgis\python\plugins
If the installation is successful, a confirmation message will appear telling you to go to> to load the newly installed plugin.
If the installation fails, the reason for the failure will be displayed in a warning dialog. Most often, errors are the result of connection problems and/or missing Python modules. In the former case you will likely need to wait before trying the install again, in the latter case, you should install the missing modules relevant to your operating system prior to using the plugin. For Linux, most required modules should be available via a package manager. For install instructions in Windows visit the module home page. If you are using a proxy, you may need to configure it under > (Gnome, OSX) or > (KDE, Windows) on the tab.
Thebutton is enabled only if the selected plugin is installed and is not a core plugin. Note that if you have installed an update to a core plugin, you can uninstall this update with the and revert to the version shipped with Quantum GIS. This default version however, cannot be uninstalled.
The second tab, contains a list of plugin repositories available for the Plugin Installer. By default, only the QGIS Official Repository is enabled. You can add several user-contributed repositories, including the central QGIS Contributed Repository and other external repositories by clicking the button. The added repositories contain a large number of useful plugins which are not maintained by the QGIS Development Team. As such, we cannot take any responsibility for them. You can also manage the repository list manually, that is add, remove, and edit the entries. Temporarily disabling a particular repository is possible by clicking the button.
Thetab is where you can configure the settings of the Plugin Installer. The checkbox tells QGIS to automatically look for plugin updates and news. By default, if this feature is enabled all repositories listed and enabled in the tab are checked for updates each time the program is started. The frequency of update checking can be adjusted using the dropdown menu, and may be adjusted from once a day right up to once a month. If a new plugin or update is available for one of the installed plugins, a notification will appear in the Status Bar. If the checkbox is disabled, looking for updates and news is performed only when the Plugin Installer is manually launched from the menu.
Some internet connections will cause problems when attempting to automatically check for updates. In these cases, a Looking for new plugins... indicator will remain visible in the Status Bar during your entire QGIS session, and may cause a program crash when exiting. In this case please disable the checkbox.
In addition, you may specify the type of plugins that are displayed by the Plugin Installer. Under Allowed plugins, you can specify whether you would like to:
- Only show plugins from the official repository
- Show all plugins except those marked as experimental,
- or Show all plugins, even those marked as experimental.
Tip xx Using experimental plugins
Experimental plugins are generally unsuitable for production use. These plugins are in the early stages of development, and should be considered 'incomplete' or 'proof of concept' tools. The QGIS development team does not recommend installing these plugins unless you intend to use them for testing purposes.
Data Providers are "special" plugins that provides access to a data store. By default, QGIS supports PostGIS layers and disk-based data stores supported by the GDAL/OGR library (Appendix appdx_ogr). A Data Provider plugin extends the ability of QGIS to use other data sources.
Data Provider plugins are registered automatically by QGIS at startup. They are not managed by the Plugin Manager but used behind the scenes when a data type is added as a layer in QGIS.