* suppression d'un �norme bug de la doc html du chapitre "Widget

creation and options" o� apparaissait plein de texte sous forme d'images

* am�lioration du rendu html (suppression d'un peu d'espace blanc
inutile, meilleure barre <hr>, suppression du texte 0.5in en d�but d'index....)

* le retour de la m�thode coords est mieux(?) document�e

* suppression d'un exemple erron� dans la m�thode find

1 files changed, 86 insertions, 77 deletions

diff --git a/doc/refman.tex b/doc/refman.tex
index 3be05b5..aa321a9 100644
--- a/doc/refman.tex
+++ b/doc/refman.tex
@@ -71,23 +71,26 @@
 \newcommand{\ident}[1] {%
   {\tt\large #1}}
 
-\newenvironment{blockindent}{\begin{quote}\vspace{-0.8\baselineskip}}{\end{quote}\vspace{-0.5\baselineskip}}
+\newenvironment{blockindent}  {\begin{quote}\latexhtml{\ifpdf\vspace{-0.8\baselineskip}\fi}{}}  {\end{quote}\latexhtml{\ifpdf\vspace{-0.5\baselineskip}\fi}{}}
+%\newenvironment{blockindent}{\begin{quote}\vspace{-0.8\baselineskip}}{\end{quote}\vspace{-0.5\baselineskip}}
 
-\newcommand{\option}[4]{%
+
+\newcommand{\option}[3]{%
   \label{opt:#1}
   \index{#1}
-  \latexhtml{\ifpdf\hyperdef{opt}{#1}{}\fi}{\htmlrule[WIDTH="300" left]}
+  \latexhtml{\ifpdf\hyperdef{opt}{#1}{}\fi}{\htmlrule[WIDTH="70\%" left]}
   \begin{tabular}{rl}
     Command line switch: & \ident{-#1} \\
     Database name: & \ident{#2} \\
     Database class: & \ident{#3} \\
-  \end{tabular}
-  \begin{blockindent}{#4}\end{blockindent} }
+  \end{tabular}}
+%  \begin{blockindent}#4\end{blockindent}}
+
 
 \newcommand{\command}[3]{%
   \label{cmd:#2}
   \index{#2}
-  \latexhtml{\ifpdf\hyperdef{cmd}{#2}{}\fi}{\htmlrule[WIDTH="300" left]}
+  \latexhtml{\ifpdf\hyperdef{cmd}{#2}{}\fi}{\htmlrule[WIDTH="70\%" left]}
   {\tt\large #1 {\bf #2} #3}}
 
 \newcommand{\zinccmd}[2]{%
@@ -96,7 +99,7 @@
 \newcommand{\mapinfocmd}[3]{%
   \label{mapcmd:#2}
   \index{#2}
-  \latexhtml{\ifpdf\hyperdef{mapcmd}{#2}{}\fi}{\htmlrule[WIDTH="300" left]}
+  \latexhtml{\ifpdf\hyperdef{mapcmd}{#2}{}\fi}{\htmlrule[WIDTH="70\%" left]}
   {\tt\large mapinfo #1 {\bf #2} #3}\\
   {\tt\large \$mainwindow->mapinfo(#1, {\bf #2}, #3) }
   % slightly buggy XXX : missing commas when #3 contains many words
@@ -207,12 +210,14 @@
 
 \title{Zinc, an advanced scriptable Canvas.\\The 3.4 pre-release Reference Manual.\\\small{[CENA technical Note NT03-532]} }
 \author{Patrick Lecoanet, Christophe Mertz}
-\date{25 February 2003}
+\date{17 March 2003}
 
 
 \begin{document}
 %pdfpagewidth: \the\pdfpagewidth pdfpageheight: \the\pdfpageheight voffset: \the\voffset ~topmargin: \the\topmargin ~textheight: \the\textheight \linebreak
-\voffset=-0.5in  \setlength\textheight{ (\textheight+0.5in) }
+
+\latexhtml{\ifpdf\voffset=-0.5in  \setlength\textheight{ (\textheight+0.5in) }\fi}
+
 %voffset: \the\voffset ~topmargin: \the\topmargin ~textheight: \the\textheight \linebreak
 
 
@@ -304,7 +309,7 @@ It has been replaced by the GLU library. So TkZinc is again fully free software.
 \item  TkZinc comes now with a Zinctrace.pm module to trace every TkZinc method call
 \item  the hierarchical view in ZincDebug.pm can now display some choosen attributes
 in a choosen format.
-\item  3 new perl demos in zinc-demos: ``tiger'' and ``curve with bezier control points''
+\item  4 new perl demos in zinc-demos: ``pathTags'', ``tiger'' and ``curve with bezier control points''
 and ``fillrule''
 \item  pathTags introduced in 3.2.6 have been documented. Label and label
 format documentation has been enhanced.
@@ -544,180 +549,180 @@ described below.
 
 
 \option{backcolor}{backColor}{BackColor}
-{
+\begin{blockindent}
 This is the color that will
 be used to fill the TkZinc window. It is also used as a default color
 for some item color attributes. See each color attribute for the
 actual source of the default color. Its default value is
 {\tt \#c3c3c3}, a light grey.
-}
+\end{blockindent}
 
 \option{borderwidth}{borderWidth}{BorderWidth}
-{
+\begin{blockindent}
   Specifies the width of the 3d border that should be displayed around the widget
   window. This border does overlap the active TkZinc display area. The area
   requested from the geometry manager (or the window manager if applicable)
   is the area defined by \optref{width} and \optref{height}, the border is not
   taken into account. This value can be given in any of the forms valid for
   coordinates (See \cident{TkGet\_Pixels}). The default value is {\tt 2}.
-}
+\end{blockindent}
 
 \option{cursor}{cursor}{Cursor}
-{
+\begin{blockindent}
   Specifies the cursor to use when the pointer is in the TkZinc window.  The default
   value is set to preserve the cursor inherited at widget creation.
-}
+\end{blockindent}
 
 \option{font}{font}{Font}
-{
+\begin{blockindent}
   The font specified by this option is used as a default font for item attributes of
   type font. Its default value is {\tt -adobe-helvetica-bold-r-normal--*-120-*-*-*-*-*-*}.
-}
+\end{blockindent}
 
 \option{forecolor}{foreColor}{ForeColor} %% XXX CM Foreground ?!
-{
+\begin{blockindent}
   The color specified by this option is used as a default color for many item color
   attributes. See each each color attribute for the actual source of the default
   color. Its default value is {\tt black}.
-}
+\end{blockindent}
 
 \option{fullreshape}{fullReshape}{FullReshape}
-{
+\begin{blockindent}
   If this option is True, the shape applied to the TkZinc window will propagate up the
   window hierarchy to the toplevel window. The result will be a shaped toplevel.
   See also the \optref{reshape} option, it controls whether a shape is applied
   to the TkZinc window or not.  The default is {\tt true}.
-}
+\end{blockindent}
 
 \option{height}{height}{Height}
-{
+\begin{blockindent}
   Specifies the height of the TkZinc window. This value can be given in any of the
   forms valid for coordinates (See \cident{Tk\_GetPixels}). The default is {\tt 100}
   pixels.
-}
+\end{blockindent}
 
 \option{highlightbackground}{highlightBackground}{HighlightBackground}
-{
+\begin{blockindent}
   Specifies the color to display in the traversal highlight region when the
   widget does not have the input focus. The default value is {\tt \#c3c3c3}.
-}
+\end{blockindent}
 
 \option{highlightcolor}{highlightColor}{HighlightColor}
-{
+\begin{blockindent}
   Specifies the color to use for the traversal highlight rectangle that is drawn
   around the widget when it has the input focus. The default value is {\tt black}.
-}
+\end{blockindent}
 
 \option{highlightthickness}{highlightThickness}{HighlightThickness}
-{
+\begin{blockindent}
   Specifies a non-negative value indicating the width of the highlight rectangle
   drawn around the outside of the widget when it has the input focus. The value may
   have any of the forms acceptable to \cident{Tk\_GetPixels}.  If the value is zero,
   no focus highlight is drawn around the widget.  The default value is {\tt 2}.
-}
+\end{blockindent}
 
 \option{insertbackground}{insertBackground}{InsertBackground}  %% XXX CM Foreground ?!
-{
+\begin{blockindent}
   Specifies the color to use as background in the area covered by the insertion
   cursor. This color will normally override either the normal background for the
   widget (or the selection background if the insertion cursor happens to fall in the
   selection). The default value is {\tt black}.
-}
+\end{blockindent}
 
 \option{insertofftime}{insertOffTime}{InsertOffTime}  %% XXX CM OffTime ?!
-{
+\begin{blockindent}
   Specifies a non-negative integer value indicating the number of milliseconds the
   insertion cursor should remain off in each blink cycle.  If this option is zero
   then the cursor is on all the time. The default value is {\tt 300}.
-}
+\end{blockindent}
 
 \option{insertontime}{insertOnTime}{InsertOnTime}  %% XXX CM OnTime ?!
-{
+\begin{blockindent}
   Specifies a non-negative integer value indicating the number of milliseconds the
   insertion cursor should remain on in each blink cycle.  The default value is {\tt 600}.
-}
+\end{blockindent}
 
 \option{insertwidth}{insertWidth}{InsertWidth}
-{
+\begin{blockindent}
   Specifies a value indicating the width of the insertion cursor.  The value may have
   any of the forms acceptable to \cident{Tk\_GetPixels}.  The default value is {\tt 2}.
-}
+\end{blockindent}
 
 \option{lightangle}{lightAngle}{LightAngle}
-{
+\begin{blockindent}
   Specifies the lighting angle used when displaying relief. The default value is {\tt 120}. %%% XXX CM to be completed!
-}
+\end{blockindent}
 
 \option{mapdistancesymbol}{mapDistanceSymbol}{MapDistanceSymbol}
-{
+\begin{blockindent}
   This option specifies the symbol to be used as a milestone along map lines. This
   option can be given any Tk bitmap which can be obtained by
   \cident{Tk\_GetBitmap}. The spacing between markers is 10 nautic miles. The default
   value is {\tt AtcSymbol19} (see \conceptref{Other resources provided by the widget}{otherresources}).
-}
+\end{blockindent}
 
 \option{maptextfont}{mapTextFont}{MapTextFont}
-{
+\begin{blockindent}
   Specifies the font used to draw the texts contained in maps. The default is
   {\tt -adobe-helvetica-bold-r-normal--*-120-*-*-*-*-*-*}.
-}
+\end{blockindent}
 
 \option{overlapmanager}{overlapManager}{OverlapManager}
-{
+\begin{blockindent}
   This option accepts an item id. It specifies if the label overlapping avoidance
   algorithm should be allowed to do its work on the track labels and which group
   should be considered to look for tracks. The default is to enable the avoidance
   algorithm in the root group (id 1). To disable the algorithm this option should
   be set to {\tt 0}.
-}
+\end{blockindent}
 
 \option{pickaperture}{pickAperture}{PickAperture}
-{
+\begin{blockindent}
   Specifies the size of an area around the pointer that is used to tell if the
   pointer is inside an item. This is useful to lessen the precision required when
   picking graphical elements. This value must be a positive integer. It defaults to
   {\tt 1}.
-}
+\end{blockindent}
 
 \option{relief}{relief}{Relief}
-{
+\begin{blockindent}
   Specifies the border relief. This option can be given any legal value for a relief
   (See \attrtyperef{relief} for a description of possible values). XXX what is the meaning
   of this option. The default value is {\tt flat}.
-}
+\end{blockindent}
 
 \option{render}{render}{Render}
-{
+\begin{blockindent}
   Specifies whether to use or not the openGL rendering. When True, requires the GLX
   extension to the X server. Must be defined at widget creation time.  This option is
   readonly and can be used to ask if the widget is drawing with the GLX extension or
   in plain X (to adapt the application code for example). The default value is {\tt false}.
-}
+\end{blockindent}
 
 \option{reshape}{reshape}{Reshape}
-{
+\begin{blockindent}
   Specifies if the clipping shape that can be set in the root group item should clip
   the root group children or be used to reshape the TkZinc window. This option can be
   used with the fullreshape option to reshape the toplevel window as well. The
   default value is {\tt true}.
-}
+\end{blockindent}
 
 \option{selectbackground}{selectBackground}{SelectBackground}  %% XXX CM Foreground ?!
-{
+\begin{blockindent}
   Specifies the background color to use for displaying the selection in text
   items. The default value is {\tt \#a0a0a0}.
-}
+\end{blockindent}
 
 \option{speedvectorlength}{speedVectorLength}{SpeedVectorLength}
-{
+\begin{blockindent}
   Specifies the duration of track speed vectors. This option is expressed using a
   time unit that should be chosen by the application (usually minutes) and kept
   coherent with the unit of the track attribute \attributeref{track}{speedvector} (usually nautic
   mile / minute). The default value is {\tt 3}.
-}
+\end{blockindent}
 
 \option{takefocus}{takeFocus}{TakeFocus}
-{
+\begin{blockindent}
   (Slightly adapted from the Tk options manpage).
 
   Determines whether the window accepts the focus during keyboard traversal (e.g., Tab and
@@ -737,25 +742,24 @@ actual source of the default color. Its default value is
   widget implementations ignore the option entirely, so you can change its meaning if you
   redefine the keyboard traversal scripts.}
   The default value is empty.
-
-}
+\end{blockindent}
 
 \option{tile}{tile}{Tile}
-{
+\begin{blockindent}
   Specifies an image name to be used as a tile for painting the TkZinc window
   background. The default value is {\tt ""} (the empty string).
-}
+\end{blockindent}
 
 \option{trackmanagedhistorysize}{trackManagedHistorySize}{TrackManagedHistorySize}
-{
+\begin{blockindent}
   This option accepts only positive integers. It specifies the size of the past
   position list that should be maintained by the track items. See also the
   \optref{trackmanagehistory} option and the \attributeref{track}{visiblehistorysize} track
   attribute. The default value is {\tt 6}.
-}
+\end{blockindent}
 
 \option{trackmanagehistory}{trackManageHistory}{TrackManageHistory}
-{
+\begin{blockindent}
   This option accepts any form valid for a boolean. It specifies if the track items
   should maintain a list of their past positions to be displayed as trailing
   speckles. If this option is turned off and then back on, the history list is erased
@@ -766,14 +770,14 @@ actual source of the default color. Its default value is
   number of past positions actually displayed if specified for each track by the
   \attributeref{track}{visiblehistorysize} attribute.  The default is to enable the history
   collection.
-}
+\end{blockindent}
 
 \option{width}{width}{Width}
-{
+\begin{blockindent}
   Specifies the width of the TkZinc window. This value can be given in any of
   the forms valid for coordinates (See \cident{Tk\_GetPixels}). The default is
   {\tt 100} pixels.
-}
+\end{blockindent}
 
 
 
@@ -1152,6 +1156,7 @@ present, the search is limited to the current group level. If a star is
 present, the search proceed from the current group level down the whole
 group subtree.
 
+A demo called ``Using pathTags'' in zinc-demos may help you better understand pathTags.
 Here are some commonly used pathTags idioms:
 
 \begin{description}
@@ -1818,8 +1823,14 @@ false.
   read. For all items that do not support multiple contours (currently all except curves)
   the {\tt contour} parameter should be omitted or specified as zero.
 
-  When {\tt coords} is used to get more than one point, the return value is {\bf always} a
-  list of lists. Each sub list contains X, Y, and 'c' if the point is a bezier control point.
+  When {\tt coords} is used to get potentially more than one point, it returns {\bf always}
+  a list of lists. Each sub list contains X, Y, and 'c' if the point is a
+  bezier control point.
+
+  When {\tt coords} is used to get exactly one point (either because it is used to
+  get the nth point of an item or because the item always has exactly one point (e.g.
+  the item is a group, track, waypoint, map, or reticle)), it returns
+  a flat list of 2 (or may be 3 for control points of curve items) values.
 
   The optional parameters must be combined to produce a given behavior. Here are the
   various form recognized by the command:
@@ -1982,7 +1993,7 @@ false.
         \# to get direct children of an atomic group with a pathTag:\\
         @children = \$zinc->find('withtag', ".atomicGroup.");\\
 
-	\# to get all groups recursevely contained in a group\\
+	\# to get all groups recursively contained in a group\\
 	@groups = \$zinc->find('withtype', 'group', ".aGroup*");
   }
 
@@ -1992,9 +2003,6 @@ false.
                 pathname {\bf find} above tagOrId \\
                 \$zinc->{\bf find}('above', tagOrId);}
         \item{\tt\large
-                pathname {\bf find} all ?inGroup? ?recursive?\\
-                \$zinc->{\bf find}('all', ?inGroup?, ?recursive?);}
-        \item{\tt\large
                 pathname {\bf find} atpriority priority ?tagOrId?\\
                 \$zinc->{\bf find}('atpriority', priority, ?tagOrId?);}
         \item{\tt\large
@@ -4499,10 +4507,11 @@ by using a small module called \ident{ZincTrace.pm}, released with \ident{TkZinc
 It will trace every call of a TkZinc method. It will trace on the standard output
 the following informations:
 \begin{itemize}
-\item the TkZinc method name
-\item the full filename where this method has been invoked
+\item the filename where the method has been invoked
 \item the line number in the source file
+\item the TkZinc method name
 \item the list of arguments in a human-readable form
+\item the returned value of this method invocation
 \end{itemize}
 
 To use this module you can import it either by adding the following