# [QGIS Commit] r9387 - in docs/trunk/english_us/user_guide: . plugins_screenies

svn_qgis at osgeo.org svn_qgis at osgeo.org
Tue Sep 23 09:47:40 EDT 2008

Author: dassau
Date: 2008-09-23 09:47:40 -0400 (Tue, 23 Sep 2008)
New Revision: 9387

docs/trunk/english_us/user_guide/plugins_screenies/plugininstaller.png
docs/trunk/english_us/user_guide/plugins_screenies/pluginmanager.png
Removed:
docs/trunk/english_us/user_guide/mapserver_export_screenies/
Modified:
docs/trunk/english_us/user_guide/Makefile
docs/trunk/english_us/user_guide/grass_integration.tex
docs/trunk/english_us/user_guide/plugins.tex
docs/trunk/english_us/user_guide/plugins_screenies/Makefile
docs/trunk/english_us/user_guide/user_guide.tex
Log:
removed mapserver_export_screenies, screenies will go into folder plugins_screenies
improved plugin section structure

Modified: docs/trunk/english_us/user_guide/Makefile
===================================================================
--- docs/trunk/english_us/user_guide/Makefile	2008-09-23 12:58:08 UTC (rev 9386)
+++ docs/trunk/english_us/user_guide/Makefile	2008-09-23 13:47:40 UTC (rev 9387)
@@ -76,9 +76,9 @@
(cd ./plugins_graticule_creator_images && make)
(cd ./plugins_installer_images && make)
(cd ./plugins_maplayer_images && make)
-#	(cd ./plugins_mapserver_export_images && make)
(cd ./plugins_quick_print_images && make)
(cd ./plugins_spit_images && make)
+	(cd ./plugins_screenies && make)
#	(cd ./plugins_python_images && make)
(cd ./getting_started_screenies && make)
(cd ./working_with_vector_screenies && make)
@@ -90,7 +90,6 @@
#	(cd ./map_server_export_screenies && make)
#	(cd ./creating_applications_screenies && make)
#	(cd ./help_and_support_screenies && make)
-#	(cd ./plugins_screenies && make)
(cd ./operating_system_icons && make)

# make html
@@ -128,6 +127,7 @@
(cd ./plugins_spit_images && make clean)
(cd ./plugins_python_images && make clean)
(cd ./plugins_maplayer_images/ && make clean)
+	(cd ./plugins_screenies && make clean)
(cd ./getting_started_screenies && make clean)
(cd ./working_with_vector_screenies && make clean)
(cd ./working_with_raster_screenies && make clean)
@@ -135,10 +135,8 @@
(cd ./working_with_projections_screenies && make clean)
(cd ./grass_integration_screenies && make clean)
(cd ./map_composer_screenies && make clean)
-	(cd ./mapserver_export_screenies && make clean)
(cd ./creating_applications_screenies && make clean)
(cd ./help_and_support_screenies && make clean)
-	(cd ./plugins_screenies && make clean)
(cd ./operating_system_icons && make clean)

# Update icons from qgis source if necessary

Modified: docs/trunk/english_us/user_guide/grass_integration.tex
===================================================================
--- docs/trunk/english_us/user_guide/grass_integration.tex	2008-09-23 12:58:08 UTC (rev 9386)
+++ docs/trunk/english_us/user_guide/grass_integration.tex	2008-09-23 13:47:40 UTC (rev 9387)
@@ -4,10 +4,16 @@
% comment out the following line:
%\updatedisclaimer

-The GRASS plugin provides access to GRASS GIS~\cite{GRASSweb} databases and functionalities. This includes visualization of GRASS raster and vector layers, digitizing vector layers, editing vector attributes, creating new vector layers and analysing GRASS 2D and 3D data with more than 300 GRASS modules.
+functionalities. This includes visualization of GRASS raster and vector
+layers, digitizing vector layers, editing vector attributes, creating new
+vector layers and analysing GRASS 2D and 3D data with more than 300 GRASS
+modules.

In this Section we'll introduce the plugin functionalities and give some
-examples on managing and working with GRASS data. Following main features are provided with the toolbar menu, when you start the GRASS plugin, as described in Section~\ref{sec:starting_grass}:
+examples on managing and working with GRASS data. Following main features
+are provided with the toolbar menu, when you start the GRASS plugin, as
+described in Section~\ref{sec:starting_grass}:

\begin{itemize}
\item \toolbtntwo{grass_open_mapset}{Open mapset}
@@ -26,17 +32,24 @@
\subsection{Starting the GRASS plugin}\label{sec:starting_grass}
\index{GRASS!starting QGIS}

-To use GRASS functionalities and/or visualize GRASS vector and raster layers in QGIS, you must select and load the GRASS plugin with the Plugin Manager. Therefore click the menu \mainmenuopt{Plugins} > \mainmenuopt{Manage Plugins}, select \dropmenuopt{GRASS} and click \button{OK}.
+To use GRASS functionalities and/or visualize GRASS vector and raster layers
+in QGIS, you must select and load the GRASS plugin with the Plugin Manager.

-You can now start loading raster and vector layers from an existing GRASS \filename{LOCATION} (see Section \ref{sec:load_grassdata}). Or you create a new GRASS \filename{LOCATION} with QGIS (see Section \ref{sec:create_loc}) and import some raster and vector data (see Section \ref{sec:import_loc_data}) for further analysis with the GRASS Toolbox (see Section \ref{subsec:grass_toolbox}).
+You can now start loading raster and vector layers from an existing GRASS
+\filename{LOCATION} (see Section \ref{sec:load_grassdata}). Or you create a
+new GRASS \filename{LOCATION} with QGIS (see Section \ref{sec:create_loc})
+and import some raster and vector data (see Section \ref{sec:import_loc_data})
+for further analysis with the GRASS Toolbox (see Section
+\ref{subsec:grass_toolbox}).

-data}

With the GRASS plugin, you can load vector or raster layers using the
appropriate button on the toolbar menu. As an example we use the QGIS alaska
-dataset (see Section \ref{label_sampledata}). It includes a small sample GRASS
-\filename{LOCATION} with 3 vector layers and 1 raster elevation map.
+dataset (see Section \ref{label_sampledata}). It includes a small sample
+GRASS \filename{LOCATION} with 3 vector layers and 1 raster elevation map.

\begin{enumerate}
@@ -68,7 +81,9 @@
\end{enumerate}

As you see, it is very simple to load GRASS raster and vector layers in QGIS.
-See following Sections for editing GRASS data and creating a new \filename{LOCATION}. More sample GRASS \filename{LOCATIONs} are available at the GRASS website at \url{http://grass.osgeo.org/download/data.php}.
+See following Sections for editing GRASS data and creating a new
+\filename{LOCATION}. More sample GRASS \filename{LOCATIONs} are available at

@@ -79,16 +94,27 @@

\subsection{GRASS LOCATION and MAPSET}\label{sec:create_loc}

-GRASS data are stored in a directory referred to as GISDBASE. This directory often called \filename{grassdata}, must be created before you start working with the GRASS plugin in QGIS. Within this directory, the GRASS GIS data
-are organized by projects stored in subdirectories called \filename{LOCATION}. Each \filename{LOCATION} is defined by its coordinate system, map projection
+GRASS data are stored in a directory referred to as GISDBASE. This directory
+often called \filename{grassdata}, must be created before you start working
+with the GRASS plugin in QGIS. Within this directory, the GRASS GIS data
+are organized by projects stored in subdirectories called \filename{LOCATION}.
+Each \filename{LOCATION} is defined by its coordinate system, map projection
and geographical boundaries. Each \filename{LOCATION} can have several
\filename{MAPSETs} (subdirectories of the \filename{LOCATION}) that are used
to subdivide the project into different topics, subregions, or as workspaces
-for individual team members (Neteler \& Mitasova 2007 \cite{neteler_mitasova07}). In order to analyse vector and raster layers with GRASS modules, you must import them into a GRASS \filename{LOCATION}.\footnote{This is not strictly true - with the GRASS modules \filename{r.external} and \filename{v.external} you can create read-only links to external GDAL/OGR-supported data sets without importing them. But because this is not the usual way for beginners to work with GRASS, this functionality will not be described here.}
+for individual team members (Neteler \& Mitasova 2007
+\cite{neteler_mitasova07}). In order to analyse vector and raster layers with
+GRASS modules, you must import them into a GRASS \filename{LOCATION}.
+\footnote{This is not strictly true - with the GRASS modules
+to external GDAL/OGR-supported data sets without importing them. But because
+this is not the usual way for beginners to work with GRASS, this functionality
+will not be described here.}

\begin{figure}[ht]
\begin{center}
-\caption{GRASS data organized in the alaska LOCATION (adapted from Neteler \& Mitasova 2007 \cite{neteler_mitasova07})}\label{fig:grass_location}\smallskip
+Mitasova 2007 \cite{neteler_mitasova07})}\label{fig:grass_location}\smallskip
\includegraphics[clip=true]{grass_location}
\end{center}
\end{figure}
@@ -104,7 +130,8 @@

\begin{figure}[ht]
\begin{center}
-\caption{Creating a new GRASS LOCATION or a new MAPSET in QGIS \nixcaption}\label{fig:create_grass_location}\smallskip
+\caption{Creating a new GRASS LOCATION or a new MAPSET in QGIS \nixcaption}
+\label{fig:create_grass_location}\smallskip
\includegraphics[clip=true]{create_grass_location}
\end{center}
\end{figure}
@@ -135,13 +162,21 @@
corner of the status bar (see Section \ref{label_projstart})).
\item Click \button{Find} to select the projection
\item Click \button{Next}
-  \item To define the default region, we have to enter the \filename{LOCATION} bounds in north, south, east, and west direction. Here we simply click on the button \button{Set current QGIS extent}, to apply the extend of the loaded layer \filename{alaska.shp} as the GRASS default region extend.
+  \item To define the default region, we have to enter the \filename{LOCATION}
+  bounds in north, south, east, and west direction. Here we simply click on
+  the button \button{Set current QGIS extent}, to apply the extend of the
\item Click \button{Next}
-  \item We also need to define a \filename{MAPSET} within our new \filename{LOCATION}. You can name it whatever you like - we used demo.\footnote{When creating a new \filename{LOCATION}, GRASS automatically creates a special \filename{MAPSET} called \filename{PERMANENT} designed to
-  store the core data for the project, its default spatial extend and coordinate system definitions (Neteler \& Mitasova 2007 \cite{neteler_mitasova07}).}
+  \item We also need to define a \filename{MAPSET} within our new
+  \filename{LOCATION}. You can name it whatever you like - we used demo.
+  \footnote{When creating a new \filename{LOCATION}, GRASS automatically
+  creates a special \filename{MAPSET} called \filename{PERMANENT} designed to
+  store the core data for the project, its default spatial extend and
+  coordinate system definitions (Neteler \& Mitasova 2007
+  \cite{neteler_mitasova07}).}
\item Check out the summary to make sure it's correct and click
\button{Finish}
-  \item The new \filename{LOCATION alaska} and two \filename{MAPSETs} \filename{demo}
+  \item The new \filename{LOCATION alaska} and two \filename{MAPSETs demo}
and \filename{PERMANENT} are created. The currently opened working set is
\filename{MAPSET demo}, as you defined.
\item Notice that some of the tools in the GRASS toolbar that were
@@ -149,46 +184,84 @@
\end{enumerate}

If that seemed like a lot of steps, it's really not all that bad and a very
-quick way to create a \filename{LOCATION}. The \filename{LOCATION alaska} is now ready for data import (see Section \ref{sec:import_loc_data}).
-You can also use the already existing vector and raster data in the sample GRASS \filename{LOCATION alaska} included in the QGIS alaska dataset \ref{label_sampledata} and move on to Section \ref{label_vectmodel}.
+quick way to create a \filename{LOCATION}. The \filename{LOCATION alaska} is
+now ready for data import (see Section \ref{sec:import_loc_data}).
+You can also use the already existing vector and raster data in the sample
+\ref{label_sampledata} and move on to Section \ref{label_vectmodel}.

-A user has only write access to a GRASS \filename{MAPSET} he created. This means, besides access to his own \filename{MAPSET}, each user can also read maps in other user's \filename{MAPSETs}, but he can modify or remove only the maps in his own \filename{MAPSET}. All \filename{MAPSETs} include a \filename{WIND} file that stores the current boundary coordinate values and
-the currently selected raster resolution (Neteler \& Mitasova 2007 \cite{neteler_mitasova07}, see Section \ref{sec:grass_region}).
+A user has only write access to a GRASS \filename{MAPSET} he created. This
+maps in other user's \filename{MAPSETs}, but he can modify or remove only
+the maps in his own \filename{MAPSET}. All \filename{MAPSETs} include a
+\filename{WIND} file that stores the current boundary coordinate values and
+the currently selected raster resolution (Neteler \& Mitasova 2007
+\cite{neteler_mitasova07}, see Section \ref{sec:grass_region}).

\begin{enumerate}
\item Start QGIS and make sure the GRASS plugin is loaded
-  \item In the GRASS toolbar, click on the \toolbtntwo{grass_open_mapset}{Open
-    mapset} icon to bring up the \filename{MAPSET} wizard.
+  \item In the GRASS toolbar, click on the
+  \toolbtntwo{grass_open_mapset}{Open mapset} icon to bring up the
+  \filename{MAPSET} wizard.
\item Select the GRASS database (GISDBASE) folder \filename{grassdata}
-  with the \filename{LOCATION alaska}, where we want to add a further \filename{MAPSET}, called test.
+  with the \filename{LOCATION alaska}, where we want to add a further
+  \filename{MAPSET}, called test.
\item Click \button{Next}.
-  \item We can use this wizard to create a new \filename{MAPSET} within an existing \filename{LOCATION} or to create a new \filename{LOCATION} altogether. Click on the radio button \radiobuttonon{Select location}
+  \item We can use this wizard to create a new \filename{MAPSET} within an
+  existing \filename{LOCATION} or to create a new \filename{LOCATION}
(see Figure \ref{fig:create_grass_location}) and click \button{Next}.
\item Enter the name \filename{text} for the new \filename{MAPSET}. Below
in the wizard you see a list of existing \filename{MAPSETs} and its owners.
-  \item Click \button{Next}, check out the summary to make sure it's all correct and click \button{Finish}
+  \item Click \button{Next}, check out the summary to make sure it's all
+  correct and click \button{Finish}
\end{enumerate}

\subsection{Importing data into a GRASS LOCATION}\label{sec:import_loc_data}

-This Section gives an example how to import raster and vector data into the \filename{alaska} GRASS \filename{LOCATION} provided by the QGIS alaska dataset. Therefore we use a landcover raster map \filename{landcover.tif} and a vector polygone Shape \filename{lakes.shp} from the QGIS alaska dataset \ref{label_sampledata}.
+This Section gives an example how to import raster and vector data into the
+dataset. Therefore we use a landcover raster map \filename{landcover.tif}
+and a vector polygone Shape \filename{lakes.shp} from the QGIS alaska
+dataset \ref{label_sampledata}.

\begin{enumerate}
\item Start QGIS and make sure the GRASS plugin is loaded.
-  \item In the GRASS toolbar, click the \toolbtntwo{grass_open_mapset}{Open
-    MAPSET} icon to bring up the \filename{MAPSET} wizard.
-  \item Select as GRASS database the folder \filename{grassdata} in the QGIS alaska dataset, as \filename{LOCATION alaska}, as \filename{MAPSET} \filename{demo} and click \button{OK}.
-  \item Now click the \toolbtntwo{grass_tools}{Open GRASS tools} icon. The GRASS Toolbox (see Section \ref{subsec:grass_toolbox}) dialog appears.
-  \item To import the raster map \filename{landcover.tif}, click the module \filename{r.in.gdal} in the \tab{Modules Tree} tab. This GRASS module allows to import GDAL supported raster files into a GRASS \filename{LOCATION}. The module dialog for \filename{r.in.gdal} appears.
-  \item Browse to the folder \filename{raster} in the QGIS alaska dataset and select the file \filename{landcover.tif}.
-  \item As raster output name define \filename{landcover\_grass} and click \button{Run}. In the \tab{Output} tab you see the currently running GRASS command \filename{r.in.gdal -o input=/path/to/landcover.tif output=landcover\_grass}.
-  \item When it says \textbf{Succesfully finished} click \button{View output}. The \filename{landcover\_grass} raster layer is now imported into GRASS and will be visualized in the QGIS canvas.
-  \item To import the vector shape \filename{lakes.shp}, click the module \filename{v.in.ogr} in the \tab{Modules Tree} tab. This GRASS module allows to import OGR supported vector files into a GRASS \filename{LOCATION}. The module dialog for \filename{v.in.ogr} appears.
-  \item Browse to the folder \filename{vmap0\_shapefiles} in the QGIS alaska dataset and select the file \filename{lakes.shp} as OGR file.
-  \item As vector output name define \filename{lakes\_grass} and click \button{Run}. You don't have to care about the other options in this example. In the \tab{Output} tab you see the currently running GRASS command \filename{v.in.ogr -o dsn=/path/to/lakes.shp output=lakes\_grass}.
-  \item When it says \textbf{Succesfully finished} click \button{View output}. The \filename{lakes\_grass} vector layer is now imported into GRASS and will be visualized in the QGIS canvas.
+  \item In the GRASS toolbar, click the \toolbtntwo{grass_open_mapset}{Open
+  MAPSET} icon to bring up the \filename{MAPSET} wizard.
+  \item Select as GRASS database the folder \filename{grassdata} in the QGIS
+  \filename{demo} and click \button{OK}.
+  \item Now click the \toolbtntwo{grass_tools}{Open GRASS tools} icon. The
+  GRASS Toolbox (see Section \ref{subsec:grass_toolbox}) dialog appears.
+  \item To import the raster map \filename{landcover.tif}, click the module
+  \filename{r.in.gdal} in the \tab{Modules Tree} tab. This GRASS module
+  allows to import GDAL supported raster files into a GRASS
+  \filename{LOCATION}. The module dialog for \filename{r.in.gdal} appears.
+  \item Browse to the folder \filename{raster} in the QGIS alaska dataset
+  and select the file \filename{landcover.tif}.
+  \item As raster output name define \filename{landcover\_grass} and click
+  \button{Run}. In the \tab{Output} tab you see the currently running GRASS
+  command \filename{r.in.gdal -o input=/path/to/landcover.tif
+  output=landcover\_grass}.
+  \item When it says \textbf{Succesfully finished} click \button{View output}.
+  The \filename{landcover\_grass} raster layer is now imported into GRASS and
+  will be visualized in the QGIS canvas.
+  \item To import the vector shape \filename{lakes.shp}, click the module
+  \filename{v.in.ogr} in the \tab{Modules Tree} tab. This GRASS module allows
+  to import OGR supported vector files into a GRASS \filename{LOCATION}. The
+  module dialog for \filename{v.in.ogr} appears.
+  \item Browse to the folder \filename{vmap0\_shapefiles} in the QGIS alaska
+  dataset and select the file \filename{lakes.shp} as OGR file.
+  \item As vector output name define \filename{lakes\_grass} and click
+  \button{Run}. You don't have to care about the other options in this
+  example. In the \tab{Output} tab you see the currently running GRASS
+  command \filename{v.in.ogr -o dsn=/path/to/lakes.shp output=lakes\_grass}.
+  \item When it says \textbf{Succesfully finished} click \button{View output}.
+  The \filename{lakes\_grass} vector layer is now imported into GRASS and will
+  be visualized in the QGIS canvas.
\end{enumerate}

@@ -200,7 +273,8 @@
vector model.\index{GRASS!topology} This means that areas are not represented
as closed polygons, but by one or more boundaries. A boundary between two
adjacent areas is digitized only once, and it is shared by both areas.
-Boundaries must be connected without gaps. An area is identified (labeled) by the centroid of the area.
+Boundaries must be connected without gaps. An area is identified (labeled)
+by the centroid of the area.

Besides boundaries and centroids, a vector map can also contain
points and lines. All these geometry elements can be mixed
@@ -219,15 +293,14 @@
the boundary between lake and forest is a road, so it can have a different
attribute table.

-The 'layer' of the feature is defined by 'layer' inside GRASS.
-'Layer' is the number which defines if there are more than one layer inside the
-dataset, e.g. if the geometry is forest or lake.
-For now, it can be only a number, in the future GRASS will also support
-names as fields in the user interface.
+The 'layer' of the feature is defined by 'layer' inside GRASS. 'Layer' is the
+number which defines if there are more than one layer inside the dataset, e.g.
+if the geometry is forest or lake. For now, it can be only a number, in the
+future GRASS will also support names as fields in the user interface.

-Attributes can be stored inside the GRASS \filename{LOCATION} as DBase or SQLITE3 or in
-external database tables, for example PostgreSQL, MySQL, Oracle,
-etc.\index{GRASS!attribute storage}
+Attributes can be stored inside the GRASS \filename{LOCATION} as DBase or
+SQLITE3 or in external database tables, for example PostgreSQL, MySQL,
+Oracle, etc.\index{GRASS!attribute storage}

Attributes in database tables are linked to geometry elements using
a 'category' value.\index{GRASS!attribute linkage} 'Category' (key, ID) is an
@@ -245,9 +318,17 @@

\subsection{Creating a new GRASS vector layer}\label{sec:creating_new_grass_vectors}\index{GRASS!Creating new vectors|see{editing!creating a new layer}}

-To create a new GRASS vector layer with the GRASS plugin click the \toolbtntwo{grass_new_vector_layer}{Create new GRASS vector} toolbar icon. Enter a name in the text box and you can start digitizing point, line or polygone geometries, following the procedure described in Section \ref{grass_digitising}.
+To create a new GRASS vector layer with the GRASS plugin click the
+\toolbtntwo{grass_new_vector_layer}{Create new GRASS vector} toolbar icon.
+Enter a name in the text box and you can start digitizing point, line or
+polygone geometries, following the procedure described in Section
+\ref{grass_digitising}.

-In GRASS it is possible to organize all sort of geometry types (point, line and area) in one layer, because GRASS uses a topological vector model, so you don't need to select the geometry type when creating a new GRASS vector. This is different from Shapefile creation with QGIS, because Shapefiles use the Simple Feature vector model (see Section \ref{sec:create shape}).
+In GRASS it is possible to organize all sort of geometry types (point, line
+and area) in one layer, because GRASS uses a topological vector model, so you
+don't need to select the geometry type when creating a new GRASS vector. This
+is different from Shapefile creation with QGIS, because Shapefiles use the
+Simple Feature vector model (see Section \ref{sec:create shape}).

\begin{Tip}\caption{\textsc{Creating an attribute table for a new GRASS vector layer}}
\qgistip{
@@ -258,11 +339,20 @@
\subsection{Digitizing and editing a GRASS vector layer}\index{GRASS!digitizing tools}\label{grass_digitising}

The digitizing tools for GRASS vector layers are accessed using the
-\toolbtntwo{grass_edit}{Edit GRASS vector layer} icon on the toolbar. Make sure you have loaded a GRASS vector and it is the selected layer in the legend before clicking on the edit tool. Figure \ref{fig:grass_digitizing_category} shows the GRASS edit dialog that is displayed when you click on the edit tool. The tools and settings are discussed in the following sections.
+\toolbtntwo{grass_edit}{Edit GRASS vector layer} icon on the toolbar. Make
+sure you have loaded a GRASS vector and it is the selected layer in the legend
+before clicking on the edit tool. Figure \ref{fig:grass_digitizing_category}
+shows the GRASS edit dialog that is displayed when you click on the edit tool.
+The tools and settings are discussed in the following sections.

\begin{Tip}\caption{\textsc{Digitizing polygones in GRASS}}
\qgistip{
-If you want to create a polygone in GRASS, you first digitize the boundary of the polygone, setting the mode to \usertext{No category}. Then you add a centroid (label point) into the closed boundary, setting the mode to \usertext{Next not used}. The reason is, that a topological vector model links attribute information of a polygon always to the centroid and not to the boundary.
+If you want to create a polygone in GRASS, you first digitize the boundary of
+the polygone, setting the mode to \usertext{No category}. Then you add a
+centroid (label point) into the closed boundary, setting the mode to
+\usertext{Next not used}. The reason is, that a topological vector model links
+attribute information of a polygon always to the centroid and not to the
+boundary.
}
\end{Tip}

@@ -316,7 +406,8 @@

\minisec{Category Tab}\index{GRASS!category settings}

-The \tab{Category} tab allows you to define the way in which the category values will be assigned to a new geometry element.
+The \tab{Category} tab allows you to define the way in which the category
+values will be assigned to a new geometry element.

\begin{figure}[h]
\begin{center}
@@ -326,7 +417,8 @@
\end{figure}

\begin{itemize}
-\item \textbf{Mode}: what category value shall be applied to new geometry elements.
+\item \textbf{Mode}: what category value shall be applied to new geometry
+elements.
\begin{itemize}
\item Next not used - apply next not yet used category value to geometry
element.
@@ -382,7 +474,8 @@

The \tab{Table} tab provides information about the database table for
a given 'layer'. Here you can add new columns to an existing attribute table,
-or create a new database table for a new GRASS vector layer (see Section \ref{sec:creating_new_grass_vectors}).
+or create a new database table for a new GRASS vector layer (see Section
+\ref{sec:creating_new_grass_vectors}).

\begin{figure}[h]
\begin{center}
@@ -393,8 +486,9 @@

\begin{Tip}\caption{\textsc{GRASS Edit Permissions}}\index{GRASS!edit
permissions}
-\qgistip{You must be the owner of the GRASS \filename{MAPSET} you want to edit. It is
-impossible to edit data layers in a \filename{MAPSET} that is not yours, even if you have write permissions.
+\qgistip{You must be the owner of the GRASS \filename{MAPSET} you want to
+edit. It is impossible to edit data layers in a \filename{MAPSET} that is not
+yours, even if you have write permissions.
}
\end{Tip}

@@ -405,26 +499,35 @@
to any defined region definitions. All newly-created rasters will have the
spatial extension and resolution of the currently defined GRASS region,
regardless of their original extension and resolution. The current GRASS
-region is stored in the \filename{\$LOCATION/\$MAPSET/WIND} file, and it defines
-north, south, east and west bounds, number of columns and rows, horizontal
-and vertical spatial resolution.
+region is stored in the \filename{\$LOCATION/\$MAPSET/WIND} file, and it
+defines north, south, east and west bounds, number of columns and rows,
+horizontal and vertical spatial resolution.

It is possible to switch on/off the visualization of the GRASS region in the
QGIS canvas using the \toolbtntwo{grass_region}{Display current GRASS region}
button. \index{GRASS!region!display}.

With the \toolbtntwo{grass_region_edit}{Edit current GRASS region} icon you
-can open a dialog to change the current region and the symbology of the GRASS region rectangle in the QGIS canvas. Type in the new region bounds and
-resolution and click \button{OK}. It also allows to select a new region interactively with your mouse on the QGIS canvas. Therefore click with the left mouse button in the QGIS canvas, open a rectangle, close it using the left mouse button again and click \button{OK}.\index{GRASS!region!editing} The GRASS module \filename{g.region} provide a lot more parameters to define an appropriate region extend and resolution for your raster analysis. You can use these parameters with the GRASS Toolbox, described in Section \ref{subsec:grass_toolbox}.
+can open a dialog to change the current region and the symbology of the GRASS
+region rectangle in the QGIS canvas. Type in the new region bounds and
+resolution and click \button{OK}. It also allows to select a new region
+interactively with your mouse on the QGIS canvas. Therefore click with the
+left mouse button in the QGIS canvas, open a rectangle, close it using the
+left mouse button again and click \button{OK}.\index{GRASS!region!editing}
+The GRASS module \filename{g.region} provide a lot more parameters to define
+an appropriate region extend and resolution for your raster analysis. You can
+use these parameters with the GRASS Toolbox, described in Section
+\ref{subsec:grass_toolbox}.

\subsection{The GRASS toolbox}\label{subsec:grass_toolbox}\index{GRASS!toolbox}

-The \toolbtntwo{grass_tools}{Open GRASS Tools} box provides GRASS
-module functionalities to work with data inside a selected GRASS \filename{LOCATION}
-and \filename{MAPSET}. To use the GRASS toolbox you need to open a \filename{LOCATION} and \filename{MAPSET} where
-you have write-permission (usually granted, if you created the \filename{MAPSET}). This is
-necessary, because new raster or vector layers created during analysis need to
-be written to the currently selected \filename{LOCATION} and \filename{MAPSET}.
+The \toolbtntwo{grass_tools}{Open GRASS Tools} box provides GRASS module
+functionalities to work with data inside a selected GRASS \filename{LOCATION}
+and \filename{MAPSET}. To use the GRASS toolbox you need to open a
+\filename{LOCATION} and \filename{MAPSET} where you have write-permission
+(usually granted, if you created the \filename{MAPSET}). This is necessary,
+because new raster or vector layers created during analysis need to be written
+to the currently selected \filename{LOCATION} and \filename{MAPSET}.

\subsubsection{Working with GRASS modules}\index{GRASS!toolbox}

@@ -442,11 +545,15 @@
grouped in thematic blocks, but are searchable as well. You find a complete
list of GRASS modules available in QGIS version \CURRENT
in appendix \ref{appdx_grass_toolbox_modules}. It is also possible to
-customize the GRASS Toolbox content. It is described in Section \ref{sec:toolbox-customizing}.
+customize the GRASS Toolbox content. It is described in Section
+\ref{sec:toolbox-customizing}.

-As shown in Figure \ref{fig:grass_modules}, you can look for the appropriate GRASS module using the thematically grouped \tab{Modules Tree} or the  searchable \tab{Modules List} tab.
+As shown in Figure \ref{fig:grass_modules}, you can look for the appropriate
+GRASS module using the thematically grouped \tab{Modules Tree} or the
+searchable \tab{Modules List} tab.

-Clicking on a grapical module icon a new tab will be added to the toolbox dialog providing three new sub-tabs \tab{Options}, \tab{Output} and
+Clicking on a grapical module icon a new tab will be added to the toolbox
+dialog providing three new sub-tabs \tab{Options}, \tab{Output} and
\tab{Manual}. In Figure \ref{fig:grass_module_dialog} you see an example
for the GRASS module \filename{v.buffer}.

@@ -463,31 +570,44 @@
The \tab{Options} tab provides a simplified module dialog where you can
usually select a raster or vector layer visualized in the QGIS canvas and
enter further module specific parameters to run the module. The provided
-module parameters are often not complete to keep the dialog
-clear. If you want to use further module parameters and flags, you need to start the GRASS Shell and run the module in the command line.
+module parameters are often not complete to keep the dialog clear. If you want
+to use further module parameters and flags, you need to start the GRASS Shell
+and run the module in the command line.

\minisec{Output}

-The \tab{Output} tab provides information about the output status of the module. When you click the \button{Run} button, the module switches to the
-\tab{Output} tab and you see information about the analysis process. If all works well, you will finally see a \usertext{Successfully finished} message.
+The \tab{Output} tab provides information about the output status of the
+module. When you click the \button{Run} button, the module switches to the
+\tab{Output} tab and you see information about the analysis process. If all
+works well, you will finally see a \usertext{Successfully finished} message.

\minisec{Manual}

The \tab{Manual} tab shows the HTML help page of the GRASS module. You can
-use it to check further module parameters and flags or to get a deeper knowledge about the purpose of the module. At the end of each module
-manual page you see further links to the \filename{Main Help index}, the \filename{Thematic index} and the \filename{Full index}. These links provide the same information as if you use the module \filename{g.manual}
+use it to check further module parameters and flags or to get a deeper
+knowledge about the purpose of the module. At the end of each module
+manual page you see further links to the \filename{Main Help index}, the
+\filename{Thematic index} and the \filename{Full index}. These links provide
+the same information as if you use the module \filename{g.manual}

\begin{Tip}\caption{\textsc{Display results immediately}}\index{GRASS!display results}
-\qgistip{If you want to display your calculation results immediately in your map canvas, you can use the 'View Output' button at the bottom of the
+map canvas, you can use the 'View Output' button at the bottom of the
module tab.
}
\end{Tip}

\subsubsection{Working with the GRASS LOCATION browser} \index{GRASS!toolbox!Browser}

-Another useful feature inside the GRASS Toolbox is the GRASS \filename{LOCATION} browser. In Figure~\ref{fig:grass_mapset_browser} you can see the current working \filename{LOCATION} with its \filename{MAPSETs}.
+Another useful feature inside the GRASS Toolbox is the GRASS
+\filename{LOCATION} browser. In Figure~\ref{fig:grass_mapset_browser} you
+can see the current working \filename{LOCATION} with its \filename{MAPSETs}.

-In the left browser windows you can browse through all \filename{MAPSETs} inside the current \filename{LOCATION}. The right browser window shows some meta information for selected raster or vector layers, e.g. resolution, bounding box, data source, connected attribute table for vector data and a command history.
+In the left browser windows you can browse through all \filename{MAPSETs}
+inside the current \filename{LOCATION}. The right browser window shows some
+meta information for selected raster or vector layers, e.g. resolution,
+bounding box, data source, connected attribute table for vector data and a
+command history.

\begin{figure}[h]
\begin{center}
@@ -508,7 +628,10 @@
\item \toolboxtwo{grass_refresh}{Refresh browser window}
\end{itemize}

-The \toolboxtwo{grass_rename_map}{Rename selected map} and \toolboxtwo{grass_delete_map}{Delete selected map} only work with maps inside your currently selected \filename{MAPSET}. All other tools also work with raster and vector layers in another \filename{MAPSET}.
+The \toolboxtwo{grass_rename_map}{Rename selected map} and
+\toolboxtwo{grass_delete_map}{Delete selected map} only work with maps inside
+your currently selected \filename{MAPSET}. All other tools also work with
+raster and vector layers in another \filename{MAPSET}.

\subsubsection{Customizing the GRASS Toolbox} \index{GRASS!toolbox!customize}
\label{sec:toolbox-customizing}
@@ -517,7 +640,8 @@
interface is provided to parse the pretty simple XML files which configures
the modules appearance and parameters inside the toolbox.

-A sample XML file for generating the module \usertext{v.buffer} (v.buffer.qgm) looks like this:
+A sample XML file for generating the module \usertext{v.buffer} (v.buffer.qgm)
+looks like this:
\begin{verbatim}
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE qgisgrassmodule SYSTEM "http://mrcc.com/qgisgrassmodule.dtd">
@@ -529,5 +653,8 @@
</qgisgrassmodule>
\end{verbatim}

-The parser reads this definition and creates a new tab inside the toolbox when you select the module. A more detailed description for adding new modules, changing the modules group, etc. can be found on the QGIS wiki at \\ \url{http://wiki.qgis.org/qgiswiki/Adding\_New\_Tools\_to\_the\_GRASS\_Toolbox}.
+The parser reads this definition and creates a new tab inside the toolbox
+when you select the module. A more detailed description for adding new
+modules, changing the modules group, etc. can be found on the QGIS wiki at \\

Modified: docs/trunk/english_us/user_guide/plugins.tex
===================================================================
--- docs/trunk/english_us/user_guide/plugins.tex	2008-09-23 12:58:08 UTC (rev 9386)
+++ docs/trunk/english_us/user_guide/plugins.tex	2008-09-23 13:47:40 UTC (rev 9387)
@@ -6,59 +6,96 @@

QGIS has been designed with a plugin architecture. This allows new
features/functions to be added to the application. Many of the features in
-QGIS are actually implemented as core or external plugins.\index{plugins!types}
+QGIS are actually implemented as \textbf{core} or \textbf{external}
+plugins.\index{plugins!types}

-A QGIS core plugin is maintained by the QGIS Development Team
-and is part of every QGIS distribution (see Section \ref{sec:core_plugins}).
+\begin{itemize}
+\item \textbf{Core Plugins} are maintained by the QGIS Development Team and
+plugins are provided in Section \ref{sec:core_plugins}.
+\item \textbf{External Plugins} are currently all written in Python. They
+are stored in external svn repositories and maintained by the individual
+author. They can be added to QGIS using the core plugin called
+provided in Section \ref{sec:external_plugins}.
+\end{itemize}

-An external plugin is stored in an external svn repository and maintained
-by the individual author. It can be added to QGIS with the Plugin installer.
-\ref{sec:external_plugins}.
+\subsection{Managing Plugins}\label{sec:managing_plugins}
+\index{plugins!managing}

-\subsection{Finding and Installing a Plugin}
-When you install QGIS, all of the core plugins are included (see chapter \ref{sec:core_plugins}). \index{plugins!installing}
+\filename{Plugin Manager} and the \filename{Plugin installer} plugin.

-Typically user-contributed plugins are distributed in source form and require compiling.
-For instructions on building and installing a user-contributed plugin, see the documentation included with the plugin.

-\subsection{Managing Plugins}\label{sec:managing_plugins}
-Loaded plugins are "remembered" when you exit the application and restored the next time you run QGIS.

-\index{plugins!manager}The Plugin Manager displays all the available plugins and their status (loaded or unloaded).
-Figure \ref{fig:pluginmanager} shows the Plugin Manager dialog.
+\begin{figure}[ht]
+   \begin{center}
+   \caption{Plugin Manager \nixcaption}\label{fig:pluginmanager}\smallskip
+   \includegraphics[clip=true, width=9cm]{pluginmanager}
+\end{center}
+\end{figure}

-%\begin{figure}[ht]
-%   \begin{center}
-%   \caption{Plugin Manager}\label{fig:pluginmanager}\smallskip
-%   \includegraphics[clip=true, width=14cm]{pluginmanager2}
-%\end{center}
-%\end{figure}
+The Plugin Manager lists all the available plugins and their status (loaded or
+unloaded). All avialable means all core plugins and all external plugins you
+added using \filename{Plugin Installer} plugin (see Section
+\ref{sec:external_plugins}). Figure \ref{fig:pluginmanager} shows the Plugin
+Manager dialog. Loaded plugins are "remembered" when you exit the application
+and restored the next time you run QGIS.

-Typically all QGIS plugins are installed in the same location.
-This location is shown in the Plugin Directory text field.
-You can tell QGIS to load plugins from another location by specifying a different directory.
+Typically all QGIS core plugins are installed in the same location on your
+computer. This location is shown in the Plugin Directory text field.
+You can tell QGIS to load plugins from another location by specifying a
+different directory.

\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 +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 Plugin Manger to determine which is causing the problem.
+You can then start QGIS and add the plugins one at a time from the Plugin Manger
+to determine which is causing the problem.
}
\end{Tip}

+
+To be able to integrate external plugins into QGIS you first need to load the
+\filename{Plugin Installer} plugin as desribed in Section
+in two steps:
+
+\begin{enumerate}
+\filename{Plugin Installer}. The new external plugin will be integrated into
+the list of available plugins in the \filename{Plugin Manager}.
+\item Load the plugin using the \filename{Plugin Manager}.
+\end{enumerate}
+
+\begin{figure}[ht]
+   \begin{center}
+   \caption{Installing external python plugins \nixcaption}
+\label{fig:plugininstaller}\smallskip
+   \includegraphics[clip=true, width=9cm]{plugininstaller}
+\end{center}
+\end{figure}
+
\subsection{Data Providers}\index{data providers}

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 \ref{appdx_ogr}).
+By default, QGIS supports PostGIS layers and disk-based data stores supported by
+the GDAL/OGR library (Appendix \ref{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 are used behind the scenes when a corresponding data type is added as a layer in QGIS.
+They are not managed by the Plugin Manager but are used behind the scenes when a
+corresponding data type is added as a layer in QGIS.

Modified: docs/trunk/english_us/user_guide/plugins_screenies/Makefile
===================================================================
--- docs/trunk/english_us/user_guide/plugins_screenies/Makefile	2008-09-23 12:58:08 UTC (rev 9386)
+++ docs/trunk/english_us/user_guide/plugins_screenies/Makefile	2008-09-23 13:47:40 UTC (rev 9387)
@@ -11,7 +11,8 @@
# JPG=qgis_icon_new_verylarge.eps\
#	nextfile.eps

-#PNG=graticule.eps\
+PNG=pluginmanager.eps\
+	plugininstaller.eps\

##### TARGETS #####

===================================================================
(Binary files differ)

Property changes on: docs/trunk/english_us/user_guide/plugins_screenies/plugininstaller.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream

===================================================================
(Binary files differ)

Property changes on: docs/trunk/english_us/user_guide/plugins_screenies/pluginmanager.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream

Modified: docs/trunk/english_us/user_guide/user_guide.tex
===================================================================
--- docs/trunk/english_us/user_guide/user_guide.tex	2008-09-23 12:58:08 UTC (rev 9386)
+++ docs/trunk/english_us/user_guide/user_guide.tex	2008-09-23 13:47:40 UTC (rev 9387)
@@ -24,8 +24,6 @@
%then each individual plugin can have a section
%in the plugins chapter
\include{plugins}
-\include{plugins_writing_in_cpp}
-\include{plugins_writing_in_python}
\include{core_plugins}
\include{plugins_decorations}
\include{plugins_delimited_text}
@@ -34,6 +32,8 @@
\include{plugins_georeferencer}
\include{external_plugins}
\include{plugins_mapserver_export}
+\include{plugins_writing_in_cpp}
+\include{plugins_writing_in_python}
%end of plugin docs
\include{creating_applications}
\include{help_and_support}