|
| 1 | +<h3>Python Plugin Installer</h3> |
| 2 | +Downloads and installs plugins from remote repositories. |
| 3 | +<br/><br/> |
| 4 | +<a href="#pltab">Plugins tab</a><br/> |
| 5 | +<a href="#retab">Repositories tab</a><br/> |
| 6 | +<a href="#optab">Options tab</a><br/> |
| 7 | + |
| 8 | +<a name="pltab"> |
| 9 | +<h4>Plugins tab</h4> |
| 10 | +</a> |
| 11 | + |
| 12 | +<p align='justify'> |
| 13 | +The <label>Plugins</label> tab contains a list of all locally installed Python plugins, as well as plugins available in |
| 14 | +remote repositories. Each plugin can be either: |
| 15 | +<ul> |
| 16 | +<li> not installed - this means the plugin is available in the repository, but is not installed yet. In |
| 17 | +order to install it, select the plugin from the list and click the <label>Install plugin</label> button.</li> |
| 18 | +<li> new - this means that the plugin is newly available in the repository.</li> |
| 19 | +<li> installed - this indicates that the plugin is already installed. If it is also available in any repository |
| 20 | +the <label>Reinstall plugin</label> button will be enabled. If the available version is older than the installed |
| 21 | +version, the <label>Downgrade plugin</label> button will appear instead.</li> |
| 22 | +<li> upgradeable - this means that the plugin is installed, but there is an updated version available. |
| 23 | +In this case, the <label>Upgrade plugin</label> button will be enabled.</li> |
| 24 | +<li> invalid - this means that the plugin is installed, but is unavailable or broken. The reason will be |
| 25 | +explained in the plugin description field.</li> |
| 26 | +</ul> |
| 27 | +</p> |
| 28 | + |
| 29 | +To install a plugin, select it from the list and click the <label>Install plugin</label> button. The plugin is installed in its own directory in: |
| 30 | +<table border=1> |
| 31 | +<tr><td>OS</td><td>system plugins</td><td>plugins installed by user</td></tr> |
| 32 | +<tr><td>Linux and other unices</td><td>./share/qgis/python/plugins</td><td>/home/$USERNAME/.qgis/python/plugins</td></tr> |
| 33 | +<tr><td>Mac OS X</td><td>./Contents/MacOS/share/qgis/python/plugins</td><td>/Users/$USERNAME/.qgis/python/plugins</td></tr> |
| 34 | +<tr><td>Windows</td><td>C:\Program Files\QGIS\python\plugins</td><td>C:\Documents and Settings\$USERNAME\.qgis\python\plugins</td></tr> |
| 35 | +</table> |
| 36 | +<br/> |
| 37 | + |
| 38 | +<p align='justify'> |
| 39 | +If the installation is successful, a confirmation message will appear. The plugin is ready to use. |
| 40 | +</p> |
| 41 | + |
| 42 | +<p align='justify'> |
| 43 | +If the installation fails, the reason for the failure will be displayed in a warning dialog. Most often, |
| 44 | +errors are the result of connection problems and/or missing Python modules. In the former case you |
| 45 | +will likely need to wait before trying the install again, in the latter case, you should install the missing |
| 46 | +modules relevant to your operating system prior to using the plugin. For Linux, most required |
| 47 | +modules should be available via a package manager. For install instructions in Windows visit the |
| 48 | +module home page. If you are using a proxy, you may need to configure it under <label>Edit</label> > <label>Options</label> |
| 49 | +(Gnome, OSX) or <label>Settings</label> > <label>Options</label> (KDE, Windows) on the <label>Proxy</label> tab. |
| 50 | +</p> |
| 51 | + |
| 52 | +<p align='justify'> |
| 53 | +The <label>Uninstall plugin</label> button is enabled only if the selected plugin is installed and is not a core |
| 54 | +plugin. Note that if you have installed an update to a core plugin, you can uninstall this update |
| 55 | +with the <label>Uninstall plugin</label> and revert to the version shipped with Quantum GIS. This default version |
| 56 | +however, cannot be uninstalled. |
| 57 | +</p> |
| 58 | + |
| 59 | + |
| 60 | + |
| 61 | + |
| 62 | +<a name="retab"> |
| 63 | +<h4>Repositories tab</h4> |
| 64 | +</a> |
| 65 | +<p align='justify'> |
| 66 | +The second tab <label>Repositories</label>, contains a list of plugin repositories available for the Plugin |
| 67 | +Installer. By default, only the QGIS Official Repository is enabled. You can add several user- |
| 68 | +contributed repositories, including the central QGIS Contributed Repository and other external repos- |
| 69 | +itories by clicking the <label>Add 3rd party repositories</label> button. The added repositories contain a large |
| 70 | +number of useful plugins which are not maintained by the QGIS Development Team. As such, we |
| 71 | +cannot take any responsibility for them. You can also manage the repository list manually, that is add, |
| 72 | +remove, and edit the entries. Temporarily disabling a particular repository is possible by clicking the |
| 73 | +<label>Edit...</label> button. |
| 74 | +</p> |
| 75 | + |
| 76 | + |
| 77 | + |
| 78 | + |
| 79 | + |
| 80 | +<a name="optab"> |
| 81 | +<h4>Options tab</h4> |
| 82 | +</a> |
| 83 | +<p align='justify'> |
| 84 | +The <label>Options</label> tab is where you can configure the settings of the Plugin Installer. |
| 85 | +The <label>x Check for updates on startup</label> checkbox tells QGIS to automatically look for plugin updates and |
| 86 | +news. By default, if this feature is enabled all repositories listed and enabled in the <label>Repositories</label> |
| 87 | +tab are checked for updates each time the program is started. The frequency of update checking |
| 88 | +can be adjusted using the dropdown menu, and may be adjusted from once a day right up to once a |
| 89 | +month. If a new plugin or update is available for one of the installed plugins, a notification will appear |
| 90 | +in the Status Bar. If the checkbox is disabled, looking for updates and news is performed only when |
| 91 | +the Plugin Installer is manually launched from the menu. |
| 92 | +</p> |
| 93 | + |
| 94 | +<p align='justify'> |
| 95 | +Some internet connections will cause problems when attempting to automatically check for updates. |
| 96 | +In these cases, a <i>Looking for new plugins...</i> indicator will remain visible in the Status Bar during your |
| 97 | +entire QGIS session, and may cause a program crash when exiting. In this case please disable the |
| 98 | +checkbox. |
| 99 | +</p> |
| 100 | + |
| 101 | + |
| 102 | +In addition, you may specify the type of plugins that are displayed by the Plugin Installer. Under |
| 103 | +<i>Allowed plugins</i>, you can specify whether you would like to: |
| 104 | +<ul> |
| 105 | +<li> Only show plugins from the official repository</li> |
| 106 | +<li> Show all plugins except those marked as experimental,</li> |
| 107 | +<li> or Show all plugins, even those marked as experimental.</li> |
| 108 | +</ul> |
| 109 | + |
| 110 | +<br/> |
| 111 | +<table border=1 width='95%' align='center'><tr><td> |
| 112 | +Note: Experimental plugins are generally unsuitable for production use. These plugins are in the early stages of |
| 113 | +development, and should be considered ’incomplete’ or ’proof of concept’ tools. The QGIS development team |
| 114 | +does not recommend installing these plugins unless you intend to use them for testing purposes. |
| 115 | +</td></tr></table> |
| 116 | + |
| 117 | + |
| 118 | + |
0 commit comments