[QGIS Commit] r8597 - docs/trunk/english_us/user_guide
svn_qgis at osgeo.org
svn_qgis at osgeo.org
Thu Jun 5 19:12:36 EDT 2008
Author: taraathan
Date: 2008-06-05 19:12:36 -0400 (Thu, 05 Jun 2008)
New Revision: 8597
Modified:
docs/trunk/english_us/user_guide/getting_started.tex
Log:
the new macros have been implemented.
Also, some platform-specific instructions have been itemized.
The format for referring to dropdown menu items, buttons and tabs has been standardized.
Note- dropdown menu icons need to be added.
Modified: docs/trunk/english_us/user_guide/getting_started.tex
===================================================================
--- docs/trunk/english_us/user_guide/getting_started.tex 2008-06-05 23:10:27 UTC (rev 8596)
+++ docs/trunk/english_us/user_guide/getting_started.tex 2008-06-05 23:12:36 UTC (rev 8597)
@@ -177,67 +177,66 @@
functions provided are:
\begin{itemize}
-
-\item \menuopt{File}
+\item \mainmenuopt{File}
\begin{itemize}
-\item \menuopt{New Project} - see Section \ref{sec:projects}
-\item \menuopt{Open Project} - see Section \ref{sec:projects}
-\item \menuopt{Open Recent Projects} - see Section \ref{sec:projects}
-\item \menuopt{Save Project} - see Section \ref{sec:projects}
-\item \menuopt{Save Project As} - see Section \ref{sec:projects}
-\item \menuopt{Save as Image}
-\item \menuopt{Export to MapServer Map} - see Section \ref{sec:mapserver_export}
-\item \menuopt{Print} - see Section \ref{label_mapcomposer}
-\item \menuopt{Exit}
+\item \dropmenuopt{New Project} - see Section \ref{sec:projects}
+\item \dropmenuopt{Open Project} - see Section \ref{sec:projects}
+\item \dropmenuopt{Open Recent Projects} - see Section \ref{sec:projects}
+\item \dropmenuopt{Save Project} - see Section \ref{sec:projects}
+\item \dropmenuopt{Save Project As} - see Section \ref{sec:projects}
+\item \dropmenuopt{Save as Image}
+\item \dropmenuopt{Export to MapServer Map} - see Section \ref{sec:mapserver_export}
+\item \dropmenuopt{Print} - see Section \ref{label_mapcomposer}
+\item \dropmenuopt{Exit}
\end{itemize}
-\item \textbf{View}
+\item \mainmenuopt{View}
\begin{itemize}
-\item \menuopt{Zoom Full}
-\item \menuopt{Zoom To Selection}
-\item \menuopt{Zoom To Layer}
-\item \menuopt{Zoom Last}
-\item \menuopt{Refresh}
-\item \menuopt{Show Bookmarks}
-\item \menuopt{New Bookmark}
-\item \menuopt{Show most toolbars}
-\item \menuopt{Hide most toolbars}
-\item \menuopt{Toolbar Visibility}
+\item \dropmenuopt{Zoom Full}
+\item \dropmenuopt{Zoom To Selection}
+\item \dropmenuopt{Zoom To Layer}
+\item \dropmenuopt{Zoom Last}
+\item \dropmenuopt{Refresh}
+\item \dropmenuopt{Show Bookmarks}
+\item \dropmenuopt{New Bookmark}
+\item \dropmenuopt{Show most toolbars}
+\item \dropmenuopt{Hide most toolbars}
+\item \dropmenuopt{Toolbar Visibility}
\end{itemize}
-\item \textbf{Layer}
+\item \mainmenuopt{Layer}
\begin{itemize}
-\item \menuopt{Add a Vector Layer} - see Section \ref{label_workingvector}
-\item \menuopt{Add a Raster Layer} - see Section \ref{label_raster}
-\item \menuopt{Add a PostGIS Layer} - see Section \ref{label_postgis}
-\item \menuopt{Add a WMS Layer} - see Section \ref{sec:ogc-wms}
-\item \menuopt{Remove Layer}
-\item \menuopt{New Vector Layer} - see Section \ref{sec:create shape}
-\item \menuopt{In Overview}
-\item \menuopt{Add All To Overview}
-\item \menuopt{Remove All From Overview}
-\item \menuopt{Hide All Layers}
-\item \menuopt{Show All Layers}
+\item \dropmenuopt{Add a Vector Layer} - see Section \ref{label_workingvector}
+\item \dropmenuopt{Add a Raster Layer} - see Section \ref{label_raster}
+\item \dropmenuopt{Add a PostGIS Layer} - see Section \ref{label_postgis}
+\item \dropmenuopt{Add a WMS Layer} - see Section \ref{sec:ogc-wms}
+\item \dropmenuopt{Remove Layer}
+\item \dropmenuopt{New Vector Layer} - see Section \ref{sec:create shape}
+\item \dropmenuopt{In Overview}
+\item \dropmenuopt{Add All To Overview}
+\item \dropmenuopt{Remove All From Overview}
+\item \dropmenuopt{Hide All Layers}
+\item \dropmenuopt{Show All Layers}
\end{itemize}
-\item \textbf{Settings}
+\item \mainmenuopt{Settings}
\begin{itemize}
-\item \menuopt{Project Properties} - see Section \ref{sec:projects}
-\item \menuopt{Custom Projection} - see Section \ref{sec:customprojections}
-\item \menuopt{Options} - see Section \ref{subsec:gui_options}
+\item \dropmenuopt{Project Properties} - see Section \ref{sec:projects}
+\item \dropmenuopt{Custom Projection} - see Section \ref{sec:customprojections}
+\item \dropmenuopt{Options} - see Section \ref{subsec:gui_options}
\end{itemize}
-\item \textbf{Plugins} - (Futher menu items are added by plugins as they are loaded.)
+\item \mainmenuopt{Plugins} - (Futher menu items are added by plugins as they are loaded.)
\begin{itemize}
-\item \menuopt{Plugin Manager} - see Section \ref{sec:managing_plugins}
+\item \dropmenuopt{Plugin Manager} - see Section \ref{sec:managing_plugins}
\end{itemize}
-\item \textbf{Help}
+\item \mainmenuopt{Help}
\begin{itemize}
-\item \menuopt{Help Contents}
-\item \menuopt{QGIS Homepage}
-\item \menuopt{Check QGIS Version}
-\item \menuopt{About}
+\item \dropmenuopt{Help Contents}
+\item \dropmenuopt{QGIS Homepage}
+\item \dropmenuopt{Check QGIS Version}
+\item \dropmenuopt{About}
\end{itemize}
\end{itemize}
@@ -259,7 +258,7 @@
\begin{Tip}
\caption{\textsc{Reappearing toolbars}} \index{layout!toolbars}
\qgistip{If you have accidentally hidden all your toolbars, you can get them back by
-choosing \menuopt{Show most toolbars} from the \menuopt{View} menu.}
+choosing menu option \mainmenuopt{View} > \dropmenuopt{Show most toolbars}.}
\end{Tip}
\subsubsection{Map Legend}\label{label_legend}
@@ -273,57 +272,57 @@
entry can be used to show or hide the layer.\index{layer!visibility}
Layers can be grouped in the legend window by adding a layer group and dragging layers
-into the group. To do so, go with the mouse to the legend window, right click, choose \menuopt{Add group}.
+into the group. To do so, go with the mouse to the legend window, right click, choose \dropmenuopt{Add group}.
A new folder appears. Now drag the layers to the folder symbol. It is then possible to toggle the
visibility of all the layers in the group with one click. To bring layers out of a group, go with
-the mouse to the layer symbol, right click, choose \menuopt{Make to toplevel item}. To give the folder a
-new name, choose \menuopt{Rename} in the right click menu of the group.
+the mouse to the layer symbol, right click, choose \dropmenuopt{Make to toplevel item}. To give the folder a
+new name, choose \dropmenuopt{Rename} in the right click menu of the group.
The content of the right mouse button context menu depends on if the loaded legend item you hold your
-mouse over is a raster or a vector layer. For GRASS vector layers the \menuopt{toggle editing} is not
+mouse over is a raster or a vector layer. For GRASS vector layers the \dropmenuopt{toggle editing} is not
available. See section \ref{grass_digitising} for infos on editing GRASS vector layers.
\begin{itemize}
\item \textbf{Right mouse button menu for raster layers}
\begin{itemize}
-\item \menuopt{Zoom to layer extent}
-\item \menuopt{Zoom to best scale (100\%)}
-\item \menuopt{Show in overview}
-\item \menuopt{Remove}
-\item \menuopt{Properties}
-\item \menuopt{Rename}
-\item \menuopt{Add Group}
-\item \menuopt{Expand all}
-\item \menuopt{Collapse all}
-\item \menuopt{Show file groups}
+\item \dropmenuopt{Zoom to layer extent}
+\item \dropmenuopt{Zoom to best scale (100\%)}
+\item \dropmenuopt{Show in overview}
+\item \dropmenuopt{Remove}
+\item \dropmenuopt{Properties}
+\item \dropmenuopt{Rename}
+\item \dropmenuopt{Add Group}
+\item \dropmenuopt{Expand all}
+\item \dropmenuopt{Collapse all}
+\item \dropmenuopt{Show file groups}
\end{itemize}
\item \textbf{Right mouse button menu for vector layers}
\begin{itemize}
-\item \menuopt{Zoom to layer extent}
-\item \menuopt{Show in overview}
-\item \menuopt{Remove}
-\item \menuopt{Open attribute table}
-\item \menuopt{Toggle editing (not available for GRASS layers)}
-\item \menuopt{Save as shapefile}
-\item \menuopt{Save selection as shapefile}
-\item \menuopt{Properties}
-\item \menuopt{Rename}
-\item \menuopt{Add Group}
-\item \menuopt{Expand all}
-\item \menuopt{Collapse all}
-\item \menuopt{Show file groups}
+\item \dropmenuopt{Zoom to layer extent}
+\item \dropmenuopt{Show in overview}
+\item \dropmenuopt{Remove}
+\item \dropmenuopt{Open attribute table}
+\item \dropmenuopt{Toggle editing (not available for GRASS layers)}
+\item \dropmenuopt{Save as shapefile}
+\item \dropmenuopt{Save selection as shapefile}
+\item \dropmenuopt{Properties}
+\item \dropmenuopt{Rename}
+\item \dropmenuopt{Add Group}
+\item \dropmenuopt{Expand all}
+\item \dropmenuopt{Collapse all}
+\item \dropmenuopt{Show file groups}
\end{itemize}
\item \textbf{Right mouse button menu for layer groups}
\begin{itemize}
-\item \menuopt{Remove}
-\item \menuopt{Rename}
-\item \menuopt{Add Group}
-\item \menuopt{Expand all}
-\item \menuopt{Collapse all}
-\item \menuopt{Show file groups}
+\item \dropmenuopt{Remove}
+\item \dropmenuopt{Rename}
+\item \dropmenuopt{Add Group}
+\item \dropmenuopt{Expand all}
+\item \dropmenuopt{Collapse all}
+\item \dropmenuopt{Show file groups}
\end{itemize}
\end{itemize}
@@ -367,7 +366,7 @@
the mouse cursor inside the map area and roll it forward (away from you) to
zoom in and backwards (towards you) to zoom out. The mouse cursor is the
center where the zoom occurs. You can customize the behavior of the mouse
-wheel zoom using the \tab{Map tools} tab under the \menuopt{Settings} ->\menuopt{Options} menu. }
+wheel zoom using the \tab{Map tools} tab under the \mainmenuopt{Settings} >\dropmenuopt{Options} menu. }
\end{Tip}
\subsubsection{Map Overview}\label{label_mapoverview}
@@ -379,7 +378,7 @@
that labels are not rendered to the map overview even if the layers in the
map overview have been set up for labeling.
You can add a single layer to the
-overview by right-clicking on it in the legend and choosing \menuopt{Show in overview}. You can also add or remove all layers to the overview using the
+overview by right-clicking on it in the legend and choosing \dropmenuopt{Show in overview}. You can also add or remove all layers to the overview using the
Overview tools on the toolbar.
You can also grab the red rectangle showing your current extent and pan around; the
@@ -455,7 +454,7 @@
You can set an option to always load new layers without drawing them. This
means the layer will be added to the map, but its visibility checkbox in the
legend will be unchecked by default. To set this option, choose
-\menuopt{Options} from the \menuopt{Settings} menu and click on the
+menu option \mainmenuopt{Settings} > \dropmenuopt{Options} and click on the
\tab{Rendering} tab. Uncheck the \checkbox{By default new layers added to the map
should be
displayed} checkbox. Any layer added to the map will be off (invisible) by
@@ -477,7 +476,7 @@
You can set an option to update the map display as features are drawn. By
default, QGIS does not display any features for a layer until the entire
layer has been rendered. To update the display as features are read from the
-datastore, choose \menuopt{Options} from the \menuopt{Settings} menu and
+datastore, choose menu option \mainmenuopt{Settings} > \dropmenuopt{Options}
click on the \tab{Rendering} tab. Set the feature count to an
appropriate value to update the display during rendering. Setting a value of 0
disables update during drawing (this is the default). Setting a value too low
@@ -493,7 +492,7 @@
\subsubsection{Measure length}\index{measure:line length}
\includegraphics[width=0.7cm]{measureline} QGIS is also able to measure real distances between given
-points according to a defined ellipsoid. Therefore choose \menuopt{Options} from the \menuopt{Settings} menu,
+points according to a defined ellipsoid. Therefore choose menu option \mainmenuopt{Settings} > \dropmenuopt{Options},
click on the \tab{Map tools} tab and choose the appropriate ellipsoid. The tool then allows you to
click points on the map. Each segment-length shows up in the measure-window and additionaly the total
length is printed. To stop measuring click your right mouse button.
@@ -518,7 +517,7 @@
Section \ref{subsec:gui_options}).
QGIS can save the state of your workspace into a project file using
-the menu option \menuopt{File} -> \menuopt{Save Project}.
+the menu option \mainmenuopt{File} > \dropmenuopt{Save Project}.
Loading saved projects is a similar process.
@@ -540,8 +539,9 @@
\subsection{GUI Options}
\label{subsec:gui_options}
\includegraphics[width=0.7cm,clip=true]{options} Some basic options for QGIS
-can be selected using the Options dialog. Select the \menuopt{Settings} entry
-from the menu and choose \menuopt{Options} or press \keystroke{Alt-O}. The tabs where you can
+can be selected using the Options dialog. Select the
+menu option \mainmenuopt{Settings} >
+ \dropmenuopt{Options} or press \keystroke{Alt-O}. The tabs where you can
optmize your options are:
\minisec{General Tab}
@@ -607,22 +607,24 @@
You can modify the options according to your needs. Some of the changes may
require a restart of QGIS before they will be effective.
-On GNU/Linux everything is saved in:
+\begin{itemize}
+\item \nix{everything is saved in:}
\begin{verbatim}
$HOME/.config/QuantumGIS/qgis.conf
\end{verbatim}
This is a normal text file consisting of blocks, where QGIS saves its current
display options, PostGIS and WMS connections, and other settings.
-On Windows settings are stored in the registry under:
+\item \win{settings are stored in the registry under:}
\begin{verbatim}
\\HKEY_CURRENT_USER\Software\QuantumGIS\qgis
\end{verbatim}
-On OS X you can find your settings in:
+\item \osx{you can find your settings in:}
\begin{verbatim}
$HOME/Library/Preferences/org.qgis.qgis.plist
\end{verbatim}
+\end{itemize}
\subsection{Spatial Bookmarks}\label{sec:bookmarks}
@@ -635,7 +637,7 @@
To create a bookmark:
\begin{enumerate}
\item Zoom or pan to the area of interest.
-\item Select the menu option \menuopt{View} -> \menuopt{New Bookmark} or press \keystroke{Ctrl-B}.
+\item Select the menu option \mainmenuopt{View} > \dropmenuopt{New Bookmark} or press \keystroke{Ctrl-B}.
\item Enter a descriptive name for the bookmark (up to 255 characters).
\item Click \button{OK} to add the bookmark or \button{Cancel} to exit without adding the bookmark.
\end{enumerate}
@@ -643,15 +645,16 @@
Note that you can have multiple bookmarks with the same name.
\subsubsection{Working with Bookmarks}
-To use or manage bookmarks, select the menu option \menuopt{View} -> \menuopt{Show Bookmarks}.
+To use or manage bookmarks, select the menu option \mainmenuopt{View} > \dropmenuopt{Show Bookmarks}.
The bookmarks dialog allows you to zoom to or delete a bookmark.
You can not edit the bookmark name or coordinates.
\subsubsection{Zooming to a Bookmark}
From the Bookmarks dialog, select the desired bookmark by clicking on it,
-then click the \button{Zoom To} button.
+then click \button{Zoom To}.
You can also zoom to a bookmark by double-clicking on it.
\subsubsection{Deleting a Bookmark}
-To delete a bookmark from the Bookmarks dialog, click on it then click the \button{Delete} button.
+To delete a bookmark from the Bookmarks dialog, click on it then click
+ \button{Delete}.
Confirm your choice by clicking \button{Yes} or cancel the delete by clicking \button{No}.
More information about the QGIS-commit
mailing list