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