[QGIS Commit] r13085 - docs/trunk/english_us/user_guide
svn_qgis at osgeo.org
svn_qgis at osgeo.org
Fri Mar 19 10:04:39 EDT 2010
Author: dassau
Date: 2010-03-19 10:04:37 -0400 (Fri, 19 Mar 2010)
New Revision: 13085
Modified:
docs/trunk/english_us/user_guide/external_plugins.tex
docs/trunk/english_us/user_guide/plugins.tex
Log:
update plugin manager usage
Modified: docs/trunk/english_us/user_guide/external_plugins.tex
===================================================================
--- docs/trunk/english_us/user_guide/external_plugins.tex 2010-03-19 13:37:31 UTC (rev 13084)
+++ docs/trunk/english_us/user_guide/external_plugins.tex 2010-03-19 14:04:37 UTC (rev 13085)
@@ -9,7 +9,7 @@
External QGIS plugins are written in Python. They are stored in either
the 'Official' or 'User contributed' QGIS Repostories, or in various other external
repositories maintained by individual authors.
-Table \ref{tab:external_plugins} shows a list of curently available 'Official'
+Table \ref{tab:external_plugins} shows a list of currently available 'Official'
plugins, with a short description.
Detailed documentation about the usage, minimum QGIS version, homepage, authors,
and other important information are provided with the external plugins themselves
@@ -17,13 +17,13 @@
\footnote{Updates of core plugins may be
available in this repository as external overlays.}
\footnote{fTools, Mapserver Export, and the Plugin Installer are Python plugins,
-but they are also part of the QGIS sources, and are automatically loaded and enabled inside
-the QGIS Plugin Manager (see Section~\ref{sec:load_external_plugin}).}
+but they are also part of the QGIS sources, and are automatically loaded and
+enabled inside the QGIS Plugin Manager (see Section~\ref{sec:load_external_plugin}).}
You will find an up-to-date list of 'Official' plugins in the Official QGIS
-Repository at \url{http://qgis.osgeo.org/download/plugins.html}. This list is also available
-automatically from the \filename{Plugins installer} via \dropmenuopttwo{plugin_installer}{Fetch Python
-Plugins...}.
+Repository at \url{http://qgis.osgeo.org/download/plugins.html}. This list is
+also available automatically from the \filename{Plugins installer}
+via \dropmenuopttwo{plugin_installer}{Fetch Python Plugins...}.
\begin{table}[H]
\centering
@@ -40,12 +40,11 @@
\includegraphics[width=0.7cm]{plugin_installer}
& Plugin Installer \index{plugins!Plugin Installer} & The most recent Python Plugin Installer.\\
\hline
-
\end{tabular}
\end{table}
-A detailed description of the installation procedure for external python plugins can be found in
-Section \ref{sec:load_external_plugin}.
+A detailed description of the installation procedure for external python
+plugins can be found in Section \ref{sec:load_external_plugin}.
\begin{Tip} \caption{\textsc{Add more repositories}}
\qgistip{To add the 'User contributed' repository and/or several external author repositories, open the
Modified: docs/trunk/english_us/user_guide/plugins.tex
===================================================================
--- docs/trunk/english_us/user_guide/plugins.tex 2010-03-19 13:37:31 UTC (rev 13084)
+++ docs/trunk/english_us/user_guide/plugins.tex 2010-03-19 14:04:37 UTC (rev 13085)
@@ -8,10 +8,12 @@
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 \textbf{core} or \textbf{external} plugins.\index{plugins!types}
+Many of the features in QGIS are actually implemented as \textbf{core}
+or \textbf{external} plugins.\index{plugins!types}
\begin{itemize}
-\item \textbf{Core Plugins} are maintained by the QGIS Development Team and are automatically part of every QGIS distribution.
+\item \textbf{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 \ref{sec:core_plugins}.
\item \textbf{External Plugins} are currently all written in Python.
@@ -23,12 +25,16 @@
\subsection{Managing Plugins}\label{sec:managing_plugins}
\index{plugins!managing}
-Managing plugins in general means loading or unloading them using the \filename{Plugin Manager}.
-External plugins first need to be installed using the \filename{Plugin Installer}.
+Managing plugins in general means loading or unloading them using
+the \filename{Plugin Manager}. External plugins can be installed and
+directly activated or uninstalled using the \filename{Python Plugin
+Installer}. To deactivate and reactivate external plugins, the
+\filename{Plugin Manager} is used again.
\subsubsection{Loading a QGIS Core Plugin}\label{sec:load_core_plugin}
-Loading a QGIS Core Plugin is done from the main menu \mainmenuopt{Plugins} > \dropmenuopttwo{mActionShowPluginManager}{Manage Plugins...}.\index{plugins!manager}
+Loading a QGIS Core Plugin is done from the main menu \mainmenuopt{Plugins}
+> \dropmenuopttwo{mActionShowPluginManager}{Manage Plugins...}.\index{plugins!manager}
\begin{figure}[ht]
\begin{center}
@@ -37,35 +43,42 @@
\end{center}
\end{figure}
-The \filename{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 \filename{Plugin Installer}
-(see Section \ref{sec:external_plugins}). Those plugins that are already loaded have a check mark
-to the left of their name. Figure \ref{fig:pluginmanager} shows the Plugin Manager dialog.
+The \filename{Plugin Manager} lists all the available plugins and their
+status (loaded or unloaded), including all core plugins and all external
+plugins that have been installed and automatically activated using the
+\filename{Python Plugin Installer} (see Section \ref{sec:external_plugins}).
+Those plugins that are already loaded have a check mark to the left of
+their name. Figure \ref{fig:pluginmanager} shows the Plugin Manager dialog.
-To enable a particular plugin, click on the checkbox to the left of the plugin name, and click \button{OK}.
-When you exit the application, a list of loaded plugins is retained, and the next time
-you run QGIS these plugins are automatically loaded.
+To enable a particular plugin, click on the checkbox to the left of the
+plugin name, and click \button{OK}. When you exit the application, a list
+of loaded plugins is retained, and the next time you run QGIS these
+plugins are automatically loaded.
\begin{Tip}\caption{\textsc{Crashing Plugins}}\index{crashes}
\qgistip{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 \ref{subsec:gui_options} for location).
-Locate the plugins settings and change all the plugin values to false to prevent them from loading.
-\nix {For example, to prevent the Delimited text plugin from loading, the entry in \$HOME/.config/QuantumGIS/qgis.conf on Linux should look like this:\usertext{Add Delimited Text Layer=false}.}
+You can stop all plugins from loading by editing your stored settings file
+(see \ref{subsec:gui_options} for location). Locate the plugins settings and
+change all the plugin values to false to prevent them from loading.
+\nix {For example, to prevent the Delimited text plugin from loading, the
+entry in \$HOME/.config/QuantumGIS/qgis.conf on Linux should look like this:
+\usertext{Add Delimited Text Layer=false}.}
\normalfont
-Do this for each plugin in the [Plugins] section.
-You can then start QGIS and add the plugins one at a time from the \filename{Plugin Manager} to
+Do this for each plugin in the [Plugins] section. You can then start QGIS
+and add the plugins one at a time from the \filename{Plugin Manager} to
determine which plugin is causing the problem.}
\end{Tip}
\subsubsection{Loading an external QGIS Plugin}\label{sec:load_external_plugin}
-There are two steps required to integrate external plugins into QGIS:
+There is only one step required to integrate external plugins into QGIS:
-\begin{enumerate}
-\item Download an external plugin from a repository using the \filename{Plugin Installer} (Section \ref{sec:python_plugin_installer}).
-The new external plugin will be added to the list of available plugins in the \filename{Plugin Manager}.
-\item Load the plugin using the \filename{Plugin Manager}.
-\end{enumerate}
+\begin{itemize}
+\item Download an external plugin from a repository using the
+\filename{Python Plugin Installer} (Section \ref{sec:python_plugin_installer}).
+The new external plugin will be added to the list of available plugins in
+the \filename{Plugin Manager} and is automatically loaded.
+\end{itemize}
\subsubsection{Using the QGIS Python Plugin Installer}\index{plugins!installing}\label{sec:python_plugin_installer}
\index{plugins!Python Plugin Installer}\index{plugins!upgrading}
@@ -78,8 +91,12 @@
\end{center}
\end{figure}
-In order to download and install an external Python plugin, click the menu \mainmenuopt{Plugins} > \dropmenuopttwo{plugin_installer}{Fetch Python Plugins...}.
-The \filename{Plugin Installer} window will appear (figure \ref{fig:plugininstaller}) with the tab \tab{Plugins}, containing a list of all locally installed Python plugins, as well as plugins available in remote repositories. Each plugin can be either:
+In order to download and install an external Python plugin, click the
+menu \mainmenuopt{Plugins} > \dropmenuopttwo{plugin_installer}{Fetch
+Python Plugins...}. The \filename{Plugin Installer} window will appear
+(figure \ref{fig:plugininstaller}) with the tab \tab{Plugins}, containing
+a list of all locally installed Python plugins, as well as plugins
+available in remote repositories. Each plugin can be either:
\begin{itemize}
\item \textbf{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{Install plugin} button.
\item \textbf{new} - this means that the plugin is newly available in the repository.
@@ -90,7 +107,8 @@
\minisec{Plugins tab}
-To install a plugin, select it from the list and click the \button{Install plugin} button. The plugin is installed in its own directory.
+To install a plugin, select it from the list and click the \button{Install plugin}
+button. The plugin is then activated and installed in its own directory.
\begin{itemize}
\item \nix{Linux and other unices}:\\
@@ -106,11 +124,19 @@
.qgis\textbackslash python\textbackslash plugins
\end{itemize}
-If the installation is successful, a confirmation message will appear telling you to go to \mainmenuopt{Plugins} > \dropmenuopttwo{mActionShowPluginManager}{Manage Plugins...} to load the newly installed plugin.
+If the installation is successful, a confirmation message will appear.
-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. \nix{For Linux, most required modules should be available via a package manager}. \win{For install instructions in Windows visit the module home page}. If you are using a proxy, you may need to configure it under \mainmenuopt{Edit} > \dropmenuopttwo{mActionOptions}{Options} (Gnome, OSX)
-or \mainmenuopt{Settings} > \dropmenuopttwo{mActionOptions}{Options} (KDE, Windows) on the \tab{Proxy} tab.
+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. \nix{For Linux, most required modules should be available via a
+package manager}. \win{For install instructions in Windows visit the module
+home page}. If you are using a proxy, you may need to configure it under
+\mainmenuopt{Edit} > \dropmenuopttwo{mActionOptions}{Options} (Gnome, OSX)
+or \mainmenuopt{Settings} > \dropmenuopttwo{mActionOptions}{Options} (KDE, Windows)
+on the \tab{Proxy} tab.
The \button{Uninstall plugin} button 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 \button{Uninstall plugin} and revert to the version shipped with Quantum GIS. This default version however, cannot be uninstalled.
@@ -122,7 +148,11 @@
The \tab{Options} tab is where you can configure the settings of the \filename{Plugin Installer}. The \checkbox{Check for updates on startup} 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{Repositories} 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 \filename{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 \textit{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.
+Although the plugin installer update can handle ports different from 80, some internet
+connections will cause problems when attempting to automatically check for updates.
+In these cases, a \textit{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 \filename{Plugin Installer}. Under \textit{Allowed plugins}, you can specify whether you would like to:
More information about the QGIS-commit
mailing list