[QGIS Commit] r8926 - docs/trunk/english_us/user_guide

[svn_qgis at osgeo.org]

Author: taraathan
Date: 2008-07-27 00:47:09 -0400 (Sun, 27 Jul 2008)
New Revision: 8926

Modified:
   docs/trunk/english_us/user_guide/conventions.tex
Log:
in conventions.tex, added comments for text styles
style fieldname has been commented out
   use guilabel, usertext or searchstring instead
macro toolbox has been commented out
   use toolboxtwo instead

Modified: docs/trunk/english_us/user_guide/conventions.tex
===================================================================
--- docs/trunk/english_us/user_guide/conventions.tex	2008-07-27 03:18:10 UTC (rev 8925)
+++ docs/trunk/english_us/user_guide/conventions.tex	2008-07-27 04:47:09 UTC (rev 8926)
@@ -3,19 +3,28 @@
 % \fbox, \shadowbox, \doublebox, \ovalbox and \Ovalbox
 %%%%%%%%%%%%%%%%8%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 %
+% general styles for text that the user should type in from the keyboard
 \renewcommand{\usertext}[1]{\texttt{#1}}
-\renewcommand{\classname}[1]{\textsf{\textbf{#1}}}
-\renewcommand{\fieldname}[1]{\textsl{#1}}
 \renewcommand{\filename}[1]{\texttt{#1}}
+% style for user input by individual keystrokes
 \renewcommand{\keystroke}[1]{\cornersize{.6}\ovalbox{\textsf{#1}}}
+% generic style for text that appears in the GUI
+\newcommand{\guilabel}[1]{\textsf{#1}}
+\newcommand{\guiheading}[1]{\textsf{#1}}
+% some styles for use only when discussing Python coding
+\renewcommand{\classname}[1]{\textsf{\textbf{#1}}}
 \renewcommand{\method}[1]{\textsf{\textit{#1}}}
-\renewcommand{\server}[1]{\textit{#1}}
-\renewcommand{\sqltable}[1]{\textsf{\textbf{#1}}}
-\newcommand{\guilabel}[1]{\textsf{#1}}
+%\renewcommand{\fieldname}[1]{\textsl{#1}}
 \newcommand{\object}[1]{\textsf{\textit{#1}}}
+% some styles for the Qt GUI
 \newcommand{\qtmainmenuopt}[1]{\textsf{#1}}
 \newcommand{\qtdropmenuopt}[1]{\textsf{#1}}
 \newcommand{\qtdialog}[1]{\textsf{#1}}
+% ??? these styles are from Gary
+\renewcommand{\server}[1]{\textit{#1}}
+\renewcommand{\sqltable}[1]{\textsf{\textbf{#1}}}
+
+
 %
 \newcommand{\dialog}[1]{
 \fcolorbox[rgb]{0.2,0.2,0.95}[rgb]{0.2,0.2,0.95}{%
@@ -112,10 +121,10 @@
 \includegraphics[width=5mm]{#3}%
  \guilabel{#4}%
 }}}
-%for backward compatibility!
-\newcommand{\toolbox}[2]{%
-\toolboxtwo{#1}{#2}%
-}
+%not to be used anymore
+%\newcommand{\toolbox}[2]{%
+%\toolboxtwo{#1}{#2}%
+%}
 % tab
 \newcommand{\tab}[1]{%
 \raisebox{-6pt}{%
@@ -286,7 +295,7 @@
 \item Keystroke Combinations: press \keystroke{Ctrl-B}, meaning press and
 hold the Ctrl key and then press the B key.
 \item Name of a File: \filename{lakes.shp}
-\item Name of a Field: \fieldname{NAMES}
+%\item Name of a Field: \fieldname{NAMES}
 \item Name of a Class: \classname{NewLayer}
 \item Method: \method{classFactory}
 \item Server: \server{example needed here}