aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/refman.tex32
1 files changed, 21 insertions, 11 deletions
diff --git a/doc/refman.tex b/doc/refman.tex
index 6c92b73..c21aea0 100644
--- a/doc/refman.tex
+++ b/doc/refman.tex
@@ -2746,7 +2746,7 @@ The default value is {\tt 0} which turn off the display of the marker.}
default value is {\tt simple}.}
\attribute{track}{mixedhistory}{boolean}{If true the track history will be plotted with
-dots every other positions. The default value is {\tt false}.}
+dots every other position. The default value is {\tt false}.}
\attribute{track}{numfields}{unsignedint}{Gives the number of fields available for the
label. This attribute is read only.}
@@ -3654,7 +3654,7 @@ default value is {\tt ""}.}
TkZinc was initially developed for building interactive radar image working on X
server. This requires very good performances, for displaying many hundred tracks and
-moving them every few seconds. Tracks are typically composed of some geometric parts and
+moving them every few second. Tracks are typically composed of some geometric parts and
some textual parts. These two parts are connected together with a leader. The geometric
parts are subject to scaling. For example the speed vector length in pixel depends on the
scale. But the textual part must not be zoomed. Managing parts which are scaled and others
@@ -4388,13 +4388,23 @@ named AlphaStipple0 to AlphaStipple15, AlphaStipple0 being the most transparent.
\section{ZincDebug.pm}
\ident{ZincDebug.pm} is a Perl module useful for debugging purpose. It can be used in a
-Perl application using TkZinc to grab items with the mouse and to get the list of
+Perl application using TkZinc to display the hierarchical tree of items, to display
+items selected by their id or tags, to grab items with the mouse and to get the list of
items enclosed or overlapped by a rectangle designated by the mouse. You will be
-presented an item list, with many interesting attributes such as position, priority,
-visibility, group...\ and even more information on request. When an application uses
+presented a list of items, with many interesting attributes such as position, priority,
+visibility, group...\ and even more information on request. Much of the selected items
+attributes can be interactively modified. When an application uses
\ident{ZincDebug.pm}, you can get a short reminder by depressing the {\tt Esc} key in
-the main window of this application. Please refer to the \ident{ZincDebug.pm} man pages
-with the classical command {\tt man ZincDebug}
+the main window of this application. For more information, please refer to the
+\ident{ZincDebug.pm} man pages with the classical command {\tt man ZincDebug}
+
+To use this module, you can import it either by adding, for example, the following
+statements in your source code:
+\code{\\use ZincDebug;\\
+finditems(\$zinc);\\
+tree(\$zinc, -optionsToDisplay => '-tags', -optionsFormat => 'row');\\}
+or simply by using the -M option of Perl:
+\code{\\perl -MZincDebug yourscript.pl\\}
\section{Tracing TkZinc methods call in perl/Tk}
@@ -4405,16 +4415,16 @@ 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 TkZinc method name
\item the full filename where this method has been invoked
\item the line number in the source file
\item the list of arguments in a human-readable form
\end{itemize}
-To use this module you can either import either by adding the following
+To use this module you can import it either by adding the following
statement in your source code:
-\code{import ZincTrace;} or better, by using the -M option of Perl:
-\code{perl -MZincTrace yourscript.pl}
+\code{\\use ZincTrace;\\} or better, by using the -M option of Perl:
+\code{\\perl -MZincTrace yourscript.pl\\}
\section{zinc-demos}
\concept{zinc-demos}