From 256d3bffae822c07f483a4055ed1c3a8afc4a11b Mon Sep 17 00:00:00 2001
From: mertz
Date: Fri, 16 May 2003 12:50:13 +0000
Subject: - default priorities have been updated, according recent changes -
 some precision on use of a lnln format for a field in a   labelformat, when
 other fields sizes are changing - more precision on connecteditem (about
 group and connectable item)   ... still not complete

---
 doc/refman.tex | 95 +++++++++++++++++++++++++++++++++++-----------------------
 1 file changed, 57 insertions(+), 38 deletions(-)

(limited to 'doc/refman.tex')

diff --git a/doc/refman.tex b/doc/refman.tex
index 9c92e35..f3def21 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.2.6i Reference Manual.},
+    pdfsubject={The pre-3.3 (3.2.93) Reference Manual.},
     pdfkeywords={tk tcl perl x11 canvas opengl script gui TkZinc},
     pagebackref,
     pdfpagemode=None,
@@ -208,9 +208,9 @@
 \setlength{\marginparwidth}{20pt}
 \setlength{\textwidth}{480pt}
 
-\title{Zinc, an advanced scriptable Canvas.\\The 3.2.6i Reference Manual.\\\small{[CENA technical Note NT03-532]} }
+\title{Zinc, an advanced scriptable Canvas.\\The pre 3.3 (3.2.93) Reference Manual.\\\small{[CENA technical Note NT03-532]} }
 \author{Patrick Lecoanet, Christophe Mertz}
-\date{2 April 2003}
+\date{16 May 2003}
 
 
 \begin{document}
@@ -291,8 +291,11 @@ This document is also referenced as CENA technical note NT03-532.
 
 \section{Differences with previous version}
 
-\subsection{Differences between 3.2.6i and 3.2.6 release}
+\subsection{Differences between 3.2.93 and 3.2.6 release}
 \begin{itemize}
+\item  TkZinc now works on windows (with Tcl).
+\item  compilation on Linux works fine now.
+\item  png images with transparencies acan now be displayed (requires openGL rendering only)
 \item  bezier items have been suppressed; they can now be easily replaced by curve items.
 \item  curve items support now a higher level of description: they may be composed of line
 segments, and bezier segments. In the future they may also support other kinds of segments
@@ -307,11 +310,11 @@ It has been replaced by the GLU library. So TkZinc is again fully free software.
 \item  curve item have a new -fillrule attribute. 
 \item  the syntax of gradient has been changed, mainly to accomodate with any color specification
 defined for X. {\bf Beware that old gradient are no more compatible}
-\item  TkZinc comes now with a Zinctrace.pm module to trace every TkZinc method call
+\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  4 new perl demos in zinc-demos: ``pathTags'', ``tiger'' and ``curve with bezier control points''
-and ``fillrule''
+and ``fillrule''. Most Perl/Tk demos have been ported to Tcl/Tk.
 \item  pathTags introduced in 3.2.6 have been documented. Label and label
 format documentation has been enhanced.
 \end{itemize}
@@ -901,6 +904,8 @@ groups.
   priority matching the priority of existing items of the group, the new item is placed on
   top of the those items. Last comer is most visible. The same rule is followed when
   changing the priority of an item and when moving an item to a new group.
+  \objectref{map} and \objectref{reticle} default priority is 0. \objectref{window}
+  item attribute is meaningless. All other items default priority is 1. 
 \item 
  The commands \cmdref{raise} and \cmdref{lower} adjust the relative order of an item
  in its group. These commands can be used to bring an item in front or to the back of
@@ -2611,7 +2616,7 @@ composed with the local transform. The default value is {\tt true}.}
 with the local transform. The default value is {\tt true}.}
 
 \attribute{group}{priority}{priority}{The absolute position in the stacking order among
-siblings of the same parent group. The default value is {\tt 6}.}
+siblings of the same parent group. The default value is {\tt 1}.}
 
 \attribute{group}{sensitive}{boolean}{Specifies if the item and all its children should
 react to events. The defaut value is {\tt true}.}
@@ -2650,10 +2655,12 @@ graphic caracteristics 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
 sensitive.
-\item a {\bf connection}, which is a link with another item. This connection may be
-visible or not, sensitive or not, and other graphic caracteristics can be be modified. Its
-partName is \ident{connection}.
+\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
+is \ident{connection}.
 \end{itemize}
+
 \item the second part is a block of texts described by a labelformat (see chapter
 \conceptref{Labels, labelformats, and fields}{labelformat}. Each text can have its graphic
 decorations (alignment, background, images, borders...). These attributes are listed in
@@ -2673,12 +2680,16 @@ anti-overlap manager. This manager tries to avoid any overlap of tracks labels.
 avoids that the label overlap the speedvector. This manager is stable over time: there
 should be few cases where labels are moved to a very different position. This manager
 applies to all tracks included in a group (by default the group 1). It can be
-enabled/disabled with the attributes XXX. New labels positions are computed by the overlap
+enabled/disabled with the TkZinc attribute \optref{overlapmanager}.
+New labels positions are computed by the overlap
 manager every time a track is moved, a track is created or destroyed and every time the
 TkZinc widget is resized. Due to software licence limitation, TkZinc \emph{do not include}
 the very last version of this anti-overlap manager. If you are interested
 in this anti-overlap manager, please contact Didier Pavet at {\tt pavet@cena.fr}.
 
+Track items can be linked together or to waypoint items. The line figuring the link
+is configurable.
+
 Applicable attributes for \ident{track} are :
 
 \attribute{track}{circlehistory}{boolean}{If set to true the track history will be plotted
@@ -2694,8 +2705,9 @@ composed with the local transform. The default value is {\tt true}.}
 \attribute{track}{composescale}{boolean}{Specifies if the current scale should be composed
 with the local transform. The default value is {\tt true}.}
 
-\attribute{track}{connecteditem}{item}{The item at the other end of the connection link.
-The default value is {\tt ""} which means that no connection link will be drawn.}
+\attribute{track}{connecteditem}{item}{The \ident{track} or \ident{waypoint} item at the
+other end of the connection link. The default value is {\tt ""} which means that
+no connection link will be drawn.}
 
 \attribute{track}{connectioncolor}{gradient}{The uniform (possibly transparent)
 color of the connection link. The first color of a real gradient color
@@ -2812,7 +2824,7 @@ label. This attribute is read only.}
 is {\tt "0 0"}.}
 
 \attribute{track}{priority}{priority}{The absolute position in the stacking order among
-siblings of the same parent group. The default value is {\tt 5}.}
+siblings of the same parent group. The default value is {\tt 1}.}
 
 \attribute{track}{sensitive}{boolean}{Specifies if the item should react to events. The
 default value is {\tt true}.}
@@ -2881,9 +2893,9 @@ partName is \ident{leader}.
 decorations (alignment, background, images, borders...). These attributes are listed in
 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 item. This connection may be
-visible or not, sensitive or not, and other graphic caracteristics can be be modified. Its
-partName is \ident{connection}.
+\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
+can be be modified. Its partName is \ident{connection}.
 \end{itemize}
 
 
@@ -2902,8 +2914,9 @@ composed with the local transform. The default value is {\tt true}. }
 \attribute{waypoint}{composescale}{boolean}{Specifies if the current scale should be
 composed with the local transform. The default value is {\tt true}. }
 
-\attribute{waypoint}{connecteditem}{item}{The item at the other end of the connection
-link. The default value is {\tt ""} which means that no connection link will be drawn.}
+\attribute{waypoint}{connecteditem}{item}{The \ident{track} or \ident{waypoint} item at the
+other end of the connection link. The default value is {\tt ""} which means that
+no connection link will be drawn.}
 
 \attribute{waypoint}{connectioncolor}{gradient}{The uniform (possibly transparent) color of
 the connection link. The first color of a real gradient color will be used. The
@@ -2996,7 +3009,7 @@ label. This attribute is read only.}
 default value is {\tt "0 0"}.}
 
 \attribute{waypoint}{priority}{priority}{The absolute position in the stacking order among
-siblings of the same parent group. The default value is {\tt 4}.}
+siblings of the same parent group. The default value is {\tt 1}.}
 
 \attribute{waypoint}{sensitive}{boolean}{Specifies if the item should react to events.
 The default value is {\tt true}.}
@@ -3031,6 +3044,8 @@ by a labelformat (see chapter \conceptref{Labels, labelformats and fields}{label
 Each text can have its graphic decorations (alignment, background, images, borders...).
 This attributes are listed in the chapter \conceptref{Labels, label formats and
 fields}{labelformat} and can be changed by the command \cmdref{itemconfigure}.
+A tabular can be attached with the \attributeref{tabular}{connecteditem} attribute to the
+label of a \objectref{track}, \objectref{waypoint} or another \objectref{tabular}. 
 
 Applicable attributes for \ident{tabular} are:
 
@@ -3046,8 +3061,9 @@ composed with the local transform. The default value is {\tt true}.}
 \attribute{tabular}{composescale}{boolean}{Specifies if the current scale should be
 composed with the local transform. The default value is {\tt true}.}
 
-\attribute{tabular}{connecteditem}{item}{Specifies the item relative to which this item is
-placed. The default value is {\tt ""}.}
+\attribute{tabular}{connecteditem}{item}{Specifies the The \ident{track}, \ident{waypoint} or
+\ident{tabular} item relative to which this item is
+placed. Connected item should be in the same group. The default value is {\tt ""}.}
 
 \attribute{tabular}{connectionanchor}{anchor}{Specifies the anchor on the connected item.
 The default value is {\tt sw}.}
@@ -3062,7 +3078,7 @@ label. This attribute is read only.}
 connected item specified). The default value is {\tt "0 0"}.}
 
 \attribute{tabular}{priority}{priority}{The absolute position in the stacking order among
-siblings of the same parent group. The default value is {\tt 3}. }
+siblings of the same parent group. The default value is {\tt 1}. }
 
 \attribute{tabular}{sensitive}{boolean}{Specifies if the item should react to events. The
 default value is {\tt true}.}
@@ -3110,7 +3126,7 @@ composed with the local transform. The default value is {\tt true}.}
 with the local transform. The default value is {\tt true}.}
 
 \attribute{text}{connecteditem}{item}{Specifies the item relative to which this item is
-placed. The default value is {\tt ""}.}
+placed. Connected item should be in the same group. The default value is {\tt ""}.}
 
 \attribute{text}{connectionanchor}{anchor}{Specifies the anchor on the connected item.
 The default value is {\tt sw}.}
@@ -3128,7 +3144,7 @@ across the text characters. The default value is {\tt false}.}
 connected item specified). The default value is {\tt "0 0"} (Tcl/Tk) or {\tt [0,0]} (Perl/Tk).}
 
 \attribute{text}{priority}{priority}{The absolute position in the stacking order among
-siblings of the same parent group. The default value is {\tt 2}.}
+siblings of the same parent group. The default value is {\tt 1}.}
 
 \attribute{text}{sensitive}{boolean}{Specifies if the item should react to events. The
 default value is {\tt true}.}
@@ -3187,7 +3203,7 @@ is set to {\tt true} without openGL rendering, it will be automatically set back
 {\tt false}.}
 
 \attribute{icon}{connecteditem}{item}{Specifies the item relative to which this item is
-placed.}
+placed. Connected item should be in the same group. The default value is {\tt ""}.}
 
 \attribute{icon}{connectionanchor}{anchor}{Specifies the anchor on the connected item.
 The default value is {\tt sw}.}
@@ -3206,7 +3222,7 @@ The default value is {\tt ""}.}
 connected item specified). The default value is {\tt "0 0"} (Tcl/Tk) or {\tt [0,0]} (Perl/Tk.}
 
 \attribute{icon}{priority}{priority}{The absolute position in the stacking order among
-siblings of the same parent group. The default value is {\tt 2}.}
+siblings of the same parent group. The default value is {\tt 1}.}
 
 \attribute{icon}{sensitive}{boolean}{Specifies if the item should react to events. The
 default value is {\tt true}.}
@@ -3270,7 +3286,7 @@ the regulars. The default value is {\tt 5} which means that a bright circle is d
 value is {\tt "0 0"}.}
 
 \attribute{reticle}{priority}{priority}{The absolute position in the stacking order among
-siblings of the same parent group. The default value is {\tt 2}.}
+siblings of the same parent group. The default value is {\tt 0}.}
 
 \attribute{reticle}{sensitive}{boolean}{Specifies if the item should react to events. The
 default value is {\tt false} as the item cannot handle events.}
@@ -3328,7 +3344,7 @@ coordinate system. The default value is {\tt ""} which means that nothing will b
 displayed by the map.}
 
 \attribute{map}{priority}{priority}{The absolute position in the stacking order among
-siblings of the same parent group. The default value is {\tt 1}.}
+siblings of the same parent group. The default value is {\tt 0}.}
 
 \attribute{map}{sensitive}{boolean}{Specifies if the item should react to events. The
 default value is {\tt false} as the item cannot handle events.}
@@ -3392,7 +3408,7 @@ the outline. The default value is {\tt simple}.}
 scalable). The default value is {\tt 1}.}
 
 \attribute{rectangle}{priority}{priority}{The absolute position in the stacking order among
-siblings of the same parent group. The default value is {\tt 2}.}
+siblings of the same parent group. The default value is {\tt 1}.}
 
 \attribute{rectangle}{relief}{relief}{Specifies the relief used to drawn the rectangle
 outline. This attribute has priority over the \attributeref{rectangle}{linepattern} and
@@ -3485,7 +3501,7 @@ less than 360 degrees. If this attribute is true the arc open end will be drawn
 slice otherwise it will be drawn as a chord. The default value is {\tt false}.}
 
 \attribute{arc}{priority}{priority}{The absolute position in the stacking order among
-siblings of the same parent group. The default value is {\tt 2}.}
+siblings of the same parent group. The default value is {\tt 1}.}
 
 \attribute{arc}{sensitive}{boolean}{Specifies if the item should react to events. The
 default value is {\tt true}.}
@@ -3600,7 +3616,7 @@ markers. The first color of a real gradient color will be used.
 The default value is the current value of the widget option \optref{forecolor}.}
 
 \attribute{curve}{priority}{priority}{The absolute position in the stacking order among
-siblings of the same parent group. The default value is {\tt 2}.}
+siblings of the same parent group. The default value is {\tt 1}.}
 
 \attribute{curve}{relief}{relief}{Specifies the relief used to drawn the curve
 outline. This attribute has priority over the \attributeref{curve}{linepattern} and
@@ -3655,7 +3671,7 @@ composed with the local transform. The default value is {\tt true}.}
 Otherwise triangles are arranged like a strip. The default value is {\tt true}.}
 
 \attribute{triangles}{priority}{priority}{The absolute position in the stacking order among
-siblings of the same parent group. The default value is {\tt 2}.}
+siblings of the same parent group. The default value is {\tt 1}.}
 
 \attribute{triangles}{sensitive}{boolean}{Specifies if the item should react to events.
 The default value is {\tt true}.}
@@ -3703,7 +3719,7 @@ composed with the local transform. The default value is {\tt true}.}
 composed with the local transform. The default value is {\tt true}.}
 
 \attribute{window}{connecteditem}{item}{Specifies the item relative to which this item is
-placed. The default value is {\tt ""}.}
+placed. Connected item should be in the same group. The default value is {\tt ""}.}
 
 \attribute{window}{connectionanchor}{anchor}{Specifies the anchor on the connected item
 used for the placement. The default value is {\tt sw}.}
@@ -3714,7 +3730,7 @@ units. The default value is {\tt 0}.}
 \attribute{window}{position}{point}{The item's position relative to the anchor (if no
 connected item specified). The default value is {\tt "0 0"} (Tcl/Tk) or {\tt [0,0]} (Perl/Tk).}
 
-\attribute{window}{priority}{priority}{Constraints of the underlying window sytem dictate
+\attribute{window}{priority}{priority}{Constraints of the underlying window system dictate
 the stacking order of window items. They can't be lowered under the other
 items. Additionally, to manipulate their stacking order, you must use the raise and lower
 Tk commands on the associated Tk window. The value of this attribute is meaningless.}
@@ -4190,10 +4206,13 @@ The following figure shows the effect of fillrule value on curves with multiple
    no image, the dimension is 0.
   \item \verb+'a'+ : the corresponding dimension is automatically adjusted to match
    the field's content plus the given value in pixels.
-  \item \verb+'l'+ : the corresponding dimension is automatically adjusted to match the
+  \item \verb+'l'+ : the corresponding dimension is adjusted to match the
    global size of the label (not counting fields with \verb+'l'+ size specs). The
-   corresponding integer parameter is not used with this size specification and it
-   is not possible to reference the field in another \verb+<fieldiPos>+ (see below).
+   corresponding integer parameter is not used with this size specification.
+   The global size of the label is considered when the labelformat is set. If some fields
+   sizes change afterwards, you should set again the labelformat so that fields using
+   a \verb+'l'+ specification are re-computed.
+   It is not possible to reference the field in another \verb+<fieldiPos>+ (see below).
   \end{itemize}
   
   \verb+<fieldiPos> ::= <pChar><fieldX><pChar><fieldY>+.
-- 
cgit v1.1

