From f7590c3d491cb963799ea3e9e112dbf090aba0f7 Mon Sep 17 00:00:00 2001
From: mertz
Date: Fri, 28 Nov 2003 09:09:44 +0000
Subject: - typo signaled by Davy Serres and Zentara - tagOrIdOrTName in
 methods about transformations - correction of smooth description

---
 doc/refman.tex | 79 ++++++++++++++++++++++++++++++++--------------------------
 1 file changed, 44 insertions(+), 35 deletions(-)

(limited to 'doc/refman.tex')

diff --git a/doc/refman.tex b/doc/refman.tex
index b12a6ae..584bce3 100644
--- a/doc/refman.tex
+++ b/doc/refman.tex
@@ -36,7 +36,7 @@
     citecolor=webbrightgreen,
     pdftitle={Zinc, an advanced scriptable Canvas.},
     pdfauthor={Patrick Lecoanet, Christophe Mertz, Centre d'Étude de la Navigation Aérienne},
-    pdfsubject={The pre-3.3 (3.2.95) Reference Manual.},
+    pdfsubject={The pre-3.3 (3.2.96) Reference Manual.},
     pdfkeywords={tk tcl perl x11 canvas opengl script gui TkZinc},
     pagebackref,
     pdfpagemode=None,
@@ -208,7 +208,7 @@
 \setlength{\marginparwidth}{20pt}
 \setlength{\textwidth}{480pt}
 
-\title{Zinc, an advanced scriptable Canvas.\\The pre 3.3 (3.2.95) Reference Manual.\\\small{[CENA technical Note NT03-532]} }
+\title{Zinc, an advanced scriptable Canvas.\\The pre 3.3 (3.2.96) Reference Manual.\\\small{[CENA technical Note NT03-532]} }
 \author{Patrick Lecoanet, Christophe Mertz}
 \date{8 Octobre 2003}
 
@@ -291,7 +291,7 @@ This document is also referenced as CENA technical note NT03-532.
 
 \section{Differences with previous version}
 
-\subsection{Differences between 3.2.95 and 3.2.6 release}
+\subsection{Differences between 3.2.96 and 3.2.6 release}
 \begin{itemize}
 \item  TkZinc with Tcl/Tk now works on windows and MacOS X (with X11 and fink).
 \item  compilation on Linux works fine now, and TkZinc for Perl is on the CPAN
@@ -448,7 +448,7 @@ under an open source license.
 \section{Authors and credits}
 
 Zinc has been developed by Patrick Lecoanet. He also developed two previous
-version called \emph{Radar Widget} which share some caracteristics with this
+version called \emph{Radar Widget} which share some characteristics with this
 version. The \emph{Radar Widget} was heavily used at CENA for many projects over nearly
 10 years. The release 2 is still in use. It was enhanced and then used for actual
 radar displays in two main French Air Traffic Control Centres 24 hours a
@@ -906,6 +906,7 @@ any time. This is the use of the \cmdref{chggroup} command.
 
 
 \section{Attributes composed with children}
+
 The following attributes are composed down the item tree to form the
 resulting attribute value in the leaf items:
 \begin{itemize}
@@ -926,6 +927,7 @@ resulting attribute value in the leaf items:
 
 
 \section{Atomic groups}
+
 It may seem at first that there is a contradiction in this title, but there is not. It is
 possible to built complex objects from simple items simply by assembling those items
 together in a group (using other intervening groups if the need arise). Once this is
@@ -950,6 +952,7 @@ and not its part.
 A small program, \ident{Atomic groups} is available as part of
 \conceptref{zinc-demos}{zinc-demos} to demonstrate the atomic groups behaviour.
 
+
 \section{Display order and display lists}
 
 The items are displayed in a specific order which determines how they stack. This
@@ -1023,6 +1026,7 @@ the events.
 
 
 \section{Transformations}
+
 In TkZinc each item is geometrically defined in its own coordinate space. So
 each time a new item is created, a new coordinate system is attached to it.
 This coordinate system must be related to the coordinate systems of the other
@@ -1056,7 +1060,7 @@ coordinate space where the origin is not in the top left corner and where the Y
 from bottom to top. It is quite simple to write a function that is triggerred on the
 window resize event whose only goal is to compute a new transformation for the group.
 Other parts of the application and the other items are not aware of this happening. A
-good factorisation example.
+good factorization example.
 
 In fact, transformation are so useful that a whole set of functions are available
 to help use them in full. Apart from the already mentioned \cmdref{translate},
@@ -1080,6 +1084,9 @@ that will probably occur. This command may be used together with the translate,
 rotate commands if someone really want, even after reading this paragraph, to implement
 the canvas move, scale and even rotate commands.
 
+A predefined named transformation exists. Its name is \ident{identity} and refers to the 
+identity transform. it can not be modified by the user.
+
 When dealing with mouse events and other sources of window coordinates, it is
 often useful to map the window coordinates to an appropriate coordinate space. The
 command \cmdref{transform} is just what is needed to do so. It is powerful enough to be
@@ -1484,7 +1491,7 @@ In this chapter, we first list all commands by categories, then we details each
 \item{Bindings} : \cmdref{bind} \cmdref{focus}
 
 \item{Coordinates} : \cmdref{anchorxy} \cmdref{bbox} \cmdref{coords} \cmdref{contour}
-\cmdref{fit} \cmdref{smooth} \cmdref{transform} \cmdref{vertexat}
+\cmdref{fit} \cmdref{hasanchor} \cmdref{smooth} \cmdref{transform} \cmdref{vertexat}
 
 \item{Named resources} : \cmdref{gname} \cmdref{gdelete} \cmdref{tsave}
 
@@ -2440,9 +2447,9 @@ false.
 \end{blockindent}
 
 
-\zinccmd{scale}{tagOrId xFactor yFactor}
+\zinccmd{scale}{tagOrIdOrTName xFactor yFactor}
 
-{\tt\large \$zinc->{\bf scale}(tagOrId, xFactor, yFactor);}
+{\tt\large \$zinc->{\bf scale}(tagOrIdOrTName, xFactor, yFactor);}
 
 \begin{blockindent}
   Add a scale factor to the items or the transform described by {\tt tagOrId}. If {\tt
@@ -2522,9 +2529,10 @@ false.
 {\tt\large @coords = \$zinc->{\bf smooth}(coordList);}
 
 \begin{blockindent}
-  This command computes a sequence of Bezier segments that will smooth the polygon
+  This command computes a sequence of segments that will smooth the polygon
   described by the vertices in {\tt coordList} and returns a list of lists describing
-  thr points and control points for the generated segments. {\tt coordList} should be either a
+  points of the generated segments. These segments are approximating a Bezier curve.
+  {\tt coordList} should be either a
   flat list of an even number of coordinates in x, y order, or a list of lists of point
   coordinates X, Y. The returned list can be used to create or change the contour of a
   curve item.
@@ -2596,26 +2604,26 @@ false.
 \end{blockindent}
 
 
-\zinccmd{translate}{tagOrId xAmount yAmount}
+\zinccmd{translate}{tagOrIdOrTName xAmount yAmount}
 
-{\tt\large \$zinc->{\bf translate}(tagOrdId, xAmount, yAmount);}
+{\tt\large \$zinc->{\bf translate}(tagOrdIdOrTName, xAmount, yAmount);}
 
 \begin{blockindent}
-  Add a translation to the items or the transform described by {\tt tagOrId}. If {\tt
-  tagOrId} describes a named transform then this transform is used to do the operation. If
-  {\tt tagOrId} describes more than one item then all the items are affected by the
-  opration. If {\tt tagOrId} describes neither a named transform nor an item, an error is
+  Add a translation to the items or the transform described by {\tt tagOrIdOrTName}. If {\tt
+  tagOrIdOrTName} describes a named transform then this transform is used to do the operation. If
+  {\tt tagOrIdOrTName} describes more than one item then all the items are affected by the
+  opration. If {\tt tagOrIdOrTName} describes neither a named transform nor an item, an error is
   raised. A separate value is specified for X and Y.
 \end{blockindent}
 
 
-\zinccmd{treset}{tagOrId}
+\zinccmd{treset}{tagOrIdOrTName}
 
-{\tt\large \$zinc->{\bf treset}(tagOrdId);}
+{\tt\large \$zinc->{\bf treset}(tagOrdIdOrTName);}
 
 \begin{blockindent}
-  Set the named transform or the transform for the items described by {\tt tagOrId} to
-  identity. If {\tt tagOrId} describes neither a named transform nor an item, an error is
+  Set the named transform or the transform for the items described by {\tt tagOrIdOrTName} to
+  identity. If {\tt tagOrIdOrTName} describes neither a named transform nor an item, an error is
   raised.
 \end{blockindent}
 
@@ -2631,19 +2639,19 @@ false.
 \end{blockindent}
 
 
-\zinccmd{tsave}{?tagOrId? tName ?invert?}
+\zinccmd{tsave}{?tagOrIdOrTName? tName ?invert?}
 
 {\tt\large \$zinc->{\bf tsave}(tName);}\\
-{\tt\large \$zinc->{\bf tsave}(tagOrdId, tName);}\\
-{\tt\large \$zinc->{\bf tsave}(tagOrdId, tName, invert);}
+{\tt\large \$zinc->{\bf tsave}(tagOrdIdOrTName, tName);}\\
+{\tt\large \$zinc->{\bf tsave}(tagOrdIdOrTName, tName, invert);}
 
 \begin{blockindent}
   Create (or reset) a transform associated with the name {\tt tName} which has for initial
-  value the transform associated with the item {\tt tagOrId}. If {\tt tagOrId} describes
-  more than one item, the topmost in display list order is used. If {\tt tagOrId} doesn't
+  value the transform associated with the item {\tt tagOrIdOrTName}. If {\tt tagOrIdOrTName} describes
+  more than one item, the topmost in display list order is used. If {\tt tagOrIdOrTName} doesn't
   describe any item, an error is raised. If {\tt tName} already exists, the transform is
   set to the new value. This command is the only way to create a named transform.
-  If {\tt tagOrId} is not specified, the command returns a boolean telling if the
+  If {\tt tagOrIdOrTName} is not specified, the command returns a boolean telling if the
   name is already in use. The {\tt invert} boolean, if specified, cause the transform
   to be inverted prior to be saved.
 \end{blockindent}
@@ -2756,17 +2764,17 @@ identified by their ``partName'':
 This speed vector may be set visible or not, sensitive or other attributes can be set such
 as color, width, ticks, mark at the end... Its partName is \ident{speedvector}.
 \item a {\bf leader} which links the current position to the label. The leader may be
-visible or not, sensitive or not, and other graphic caracteristics can be modified. Its
+visible or not, sensitive or not, and other graphic characteristics can be modified. Its
 partName is \ident{leader}.
 \item {\bf past positions} which are previous position after the track has been moved by
 the \cmdref{coords} command. The number of such past positions, their visibility and other
-graphic caracteristics can be be modified. This part is never sensitive.
+graphic characteristics can be be modified. This part is never sensitive.
 \item a {\bf marker}, which is a circle around the current position. This marker can be
-visible or not and other graphic caracteristics can be configured. The marker is never
+visible or not and other graphic characteristics can be configured. The marker is never
 sensitive.
 \item a {\bf connection}, which is a link with another track or waypoint item; links are
 drawn between their {\bf current position}. This connection may be visible or not,
-sensitive or not, and other graphic caracteristics can be be modified. Its partName
+sensitive or not, and other graphic characteristics can be be modified. Its partName
 is \ident{connection}.
 \end{itemize}
 
@@ -2995,7 +3003,7 @@ A waypoint is composed of the following parts:
 \begin{itemize} 
 \item the {\bf position} of the waypoint. Its partName is \ident{position}.
 \item a {\bf leader} which links the current position to the label. The leader may be
-visible or not, sensitive or not, and other graphic caracteristics can be be modified. Its
+visible or not, sensitive or not, and other graphic characteristics can be be modified. Its
 partName is \ident{leader}.
 \item a {\bf label} which is a block of texts described by a labelformat (see chapter
 \conceptref{Labels, labelformat, and fields}{labelformat}. Each text can have its graphic
@@ -3003,7 +3011,7 @@ decorations (alignment, background, images, borders...). These attributes are li
 the chapter \conceptref{Labels, label formats and fields}{labelformat} and can be changed
 by the command \cmdref{itemconfigure}.
 \item a {\bf connection}, which is a link with another \ident{waypoint} or \ident{track} item.
-This connection may be visible or not, sensitive or not, and other graphic caracteristics
+This connection may be visible or not, sensitive or not, and other graphic characteristics
 can be be modified. Its partName is \ident{connection}.
 \end{itemize}
 
@@ -3901,9 +3909,10 @@ argument of the \cmdref{add} method. The field number can not be changed after c
 These fields will be indexed from 0 to n-1. The number of fields can be read
 with the command \cmdref{numparts}. For example:
 \begin{verbatim}
- $track = $zinc->add('track', 4, ....);
- # this creates a track item with 4 fields, indexed from 0 to 3
+ $track = $zinc->add('track',1, 4, ....);
+ # this creates a track item in root group with 4 fields, indexed from 0 to 3
 \end{verbatim}
+% $ comment for emacs colorization only!
 \item The rectangular geometries of displayable fields are defined through
 the item attribut \ident{-labelformat}. The value is a string following
 the syntax of the \attrtyperef{labelformat} type. This attribute can be set at any time;
@@ -4071,7 +4080,7 @@ by any new user of TkZinc: \attrtyperef{gradient} and \attrtyperef{labelformat}.
 
 \attrtype{anchor}
 \begin{blockindent}
-  Specifies one of the nine caracteristic points of a rectangle or a bounding box that will
+  Specifies one of the nine characteristic points of a rectangle or a bounding box that will
   be used to position the object. These points include the four corners, the four edge
   centers, and the center of the rectangle. The possible values are: {\tt nw}, {\tt n},
   {\tt ne}, {\tt e}, {\tt se}, {\tt s}, {\tt sw}, {\tt w}, {\tt center}.
-- 
cgit v1.1

