tex/vym.tex
author insilmaril
Wed, 08 Mar 2006 12:59:08 +0000
changeset 236 22a885118d50
parent 233 c3943fbd0e74
child 245 27b71695d690
permissions -rw-r--r--
Fixed Image Preview in FileDialog
insilmaril@28
     1
\documentclass{article}
insilmaril@28
     2
\usepackage{a4}
insilmaril@28
     3
\usepackage[latin1]{inputenc}
insilmaril@28
     4
\usepackage{verbatim}
insilmaril@28
     5
\usepackage{hyperref}
insilmaril@28
     6
\usepackage{graphicx}
insilmaril@28
     7
\usepackage{longtable}
insilmaril@28
     8
insilmaril@28
     9
insilmaril@28
    10
%\input{udmath}
insilmaril@28
    11
insilmaril@28
    12
insilmaril@28
    13
\hypersetup{bookmarks, bookmarksopen,
insilmaril@28
    14
  pdftitle={VYM - a tool for visual thinking },
insilmaril@28
    15
  pdfauthor={Uwe Drechsel},    
insilmaril@28
    16
  pdfsubject={map},
insilmaril@28
    17
  pdfkeywords={map, tool},
insilmaril@28
    18
  pdfpagemode={UseOutlines},                                 
insilmaril@28
    19
  bookmarksopenlevel={1},   
insilmaril@28
    20
  colorlinks={true},     
insilmaril@28
    21
  linkcolor={blue},
insilmaril@28
    22
  urlcolor={green},
insilmaril@28
    23
  citecolor={red}} 
insilmaril@28
    24
insilmaril@28
    25
insilmaril@28
    26
\newcommand{\vym}{{\sc vym }}
insilmaril@28
    27
\newcommand{\ra}{$\longrightarrow$}
insilmaril@28
    28
\newcommand{\la}{$\longleftarrow$}
insilmaril@28
    29
\newcommand{\ua}{$\uparrow$}
insilmaril@28
    30
\newcommand{\da}{$\downarrow$}
insilmaril@28
    31
\newcommand{\key}[1]{[#1]}
insilmaril@28
    32
insilmaril@28
    33
\begin{document}
insilmaril@233
    34
\title{
insilmaril@233
    35
	\includegraphics[width=8cm]{vym-logo-new.png}
insilmaril@233
    36
	\\
insilmaril@233
    37
VYM \\ -- \\View Your Mind}
insilmaril@28
    38
\author{\textcopyright Uwe Drechsel  }
insilmaril@28
    39
insilmaril@233
    40
insilmaril@28
    41
\maketitle
insilmaril@28
    42
insilmaril@233
    43
\newpage
insilmaril@233
    44
insilmaril@28
    45
\tableofcontents
insilmaril@28
    46
insilmaril@28
    47
\newpage
insilmaril@28
    48
insilmaril@28
    49
\section{Introduction}
insilmaril@28
    50
\subsection{What is a \vym map?}
insilmaril@28
    51
A \vym map (in short words {\em map}) is a tree like structure:
insilmaril@28
    52
\begin{center}
insilmaril@28
    53
	\includegraphics[width=12cm]{example1.png}
insilmaril@28
    54
\end{center}
insilmaril@28
    55
Such maps can be drawn by hand on paper or a flip chart and help to
insilmaril@28
    56
structure your thoughs. While a tree like structure like above can be
insilmaril@28
    57
drawn by hand or any drawing software \vym offers
insilmaril@28
    58
much more features to work with such maps. \vym is not another drawing
insilmaril@28
    59
software, but a tool to store and modify information in an intuitive
insilmaril@28
    60
way. For example you can reorder parts of the map by pressing a key or
insilmaril@28
    61
add various information like a complete email by a simple mouse click.
insilmaril@28
    62
insilmaril@28
    63
\subsection{Why should I use maps? Time, Space and your Brain.}
insilmaril@28
    64
\subsubsection*{Space}
insilmaril@28
    65
A map can concentrate a very complex content on little space e.g. a
insilmaril@28
    66
piece of paper. It helps to use both sides of your brain: the logical
insilmaril@28
    67
side and also your creative side (e.g. by using pictures, colors and
insilmaril@28
    68
keywords in a map, so called {\em anchors}).  It is a technique to
insilmaril@28
    69
organize the way you think: It can help you by developing, sorting and
insilmaril@28
    70
memorizing your thoughts. 
insilmaril@28
    71
insilmaril@28
    72
\subsubsection*{Time}
insilmaril@28
    73
Because you just use keywords and drawings, it is much faster than good
insilmaril@28
    74
old fashioned notes. Your brain memorizes things by associating them to
insilmaril@28
    75
other things -- a map makes use of those connections and stimulates
insilmaril@28
    76
new asccociations. 
insilmaril@28
    77
insilmaril@125
    78
insilmaril@28
    79
\subsubsection*{Your Brain}
insilmaril@28
    80
In 1960 the Prof. {\sc Roger Sperry} discovered that both hemispheres
insilmaril@28
    81
of the human brain have different tasks (of course both of them
insilmaril@125
    82
basically {\em can} do the same): 
insilmaril@125
    83
\begin{center}
insilmaril@125
    84
\begin{tabular}{|p{5.5cm}|p{5.5cm}|} \hline
insilmaril@125
    85
	Left side & Right side \\ \hline
insilmaril@125
    86
	\begin{itemize}
insilmaril@125
    87
	   \item verbal speech and writing 
insilmaril@125
    88
	   \item numbers
insilmaril@125
    89
	   \item logical thinking
insilmaril@125
    90
	   \item analyzing and details
insilmaril@125
    91
	   \item science
insilmaril@125
    92
	   \item linear thinking
insilmaril@125
    93
	   \item concept of time
insilmaril@125
    94
	\end{itemize} &
insilmaril@125
    95
	\begin{itemize}
insilmaril@125
    96
		\item body language
insilmaril@125
    97
		\item visual thinking, day dreams
insilmaril@125
    98
		\item intuition and emotion
insilmaril@125
    99
		\item overview of things
insilmaril@125
   100
		\item creativity
insilmaril@125
   101
		\item art, music, dancing
insilmaril@125
   102
		\item non-linear thinking, connecting things
insilmaril@125
   103
		\item spatial awareness
insilmaril@125
   104
	\end{itemize}     \\ \hline
insilmaril@125
   105
\end{tabular}	
insilmaril@125
   106
\end{center}
insilmaril@28
   107
In our science oriented society we have learned to mainly rely on our
insilmaril@28
   108
left side of the brain, the "rational" one. In other cultures,
insilmaril@28
   109
especially like the native americans and other "old" cultures, the right
insilmaril@28
   110
side is much more important. maps are just one way to stimulate the
insilmaril@28
   111
other side and make use of additional ressources we all have.
insilmaril@28
   112
insilmaril@28
   113
insilmaril@28
   114
\subsection{Where could I use a map?}
insilmaril@28
   115
Here are some examples, how you can use those maps
insilmaril@28
   116
\begin{itemize}
insilmaril@28
   117
    \item to prepare articles, papers, books, talks, \ldots
insilmaril@28
   118
    \item to sort complex data
insilmaril@28
   119
    \item to memorize facts, persons, vocabulary, \ldots
insilmaril@28
   120
    \item to sort emails, files and bookmarks on your computer
insilmaril@28
   121
    \item to moderate conferences
insilmaril@28
   122
\end{itemize}
insilmaril@28
   123
insilmaril@28
   124
\subsection{What you shouldn't do with a map...}
insilmaril@28
   125
A map drawn by somebody shows the way the author thinks. There is
insilmaril@233
   126
no right or wrong in the way it is drawn, so there is no way to criticize
insilmaril@28
   127
it. "It is, what it is" ({\sc F.~Lehmann}).
insilmaril@28
   128
insilmaril@28
   129
%\section{Tutorials}
insilmaril@28
   130
%TODO
insilmaril@28
   131
insilmaril@125
   132
\subsection{Internet Ressources} 
insilmaril@125
   133
A good starting point to learn more about maps in general is Wikipedia:
insilmaril@125
   134
\begin{itemize}
insilmaril@125
   135
	\item English: 
insilmaril@125
   136
		\href{http://en.wikipedia.org/wiki/Mind_map}{http://en.wikipedia.org/wiki/Mind\_map}
insilmaril@125
   137
	\item German: 
insilmaril@125
   138
		\href{http://de.wikipedia.org/wiki/Mindmap}{http://de.wikipedia.org/wiki/Mindmap}
insilmaril@125
   139
\end{itemize}
insilmaril@125
   140
insilmaril@233
   141
\subsection{Concept of \vym: Maps, branches, mapeditor and noteeditor}
insilmaril@28
   142
insilmaril@28
   143
%TODO may add a general introduction here...
insilmaril@28
   144
insilmaril@28
   145
\vym uses two windows: an editor for the map itself and another one for
insilmaril@28
   146
notes, which are part of the map. Let's call them {\em mapeditor} and
insilmaril@28
   147
{\em noteeditor}: 
insilmaril@28
   148
\begin{center}
insilmaril@28
   149
	\includegraphics[width=8cm]{windows.png}
insilmaril@28
   150
\end{center}
insilmaril@28
   151
Usually you will work in the {\em mapeditor} by just adding new
insilmaril@28
   152
branches, moving around and reordering them. The various ways to do this
insilmaril@28
   153
will be explained in \ref{mapeditor}. You can store additional
insilmaril@28
   154
information e.g. the content of a email easily in a {\em branch}: Just
insilmaril@28
   155
type or copy\&paste it into the {\em noteeditor}. Working with notes is
insilmaril@28
   156
explained in \ref{noteeditor}
insilmaril@28
   157
insilmaril@28
   158
The map itself has always a {\em mapcenter}.  The
insilmaril@28
   159
mapcenter has {\em branches} just like the trunk of a tree. Each branch
insilmaril@28
   160
in turn may have branches again.
insilmaril@28
   161
\begin{center}
insilmaril@28
   162
	\includegraphics[width=10cm]{branches.png}
insilmaril@28
   163
\end{center}
insilmaril@28
   164
We will call a branch directly connected to the mapcenter a {\em
insilmaril@28
   165
mainbranch}, because it determines the position of all its child
insilmaril@28
   166
branches.
insilmaril@28
   167
insilmaril@28
   168
The mapcenter and the branches all have a {\em heading}. This is the
insilmaril@28
   169
text you see in the mapeditor. Usually it should just be one or a few
insilmaril@28
   170
words, so that one can easily keep track of the whole map.
insilmaril@28
   171
insilmaril@28
   172
insilmaril@28
   173
In the toolbar above the mapeditor you see various symbols.
insilmaril@28
   174
\begin{center}
insilmaril@28
   175
	\includegraphics[width=8cm]{default-flags.png}
insilmaril@28
   176
\end{center}
insilmaril@28
   177
These are called {\em flags} and can be used to mark branches in the
insilmaril@28
   178
map, e.g. if something is important or questionable. 
insilmaril@28
   179
There are also more flags set by \vym automatically to show additional
insilmaril@28
   180
information, e.g. when a  exists for a  particular branch.
insilmaril@28
   181
insilmaril@104
   182
By default some of these flags are set exclusively e.g. when the \lq
insilmaril@104
   183
thumb-up\rq flag is set, then the \lq thumb down\rq is unset and vice
insilmaril@104
   184
versa. You can change this default behaviour in the settings menu.
insilmaril@104
   185
insilmaril@233
   186
%TODO add info about toolbars e.g. undo/redo, ...
insilmaril@233
   187
insilmaril@28
   188
\section{Mapeditor} \label {mapeditor}
insilmaril@28
   189
\subsection{Start a new map}
insilmaril@28
   190
After \vym is started two windows will open: the mapeditor and the
insilmaril@28
   191
noteditor. Usually you will work in both windows, but at the moment we
insilmaril@28
   192
will just need the mapeditor. 
insilmaril@28
   193
insilmaril@28
   194
Select the mapcenter "New map" in the middle of the mapeditor by
insilmaril@28
   195
left-clicking with the mouse. It will turn yellow to show that is
insilmaril@103
   196
selected. There are several ways to add a new branch to the center:
insilmaril@28
   197
\begin{itemize}
insilmaril@103
   198
	\item Using the mouse: Open the context meny by clicking with the
insilmaril@103
   199
	right mouse button (CTRL-Click on Mac) onto the
insilmaril@103
   200
	mapcenter and choose Add \ra Add as child
insilmaril@103
   201
	\item Press \key{Ins} or \key{A}
insilmaril@28
   202
\end{itemize}
insilmaril@28
   203
A new branch will appear and you will be able to type the heading of the
insilmaril@28
   204
branch. Finish adding the new branch by pressing \key{Enter}.
insilmaril@28
   205
%tipp
insilmaril@28
   206
Sometimes it comes handy to add a new branch above or below the current
insilmaril@104
   207
one. Use \key{Ins} together with \key{Shift} or \key{Ctrl}. It is also
insilmaril@104
   208
possible to add a branch in such a way, that the current selection
insilmaril@104
   209
becomes the child of the new branch, which is like inserting it {\em
insilmaril@104
   210
before} the selection. This can be done using the context menu.
insilmaril@28
   211
insilmaril@28
   212
\subsection{Navigate through a map}
insilmaril@28
   213
\subsubsection*{Select branches}
insilmaril@28
   214
To select branches you can use the left button of your mouse or also the
insilmaril@28
   215
arrow keys. Depending on the {\em orientation} of a branch type
insilmaril@28
   216
\key{\la} or \key{\ra} to get nearer to the mapcenter or deeper
insilmaril@28
   217
down into the branches. Within a set of branches, let's call them a 
insilmaril@28
   218
{\em subtree}, you can use \key{\ua} and \key{\da} to go up and down. You can
insilmaril@28
   219
also use \key{Pos1} and \key{End} to select the first and last branch.
insilmaril@28
   220
insilmaril@28
   221
insilmaril@28
   222
\subsubsection*{Zoom a map}
insilmaril@28
   223
While adding more and more branches the size of the map may become
insilmaril@28
   224
bigger than the mapeditor window. You can use the scrollbars on the
insilmaril@28
   225
right and the bottom of your mapeditor window to scroll, but it is
insilmaril@28
   226
easier to just scroll using the left mouse button: Click onto the {\em
insilmaril@28
   227
canvas} itself, the empty space somewhere between the branches. The
insilmaril@28
   228
mouse pointer will change from an arrow to a hand, now move the visible
insilmaril@28
   229
part of the map to show the desired part.
insilmaril@28
   230
insilmaril@28
   231
If you select branches using the arrow keys, the map will scroll
insilmaril@28
   232
to ensure that the selected branch is always visible.
insilmaril@28
   233
insilmaril@28
   234
Working with huge maps, the {\em zoom}-function comes in handy: You can
insilmaril@28
   235
use 
insilmaril@28
   236
\begin{itemize}
insilmaril@28
   237
	\item from the menu View \ra Zoom
insilmaril@28
   238
	\item the toolbar buttons 
insilmaril@28
   239
		\begin{center}
insilmaril@28
   240
			\includegraphics[width=3cm]{zoom-buttons.png}
insilmaril@28
   241
		\end{center}	
insilmaril@28
   242
\end{itemize}	
insilmaril@28
   243
The crossed magnifying lens resets the zoomed view to its original size.
insilmaril@28
   244
insilmaril@28
   245
insilmaril@28
   246
\subsubsection*{Find Function} \label{findwindow}
insilmaril@28
   247
With huge maps there is the need to have a
insilmaril@28
   248
find function. Choose Edit \ra Find to open the Find Window:
insilmaril@28
   249
\begin{center}
insilmaril@28
   250
	\includegraphics[width=6cm]{find-window.png}
insilmaril@28
   251
\end{center}	
insilmaril@28
   252
The text you enter here will be searched in all the headings and also in
insilmaril@28
   253
notes. Everytime you press the "Find"-button it will look for the next
insilmaril@28
   254
occurence, which then will be selected automatically. If the search
insilmaril@28
   255
fails, there will appear a short message "Nothing found" or a few
insilmaril@28
   256
seconds in the {\em statusbar} on the bottom of the mapeditor.
insilmaril@28
   257
insilmaril@28
   258
\subsubsection*{Scroll a part of the map}
insilmaril@28
   259
A very big subtree of a map e.g. a branch with hundreds of childs makes
insilmaril@28
   260
it very hard to keep an overview over the whole map. You can hide all
insilmaril@28
   261
the childs of a branch by {\em scrolling} it -- this function is also
insilmaril@28
   262
often called {\em folding}. Think of the whole subtree as painted onto a
insilmaril@28
   263
big newspaper. You can scroll the paper to a small roll, leaving just
insilmaril@28
   264
the headline readable.
insilmaril@28
   265
insilmaril@28
   266
To scroll or unscroll a branch and its childs, press the
insilmaril@28
   267
\begin{itemize}
insilmaril@103
   268
	\item \key{Scroll} key or  \key{S}
insilmaril@28
   269
	\item press the middle-mouse button or
insilmaril@28
   270
	\item choose the little scroll from the toolbar.
insilmaril@28
   271
\end{itemize}
insilmaril@28
   272
If you select parts of a scrolled branch e.g. using the find function or
insilmaril@28
   273
by using the arrow-keys, it will unscroll temporary. This is shown as a
insilmaril@28
   274
scroll with a little hour glass. If the temporary unscrolled part is not
insilmaril@28
   275
longer needed, it will be hidden again automatically. It is also
insilmaril@28
   276
possible to unscroll all branches using "Edit\ra Unscroll all scrolled
insilmaril@28
   277
branches".
insilmaril@28
   278
insilmaril@28
   279
insilmaril@28
   280
insilmaril@28
   281
\subsection{Modify and move branches}
insilmaril@28
   282
\subsubsection*{Modify the heading of a branch}
insilmaril@28
   283
You can edit the heading by selecting the branch and then
insilmaril@28
   284
\begin{itemize}
insilmaril@28
   285
	\item pressing \key{Enter}
insilmaril@28
   286
	\item double-clicking with left mouse.
insilmaril@28
   287
\end{itemize}
insilmaril@28
   288
Just type the new heading (or edit the old one) and press \key{Enter}.
insilmaril@28
   289
insilmaril@28
   290
\subsubsection*{Move a branch}
insilmaril@28
   291
The easiest way to move a branch is to select it with left-mouse and
insilmaril@28
   292
drag it to the destination while keeping the mouse button pressed.
insilmaril@28
   293
Depending on the branch  it will be
insilmaril@28
   294
\begin{itemize}
insilmaril@28
   295
	\item moved to the destination or
insilmaril@28
   296
	\item {\em linked} to a new {\em parent} (mapcenter or branch)
insilmaril@28
   297
\end{itemize}
insilmaril@28
   298
If you drag the branch over another one or over the mapcenter, you will
insilmaril@28
   299
notice that the  link connecting it to the old parent will be changed to
insilmaril@28
   300
lead to the  new parent which is now under your mousepointer. 
insilmaril@28
   301
If you release the button now, the branch will be relinked.
insilmaril@28
   302
insilmaril@28
   303
If you release the button in the middle of nowhere, the result will
insilmaril@28
   304
depend on the type of branch you are releasing:
insilmaril@28
   305
\begin{itemize}
insilmaril@28
   306
	\item A mainbranch is directly connected to the mapcenter.
insilmaril@28
   307
		It will stay on its new position.
insilmaril@28
   308
	\item An ordinary branch will "jump" back to its original position.	
insilmaril@28
   309
\end{itemize}
insilmaril@28
   310
Thus you can easily rearrange the layout of the mainbranches to avoid
insilmaril@28
   311
overlapping of their subtrees.
insilmaril@28
   312
There is another convenient way to move branches, especially if you want
insilmaril@28
   313
to {\em reorder} a subtree: You can move a branch up or down in a
insilmaril@28
   314
subtree by
insilmaril@28
   315
\begin{itemize}
insilmaril@28
   316
	\item pressing \key{\ua} and \key {\da}
insilmaril@28
   317
	\item selecting Edit \ra Move branch
insilmaril@28
   318
	\item clicking on the toolbar buttons:
insilmaril@28
   319
		\begin{center}
insilmaril@28
   320
			\includegraphics[width=1.5cm]{move-buttons.png}
insilmaril@28
   321
		\end{center}	
insilmaril@28
   322
\end{itemize}
insilmaril@28
   323
%tipp
insilmaril@28
   324
There is yet another way to move branches: If you press \key{Shift} or
insilmaril@28
   325
\key{Ctrl} while moving with the mouse, the branch will be added above
insilmaril@28
   326
or below the one the mouse pointer is over. This helps also to reorder a
insilmaril@28
   327
map.
insilmaril@28
   328
insilmaril@28
   329
\subsection{The right side of your brain - colors and images}
insilmaril@28
   330
\subsubsection*{Change color of a heading}
insilmaril@28
   331
You can also use colors to put more information into a map, e.g. use
insilmaril@28
   332
red, green and more colors to prioritize tasks. Again you can
insilmaril@28
   333
\begin{itemize}
insilmaril@28
   334
	\item use the menu and choose e.g Format \rq Set Color
insilmaril@28
   335
	\item use the toolbar
insilmaril@28
   336
		\begin{center}
insilmaril@28
   337
			\includegraphics[width=3cm]{color-buttons.png}
insilmaril@28
   338
		\end{center}	
insilmaril@28
   339
\end{itemize}
insilmaril@28
   340
The first button (black in the graphic above) shows the actual color.
insilmaril@28
   341
Clicking on it let's you choose another color. You can also "pick"
insilmaril@28
   342
another color by selecting a branch with the desired color and using the
insilmaril@28
   343
"pick color" button. Both of the buttons showing a bucket actually put
insilmaril@28
   344
the current color to the selected branch. While the first one just
insilmaril@28
   345
colors the heading of the selection, the last one also colors all the
insilmaril@28
   346
childs of the selected branch.
insilmaril@28
   347
insilmaril@28
   348
%tipp
insilmaril@28
   349
A very useful function is the "copy color" using the mouse: Select the
insilmaril@28
   350
branch which should get the new color, then press \key{Ctrl} and
insilmaril@28
   351
simultanously click with left-mouse on another branch to copy its color
insilmaril@28
   352
to the first one. Here the childs of the selection also will get the new
insilmaril@28
   353
color, if you just want to color the selection itself, additionally
insilmaril@28
   354
press \key{Shift}.
insilmaril@28
   355
insilmaril@28
   356
\subsubsection*{Use flags}
insilmaril@28
   357
\vym provides various flags. You see them in the toolbar on top of the
insilmaril@28
   358
mapeditor window. (Note: Like all toolbars you can also move them to the
insilmaril@28
   359
left or the right side of the window or even detach them. Just grab the
insilmaril@28
   360
very left "dotted" part of the toolbar with your left-mouse button.) 
insilmaril@28
   361
\begin{center}
insilmaril@28
   362
	\includegraphics[width=8cm]{default-flags.png}
insilmaril@28
   363
\end{center}
insilmaril@28
   364
If you have a branch selected, you can set any number of flags by
insilmaril@28
   365
clicking them in the toolbar. The toolbar buttons change their state and
insilmaril@28
   366
always reflect the flags set in the selected branch.
insilmaril@28
   367
insilmaril@28
   368
Presently \vym uses two kinds of flags: {\em System Flags} and {\em
insilmaril@28
   369
Standard Flags}. The standard flags are those shown in the toolbar.
insilmaril@28
   370
System flags are set by \vym to indicate e.g. that there is additional
insilmaril@28
   371
information in a note (more on this in \ref{noteeditor}). Later versions
insilmaril@28
   372
of \vym may have another kind of flags, which may be edited by the user.
insilmaril@28
   373
insilmaril@28
   374
\subsubsection*{Images}
insilmaril@125
   375
The easiest way to add an image to a branch is by dragging it e.g. from a
insilmaril@125
   376
webbrowser to the mapeditor while a branch is selected there.
insilmaril@125
   377
insilmaril@125
   378
You can also add a image to a branch by opening the context menu of the
insilmaril@125
   379
branch choose "Add Image". A
insilmaril@28
   380
dialog window lets you choose the image to load. 
insilmaril@28
   381
\footnote{Supported image types are: PNG, BMP, XBM, XPM and PNM. It may
insilmaril@28
   382
	also support JPEG, MNG and GIF, if specially configured during
insilmaril@28
   383
	compilation (as done when \vym is part of SUSE LINUX).}
insilmaril@28
   384
While an image is selected in the dialog, you can see a preview of the
insilmaril@233
   385
image. It is also possible to select multiple images.	
insilmaril@28
   386
insilmaril@28
   387
You can position the image anywhere you want, just drag it with left
insilmaril@28
   388
mouse. To relink it to another branch, press \key{Shift} while moving
insilmaril@28
   389
it. To delete it, press \key{Del}. 
insilmaril@28
   390
insilmaril@28
   391
If you right-click onto an image, a context menu will open which let's
insilmaril@28
   392
you first choose one of several image formats. Then a file dialog opens
insilmaril@28
   393
to save the image. Hint: This is used to "export" the image, it will be
insilmaril@28
   394
saved anyway in the map itself! You can also cut and
insilmaril@28
   395
copy images, but it is not possible to add objects to an image\footnote{
insilmaril@28
   396
	Images are regarded as "extra feature". It would make working with
insilmaril@28
   397
	the map much more complex if e.g. images could be linked to images.}
insilmaril@28
   398
insilmaril@28
   399
The option \lq{\bf Use for export} \rq controls the output of exports
insilmaril@28
   400
e.g. to HTML: If set to no, the image won't appear in the {\em text}
insilmaril@28
   401
part of the output. This is useful for large images or if images are
insilmaril@28
   402
used as a kind of frame e.g. the famous cloud symbol around a part of
insilmaril@28
   403
the map. Those shouldn't appear in the middle of the text.
insilmaril@28
   404
insilmaril@28
   405
At the moment image support is preliminary: Images will be saved
insilmaril@28
   406
together with all the other data of a map in the {\tt .vym}-file.
insilmaril@28
   407
Later versions will include more functionality like resizing the images,
insilmaril@28
   408
changing its z-value (put it into background) etc.
insilmaril@28
   409
insilmaril@28
   410
\subsubsection*{Frames}
insilmaril@28
   411
A frame can be added to a branch by clicking with the
insilmaril@28
   412
right-mouse button.  A context menu will open, where you can choose the
insilmaril@28
   413
frame. At the moment just a rectangle resp. "No Frame" will be offered,
insilmaril@28
   414
nevertheless you can use images as frames. Have a look at the demo map
insilmaril@28
   415
{\tt todo.vym} as an example, where the mapcenter is a cloud. You can
insilmaril@28
   416
use an external drawing program like {\tt gimp} to create an image,
insilmaril@28
   417
preferable with an transparency channel, so that you can design frames
insilmaril@28
   418
which don't use a rectangular borderline, just like the cloud.
insilmaril@28
   419
insilmaril@28
   420
insilmaril@28
   421
\subsection{Background design}
insilmaril@28
   422
The design of the background of a map and also of the links connecting
insilmaril@28
   423
various parts of the map can be changed by
insilmaril@28
   424
\begin{itemize}
insilmaril@28
   425
	\item Selecting Format from the menu
insilmaril@28
   426
	\item Right clicking onto the canvas, which will open a context menu
insilmaril@28
   427
\end{itemize}
insilmaril@28
   428
insilmaril@28
   429
\subsubsection*{Background color}
insilmaril@28
   430
The color is set (and also displayed) as "Set background color".
insilmaril@28
   431
insilmaril@28
   432
\subsubsection*{Link color}
insilmaril@28
   433
Links connecting branches can be colored in one of the following ways:
insilmaril@28
   434
\begin{itemize}
insilmaril@28
   435
	\item use the color of the heading of the branch the links is
insilmaril@28
   436
	\item use {\em one} color for all links. The default color is blue.
insilmaril@28
   437
	leading to.
insilmaril@28
   438
\end{itemize}
insilmaril@28
   439
The latter can be set with "Set link color". Check or uncheck the "Use
insilmaril@28
   440
color of heading for link" option to choose one of the two designs for
insilmaril@28
   441
your map.
insilmaril@28
   442
insilmaril@28
   443
\subsubsection*{Link style}
insilmaril@28
   444
\vym offers four different styles for the appearences of links:
insilmaril@28
   445
\begin{itemize}
insilmaril@28
   446
	\item Line
insilmaril@28
   447
	\item Parabel
insilmaril@28
   448
	\item Thick Line
insilmaril@28
   449
	\item Thick Parabel
insilmaril@28
   450
\end{itemize}
insilmaril@28
   451
The "thick" styles only draw links starting at mapcenter thick, the rest
insilmaril@28
   452
of the map is always painted "thin".
insilmaril@28
   453
insilmaril@28
   454
insilmaril@28
   455
\subsection{Link to other documents}
insilmaril@28
   456
Presently \vym supports two kind of links:
insilmaril@28
   457
\begin{itemize}
insilmaril@28
   458
	\item Document, which will be opened in an external webbrowser
insilmaril@28
   459
	\item \vym map, which will be opened in \vym itself
insilmaril@28
   460
\end{itemize}
insilmaril@28
   461
insilmaril@28
   462
\subsubsection*{Webbrowser}
insilmaril@28
   463
Modern Webbrowsers like {\tt konqueror} are able to display various
insilmaril@28
   464
types of files, both local or in the internet. To enter the URL of
insilmaril@28
   465
any document, right-click  onto a branch or use the Edit Menu
insilmaril@28
   466
and choose "Edit URL". Enter the path to your document (or copy and
insilmaril@28
   467
paste it from your browser). Examples for valid paths are:
insilmaril@28
   468
\begin{verbatim}
insilmaril@28
   469
	http://www.insilmaril.de/vym/index.html
insilmaril@28
   470
	file:/usr/share/doc/packages/vym/doc/vym.pdf
insilmaril@28
   471
\end{verbatim}
insilmaril@28
   472
If an URL was entered, a little globe will appear in the branch. By
insilmaril@28
   473
clicking on the globe in the toolbar or the context menu an external
insilmaril@28
   474
browser\footnote{
insilmaril@28
   475
	The browser can be changed in the Settings Menu.}
insilmaril@28
   476
will be started.
insilmaril@28
   477
\begin{center}
insilmaril@28
   478
	\includegraphics[width=0.5cm]{flag-url.png}
insilmaril@28
   479
\end{center}
insilmaril@127
   480
If you want to keep bookmarks in a map, select a branch where you want
insilmaril@128
   481
to add the bookmark, then simply drag the URL from your browser to the
insilmaril@127
   482
map. Also you could use an existing heading as URL: Right click onto the
insilmaril@127
   483
branch and select "Use heading for URL".
insilmaril@28
   484
insilmaril@28
   485
\subsubsection*{\vym map}
insilmaril@28
   486
To link to to another map right click on a branch or choose "Edit \ra
insilmaril@28
   487
Enter \vym link". A file dialog opens where you can choose the map. A
insilmaril@28
   488
branch with a link is marked with 
insilmaril@28
   489
\begin{center}
insilmaril@28
   490
	\includegraphics[width=0.5cm]{flag-vymlink.png}
insilmaril@28
   491
\end{center}
insilmaril@28
   492
Clicking this flag in the toolbar or in the context menu of a branch
insilmaril@28
   493
will open the map in another tab (see \ref{tabs} for working with
insilmaril@28
   494
multiple maps). To delete an existing link, just press the "Cancel"
insilmaril@28
   495
button.
insilmaril@28
   496
insilmaril@28
   497
Technical note: Internally \vym uses absolute paths, to avoid opening
insilmaril@28
   498
several tabs containing the same map. When a map is saved, this path is
insilmaril@28
   499
converted to a relative one (e.g. {\tt /home/user/vym.map} might become
insilmaril@28
   500
{\tt ./vym.map}. This makes it fairly easy to use multiple maps on
insilmaril@28
   501
different computers or export them to HTML in future.
insilmaril@28
   502
insilmaril@28
   503
\subsection{Multiple maps} \label{tabs}
insilmaril@28
   504
You can work on multiple maps at the same time. Each new map is opened
insilmaril@28
   505
in another {\em tab}. The available tabs are shown just above the
insilmaril@28
   506
mapeditor. You can use the normal cut/copy/paste functions to
insilmaril@28
   507
copy data from one map to another.
insilmaril@28
   508
insilmaril@28
   509
%todo
insilmaril@28
   510
insilmaril@28
   511
%TODO
insilmaril@28
   512
%\subsubsection{Menus}
insilmaril@28
   513
%\subsubsection{Keyboard shortcuts}
insilmaril@28
   514
insilmaril@28
   515
% Settings
insilmaril@28
   516
% Images
insilmaril@28
   517
% Copy & Paste
insilmaril@28
   518
% Working with tabs (multiple maps)
insilmaril@28
   519
% Exporting
insilmaril@28
   520
% Scrolling
insilmaril@28
   521
insilmaril@28
   522
\section{Noteeditor} \label {noteeditor}
insilmaril@28
   523
If you want to save more text in a branch e.g. a complete email, a
insilmaril@28
   524
cooking recipe, or the whole source code of a software project, you can
insilmaril@125
   525
use the noteeditor. 
insilmaril@233
   526
\begin{center}
insilmaril@233
   527
	\includegraphics[width=8cm]{noteeditor.png}
insilmaril@233
   528
\end{center}
insilmaril@233
   529
This editor displays text associated to a branch selected in the
insilmaril@233
   530
mapeditor. To visualize that there maybe is no text yet, the noteeditor
insilmaril@233
   531
shows different background colors depending on its state:
insilmaril@28
   532
insilmaril@125
   533
\subsection{States}
insilmaril@28
   534
Before you can type or paste text into it, you have
insilmaril@28
   535
to select a branch in the mapeditor. Note that the background color
insilmaril@28
   536
of the noteeditor indicates its state:
insilmaril@28
   537
\begin{itemize}
insilmaril@28
   538
	\item black: no branch selected
insilmaril@28
   539
	\item grey: no text entered yet
insilmaril@28
   540
	\item white: text is already available
insilmaril@28
   541
\end{itemize}	
insilmaril@28
   542
To show you in the mapeditor itself that there is a note with more
insilmaril@28
   543
information for a particular branch, a little note flag will appear next
insilmaril@28
   544
to the heading of the branch. See the lower branch on the right side:
insilmaril@28
   545
\begin{center}
insilmaril@28
   546
	\includegraphics[width=8cm]{branches-flags.png}
insilmaril@28
   547
\end{center}
insilmaril@28
   548
insilmaril@125
   549
\subsection{Import and export notes}
insilmaril@28
   550
The note is always saved automatically within the \vym file itself.
insilmaril@28
   551
Nevertheless sometimes it is nice to import a note from an external file
insilmaril@28
   552
or write it. Use "File\ra~Import" and "File\ra~Export" to do so. 
insilmaril@28
   553
insilmaril@125
   554
\subsection{Edit and print note}
insilmaril@28
   555
Editing works like in any simple texteditor, including undo and redo
insilmaril@28
   556
functions. You can delete the complete note by clicking the
insilmaril@28
   557
trashcan. Only the note itself is printed by clicking the printer icon.
insilmaril@28
   558
insilmaril@28
   559
When pasting into the editor using the X11 copy\&paste mechanism, the
insilmaril@28
   560
editor will create a paragraph for each new line. Usually this is not
insilmaril@28
   561
wanted, so there you can convert all paragraphs into linebreaks by using
insilmaril@28
   562
Edit~\ra~Remove~Paragraphs or \key{ALT-X}.
insilmaril@28
   563
insilmaril@233
   564
\subsection{RichText: Colors, paragraphs and formatted text}
insilmaril@233
   565
\vym supports formatted text (QT Rich Text) in the noteeditor since
insilmaril@233
   566
version 1.4.7.  Colors and text attributes (e.g. italic, bold) can be
insilmaril@233
   567
set with the buttons above the text.  The text itself is divided in
insilmaril@233
   568
paragraphs. For each paragraph the format can be set (e.g. centered,
insilmaril@233
   569
right). A paragraph is ended when a \key{Return} is entered. If you just
insilmaril@233
   570
want to begin a new line, press \key{CTRL-Return}.
insilmaril@233
   571
insilmaril@233
   572
\subsection{Fonts and how to quickly switch them}
insilmaril@28
   573
The noteeditor is ment to be used for simple notes, not really as full
insilmaril@28
   574
featured text editor. Because of many requests \vym supports now
insilmaril@28
   575
formatted text in the noteeditor\footnote{
insilmaril@28
   576
	\vym uses the QRichtText format, which is basically a subset of the
insilmaril@28
   577
	formatting provided in HTML.}
insilmaril@28
   578
Two default fonts are supported which can be set in the Settings menu.
insilmaril@28
   579
One is a fixed width font, the other has variable width. The fixed font
insilmaril@28
   580
is usually used for emails, source code etc.\ while the variable font is
insilmaril@28
   581
used for simple notes, where one doesn't need fixed character widths.
insilmaril@28
   582
Both fonts can easily switched using the following symbol from the
insilmaril@28
   583
toolbar:
insilmaril@28
   584
\begin{center}
insilmaril@28
   585
	\includegraphics[width=0.5cm]{formatfixedfont.png}
insilmaril@28
   586
\end{center}
insilmaril@28
   587
In the Settings menu both fonts can be set and also which font should be
insilmaril@28
   588
used for default. 
insilmaril@28
   589
insilmaril@28
   590
Additionally to the default fonts any font installed on your system can
insilmaril@28
   591
be used. Please note, that the chosen font also will be used for HTML
insilmaril@28
   592
exports, so you should only use fonts which are available generally.
insilmaril@28
   593
insilmaril@217
   594
\subsection{Find text}
insilmaril@28
   595
The noteeditor itself has no Find function, use Find in the mapeditor,
insilmaril@28
   596
which will also search all notes (see \ref{findwindow}).
insilmaril@28
   597
insilmaril@217
   598
\subsection{Paste text into note editor}
insilmaril@28
   599
Often you will paste text into the editor from another application e.g.
insilmaril@28
   600
an email. Normally \vym will generate a new paragraph for each new line.
insilmaril@28
   601
This usually is not what you want, so you can choose from the menu
insilmaril@28
   602
insilmaril@125
   603
\subsection{Advanced actions}
insilmaril@217
   604
\subsubsection*{Edit \ra Convert subsubsections:}
insilmaril@125
   605
This turns subsubsections in selected text (or all text, if nothing is
insilmaril@28
   606
selected) into linebreaks. This is especially useful for snippets of
insilmaril@28
   607
source code.
insilmaril@28
   608
insilmaril@217
   609
\subsubsection*{Edit \ra Join Lines:}
insilmaril@28
   610
Tries to format text, so that empty lines are used to delimit
insilmaril@28
   611
paragraphs. This is done for selected text (or all text, if nothing is
insilmaril@28
   612
selected). Especially useful for text like emails, meeting minutes etc.
insilmaril@28
   613
insilmaril@28
   614
\section{Hello world}
insilmaril@233
   615
This section is about how \vym can interact with other applications.
insilmaril@233
   616
Many applications meanwhile can read and write their data using XML, the
insilmaril@233
   617
eXtensible Markup Language. \vym also uses XML to save its maps, see
insilmaril@233
   618
\ref{fileformat} for a more detailed description. 
insilmaril@233
   619
insilmaril@233
   620
So if your an application understands XML, chances are good that someone
insilmaril@233
   621
could write import/export filters for \vym. Volunteers are always
insilmaril@233
   622
welcome ;-)
insilmaril@233
   623
insilmaril@233
   624
\subsection{Import} 
insilmaril@233
   625
insilmaril@233
   626
\subsubsection*{KDE Bookmarks}
insilmaril@233
   627
The integrated bookmark editor in KDE is somewhat limited, so why not
insilmaril@233
   628
use \vym to maintain the bookmark mess? To create a new map containing
insilmaril@233
   629
your current KDE bookmarks just choose
insilmaril@233
   630
\begin{itemize}
insilmaril@233
   631
	\item File \ra Import\ra KDE Bookmarks
insilmaril@233
   632
\end{itemize}
insilmaril@233
   633
insilmaril@233
   634
\subsubsection*{Mind Manager}
insilmaril@233
   635
\vym has currently a very basic import filter to convert maps created by
insilmaril@233
   636
{\em Mind Manager}\footnote{Mind Manager is a professional software by
insilmaril@233
   637
Mindjet. Both names are registered trademarks by Mindjet. For more
insilmaril@233
   638
information see their website at
insilmaril@233
   639
\href{http://mindjet.de}{http://mindjet.de}} into \vym maps. Notes and
insilmaril@233
   640
pictures are not converted at the moment. You can import files with
insilmaril@233
   641
\begin{itemize}
insilmaril@233
   642
	\item File \ra Import\ra Mind Manager
insilmaril@233
   643
\end{itemize}
insilmaril@233
   644
insilmaril@233
   645
insilmaril@233
   646
\subsubsection*{Directory structure}
insilmaril@233
   647
\vym can read a directory structure. This is mainly for
insilmaril@233
   648
testing \vym e.g. to easily create huge maps used for benchmarks (yes,
insilmaril@233
   649
there is still room to optimize \vym ;-)
insilmaril@28
   650
insilmaril@28
   651
\subsection{Export}
insilmaril@233
   652
\vym supports various formats to help other applications.
insilmaril@233
   653
insilmaril@233
   654
\subsubsection*{Open Office}
insilmaril@233
   655
Open Office beginning with version~2 uses the so called "Open Office
insilmaril@233
   656
Document Format", which can be written by \vym. The options are
insilmaril@233
   657
currently limited, but it possible to export presentations which can be
insilmaril@233
   658
opened in Open Office Impress. By selecting
insilmaril@28
   659
\begin{itemize}
insilmaril@233
   660
	\item File \ra Export\ra Open Office
insilmaril@28
   661
\end{itemize}
insilmaril@233
   662
you get a file dialogue where you can choose the output file and the
insilmaril@233
   663
file type:
insilmaril@233
   664
\begin{center}
insilmaril@233
   665
	\includegraphics[width=12cm]{export-oo.png}
insilmaril@233
   666
\end{center}
insilmaril@233
   667
The file types represent various templates, which can be created with
insilmaril@233
   668
some manual work from an existing Open Office document. The structure of
insilmaril@233
   669
\vym map is then inserted into a template. 
insilmaril@233
   670
There are some limitations at the moment:
insilmaril@233
   671
\begin{itemize}
insilmaril@233
   672
	\item \vym can't take care of page lengths, so you have to check and
insilmaril@233
   673
	probably reedit in Open Office to avoid text running over the end of
insilmaril@233
   674
	a page
insilmaril@233
   675
	\item Images and flags are not used at the moment
insilmaril@233
   676
	\item Notes are just written as plain text, without RichText
insilmaril@233
   677
\end{itemize}
insilmaril@233
   678
Some of the templates make use of {\em sections} e.g. insert the
insilmaril@233
   679
headings of mainbranches as chapters for sections into the presentation.
insilmaril@28
   680
insilmaril@28
   681
\subsubsection*{Image}
insilmaril@28
   682
\vym supports all image formats which are natively supported by the
insilmaril@28
   683
QT~toolkit:
insilmaril@28
   684
BMP, JPEG, PBM, PGM, PNG, PPN, XPM, and XBM.
insilmaril@28
   685
For use in websites and for sending images by email PNG is a good
insilmaril@28
   686
recommodation regarding quality and size of the image. \vym uses QTs
insilmaril@28
   687
default options for compressing the images.
insilmaril@28
   688
insilmaril@28
   689
\subsubsection*{ASCII}
insilmaril@28
   690
Exporting an image as text is somewhat experimental at the moment. Later
insilmaril@28
   691
this will probably done using stylesheets. So the output may change in
insilmaril@28
   692
future versions of \vym.
insilmaril@28
   693
insilmaril@233
   694
\subsubsection*{\LaTeX}
insilmaril@233
   695
\vym can generate an input file for \LaTeX. Currently this is considered
insilmaril@233
   696
as experimental, there are no options (yet). 
insilmaril@233
   697
By selecting
insilmaril@233
   698
\begin{itemize}
insilmaril@233
   699
	\item File \ra Export\ra \LaTeX 
insilmaril@233
   700
\end{itemize}
insilmaril@233
   701
you will be asked in a file dialog for the name of the output file. This
insilmaril@233
   702
file should be included in a \LaTeX document using command  
insilmaril@233
   703
\begin{verbatim}
insilmaril@233
   704
	\include{inputfile.tex}
insilmaril@233
   705
\end{verbatim}
insilmaril@233
   706
insilmaril@233
   707
\subsubsection*{XHTML (Webpages)}
insilmaril@233
   708
insilmaril@233
   709
This is the format you want to use to create a webpage. For an example
insilmaril@233
   710
have a look at the \vym homepage: 
insilmaril@233
   711
\href{http://www.InSilmaril.de/vym}{www.InSilmaril.de/vym}
insilmaril@233
   712
insilmaril@233
   713
Some explanation how this works: 
insilmaril@233
   714
Before a map is exported as XHTML, it will be first written as XML into a
insilmaril@28
   715
directory (see \ref{xmlexport}). Then the external program {\tt
insilmaril@28
   716
xsltproc}\footnote{On SUSE Linux {\tt xsltproc} is installed by
insilmaril@28
   717
default.}
insilmaril@28
   718
will be called to process the XML file and generate HTML code.
insilmaril@28
   719
A dialog allows to set various options:
insilmaril@28
   720
\begin{itemize}
insilmaril@28
   721
	\item {\bf Include image:} If set, \vym will creat an image map at
insilmaril@28
   722
	the top of the HTML output. Clicking on a branch in the map will
insilmaril@28
   723
	jump to the corresponding section in the output.
insilmaril@28
   724
insilmaril@28
   725
	\item {\bf Colored headings:}
insilmaril@28
   726
	If set to yes, \vym will color the headings in the text part  with the
insilmaril@28
   727
	same colors like in the map.
insilmaril@28
   728
	\item {\bf Show Warnings:}
insilmaril@28
   729
	If set to yes, \vym will ask before overwriting data.
insilmaril@28
   730
	\item {\bf Show output:}
insilmaril@28
   731
	This is useful mainly for debugging. It will show how the processing of
insilmaril@28
   732
	the XML file works by calling the external {\tt xsltproc}.
insilmaril@28
   733
\end{itemize}
insilmaril@28
   734
Additionally the paths to the CSS and XSL stylesheets can be set. By
insilmaril@28
   735
default on SUSE~Linux they will be in {\tt /usr/share/vym/styles}.
insilmaril@28
   736
insilmaril@28
   737
insilmaril@28
   738
\subsubsection*{XML} \label{xmlexport}
insilmaril@28
   739
The map is written into a directory both as an image and as XML. The
insilmaril@28
   740
directory is set in a file dialog. If the directory is not empty, you
insilmaril@28
   741
will be questioned if you risk to overwrite its contents.
insilmaril@28
   742
insilmaril@28
   743
It is possible to export different maps into the same directory. Each
insilmaril@28
   744
file generated will have the map's name as prefix, e.g. {\tt todo.vym}
insilmaril@28
   745
becomes {\tt todo.xml}, {\tt todo.png}, {\tt todo-image-1.png} and so
insilmaril@28
   746
on. This is useful if e.g. for a website several combined maps have to
insilmaril@28
   747
be stored in the same directory.
insilmaril@28
   748
insilmaril@105
   749
\subsubsection*{Export a part of a map}
insilmaril@128
   750
Select a branch you want to export together with its childs, then open
insilmaril@105
   751
the context menu and choose {\em Save Selection}. This will create a
insilmaril@105
   752
file with the postfix {\tt .vyp}, which is an abbreviation for \lq vym
insilmaril@105
   753
part\rq.
insilmaril@105
   754
insilmaril@125
   755
insilmaril@125
   756
\section{Advanced Editing}
insilmaril@125
   757
\vym offers a few shortcuts to let you work more quickly and literally
insilmaril@125
   758
to connect any branches directly.  
insilmaril@125
   759
\subsection{Modifier Modes} 
insilmaril@125
   760
Modifiers are for example the \key{Shift}- or the \key{Alt}-keys. When
insilmaril@125
   761
pressed while doing actions with the mouse, they will cause \vym to use
insilmaril@125
   762
a "modified" action. E.g. you can move branches with mouse. If
insilmaril@125
   763
\key{Ctrl} or \key{Alt}is pressed while releasing the branch, it will be
insilmaril@125
   764
added above/below the target, not as child of the target.
insilmaril@125
   765
insilmaril@125
   766
Without a modifier pressed, the first click on a branch just selects
insilmaril@125
   767
it. For the behaviour of the \key{Ctrl} modifier there are several
insilmaril@125
   768
options, which can be set from the modifier toolbar:
insilmaril@125
   769
\begin{center}
insilmaril@125
   770
	\includegraphics[width=3cm]{modmodes.png}
insilmaril@125
   771
\end{center}
insilmaril@125
   772
The default  is to copy the color from the clicked branch to the already
insilmaril@125
   773
selected branch. In the toolbar shown above the default modifier is
insilmaril@125
   774
selected, namely to copy the color of a branch. The second modifier
insilmaril@125
   775
let's you easily copy a whole branch with a single click. The third
insilmaril@125
   776
modifier lets you create {\em xLinks}, which will be explained in the
insilmaril@125
   777
next section.
insilmaril@125
   778
insilmaril@125
   779
\subsection{XLinks}
insilmaril@125
   780
So far all the data in the \vym map has been treelike. Using xLinks you
insilmaril@125
   781
can link one branch to any other, just like attaching a rope between two
insilmaril@125
   782
branches in a real tree. This is especially useful in complex maps,
insilmaril@125
   783
where you want to have crossreferences which don't fit on the same
insilmaril@125
   784
visible area, which fits on your screen. The following example, which is
insilmaril@125
   785
part of the \vym package, still fits on one screen, but shows how data
insilmaril@125
   786
can be crosslinked. In the graphics there is a link from a task (prepare
insilmaril@125
   787
a presentation) to general information:
insilmaril@125
   788
\begin{center}
insilmaril@125
   789
	\includegraphics[width=12cm]{xlink.png}
insilmaril@125
   790
\end{center}
insilmaril@125
   791
Note that a xLink which points to a branch that is not visible (because
insilmaril@125
   792
it is scrolled), is just show as a little horizontal arrow. In the
insilmaril@125
   793
screenshot above have a look at the \lq Tuesday\rq\ branch.
insilmaril@125
   794
insilmaril@233
   795
\subsubsection*{Create a xLink}
insilmaril@125
   796
Choose the link mode from the modifier toolbar (by clicking or pressing
insilmaril@125
   797
\key{L}). Select the branch, where the xLink should start. Press the
insilmaril@125
   798
modifier key \key{Ctr} and simultanously click on the branch where the
insilmaril@125
   799
link should end. (The link is already drawn before you release the mouse
insilmaril@125
   800
key). If you release the mouse over a branch the xLink becomes
insilmaril@125
   801
permanent.
insilmaril@125
   802
insilmaril@233
   803
\subsubsection*{Modify or delete a xLink}
insilmaril@125
   804
Open the context menu of a branch and select \lq Edit xLink\rq. A
insilmaril@125
   805
submenu contains all the xLinks of the branch (if there are any). They
insilmaril@125
   806
are named like the branches, where they end. Choose one and
insilmaril@125
   807
the xLink dialogue opens, where you can set color, width and also delete
insilmaril@125
   808
the xLink.
insilmaril@125
   809
insilmaril@233
   810
\subsubsection*{Follow a xLink}
insilmaril@125
   811
In a complext \vym map it sometimes comes handy to jump to the other end
insilmaril@125
   812
of a xLink. You can do this by opening the context menu of the branch
insilmaril@125
   813
and clicking on \lq Goto xLink\rq and selecting the xLink you want to
insilmaril@125
   814
follow.
insilmaril@125
   815
insilmaril@125
   816
insilmaril@125
   817
insilmaril@233
   818
\subsection{Adding and removing branches}
insilmaril@125
   819
The context menu of a branch shows some more ways to add and delete data
insilmaril@125
   820
e.g. you can delete a branch while keeping its childs. The childs become
insilmaril@125
   821
linked to the parent of the previously removed branch.
insilmaril@125
   822
Similar branches can be inserted into existing maps. For keyboard
insilmaril@125
   823
shortcuts also have a look at the context menu.
insilmaril@28
   824
insilmaril@233
   825
\subsection{Adding a whole map or a part of a map}
insilmaril@233
   826
Select a branch where you want to add a previously saved map ({\tt .vym})or a part
insilmaril@233
   827
of a map ({\tt .vyp}) , then open
insilmaril@233
   828
the context menu and choose {\em Add \ra Import}. For the import you can
insilmaril@233
   829
choose between {\em Import Add} and {\em Import Replace}: The imported
insilmaril@233
   830
data will be added after the selection resp. replace the selection.
insilmaril@233
   831
insilmaril@105
   832
insilmaril@105
   833
\section{\vym on Mac OS X}
insilmaril@105
   834
\subsection{Overview}
insilmaril@105
   835
Basically there are two ways to run \vym on Macs:
insilmaril@233
   836
\subsubsection*{QT Mac Edition:}
insilmaril@105
   837
	\vym here provides the well known Mac look and feel.  \vym is
insilmaril@105
   838
	available as zipped Mac OS X application. It has been compiled and
insilmaril@105
   839
	tested in Mac~OS~10.3, but should also work on Tiger. It is using
insilmaril@105
   840
	the Mac version of Trolltechs QT library.  
insilmaril@233
   841
\subsubsection*{X11}
insilmaril@105
   842
	\vym can also be run using the Linux version, but then menus and
insilmaril@105
   843
	handling will also be those of the Linux version e.g. The menu bar
insilmaril@105
   844
	will look different. 
insilmaril@105
   845
insilmaril@125
   846
\subsection	{Contextmenu and special keys}
insilmaril@125
   847
Most Macs unfortunatly just have a single mouse button. In order to show
insilmaril@125
   848
the context menu which usually would be opened with the right mouse
insilmaril@125
   849
button, you can click while pressing the \key{kommand}-key.
insilmaril@125
   850
insilmaril@125
   851
Especially on Laptops some of the keys usually used on PC keyboards seem
insilmaril@125
   852
to be missing. The QT-Mac Edition of \vym has its own keyboard
insilmaril@125
   853
shortcuts. To find the shortcuts just have a look at all the menu
insilmaril@125
   854
entries, the shortcut is visible next to an entry. Toolbar buttons also
insilmaril@125
   855
may have shortcuts, just position the mouse pointer over a button and
insilmaril@125
   856
wait for the little help window to appear. 
insilmaril@125
   857
insilmaril@125
   858
\subsection {Viewing external links}
insilmaril@125
   859
\vym on Mac uses the system call {\tt /usr/bin/open} to view links.
insilmaril@125
   860
Mac~OS determines automatically if the link is a pdf or www page and
insilmaril@125
   861
opens the right browser.
insilmaril@125
   862
insilmaril@233
   863
insilmaril@233
   864
\begin{appendix}
insilmaril@233
   865
insilmaril@233
   866
\section{Contributing to \vym}
insilmaril@233
   867
insilmaril@233
   868
\subsection{Getting help}
insilmaril@233
   869
insilmaril@233
   870
\subsubsection*{Frequently asked questions}
insilmaril@233
   871
Please refer to the FAQ available on the \vym website:
insilmaril@125
   872
\begin{center}
insilmaril@125
   873
\href{http://www.InSilmaril.de/vym/faq.html}{http://www.InSilmaril.de/vym/faq.html}
insilmaril@125
   874
\end{center}
insilmaril@105
   875
insilmaril@233
   876
\subsubsection*{Mailinglists}
insilmaril@233
   877
There are two mailinglists: {\tt vym-forum} is the \vym users forum to
insilmaril@233
   878
discuss various questions, while {\tt vym-devel} is intended for people
insilmaril@233
   879
interested in contributing to \vym. You can view the archives and
insilmaril@233
   880
subscribe at
insilmaril@233
   881
\begin{center}
insilmaril@233
   882
\href{https://sourceforge.net/mail/?group_id=127802}{https://sourceforge.net/mail/?group\_id=127802}
insilmaril@233
   883
\end{center}
insilmaril@233
   884
insilmaril@233
   885
\subsubsection*{Contacting the author}
insilmaril@233
   886
Especially for support questions please try the mailinglists first. If
insilmaril@233
   887
everything else fails you can contact the Uwe Drechsel at
insilmaril@233
   888
\begin{center}
insilmaril@233
   889
\href{mailto:vym@InSilmaril.de}{vym@Insilmaril.de}
insilmaril@233
   890
\end{center}
insilmaril@233
   891
insilmaril@233
   892
insilmaril@233
   893
\subsection{Compiling from the sources}
insilmaril@233
   894
\subsubsection*{Get the sources}
insilmaril@233
   895
insilmaril@233
   896
\subsubsection*{The Qt toolkit}
insilmaril@233
   897
Qt is C++ toolkit for multiplatform GUI and application development. It
insilmaril@233
   898
provides single-source portability across MS~Windows, Mac~OS~X, Linux
insilmaril@233
   899
ans all major commercial Unix variants. Qt is also available for
insilmaril@233
   900
embedded devices. Qt is a Trolltech product. See 
insilmaril@233
   901
\href{http://www.trolltech.com/qt/}{www.trolltech.com/qt} 
insilmaril@233
   902
for more information
insilmaril@233
   903
insilmaril@233
   904
insilmaril@233
   905
\subsubsection*{Compiling \vym }
insilmaril@233
   906
Make sure you have installed your Qt environment properly, see the Qt
insilmaril@233
   907
documentation for details. You need to have the Qt command {\tt qmake}
insilmaril@233
   908
in your {\tt PATH}-environment, then run
insilmaril@233
   909
\begin{verbatim}
insilmaril@233
   910
qmake
insilmaril@233
   911
make  
insilmaril@233
   912
make install
insilmaril@233
   913
\end{verbatim}
insilmaril@233
   914
The last command {\tt make install} needs root-permissions. Of course it
insilmaril@233
   915
may be omitted, if you just want to test \vym.
insilmaril@233
   916
insilmaril@233
   917
\subsubsection*{Compiling \vym on Macs}
insilmaril@233
   918
insilmaril@233
   919
\subsection{\vym file format} \label{fileformat}
insilmaril@233
   920
\vym maps usually have the postfix "{\tt .vym}" and represent a
insilmaril@233
   921
compressed archive of data. If you want to have a
insilmaril@233
   922
closer look into the data structure map called "mapname.vym", 
insilmaril@233
   923
just uncompress the map manually using
insilmaril@233
   924
\begin{verbatim}
insilmaril@233
   925
	unzip mapname.vym
insilmaril@233
   926
\end{verbatim}
insilmaril@233
   927
This will create directories named {\tt images} and {\tt flags} in your
insilmaril@233
   928
current directory and also the map itself, usually named {\tt
insilmaril@233
   929
mapname.xml}.
insilmaril@233
   930
The XML structure of \vym is pretty self explaining, just have a look at
insilmaril@233
   931
{\tt mapname.xml}.
insilmaril@233
   932
insilmaril@233
   933
This XML file can be loaded directly into \vym, it does not have to be
insilmaril@233
   934
compressed. If you want to compress all the data yourself, use
insilmaril@233
   935
\begin{verbatim}
insilmaril@233
   936
	zip -r mapname.vym .
insilmaril@233
   937
\end{verbatim}
insilmaril@233
   938
to compress all data in your current directory.
insilmaril@233
   939
insilmaril@233
   940
\subsection{New features}
insilmaril@28
   941
There are lots of features which might find their way into \vym.
insilmaril@233
   942
Together with \vym you should have received a directory with several
insilmaril@28
   943
maps e.g. on SUSE~LINUX this is
insilmaril@28
   944
\begin{center}
insilmaril@28
   945
	{\tt /usr/share/doc/packages/vym/demos}
insilmaril@28
   946
\end{center}
insilmaril@28
   947
where you find the map {\tt todo.vym}. It lists quite a lot of things to
insilmaril@233
   948
be done in future. If you have more ideas, contact the development team
insilmaril@233
   949
at
insilmaril@233
   950
{\tt vym-devel@lists.sourceforge.net}.
insilmaril@28
   951
insilmaril@28
   952
insilmaril@233
   953
\subsection{New languages support}
insilmaril@233
   954
\subsection{New export/import filters}
insilmaril@233
   955
insilmaril@233
   956
\end{appendix}
insilmaril@233
   957
\end{document}
insilmaril@28
   958
insilmaril@125
   959
%TODO
insilmaril@125
   960
%\subsubsection{Menus}
insilmaril@125
   961
%\subsubsection{Keyboard shortcuts}
insilmaril@125
   962
%Where does vym save its settings? -> ~/.qt/vymrc
insilmaril@125
   963
insilmaril@28
   964
insilmaril@28
   965
% INDEX
insilmaril@28
   966
% mapeditor
insilmaril@28
   967
% noteditor
insilmaril@28
   968
% branch
insilmaril@28
   969
% mapcenter
insilmaril@28
   970
% heading
insilmaril@28
   971
% flag
insilmaril@28
   972
% orientation 
insilmaril@28
   973
% zoom
insilmaril@28
   974
% orientation
insilmaril@28
   975
% Toolbar
insilmaril@28
   976
% Zoom
insilmaril@28
   977
% Find
insilmaril@28
   978
% statusbar
insilmaril@28
   979
% link
insilmaril@28
   980
% mainbranch
insilmaril@28
   981
% subtree
insilmaril@28
   982
% reorder
insilmaril@28
   983
% scroll
insilmaril@28
   984
% fold
insilmaril@104
   985
% vymlink
insilmaril@104
   986
% xlink
insilmaril@125
   987
% modMode
insilmaril@104
   988
% context menu
insilmaril@104
   989
% Mac OS X
insilmaril@28
   990
insilmaril@28
   991
insilmaril@28
   992
insilmaril@125
   993
\end{document}