1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/tex/vym.tex Sun Jan 30 12:59:03 2005 +0000
1.3 @@ -0,0 +1,927 @@
1.4 +\documentclass{article}
1.5 +\usepackage{a4}
1.6 +\usepackage[latin1]{inputenc}
1.7 +\usepackage{verbatim}
1.8 +\usepackage{hyperref}
1.9 +\usepackage{graphicx}
1.10 +\usepackage{longtable}
1.11 +
1.12 +
1.13 +%\input{udmath}
1.14 +
1.15 +
1.16 +\hypersetup{bookmarks, bookmarksopen,
1.17 + pdftitle={VYM - a tool for visual thinking },
1.18 + pdfauthor={Uwe Drechsel},
1.19 + pdfsubject={map},
1.20 + pdfkeywords={map, tool},
1.21 + pdfpagemode={UseOutlines},
1.22 + bookmarksopenlevel={1},
1.23 + colorlinks={true},
1.24 + linkcolor={blue},
1.25 + urlcolor={green},
1.26 + citecolor={red}}
1.27 +
1.28 +
1.29 +\newcommand{\vym}{{\sc vym }}
1.30 +\newcommand{\ra}{$\longrightarrow$}
1.31 +\newcommand{\la}{$\longleftarrow$}
1.32 +\newcommand{\ua}{$\uparrow$}
1.33 +\newcommand{\da}{$\downarrow$}
1.34 +\newcommand{\key}[1]{[#1]}
1.35 +
1.36 +\begin{document}
1.37 +\title{VYM \\ -- \\View Your Mind}
1.38 +\author{\textcopyright Uwe Drechsel }
1.39 +%\date{September 26, 2002}
1.40 +
1.41 +\maketitle
1.42 +
1.43 +\tableofcontents
1.44 +
1.45 +\newpage
1.46 +
1.47 +\section{Introduction}
1.48 +\subsection{What is a \vym map?}
1.49 +A \vym map (in short words {\em map}) is a tree like structure:
1.50 +\begin{center}
1.51 + \includegraphics[width=12cm]{example1.png}
1.52 +\end{center}
1.53 +Such maps can be drawn by hand on paper or a flip chart and help to
1.54 +structure your thoughs. While a tree like structure like above can be
1.55 +drawn by hand or any drawing software \vym offers
1.56 +much more features to work with such maps. \vym is not another drawing
1.57 +software, but a tool to store and modify information in an intuitive
1.58 +way. For example you can reorder parts of the map by pressing a key or
1.59 +add various information like a complete email by a simple mouse click.
1.60 +
1.61 +\subsection{Why should I use maps? Time, Space and your Brain.}
1.62 +\subsubsection*{Space}
1.63 +A map can concentrate a very complex content on little space e.g. a
1.64 +piece of paper. It helps to use both sides of your brain: the logical
1.65 +side and also your creative side (e.g. by using pictures, colors and
1.66 +keywords in a map, so called {\em anchors}). It is a technique to
1.67 +organize the way you think: It can help you by developing, sorting and
1.68 +memorizing your thoughts.
1.69 +
1.70 +\subsubsection*{Time}
1.71 +Because you just use keywords and drawings, it is much faster than good
1.72 +old fashioned notes. Your brain memorizes things by associating them to
1.73 +other things -- a map makes use of those connections and stimulates
1.74 +new asccociations.
1.75 +
1.76 +\subsubsection*{Your Brain}
1.77 +In 1960 the Prof. {\sc Roger Sperry} discovered that both hemispheres
1.78 +of the human brain have different tasks (of course both of them
1.79 +basically {\em can} do the same): The left side is specialised in
1.80 +\begin{itemize}
1.81 + \item verbal speech and writing
1.82 + \item numbers
1.83 + \item logical thinking
1.84 + \item analyzing and details
1.85 + \item science
1.86 + \item linear thinking
1.87 + \item concept of time
1.88 +\end{itemize}
1.89 +while the right side of the human brain is specialised in
1.90 +\begin{itemize}
1.91 + \item body language
1.92 + \item visual thinking, day dreams
1.93 + \item intuition and emotion
1.94 + \item overview of things
1.95 + \item creativity
1.96 + \item art, music, dancing
1.97 + \item non-linear thinking, connecting things
1.98 + \item spatial awareness
1.99 +\end{itemize}
1.100 +In our science oriented society we have learned to mainly rely on our
1.101 +left side of the brain, the "rational" one. In other cultures,
1.102 +especially like the native americans and other "old" cultures, the right
1.103 +side is much more important. maps are just one way to stimulate the
1.104 +other side and make use of additional ressources we all have.
1.105 +
1.106 +
1.107 +\subsection{Where could I use a map?}
1.108 +Here are some examples, how you can use those maps
1.109 +\begin{itemize}
1.110 + \item to prepare articles, papers, books, talks, \ldots
1.111 + \item to sort complex data
1.112 + \item to memorize facts, persons, vocabulary, \ldots
1.113 + \item to sort emails, files and bookmarks on your computer
1.114 + \item to moderate conferences
1.115 +\end{itemize}
1.116 +
1.117 +\subsection{What you shouldn't do with a map...}
1.118 +A map drawn by somebody shows the way the author thinks. There is
1.119 +no right or wrong in the way it is drawn, so there is no way to critize
1.120 +it. "It is, what it is" ({\sc F.~Lehmann}).
1.121 +
1.122 +%\section{Tutorials}
1.123 +%TODO
1.124 +
1.125 +\section{Concept}
1.126 +
1.127 +%TODO may add a general introduction here...
1.128 +
1.129 +\vym uses two windows: an editor for the map itself and another one for
1.130 +notes, which are part of the map. Let's call them {\em mapeditor} and
1.131 +{\em noteeditor}:
1.132 +\begin{center}
1.133 + \includegraphics[width=8cm]{windows.png}
1.134 +\end{center}
1.135 +Usually you will work in the {\em mapeditor} by just adding new
1.136 +branches, moving around and reordering them. The various ways to do this
1.137 +will be explained in \ref{mapeditor}. You can store additional
1.138 +information e.g. the content of a email easily in a {\em branch}: Just
1.139 +type or copy\&paste it into the {\em noteeditor}. Working with notes is
1.140 +explained in \ref{noteeditor}
1.141 +
1.142 +The map itself has always a {\em mapcenter}. The
1.143 +mapcenter has {\em branches} just like the trunk of a tree. Each branch
1.144 +in turn may have branches again.
1.145 +\begin{center}
1.146 + \includegraphics[width=10cm]{branches.png}
1.147 +\end{center}
1.148 +We will call a branch directly connected to the mapcenter a {\em
1.149 +mainbranch}, because it determines the position of all its child
1.150 +branches.
1.151 +
1.152 +The mapcenter and the branches all have a {\em heading}. This is the
1.153 +text you see in the mapeditor. Usually it should just be one or a few
1.154 +words, so that one can easily keep track of the whole map.
1.155 +
1.156 +
1.157 +In the toolbar above the mapeditor you see various symbols.
1.158 +\begin{center}
1.159 + \includegraphics[width=8cm]{default-flags.png}
1.160 +\end{center}
1.161 +These are called {\em flags} and can be used to mark branches in the
1.162 +map, e.g. if something is important or questionable.
1.163 +There are also more flags set by \vym automatically to show additional
1.164 +information, e.g. when a exists for a particular branch.
1.165 +
1.166 +\section{Mapeditor} \label {mapeditor}
1.167 +\subsection{Start a new map}
1.168 +After \vym is started two windows will open: the mapeditor and the
1.169 +noteditor. Usually you will work in both windows, but at the moment we
1.170 +will just need the mapeditor.
1.171 +
1.172 +Select the mapcenter "New map" in the middle of the mapeditor by
1.173 +left-clicking with the mouse. It will turn yellow to show that is
1.174 +selected. There are two ways to add a new branch to the center:
1.175 +\begin{itemize}
1.176 + \item Main menu on top of mapeditor window:
1.177 + Edit \ra Add new Branch
1.178 + \item Press \key{Ins}
1.179 +\end{itemize}
1.180 +A new branch will appear and you will be able to type the heading of the
1.181 +branch. Finish adding the new branch by pressing \key{Enter}.
1.182 +%tipp
1.183 +Sometimes it comes handy to add a new branch above or below the current
1.184 +one. Use \key{Ins} together with \key{Shift} or \key{Ctrl}.
1.185 +
1.186 +\subsection{Navigate through a map}
1.187 +\subsubsection*{Select branches}
1.188 +To select branches you can use the left button of your mouse or also the
1.189 +arrow keys. Depending on the {\em orientation} of a branch type
1.190 +\key{\la} or \key{\ra} to get nearer to the mapcenter or deeper
1.191 +down into the branches. Within a set of branches, let's call them a
1.192 +{\em subtree}, you can use \key{\ua} and \key{\da} to go up and down. You can
1.193 +also use \key{Pos1} and \key{End} to select the first and last branch.
1.194 +
1.195 +
1.196 +\subsubsection*{Zoom a map}
1.197 +While adding more and more branches the size of the map may become
1.198 +bigger than the mapeditor window. You can use the scrollbars on the
1.199 +right and the bottom of your mapeditor window to scroll, but it is
1.200 +easier to just scroll using the left mouse button: Click onto the {\em
1.201 +canvas} itself, the empty space somewhere between the branches. The
1.202 +mouse pointer will change from an arrow to a hand, now move the visible
1.203 +part of the map to show the desired part.
1.204 +
1.205 +If you select branches using the arrow keys, the map will scroll
1.206 +to ensure that the selected branch is always visible.
1.207 +
1.208 +Working with huge maps, the {\em zoom}-function comes in handy: You can
1.209 +use
1.210 +\begin{itemize}
1.211 + \item from the menu View \ra Zoom
1.212 + \item the toolbar buttons
1.213 + \begin{center}
1.214 + \includegraphics[width=3cm]{zoom-buttons.png}
1.215 + \end{center}
1.216 +\end{itemize}
1.217 +The crossed magnifying lens resets the zoomed view to its original size.
1.218 +
1.219 +
1.220 +\subsubsection*{Find Function} \label{findwindow}
1.221 +With huge maps there is the need to have a
1.222 +find function. Choose Edit \ra Find to open the Find Window:
1.223 +\begin{center}
1.224 + \includegraphics[width=6cm]{find-window.png}
1.225 +\end{center}
1.226 +The text you enter here will be searched in all the headings and also in
1.227 +notes. Everytime you press the "Find"-button it will look for the next
1.228 +occurence, which then will be selected automatically. If the search
1.229 +fails, there will appear a short message "Nothing found" or a few
1.230 +seconds in the {\em statusbar} on the bottom of the mapeditor.
1.231 +
1.232 +\subsubsection*{Scroll a part of the map}
1.233 +A very big subtree of a map e.g. a branch with hundreds of childs makes
1.234 +it very hard to keep an overview over the whole map. You can hide all
1.235 +the childs of a branch by {\em scrolling} it -- this function is also
1.236 +often called {\em folding}. Think of the whole subtree as painted onto a
1.237 +big newspaper. You can scroll the paper to a small roll, leaving just
1.238 +the headline readable.
1.239 +
1.240 +To scroll or unscroll a branch and its childs, press the
1.241 +\begin{itemize}
1.242 + \item \key{Scroll} key or
1.243 + \item press the middle-mouse button or
1.244 + \item choose the little scroll from the toolbar.
1.245 +\end{itemize}
1.246 +If you select parts of a scrolled branch e.g. using the find function or
1.247 +by using the arrow-keys, it will unscroll temporary. This is shown as a
1.248 +scroll with a little hour glass. If the temporary unscrolled part is not
1.249 +longer needed, it will be hidden again automatically. It is also
1.250 +possible to unscroll all branches using "Edit\ra Unscroll all scrolled
1.251 +branches".
1.252 +
1.253 +
1.254 +
1.255 +\subsection{Modify and move branches}
1.256 +\subsubsection*{Modify the heading of a branch}
1.257 +You can edit the heading by selecting the branch and then
1.258 +\begin{itemize}
1.259 + \item pressing \key{Enter}
1.260 + \item double-clicking with left mouse.
1.261 +\end{itemize}
1.262 +Just type the new heading (or edit the old one) and press \key{Enter}.
1.263 +
1.264 +\subsubsection*{Move a branch}
1.265 +The easiest way to move a branch is to select it with left-mouse and
1.266 +drag it to the destination while keeping the mouse button pressed.
1.267 +Depending on the branch it will be
1.268 +\begin{itemize}
1.269 + \item moved to the destination or
1.270 + \item {\em linked} to a new {\em parent} (mapcenter or branch)
1.271 +\end{itemize}
1.272 +If you drag the branch over another one or over the mapcenter, you will
1.273 +notice that the link connecting it to the old parent will be changed to
1.274 +lead to the new parent which is now under your mousepointer.
1.275 +If you release the button now, the branch will be relinked.
1.276 +
1.277 +If you release the button in the middle of nowhere, the result will
1.278 +depend on the type of branch you are releasing:
1.279 +\begin{itemize}
1.280 + \item A mainbranch is directly connected to the mapcenter.
1.281 + It will stay on its new position.
1.282 + \item An ordinary branch will "jump" back to its original position.
1.283 +\end{itemize}
1.284 +Thus you can easily rearrange the layout of the mainbranches to avoid
1.285 +overlapping of their subtrees.
1.286 +There is another convenient way to move branches, especially if you want
1.287 +to {\em reorder} a subtree: You can move a branch up or down in a
1.288 +subtree by
1.289 +\begin{itemize}
1.290 + \item pressing \key{\ua} and \key {\da}
1.291 + \item selecting Edit \ra Move branch
1.292 + \item clicking on the toolbar buttons:
1.293 + \begin{center}
1.294 + \includegraphics[width=1.5cm]{move-buttons.png}
1.295 + \end{center}
1.296 +\end{itemize}
1.297 +%tipp
1.298 +There is yet another way to move branches: If you press \key{Shift} or
1.299 +\key{Ctrl} while moving with the mouse, the branch will be added above
1.300 +or below the one the mouse pointer is over. This helps also to reorder a
1.301 +map.
1.302 +
1.303 +\subsection{The right side of your brain - colors and images}
1.304 +\subsubsection*{Change color of a heading}
1.305 +You can also use colors to put more information into a map, e.g. use
1.306 +red, green and more colors to prioritize tasks. Again you can
1.307 +\begin{itemize}
1.308 + \item use the menu and choose e.g Format \rq Set Color
1.309 + \item use the toolbar
1.310 + \begin{center}
1.311 + \includegraphics[width=3cm]{color-buttons.png}
1.312 + \end{center}
1.313 +\end{itemize}
1.314 +The first button (black in the graphic above) shows the actual color.
1.315 +Clicking on it let's you choose another color. You can also "pick"
1.316 +another color by selecting a branch with the desired color and using the
1.317 +"pick color" button. Both of the buttons showing a bucket actually put
1.318 +the current color to the selected branch. While the first one just
1.319 +colors the heading of the selection, the last one also colors all the
1.320 +childs of the selected branch.
1.321 +
1.322 +%tipp
1.323 +A very useful function is the "copy color" using the mouse: Select the
1.324 +branch which should get the new color, then press \key{Ctrl} and
1.325 +simultanously click with left-mouse on another branch to copy its color
1.326 +to the first one. Here the childs of the selection also will get the new
1.327 +color, if you just want to color the selection itself, additionally
1.328 +press \key{Shift}.
1.329 +
1.330 +\subsubsection*{Use flags}
1.331 +\vym provides various flags. You see them in the toolbar on top of the
1.332 +mapeditor window. (Note: Like all toolbars you can also move them to the
1.333 +left or the right side of the window or even detach them. Just grab the
1.334 +very left "dotted" part of the toolbar with your left-mouse button.)
1.335 +\begin{center}
1.336 + \includegraphics[width=8cm]{default-flags.png}
1.337 +\end{center}
1.338 +If you have a branch selected, you can set any number of flags by
1.339 +clicking them in the toolbar. The toolbar buttons change their state and
1.340 +always reflect the flags set in the selected branch.
1.341 +
1.342 +Presently \vym uses two kinds of flags: {\em System Flags} and {\em
1.343 +Standard Flags}. The standard flags are those shown in the toolbar.
1.344 +System flags are set by \vym to indicate e.g. that there is additional
1.345 +information in a note (more on this in \ref{noteeditor}). Later versions
1.346 +of \vym may have another kind of flags, which may be edited by the user.
1.347 +
1.348 +\subsubsection*{Images}
1.349 +You can add a image to a branch or the mapcenter by clicking with the
1.350 +right-mouse button. A context menu will open, choose "Add Image". A
1.351 +dialog window lets you choose the image to load.
1.352 +\footnote{Supported image types are: PNG, BMP, XBM, XPM and PNM. It may
1.353 + also support JPEG, MNG and GIF, if specially configured during
1.354 + compilation (as done when \vym is part of SUSE LINUX).}
1.355 +While an image is selected in the dialog, you can see a preview of the
1.356 +image.
1.357 +
1.358 +You can position the image anywhere you want, just drag it with left
1.359 +mouse. To relink it to another branch, press \key{Shift} while moving
1.360 +it. To delete it, press \key{Del}.
1.361 +
1.362 +If you right-click onto an image, a context menu will open which let's
1.363 +you first choose one of several image formats. Then a file dialog opens
1.364 +to save the image. Hint: This is used to "export" the image, it will be
1.365 +saved anyway in the map itself! You can also cut and
1.366 +copy images, but it is not possible to add objects to an image\footnote{
1.367 + Images are regarded as "extra feature". It would make working with
1.368 + the map much more complex if e.g. images could be linked to images.}
1.369 +
1.370 +The option \lq{\bf Use for export} \rq controls the output of exports
1.371 +e.g. to HTML: If set to no, the image won't appear in the {\em text}
1.372 +part of the output. This is useful for large images or if images are
1.373 +used as a kind of frame e.g. the famous cloud symbol around a part of
1.374 +the map. Those shouldn't appear in the middle of the text.
1.375 +
1.376 +At the moment image support is preliminary: Images will be saved
1.377 +together with all the other data of a map in the {\tt .vym}-file.
1.378 +Later versions will include more functionality like resizing the images,
1.379 +changing its z-value (put it into background) etc.
1.380 +
1.381 +\subsubsection*{Frames}
1.382 +A frame can be added to a branch by clicking with the
1.383 +right-mouse button. A context menu will open, where you can choose the
1.384 +frame. At the moment just a rectangle resp. "No Frame" will be offered,
1.385 +nevertheless you can use images as frames. Have a look at the demo map
1.386 +{\tt todo.vym} as an example, where the mapcenter is a cloud. You can
1.387 +use an external drawing program like {\tt gimp} to create an image,
1.388 +preferable with an transparency channel, so that you can design frames
1.389 +which don't use a rectangular borderline, just like the cloud.
1.390 +
1.391 +
1.392 +\subsection{Background design}
1.393 +The design of the background of a map and also of the links connecting
1.394 +various parts of the map can be changed by
1.395 +\begin{itemize}
1.396 + \item Selecting Format from the menu
1.397 + \item Right clicking onto the canvas, which will open a context menu
1.398 +\end{itemize}
1.399 +
1.400 +\subsubsection*{Background color}
1.401 +The color is set (and also displayed) as "Set background color".
1.402 +
1.403 +\subsubsection*{Link color}
1.404 +Links connecting branches can be colored in one of the following ways:
1.405 +\begin{itemize}
1.406 + \item use the color of the heading of the branch the links is
1.407 + \item use {\em one} color for all links. The default color is blue.
1.408 + leading to.
1.409 +\end{itemize}
1.410 +The latter can be set with "Set link color". Check or uncheck the "Use
1.411 +color of heading for link" option to choose one of the two designs for
1.412 +your map.
1.413 +
1.414 +\subsubsection*{Link style}
1.415 +\vym offers four different styles for the appearences of links:
1.416 +\begin{itemize}
1.417 + \item Line
1.418 + \item Parabel
1.419 + \item Thick Line
1.420 + \item Thick Parabel
1.421 +\end{itemize}
1.422 +The "thick" styles only draw links starting at mapcenter thick, the rest
1.423 +of the map is always painted "thin".
1.424 +
1.425 +
1.426 +\subsection{Link to other documents}
1.427 +Presently \vym supports two kind of links:
1.428 +\begin{itemize}
1.429 + \item Document, which will be opened in an external webbrowser
1.430 + \item \vym map, which will be opened in \vym itself
1.431 +\end{itemize}
1.432 +
1.433 +\subsubsection*{Webbrowser}
1.434 +Modern Webbrowsers like {\tt konqueror} are able to display various
1.435 +types of files, both local or in the internet. To enter the URL of
1.436 +any document, right-click onto a branch or use the Edit Menu
1.437 +and choose "Edit URL". Enter the path to your document (or copy and
1.438 +paste it from your browser). Examples for valid paths are:
1.439 +\begin{verbatim}
1.440 + http://www.insilmaril.de/vym/index.html
1.441 + file:/usr/share/doc/packages/vym/doc/vym.pdf
1.442 +\end{verbatim}
1.443 +If an URL was entered, a little globe will appear in the branch. By
1.444 +clicking on the globe in the toolbar or the context menu an external
1.445 +browser\footnote{
1.446 + The browser can be changed in the Settings Menu.}
1.447 +will be started.
1.448 +\begin{center}
1.449 + \includegraphics[width=0.5cm]{flag-url.png}
1.450 +\end{center}
1.451 +If you want to keep bookmarks in a map, you may want to copy the heading
1.452 +as URL: Right click onto the branch and select "Use heading for URL".
1.453 +
1.454 +\subsubsection*{\vym map}
1.455 +To link to to another map right click on a branch or choose "Edit \ra
1.456 +Enter \vym link". A file dialog opens where you can choose the map. A
1.457 +branch with a link is marked with
1.458 +\begin{center}
1.459 + \includegraphics[width=0.5cm]{flag-vymlink.png}
1.460 +\end{center}
1.461 +Clicking this flag in the toolbar or in the context menu of a branch
1.462 +will open the map in another tab (see \ref{tabs} for working with
1.463 +multiple maps). To delete an existing link, just press the "Cancel"
1.464 +button.
1.465 +
1.466 +Technical note: Internally \vym uses absolute paths, to avoid opening
1.467 +several tabs containing the same map. When a map is saved, this path is
1.468 +converted to a relative one (e.g. {\tt /home/user/vym.map} might become
1.469 +{\tt ./vym.map}. This makes it fairly easy to use multiple maps on
1.470 +different computers or export them to HTML in future.
1.471 +
1.472 +\subsection{Multiple maps} \label{tabs}
1.473 +You can work on multiple maps at the same time. Each new map is opened
1.474 +in another {\em tab}. The available tabs are shown just above the
1.475 +mapeditor. You can use the normal cut/copy/paste functions to
1.476 +copy data from one map to another.
1.477 +
1.478 +%todo
1.479 +
1.480 +%TODO
1.481 +%\subsubsection{Menus}
1.482 +%\subsubsection{Keyboard shortcuts}
1.483 +
1.484 +% Settings
1.485 +% Images
1.486 +% Copy & Paste
1.487 +% Working with tabs (multiple maps)
1.488 +% Exporting
1.489 +% Scrolling
1.490 +
1.491 +\section{Noteeditor} \label {noteeditor}
1.492 +If you want to save more text in a branch e.g. a complete email, a
1.493 +cooking recipe, or the whole source code of a software project, you can
1.494 +use the noteeditor. Since version 1.4.7 \vym supports formatted text in
1.495 +the noteeditor.
1.496 +
1.497 +\subsubsection*{States}
1.498 +Before you can type or paste text into it, you have
1.499 +to select a branch in the mapeditor. Note that the background color
1.500 +of the noteeditor indicates its state:
1.501 +\begin{itemize}
1.502 + \item black: no branch selected
1.503 + \item grey: no text entered yet
1.504 + \item white: text is already available
1.505 +\end{itemize}
1.506 +To show you in the mapeditor itself that there is a note with more
1.507 +information for a particular branch, a little note flag will appear next
1.508 +to the heading of the branch. See the lower branch on the right side:
1.509 +\begin{center}
1.510 + \includegraphics[width=8cm]{branches-flags.png}
1.511 +\end{center}
1.512 +
1.513 +\subsubsection*{Import and export notes}
1.514 +The note is always saved automatically within the \vym file itself.
1.515 +Nevertheless sometimes it is nice to import a note from an external file
1.516 +or write it. Use "File\ra~Import" and "File\ra~Export" to do so.
1.517 +
1.518 +\subsubsection*{Edit and print note}
1.519 +Editing works like in any simple texteditor, including undo and redo
1.520 +functions. You can delete the complete note by clicking the
1.521 +trashcan. Only the note itself is printed by clicking the printer icon.
1.522 +
1.523 +When pasting into the editor using the X11 copy\&paste mechanism, the
1.524 +editor will create a paragraph for each new line. Usually this is not
1.525 +wanted, so there you can convert all paragraphs into linebreaks by using
1.526 +Edit~\ra~Remove~Paragraphs or \key{ALT-X}.
1.527 +
1.528 +\subsubsection*{Fonts}
1.529 +The noteeditor is ment to be used for simple notes, not really as full
1.530 +featured text editor. Because of many requests \vym supports now
1.531 +formatted text in the noteeditor\footnote{
1.532 + \vym uses the QRichtText format, which is basically a subset of the
1.533 + formatting provided in HTML.}
1.534 +Two default fonts are supported which can be set in the Settings menu.
1.535 +One is a fixed width font, the other has variable width. The fixed font
1.536 +is usually used for emails, source code etc.\ while the variable font is
1.537 +used for simple notes, where one doesn't need fixed character widths.
1.538 +Both fonts can easily switched using the following symbol from the
1.539 +toolbar:
1.540 +\begin{center}
1.541 + \includegraphics[width=0.5cm]{formatfixedfont.png}
1.542 +\end{center}
1.543 +In the Settings menu both fonts can be set and also which font should be
1.544 +used for default.
1.545 +
1.546 +Additionally to the default fonts any font installed on your system can
1.547 +be used. Please note, that the chosen font also will be used for HTML
1.548 +exports, so you should only use fonts which are available generally.
1.549 +
1.550 +\subsubsection*{Colors and formatted text}
1.551 +Colors and text attributes (e.g. italic, bold) can
1.552 +be set with the buttons above the text.
1.553 +The text itself is divided in paragraphs. For each paragraph the format
1.554 +can be set (e.g. centered, right). A paragraph is ended when a
1.555 +\key{Return} is entered. If you just want to begin a new line, press
1.556 +\key{CTRL-Return}.
1.557 +
1.558 +\subsubsection*{Finding text}
1.559 +The noteeditor itself has no Find function, use Find in the mapeditor,
1.560 +which will also search all notes (see \ref{findwindow}).
1.561 +
1.562 +\subsubsection*{Pasting text into note editor}
1.563 +Often you will paste text into the editor from another application e.g.
1.564 +an email. Normally \vym will generate a new paragraph for each new line.
1.565 +This usually is not what you want, so you can choose from the menu
1.566 +
1.567 +\paragraph{Edit \ra Convert Paragraphs:}
1.568 +This turns paragraphs in selected text (or all text, if nothing is
1.569 +selected) into linebreaks. This is especially useful for snippets of
1.570 +source code.
1.571 +
1.572 +\paragraph{Edit \ra Join Lines:}
1.573 +Tries to format text, so that empty lines are used to delimit
1.574 +paragraphs. This is done for selected text (or all text, if nothing is
1.575 +selected). Especially useful for text like emails, meeting minutes etc.
1.576 +
1.577 +\section{Hello world}
1.578 +\vym can export its maps in various formats and can import data from
1.579 +outside (though import is still limited at the moment).
1.580 +
1.581 +\subsection{Export}
1.582 +The format in which the map will be exported can be chosen with
1.583 +\begin{itemize}
1.584 + \item File \ra Export \ra {\em format}
1.585 +\end{itemize}
1.586 +\vym offers both HTML and ASCII export.
1.587 +
1.588 +\subsubsection*{Image}
1.589 +\vym supports all image formats which are natively supported by the
1.590 +QT~toolkit:
1.591 +BMP, JPEG, PBM, PGM, PNG, PPN, XPM, and XBM.
1.592 +For use in websites and for sending images by email PNG is a good
1.593 +recommodation regarding quality and size of the image. \vym uses QTs
1.594 +default options for compressing the images.
1.595 +
1.596 +\subsubsection*{ASCII}
1.597 +Exporting an image as text is somewhat experimental at the moment. Later
1.598 +this will probably done using stylesheets. So the output may change in
1.599 +future versions of \vym.
1.600 +
1.601 +\subsubsection*{HTML}
1.602 +Before a map is exported as HTML, it will be first written as XML into a
1.603 +directory (see \ref{xmlexport}). Then the external program {\tt
1.604 +xsltproc}\footnote{On SUSE Linux {\tt xsltproc} is installed by
1.605 +default.}
1.606 +will be called to process the XML file and generate HTML code.
1.607 +%A script then will transform the XML
1.608 +%version.
1.609 +A dialog allows to set various options:
1.610 +\begin{itemize}
1.611 + \item {\bf Include image:} If set, \vym will creat an image map at
1.612 + the top of the HTML output. Clicking on a branch in the map will
1.613 + jump to the corresponding section in the output.
1.614 +
1.615 + \item {\bf Colored headings:}
1.616 + If set to yes, \vym will color the headings in the text part with the
1.617 + same colors like in the map.
1.618 + \item {\bf Show Warnings:}
1.619 + If set to yes, \vym will ask before overwriting data.
1.620 + \item {\bf Show output:}
1.621 + This is useful mainly for debugging. It will show how the processing of
1.622 + the XML file works by calling the external {\tt xsltproc}.
1.623 +\end{itemize}
1.624 +Additionally the paths to the CSS and XSL stylesheets can be set. By
1.625 +default on SUSE~Linux they will be in {\tt /usr/share/vym/styles}.
1.626 +
1.627 +%\paragraph{WIKI style:} This is very useful for easy design of webpages.
1.628 +%Here is a short overview:
1.629 +%\begin{verbatim}
1.630 +%Lines:
1.631 +% + Big headlines start with the '+' character.
1.632 +% - Small headlines start with the '-' character.
1.633 +% Normal text doesn't have any starting notation.
1.634 +% ! Notes start with an exclamation.
1.635 +% . Indented text starts with a dot.
1.636 +% ? Questions start with a question-mark, and
1.637 +% = Answers starts with the equal-sign.
1.638 +% * Points for a item-list
1.639 +% # clues
1.640 +%
1.641 +%Links:
1.642 +% use '{...}' or '{(vym homepage) http://www.insilmaril.de/vym/}'
1.643 +% for external links.
1.644 +%
1.645 +%Markup:
1.646 +% |This is bold| text, while
1.647 +% |/this text is italic|,
1.648 +% |*this is pre-formatted|, and
1.649 +% |!this is a note|
1.650 +%\end{verbatim}
1.651 +%
1.652 +%\paragraph{Show output:} This is used for debugging. \vym uses an
1.653 +%the external script {\tt vym2html.sh} to preprocess the XML-data. Then
1.654 +%\vym calls {\tt xsltproc} to generate the HTML page by using various
1.655 +%{\tt .xsl} stylesheets and {\tt wireframe.css}. If you run into problems
1.656 +%here, changing paths in {\tt $\sim$/.qt/vymrc} might help.
1.657 +
1.658 +\subsubsection*{XML} \label{xmlexport}
1.659 +The map is written into a directory both as an image and as XML. The
1.660 +directory is set in a file dialog. If the directory is not empty, you
1.661 +will be questioned if you risk to overwrite its contents.
1.662 +
1.663 +It is possible to export different maps into the same directory. Each
1.664 +file generated will have the map's name as prefix, e.g. {\tt todo.vym}
1.665 +becomes {\tt todo.xml}, {\tt todo.png}, {\tt todo-image-1.png} and so
1.666 +on. This is useful if e.g. for a website several combined maps have to
1.667 +be stored in the same directory.
1.668 +
1.669 +\subsection{Import}
1.670 +At the moment \vym can read a directory structure. This is mainly for
1.671 +testing \vym e.g. to easily create huge maps used for benchmarks (yes,
1.672 +there is still room to optimize \vym ;-)
1.673 +
1.674 +Many other applications meanwhile can export their data using XML, so
1.675 +volunteers to write import filters are welcome.
1.676 +
1.677 +\subsection{File format}
1.678 +\vym maps usually have the postfix "{\tt .vym}" and represent a
1.679 +compressed archive of data. If you want to have a
1.680 +closer look into the data structure, just uncompress the map manually
1.681 +using
1.682 +\begin{verbatim}
1.683 + unzip vymfile.vym
1.684 +\end{verbatim}
1.685 +A directory named {\tt vymfile} will be created containing further
1.686 +directories both for {\tt images} and {\tt flags}. In the {\tt vymfile}
1.687 +directory you will find the map itself, usually named {\tt vymfile.xml}.
1.688 +
1.689 +This file can be loaded directly into \vym, it does not have to be
1.690 +compressed. If you want to compress all the data yourself, use
1.691 +\begin{verbatim}
1.692 + cd vymfile
1.693 + zip -r vymfile.vym .
1.694 +\end{verbatim}
1.695 +
1.696 +
1.697 +%TODO
1.698 +%\subsubsection{Menus}
1.699 +%\subsubsection{Keyboard shortcuts}
1.700 +%Where does vym save its settings? -> ~/.qt/vymrc
1.701 +
1.702 +\section{History of \vym}
1.703 +\subsection{Future}
1.704 +There are lots of features which might find their way into \vym.
1.705 +Together with \vym you should have received a directory with example
1.706 +maps e.g. on SUSE~LINUX this is
1.707 +\begin{center}
1.708 + {\tt /usr/share/doc/packages/vym/demos}
1.709 +\end{center}
1.710 +where you find the map {\tt todo.vym}. It lists quite a lot of things to
1.711 +be done in future. If you have more ideas, contact the author at
1.712 +{\tt vym@insilmaril.de}.
1.713 +
1.714 +\subsection{Past}
1.715 +\begin{center}
1.716 +\begin{longtable}{|lcp{8cm}l|} \hline
1.717 +Version & & Comment & Date \\ \hline \hline \endhead
1.718 + \hline \endfoot
1.719 +1.6.0 & - & Added saving of xhtml settings in map& 2004-12-14 \\
1.720 +1.5.2 & - & Added Import of maps with two modes:
1.721 + add/replace & 2004-12-13 \\
1.722 + & - & Added export of part of maps & \\
1.723 + & - & Added joining of paragraphs in text editor & \\
1.724 + & - & Optimized undo: Only relevant parts are saved, which
1.725 + dramatically improves e.g. moving branches up/down
1.726 + in most maps & \\
1.727 + & - & Bugfix: QTextEdit generates invalid XML code, which
1.728 + could lead to a parse error, if font name contains a \& & \\
1.729 + & - & Bugfix: Wrong order of mainbranches in Export & \\
1.730 + & - & Bugfix: zip archive was not deleted before save, which
1.731 + could lead to much bigger files, e.g.
1.732 + when working on older \vym maps or deleted images& \\
1.733 + & - & Bugfix: Printing in Texteditor & \\
1.734 + & - & Bugfix: Wrong URLs in xhtml output & \\
1.735 + & - & Bugfix: Segfault fixed at Cursor left/right in empty map& \\
1.736 +1.5.1 & - & More options in xhtml export: external scripts & 2004-10-01 \\
1.737 +1.5.0 & - & Public release of all changes since 1.4.1 & 2004-09-26 \\
1.738 + & - & New function to replace paragraphs in note editor
1.739 + by linebreaks, this makes pasted text much nicer& \\
1.740 + & - & New option to toggle exporting of of floatimages& \\
1.741 + & - & z-plane of floatimages can be set (manually only)& \\
1.742 + & - & Bugfix: Wrong ordering of branches, if mainbranch is
1.743 + exactly left of center& \\
1.744 +1.4.7 & - & New Export to HTML by Thomas Schraitle. & 2004-09.24 \\
1.745 + & - & Bugfix: vymLink& \\
1.746 + & - & Bugfix: spaces and dots in filenames & \\
1.747 + & - & Bugfix: Error message if xsltproc is not installed& \\
1.748 +1.4.6 & - & New file format: notes are saved as part of the .xml file
1.749 + & 2004-09-15 \\
1.750 + & - & Note Editor supports Rich Text now.&\\
1.751 + & - & Parser now also nows {\tt standardflag} (all letters
1.752 + lowercase)&\\
1.753 +1.4.5 & - & Correct handling of font size in Heading & 2004-08-23 \\
1.754 +1.4.4 & - & Selecting with cursor now works between subtrees & 2004-07-29 \\
1.755 + & - & Bugfix: vymLink was set to temporary dir in 1.4.3 & \\
1.756 + & - & Bugfix: & \\
1.757 +1.4.3 & - & Optimisation: Reduced canvas objects by only
1.758 + creating objects for used flags & 2004-07-19 \\
1.759 + & - & Better visualization of moving branch above/below target&\\
1.760 + & - & Find Window informs with dialog, if the search failed&\\
1.761 + & - & System Flags are clickable now &\\
1.762 + & - & Reworked CSS and XST stylsheets (comments, indent, browser
1.763 + compatibility) &\\
1.764 + & - & vymLinks are shown in statusbar &\\
1.765 + & - & current directory is save &\\
1.766 + & - & Rewritten load/save to improve multimap handling and
1.767 + unzipped files&\\
1.768 + & - & Bugfix: vymLinks don't get deleted
1.769 + when Cancel is pressed &\\
1.770 + & - & Bugfix: Fixed a bunch of bugs in XSL for HTML export& \\
1.771 + & - & Bugfix: More toolbar buttons disabled, if action not
1.772 + possible& \\
1.773 + & - & Bugfix: Renaming .vymfile now works&\\
1.774 + & - & Bugfix: mapChanged set when toggling flags&\\
1.775 + & - & Bugfix: CTRL-N was used twice &\\
1.776 + & - & Bugfix: Del didn't work on floatimage &\\
1.777 +1.4.2 & - & Bugfix: Float image could not be deleted& \\
1.778 +1.4.1 & - & Bugfix: Color of branch not saved & 2004-05-25 \\
1.779 + & - & Bugfix: wrong path at HTML export & \\
1.780 + & - & Bugfix: map is not save with special characters in path& \\
1.781 +1.4.0 & - & Ask for confirmation before opening
1.782 + a map in multiple editors & 2004-05-17 \\
1.783 + & - & Save state of note editor (visible/minimized)& \\
1.784 + & - & Export to HTML & \\
1.785 + & - & Author and Comment is saved in map & \\
1.786 + & - & Stats are shown in Edit MapInfo & \\
1.787 + & - & Changes for OS X port (QCursor, QContextMenuEvent) & \\
1.788 + & - & Bugfix: Fonts from note editor are save now &\\
1.789 + & - & Bugfix: invisible image when parent is scrolled &\\
1.790 + & - & Bugfix: Segfault pressing "enter" for floatimage &\\
1.791 + & - & Bugfix: Images can't be outside of exported area
1.792 + anymore.& \\
1.793 + & - & Bugfix: Filenames with blanks & \\
1.794 + & - & Bugfix: Old maplink is shown when editing maplink& \\
1.795 + & - & Bugfix: always show cursor while editing heading & \\
1.796 +1.3.5 & - & Export map to dir & 2004-04-16 \\
1.797 + & - & Export to any of QTs image formats & \\
1.798 + & - & Also right side of selection is always visible now.& \\
1.799 +1.3.4 & - & Load last maps in file menu & 2004-04-07 \\
1.800 + & - & save last image path for loading & \\
1.801 + & - & Also export standard flags to dir. & \\
1.802 +1.3.3 & - & Enabled <br> in headings as manual linebreak & 2004-03-26 \\
1.803 + & - & Heading can be copied to URL &\\
1.804 + & - & Bugfix: GIFs are automatically converted to PNG now&\\
1.805 +1.3.2 & - & Add and move branches above/below selection, Texteditor copy all,& 2004-03-26 \\
1.806 +1.3.1 & - & Export to directory, changed naming in .vym& 2004-03-25 \\
1.807 +1.3.0 & - & Bugfix: Check if map can be saved at all& 2004-03-23 \\
1.808 +1.2.12 & - & Select image format before saving image & 2004-03-22 \\
1.809 +1.2.11 & - & Selecting mainbranches by up/down & 2004-03-18 \\
1.810 + & - & Export ASCII (experimental) & \\
1.811 + & - & Each map can be saved individually at quit & \\
1.812 + & - & Bugfix: Opening VymLink crashes QT & \\
1.813 + & - & Bugfix: 50\% less objects on canvas & \\
1.814 + & - & Bugfix: Ignoring LANG, now always written as UTF8&\\
1.815 +1.2.10 & - & Sort Mainbranches by angle to y-axis& 2004-03-16 \\
1.816 + & - & Import directory structure & \\
1.817 + & - & Fix: Set FrameType of MapCenter while loading map &\\
1.818 +1.2.9 & - & Jump to another vym map & 2004-03-12 \\
1.819 + & - & Mainbranches are alwas ordered clockwise & \\
1.820 +1.2.8 & - & Change frame types in context menu & 2004-03-03 \\
1.821 +1.2.7 & - & Copy / Paste and save Floatimages & 2004-02-25 \\
1.822 +1.2.6 & - & Closing vym in KDE now asks for save, too & 2004-02-24 \\
1.823 + & - & Context menu for branches & \\
1.824 + & - & Selection is saved in .vym file & \\
1.825 +1.2.5 & - & URLs to external links can be added & 2004-02-18 \\
1.826 + & - & All actions are deactived if not possible & \\
1.827 +1.2.4 & - & Images: Can be loaded, saved, relinked to other parents
1.828 +& 2004-02-16 \\
1.829 +1.2.3 & - & Zoom: Reset and finer steps shrinking/enlarging & 2004-01-27 \\
1.830 +1.2.2 & - & Editing of links (style and color) & 2004-01-27 \\
1.831 +1.2.1 & - & Bugfix: LineEdit when adding branch has correct position
1.832 + again. & 2004-01-27 \\
1.833 +1.2.0 & - & Scrolled parts are automatically unscrolled when
1.834 + selected and scrolled again later. & 2004-01-23 \\
1.835 + & - & Bugfix: Save flag is updated when multiple maps are opened& \\
1.836 + & - & Bugfix: Moving of branches is faster and more accurat
1.837 + when adding to mapcenter& \\
1.838 +1.1.7 & - & Bugfix: Remember filename of note in noteeditor & 2003-12-04 \\
1.839 +1.1.6 & - & Find Text also in Notes. & 2003-12-02 \\
1.840 +1.1.5 & - & Bugfix: Correct setting and positioning when relinking branches & 2003-11-07 \\
1.841 +1.1.4 & - & Scroll mode added (folding of subtrees). & 2003-11-03 \\
1.842 + & - & Bugfix: Wrong position of linedit in zoomed view& \\
1.843 +1.1.3 & - & Added clear button in find window, bugfixes & 2003-10-09 \\
1.844 +1.1.2 & - & Links can be colored with color of heading & 2003-10-07 \\
1.845 +1.1.1 & - & Improved visualization of linking to new branch& 2003-09-26 \\
1.846 +1.1.0 & - & Find Function & 2003-09-25 \\
1.847 + & - & Selection always stays in view & \\ \hline
1.848 +1.0.1 & - & Find function scrolls to result now & 2003-09-18\\
1.849 + & - & Bugfix: Adding branch with midmouse & \\
1.850 + & - & Bugfix: multiple repositioning of map,
1.851 + when noteeditor was changed (speedup) & \\
1.852 + & - & New Linestyles (still hardcoded) & \\ \hline
1.853 +1.0.0 & - & First public stable release & 2003-09-16 \\ \hline
1.854 +0.9.0 & - & added quick color picker (CTRL + Left Mouse) & ? \\ \hline
1.855 +0.8.0 & - & added automatic canvas resizer, removed manual resizing of
1.856 + canvas & \\
1.857 +
1.858 + & - & added settings option to paste text into new branch & \\
1.859 + & - & simplified code & \\
1.860 + & - & Added heart flag & \\
1.861 + & - & Choose and switch between fixed and variable width fonts& \\
1.862 + & - & note editor & \\
1.863 + & - & Fixed segfault caused by undo and a call of updateNoteFlag of
1.864 + note editor & \\
1.865 + & - & Added settings menu to configure autoselect \& autoedit mode & \\
1.866 + & - & autoedit \& autoselect mode & \\
1.867 + & - & Fixed ugly display problem with QT Palette (Klaas Freitag)& \\
1.868 + & - & Reduced temporary directories from 4 to 1 & \\
1.869 + & - & Added wordwrap in printing of notes & \\
1.870 + & - & New toolbar buttons in texteditor & \\
1.871 + & - & Set background color & \\
1.872 + & - & Fixed bug: Flags in toolbar not updated when selecting map center & \\ \hline
1.873 +0.7.0 & - & No more segfault, when an object is deleted while being edited & \\
1.874 + & - & Keep focus constant when zooming in/out & \\
1.875 + & - & Export as png graphic & \\
1.876 + & - & Keep Center of map where it is while zooming & \\
1.877 + & - & Added Standard Flags (Smiley, Hook, Stopsign, ...) & \\
1.878 + & - & MDI: Multi Document Interface enables working on several
1.879 + maps simultanously & \\
1.880 + & - & Enabled creating a new map via argument on commandline & \\
1.881 + & - & Changed file extension from .mmap to .vym & \\
1.882 + & - & noteeditor changes color, if empty or nothing is selected & \\
1.883 + & - & Changes in NoteEditor window are recognized by main window,
1.884 + too, thus preventing loosing data when quitting the program. & \\ \hline
1.885 +0.6.0 & - & New rendering engine: Faster, no flickering & \\ \hline
1.886 +0.5.0 & - & Changed printing to use maximum space on paper& \\
1.887 + & - & Note editor is hidden, too, when mapeditor is minimized& \\
1.888 + & - & New (compressed) file format& \\ \hline
1.889 +0.4.0 & - & Size of map is saved& \\
1.890 + & - & Multi Line Headings & \\
1.891 + & - & Reworked Rendering Engine: Much faster now.& \\
1.892 + & - & Reworked Undo: Much faster now.& \\
1.893 + & - & Enabled moving of map center& \\
1.894 + & - & Multi-line headings & \\ \hline
1.895 +0.3.0 & - & Introduced Undo& \\
1.896 + & - & Fixed some bugs & \\ \hline
1.897 +0.2.0 & - & Moving view of map improved:& \\
1.898 + & - & New handling (acrobat reader style)& \\
1.899 + & - & New mousepointer& \\
1.900 + & - & Several tools to color a map& \\ \hline
1.901 +0.1.0 & - & Inital version, basic map layout & \\
1.902 + & - & Data is stored in XML& \\
1.903 +\end{longtable}
1.904 +\end{center}
1.905 +
1.906 +
1.907 +% INDEX
1.908 +% mapeditor
1.909 +% noteditor
1.910 +% branch
1.911 +% mapcenter
1.912 +% heading
1.913 +% flag
1.914 +% orientation
1.915 +% zoom
1.916 +% orientation
1.917 +% Toolbar
1.918 +% Zoom
1.919 +% Find
1.920 +% statusbar
1.921 +% link
1.922 +% mainbranch
1.923 +% subtree
1.924 +% reorder
1.925 +% scroll
1.926 +% fold
1.927 +
1.928 +
1.929 +
1.930 +\end{document}
1.931 \ No newline at end of file