1.1 --- a/tex/vym.tex Wed May 02 15:31:20 2007 +0000
1.2 +++ b/tex/vym.tex Mon Jun 18 15:10:19 2007 +0000
1.3 @@ -4,11 +4,7 @@
1.4 \usepackage{verbatim}
1.5 \usepackage{hyperref}
1.6 \usepackage{graphicx}
1.7 -\usepackage{longtable}
1.8 -
1.9 -
1.10 -%\input{udmath}
1.11 -
1.12 +%\usepackage{longtable}
1.13
1.14 \hypersetup{bookmarks, bookmarksopen,
1.15 pdftitle={VYM - a tool for visual thinking },
1.16 @@ -34,7 +30,7 @@
1.17 \title{
1.18 \includegraphics[width=8cm]{images/vym-logo-new.png}
1.19 \\
1.20 -VYM \\ -- \\View Your Mind\\ {\small Version 1.8.71}}
1.21 +VYM \\ -- \\View Your Mind\\ {\small Version 1.9.0}}
1.22 \author{\textcopyright Uwe Drechsel }
1.23
1.24
1.25 @@ -148,10 +144,22 @@
1.26
1.27 \section{The Concept of the \vym application}
1.28 %TODO may add a general introduction here...
1.29 -\subsection{Windows: Mapeditor, Noteeditor, and more}
1.30 -\vym uses two windows in the main: an editor for the map itself and another one for
1.31 -notes asociated with the branches, which are part of the map. Let's call them {\em mapeditor} and {\em noteeditor}:
1.32 -
1.33 +\subsection{The Mainwindow and its satellites} \label{satellite}
1.34 +\vym comes with several windows, the central one being the {\em
1.35 +mapeditor}.
1.36 +More windows, each having a special purpose, can be opened and arranged
1.37 +around the mainwindow\footnote{
1.38 + The advantage of having separate window instead of integrating them
1.39 + in a combined workspace is flexibility in arranging the windows. For
1.40 + example I usually have the {\em noteeditor} "behind" the {\em
1.41 + mapeditor}. On Linux my windowmanager (KDE) allows me to enter text
1.42 + into a small visible corner of the {\em noteeditor} withour clicking
1.43 + the mouse button in it. I just push the mouse around to set the
1.44 + window focus, a concept which is useful also working with
1.45 + \href{http://www.gimp.org}{http://www.gimp.org}.
1.46 +}.
1.47 +The image below shows the {\em mapeditor}
1.48 +together with the often used {\em noteeditor}:
1.49 \begin{center}
1.50 \includegraphics[width=8cm]{images/windows.png}
1.51 \end{center}
1.52 @@ -162,9 +170,13 @@
1.53 type or copy\&paste it into the {\em noteeditor}. Working with notes is
1.54 explained in \ref{noteeditor}
1.55
1.56 -A third window which can be toggled on or off is the {\em history
1.57 -window}. It can be used to see the latest actions performed on a map and
1.58 -also to undo and redo actions. Details are in \ref{historywindow}.
1.59 +Here is a list of the available satellite windows:
1.60 +\begin{itemize}
1.61 + \item Noteeditor (see \ref {noteeditor})
1.62 + \item Historywindow (see \ref{historywindow})
1.63 + \item Branch Property Window (see \ref{propwindow})
1.64 +\end{itemize}
1.65 +
1.66
1.67 \subsection{Menus and Context menus}
1.68 At the top of each window you will find the menubar. The options provided there
1.69 @@ -175,15 +187,16 @@
1.70
1.71 \subsection{Toolbars}
1.72 The toolbars in the mainwindows give quick access to many functions and
1.73 -also display the state of a branch. For example a part of of the map
1.74 -can be hidden when the map is exported into an Open~Office presentation.
1.75 -To show this the branch in the map will show a little cloud symbol,
1.76 -which is also "switched on" in the toolbar.
1.77 +also display the state of selected objects in the map. For example a
1.78 +branch may show certain {\em flags}, the corresponding flags are also
1.79 +set in the toolbar.
1.80
1.81 -Note that you can reposition all toolbars by simply grabbing and draging them to a new position. For example you can move the flags-toolbar from its original horizontal
1.82 -position on top of the mapeditor to a vertical position on the right
1.83 -side. You can even detach it and make it "float" separate from the other
1.84 -windows. Or just insert it again at its original position.
1.85 +Note that you can reposition all toolbars by simply grabbing and
1.86 +dragging them with the toolbar handle to a new position. For example you
1.87 +can move the flags-toolbar from its original horizontal position on top
1.88 +of the mapeditor to a vertical position on the right side. Or just
1.89 +insert it again at its original position. Also hiding some of the
1.90 +toolbars is possible by right-clicking on the toolbar handle.
1.91
1.92 \subsection{Maps}
1.93 The {\em map} itself has always a {\em mapcenter}. The
1.94 @@ -213,9 +226,6 @@
1.95 "thumb-up" flag is set, then the "thumb down" is reset and vice
1.96 versa. You can change this default behaviour in the settings menu.
1.97
1.98 -%TODO add info about toolbars e.g. undo/redo, ...
1.99 -%TODO or reference to advanced editing undo/redo
1.100 -
1.101 \section{Mapeditor} \label {mapeditor}
1.102 \subsection{Start a new map}
1.103 After \vym is started two windows will open: the {\em mapeditor} and the {\em noteditor}. Usually you will work in both windows, but at the moment we
1.104 @@ -236,8 +246,8 @@
1.105 Sometimes it comes in handy to be able to add a new branch above or below the current
1.106 one.
1.107 \begin{itemize}
1.108 - \item Use \key{Shift} \together with \key{Ins} to add a branch above the selected one or...
1.109 - \item \key{Ctrl} \together with \key{Ins} to add one below.
1.110 + \item Use \key{Shift-Ins} to add a branch above the selected one or...
1.111 + \item \key{Ctrl-Ins} to add one below.
1.112 \end{itemize}
1.113 It is also
1.114 possible to add a branch in such a way, that the current selection
1.115 @@ -366,7 +376,7 @@
1.116 \item use the menu and choose e.g Format \ra Set Color
1.117 \item use the toolbar
1.118 \begin{center}
1.119 - \includegraphics[width=3cm]{images/colour-buttons.png}
1.120 + \includegraphics[width=3cm]{images/color-buttons.png}
1.121 \end{center}
1.122 \end{itemize}
1.123 The first button (black in the graphic above) shows the current colour.
1.124 @@ -408,7 +418,7 @@
1.125 webbrowser to the mapeditor while a branch is selected there.
1.126
1.127 You can also add an image to a branch by opening the context menu of the
1.128 -branch. Right click the selected branch, choose "Add" then "Add Image". A
1.129 +branch. Right click the selected branch, choose "Add Image". A
1.130 dialog window enables you choose the image to load.
1.131 \footnote{Supported image types are: PNG, BMP, XBM, XPM and PNM. It may
1.132 also support JPEG, MNG and GIF, if specially configured during
1.133 @@ -442,17 +452,16 @@
1.134 changing its z-value (put it into background) etc.
1.135
1.136 \subsubsection*{Frames}
1.137 -A frame can be added to a branch by clicking with the
1.138 -right-mouse button. A context menu will open, where you can choose the
1.139 -frame. At the moment just a rectangle is offered. "No Frame" will be offered as the default for branches,
1.140 -nevertheless you can use images as frames. Have a look at the demo map
1.141 -{\tt todo.vym} as an example, where the mapcenter is a cloud. You can
1.142 -use an external drawing program like {\tt gimp} to create an image,
1.143 +A frame can be added to a branch in the {\em property window} (see
1.144 +\ref{propwindow}).
1.145 +Alternatively, you can use use images as frames. Have a look at the demo
1.146 +map {\tt todo.vym} as an example, where the mapcenter is a cloud. You
1.147 +can use an external drawing program like {\tt gimp} to create an image,
1.148 preferable with an transparency channel, so that you can design frames
1.149 -which don't use a rectangular borderline, just like the cloud.
1.150 +which don't use a rectangular borderline, just like that cloud.
1.151
1.152
1.153 -\subsection{Background design}
1.154 +\subsection{Design of map background and connecting links }
1.155 The design of the background of a map and also of the links connecting
1.156 various parts of the map can be changed by
1.157 \begin{itemize}
1.158 @@ -460,8 +469,11 @@
1.159 \item Right clicking on the canvas, which will open a context menu
1.160 \end{itemize}
1.161
1.162 -\subsubsection*{Background colour}
1.163 +\subsubsection*{Background }
1.164 The colour is set (and also displayed) as "Set background colour".
1.165 +Alternatevily you can set an background image, though this is not
1.166 +recommended in general. Working on the map becomes slow and the image
1.167 +currently cannot be positioned freely.
1.168
1.169 \subsubsection*{Link colour}
1.170 Links connecting branches can be coloured in one of two ways:
1.171 @@ -514,6 +526,11 @@
1.172 For more information on working with bookmarks and webbrowsers see
1.173 section \ref{bookmarks}.
1.174
1.175 +In the context menu there is also an option to open all URLs found
1.176 +in the selected subtree of the map. That's useful to simultanously open
1.177 +a collection of URLs in the webbrowser, especially if the browser can
1.178 +open them in tabs (like Konqueror).
1.179 +
1.180
1.181 \subsubsection*{\vym map}
1.182 To link to to another map right click on a branch and choose "Edit \vym link". A file dialog opens where you can choose the map. A
1.183 @@ -524,6 +541,10 @@
1.184 Clicking this flag beside the branch heading, in the toolbar or in the context menu of a branch will open the map in another tab (see \ref{tabs} for working with
1.185 multiple maps). To delete an existing link, just right click the branch and select "Delete \vym link".
1.186
1.187 +In the context menu there is also an option to open all vymlinks found
1.188 +in the selected subtree of the map. That's useful to simultanously open
1.189 +a collection of related maps.
1.190 +
1.191 Technical note: Internally \vym uses absolute paths, to avoid opening
1.192 several tabs containing the same map. When a map is saved, this path is
1.193 converted to a relative one (e.g. {\tt /home/user/vym.map} might become
1.194 @@ -584,11 +605,6 @@
1.195 functions. You can delete the complete note by clicking the
1.196 trashcan. Only the note itself is printed by clicking the printer icon.
1.197
1.198 -When pasting into the editor using the X11 copy\&paste mechanism, the
1.199 -editor will create a paragraph for each new line. Usually this is not
1.200 -wanted, so there you can convert all paragraphs into linebreaks by using
1.201 -Edit~\ra~Remove~Paragraphs or \key{ALT-X}.
1.202 -
1.203 \subsection{RichText: Colours, paragraphs and formatted text}
1.204 \vym supports formatted text (QT Rich Text) in the noteeditor since
1.205 version 1.4.7. Colours and text attributes (e.g. italic, bold) can be
1.206 @@ -599,7 +615,7 @@
1.207
1.208 \subsection{Fonts and how to switch them quickly}
1.209 The noteeditor is designed to be used for simple notes, not really as a full
1.210 -featured word processor. Because of many requests \vym now supports
1.211 +featured word processor. Because of many requests \vym supports
1.212 formatted text in the noteeditor\footnote{
1.213 \vym uses the QRichtText format, which is basically a subset of the
1.214 formatting provided in HTML.}
1.215 @@ -627,6 +643,7 @@
1.216 an email. Normally \vym will generate a new paragraph for each new line.
1.217 This usually is not what you want, so you can choose from the menu
1.218
1.219 +
1.220 \section{Hello world}
1.221 This section is about how \vym can interact with other applications.
1.222 Many applications can now read and write their data using XML, the
1.223 @@ -791,8 +808,35 @@
1.224
1.225 \section{Advanced Editing}
1.226
1.227 +\subsection{Properties of an object}
1.228 +For any branch you can open a satellite window (see \ref{satellite}):
1.229 +the {\em property window}:
1.230 +\begin{center}
1.231 + \includegraphics[width=8cm]{images/propwindow.png}
1.232 + \label{propwindow}
1.233 +\end{center}
1.234 +%FIXME create screenshot
1.235 +%FIXME explain the tabs
1.236 +
1.237 +\begin{itemize}
1.238 + \item Frame
1.239 + \item Link (see \ref{hideunselected})
1.240 + \item Layout (see \ref{incimg})
1.241 +\end{itemize}
1.242 +
1.243 \subsection{Changing the history: Undo and Redo}
1.244 -%FIXME
1.245 +\vym keeps track of all changes done in a map. The default number of
1.246 +changes which can be undone is~75. The complete history can be seen in
1.247 +the {\em historywindow}:
1.248 +\begin{center}
1.249 + \includegraphics[width=8cm]{images/historywindow.png}
1.250 + \label{historywindow}
1.251 +\end{center}
1.252 +A single step back be undone or redone with \key{CTRL-Z} or \key{CTRL-Y},
1.253 +or by using the buttons in the toolbar or the {\em historywindow}.
1.254 +Inside the {\em historywindow}, you can click on a line to unwind all
1.255 +actions done until that point in time -- or redo all changes by clicking
1.256 +on the last line.
1.257
1.258 \subsection{Macros} \label{macros}
1.259 Macros have been added to \vym in version~1.9.0. Each function key
1.260 @@ -807,7 +851,7 @@
1.261 Settings menu. More information on using scripts in \vym is found in
1.262 appendix~\ref{scripts}.
1.263
1.264 -\subsection{How to deal with Bookmarks} \label{bookmarks}
1.265 +\subsection{Bookmarks} \label{bookmarks}
1.266 \subsubsection*{Open new tabs instead of new windows}
1.267 If you use konqueror as your browser, \vym will remember the konqueror session which
1.268 was opened first by \vym. You can also press \key{Ctrl} and click to
1.269 @@ -837,13 +881,13 @@
1.270 \end{itemize}
1.271 The URL will be build from the number in the heading.
1.272
1.273 -\subsection{Associating images with a branch}
1.274 +\subsection{Associating images with a branch} \label{incimg}
1.275 The default setting for an image is for it to float "freely". Images can be
1.276 positioned anywhere on the canvas, but may end up in the same place as other
1.277 parts of the map obscuring that part of the map.
1.278
1.279 The solution is to insert or include them "into" a branch. This can be done via
1.280 -the context menu of their parent branch:
1.281 +the property window (see \ref{propwindow}):
1.282 \begin{itemize}
1.283 \item Include images horizontally
1.284 \item Include images vertically
1.285 @@ -857,9 +901,10 @@
1.286 \subsection{Modifier Modes}
1.287 Modifiers are for example the \key{Shift}- the \key{Ctrl}- ot the \key{Alt}-keys. When
1.288 pressed while applying mouse actions, they will cause \vym to use
1.289 -a "modified" action. e.g. you can move branches with the mouse. If
1.290 -\key{Ctrl} or \key{Alt}is pressed while releasing the branch, it will be
1.291 -added above/below the target, not as child of the target.
1.292 +a "modified" version of the action which usually would be done.
1.293 +
1.294 +%\key{Ctrl} or \key{Alt}is pressed while releasing the branch, it will be
1.295 +%added above/below the target, not as child of the target.
1.296
1.297 Without a modifier key pressed, the first mouse click on a branch just selects
1.298 it. For the behaviour of the \key{Ctrl} modifier there are several
1.299 @@ -867,13 +912,14 @@
1.300 \begin{center}
1.301 \includegraphics[width=3cm]{images/modmodes.png}
1.302 \end{center}
1.303 -The default is to copy the colour from the clicked branch to the already
1.304 -selected branch. In the toolbar shown above the default modifier is
1.305 -selected, namely to copy the colour of a branch. The second modifier
1.306 +The default mode is to copy the colour from the clicked branch to the already
1.307 +selected branch. The figure above shows the toolbar with the default modifier
1.308 +selected. The second modifier
1.309 let's you easily copy a whole branch with a single click. The third
1.310 -modifier lets you create links between branches called {\em xLinks}. They will be explained in the next section.
1.311 +modifier lets you create links between branches called {\em xLinks}.
1.312 +They will be explained in the next section \ref{xlinks}.
1.313
1.314 -\subsection{Hide links of unselected objects}
1.315 +\subsection{Hide links of unselected objects} \label{hidelink}
1.316 Sometimes it would be useful to position a branch freely, just like a
1.317 mainbranch or an image. This is possible for all
1.318 branches, you can use a mainbranch and hide its connecting link to the
1.319 @@ -882,8 +928,9 @@
1.320 \begin{center}
1.321 \includegraphics[width=9cm]{images/hiddenlink.png}
1.322 \end{center}
1.323 -To hide the link between a branch and its parent open the context
1.324 -menu (Right Click) and check Hide link if object is not selected.
1.325 +To hide the link between a branch and its parent open the
1.326 +\ref{propwindow} and check "Hide link if object is not selected" on
1.327 +"Link" tab.
1.328
1.329
1.330 \subsection{XLinks} \label{xlinks}
1.331 @@ -906,11 +953,17 @@
1.332 link should start and drag the mouse pointer to the branch where the link is to end. (The link is drawn to follow the mouse pointer). When you release the mouse over a branch the xLink becomes permanent.
1.333
1.334 \subsubsection*{Modify or delete a xLink}
1.335 -First select a branch at either end of the xLink. Then open the context menu and select \lq Edit xLink\rq. A submenu contains all the xLinks of the branch (if there are any). They are named like the branches, where they end. Choose one and the xLink dialogue opens, where you can set colour, width and also delete the xLink.
1.336 +First select a branch at either end of the xLink. Then open the context
1.337 +menu and select \lq Edit xLink\rq. A submenu contains all the xLinks of
1.338 +the branch (if there are any). They are named like the branches, where
1.339 +they end. Choose one and the xLink dialogue opens, where you can set
1.340 +colour, width and also delete the xLink.
1.341
1.342 \subsubsection*{Follow a xLink}
1.343 In a complex \vym map it sometimes comes in handy to be able to jump to the other end
1.344 -of a xLink. You can do this by opening the context menu of the branch and clicking on \lq Goto xLink\rq and selecting the xLink you want to follow.
1.345 +of a xLink. You can do this by opening the context menu of the branch
1.346 +and clicking on \lq Goto xLink\rq and selecting the xLink you want to
1.347 +follow.
1.348
1.349
1.350
1.351 @@ -922,10 +975,11 @@
1.352 shortcuts also have a look at the context menu.
1.353
1.354 \subsection{Adding a whole map or a part of a map}
1.355 -Select a branch where you want to add a previously saved map ({\tt .vym})or a part
1.356 -of a map ({\tt .vyp}) , then open the context menu and choose {\em Add \ra Add Map (Insert)}. For the import you can choose between {\em Add Map (Insert)} and {\em Add Map (Replace)}: The imported data will be added after the selected branch.
1.357 -
1.358 -\label{historywindow}
1.359 +Select a branch where you want to add a previously saved map ({\tt
1.360 +.vym})or a part of a map ({\tt .vyp}) , then open the context menu and
1.361 +choose {\em Add \ra Add Map (Insert)}. For the import you can choose
1.362 +between {\em Add Map (Insert)} and {\em Add Map (Replace)}: The imported
1.363 +data will be added after the selected branch.
1.364
1.365 \section{\vym on Mac OS X}
1.366 \subsection{Overview}
1.367 @@ -992,7 +1046,7 @@
1.368 \begin{center}
1.369 \begin{tabular}{cccp{8cm}}\\
1.370 \bf Option & \bf Comment & \bf Argument & \bf Description \\ \hline
1.371 -v & version & & Show version ov \vym\\
1.372 +v & version & & Show version and codename of \vym\\
1.373 l & local & & Use local paths to stylesheets, translations, icons,
1.374 etc. instead of system paths. Useful for testing\\
1.375 h & help & & Show help\\