tex/vym.tex
author insilmaril
Fri, 08 Jul 2005 08:06:36 +0000
changeset 124 e0f6a21cc6d6
parent 106 4083860dd82e
child 125 8cdfa8dda71e
permissions -rw-r--r--
corrected vym.tex
     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{VYM \\ -- \\View Your Mind}
    35 \author{\textcopyright Uwe Drechsel  }
    36 
    37 \maketitle
    38 
    39 \tableofcontents
    40 
    41 \newpage
    42 
    43 \section{Introduction}
    44 \subsection{What is a \vym map?}
    45 A \vym map (in short words {\em map}) is a tree like structure:
    46 \begin{center}
    47 	\includegraphics[width=12cm]{example1.png}
    48 \end{center}
    49 Such maps can be drawn by hand on paper or a flip chart and help to
    50 structure your thoughs. While a tree like structure like above can be
    51 drawn by hand or any drawing software \vym offers
    52 much more features to work with such maps. \vym is not another drawing
    53 software, but a tool to store and modify information in an intuitive
    54 way. For example you can reorder parts of the map by pressing a key or
    55 add various information like a complete email by a simple mouse click.
    56 
    57 \subsection{Why should I use maps? Time, Space and your Brain.}
    58 \subsubsection*{Space}
    59 A map can concentrate a very complex content on little space e.g. a
    60 piece of paper. It helps to use both sides of your brain: the logical
    61 side and also your creative side (e.g. by using pictures, colors and
    62 keywords in a map, so called {\em anchors}).  It is a technique to
    63 organize the way you think: It can help you by developing, sorting and
    64 memorizing your thoughts. 
    65 
    66 \subsubsection*{Time}
    67 Because you just use keywords and drawings, it is much faster than good
    68 old fashioned notes. Your brain memorizes things by associating them to
    69 other things -- a map makes use of those connections and stimulates
    70 new asccociations. 
    71 
    72 \subsubsection*{Your Brain}
    73 In 1960 the Prof. {\sc Roger Sperry} discovered that both hemispheres
    74 of the human brain have different tasks (of course both of them
    75 basically {\em can} do the same): The left side is specialised in 
    76 \begin{itemize}
    77    \item verbal speech and writing 
    78    \item numbers
    79    \item logical thinking
    80    \item analyzing and details
    81    \item science
    82    \item linear thinking
    83    \item concept of time
    84 \end{itemize}
    85 while the right side of the human brain is specialised in
    86 \begin{itemize}
    87     \item body language
    88     \item visual thinking, day dreams
    89     \item intuition and emotion
    90     \item overview of things
    91     \item creativity
    92     \item art, music, dancing
    93     \item non-linear thinking, connecting things
    94     \item spatial awareness
    95 \end{itemize}    
    96 In our science oriented society we have learned to mainly rely on our
    97 left side of the brain, the "rational" one. In other cultures,
    98 especially like the native americans and other "old" cultures, the right
    99 side is much more important. maps are just one way to stimulate the
   100 other side and make use of additional ressources we all have.
   101 
   102 
   103 \subsection{Where could I use a map?}
   104 Here are some examples, how you can use those maps
   105 \begin{itemize}
   106     \item to prepare articles, papers, books, talks, \ldots
   107     \item to sort complex data
   108     \item to memorize facts, persons, vocabulary, \ldots
   109     \item to sort emails, files and bookmarks on your computer
   110     \item to moderate conferences
   111 \end{itemize}
   112 
   113 \subsection{What you shouldn't do with a map...}
   114 A map drawn by somebody shows the way the author thinks. There is
   115 no right or wrong in the way it is drawn, so there is no way to critize
   116 it. "It is, what it is" ({\sc F.~Lehmann}).
   117 
   118 %\section{Tutorials}
   119 %TODO
   120 
   121 \section{Concept}
   122 
   123 %TODO may add a general introduction here...
   124 
   125 \vym uses two windows: an editor for the map itself and another one for
   126 notes, which are part of the map. Let's call them {\em mapeditor} and
   127 {\em noteeditor}: 
   128 \begin{center}
   129 	\includegraphics[width=8cm]{windows.png}
   130 \end{center}
   131 Usually you will work in the {\em mapeditor} by just adding new
   132 branches, moving around and reordering them. The various ways to do this
   133 will be explained in \ref{mapeditor}. You can store additional
   134 information e.g. the content of a email easily in a {\em branch}: Just
   135 type or copy\&paste it into the {\em noteeditor}. Working with notes is
   136 explained in \ref{noteeditor}
   137 
   138 The map itself has always a {\em mapcenter}.  The
   139 mapcenter has {\em branches} just like the trunk of a tree. Each branch
   140 in turn may have branches again.
   141 \begin{center}
   142 	\includegraphics[width=10cm]{branches.png}
   143 \end{center}
   144 We will call a branch directly connected to the mapcenter a {\em
   145 mainbranch}, because it determines the position of all its child
   146 branches.
   147 
   148 The mapcenter and the branches all have a {\em heading}. This is the
   149 text you see in the mapeditor. Usually it should just be one or a few
   150 words, so that one can easily keep track of the whole map.
   151 
   152 
   153 In the toolbar above the mapeditor you see various symbols.
   154 \begin{center}
   155 	\includegraphics[width=8cm]{default-flags.png}
   156 \end{center}
   157 These are called {\em flags} and can be used to mark branches in the
   158 map, e.g. if something is important or questionable. 
   159 There are also more flags set by \vym automatically to show additional
   160 information, e.g. when a  exists for a  particular branch.
   161 
   162 By default some of these flags are set exclusively e.g. when the \lq
   163 thumb-up\rq flag is set, then the \lq thumb down\rq is unset and vice
   164 versa. You can change this default behaviour in the settings menu.
   165 
   166 \section{Mapeditor} \label {mapeditor}
   167 \subsection{Start a new map}
   168 After \vym is started two windows will open: the mapeditor and the
   169 noteditor. Usually you will work in both windows, but at the moment we
   170 will just need the mapeditor. 
   171 
   172 Select the mapcenter "New map" in the middle of the mapeditor by
   173 left-clicking with the mouse. It will turn yellow to show that is
   174 selected. There are several ways to add a new branch to the center:
   175 \begin{itemize}
   176 	\item Using the mouse: Open the context meny by clicking with the
   177 	right mouse button (CTRL-Click on Mac) onto the
   178 	mapcenter and choose Add \ra Add as child
   179 	\item Press \key{Ins} or \key{A}
   180 \end{itemize}
   181 A new branch will appear and you will be able to type the heading of the
   182 branch. Finish adding the new branch by pressing \key{Enter}.
   183 %tipp
   184 Sometimes it comes handy to add a new branch above or below the current
   185 one. Use \key{Ins} together with \key{Shift} or \key{Ctrl}. It is also
   186 possible to add a branch in such a way, that the current selection
   187 becomes the child of the new branch, which is like inserting it {\em
   188 before} the selection. This can be done using the context menu.
   189 
   190 \subsection{Navigate through a map}
   191 \subsubsection*{Select branches}
   192 To select branches you can use the left button of your mouse or also the
   193 arrow keys. Depending on the {\em orientation} of a branch type
   194 \key{\la} or \key{\ra} to get nearer to the mapcenter or deeper
   195 down into the branches. Within a set of branches, let's call them a 
   196 {\em subtree}, you can use \key{\ua} and \key{\da} to go up and down. You can
   197 also use \key{Pos1} and \key{End} to select the first and last branch.
   198 
   199 
   200 \subsubsection*{Zoom a map}
   201 While adding more and more branches the size of the map may become
   202 bigger than the mapeditor window. You can use the scrollbars on the
   203 right and the bottom of your mapeditor window to scroll, but it is
   204 easier to just scroll using the left mouse button: Click onto the {\em
   205 canvas} itself, the empty space somewhere between the branches. The
   206 mouse pointer will change from an arrow to a hand, now move the visible
   207 part of the map to show the desired part.
   208 
   209 If you select branches using the arrow keys, the map will scroll
   210 to ensure that the selected branch is always visible.
   211 
   212 Working with huge maps, the {\em zoom}-function comes in handy: You can
   213 use 
   214 \begin{itemize}
   215 	\item from the menu View \ra Zoom
   216 	\item the toolbar buttons 
   217 		\begin{center}
   218 			\includegraphics[width=3cm]{zoom-buttons.png}
   219 		\end{center}	
   220 \end{itemize}	
   221 The crossed magnifying lens resets the zoomed view to its original size.
   222 
   223 
   224 \subsubsection*{Find Function} \label{findwindow}
   225 With huge maps there is the need to have a
   226 find function. Choose Edit \ra Find to open the Find Window:
   227 \begin{center}
   228 	\includegraphics[width=6cm]{find-window.png}
   229 \end{center}	
   230 The text you enter here will be searched in all the headings and also in
   231 notes. Everytime you press the "Find"-button it will look for the next
   232 occurence, which then will be selected automatically. If the search
   233 fails, there will appear a short message "Nothing found" or a few
   234 seconds in the {\em statusbar} on the bottom of the mapeditor.
   235 
   236 \subsubsection*{Scroll a part of the map}
   237 A very big subtree of a map e.g. a branch with hundreds of childs makes
   238 it very hard to keep an overview over the whole map. You can hide all
   239 the childs of a branch by {\em scrolling} it -- this function is also
   240 often called {\em folding}. Think of the whole subtree as painted onto a
   241 big newspaper. You can scroll the paper to a small roll, leaving just
   242 the headline readable.
   243 
   244 To scroll or unscroll a branch and its childs, press the
   245 \begin{itemize}
   246 	\item \key{Scroll} key or  \key{S}
   247 	\item press the middle-mouse button or
   248 	\item choose the little scroll from the toolbar.
   249 \end{itemize}
   250 If you select parts of a scrolled branch e.g. using the find function or
   251 by using the arrow-keys, it will unscroll temporary. This is shown as a
   252 scroll with a little hour glass. If the temporary unscrolled part is not
   253 longer needed, it will be hidden again automatically. It is also
   254 possible to unscroll all branches using "Edit\ra Unscroll all scrolled
   255 branches".
   256 
   257 
   258 
   259 \subsection{Modify and move branches}
   260 \subsubsection*{Modify the heading of a branch}
   261 You can edit the heading by selecting the branch and then
   262 \begin{itemize}
   263 	\item pressing \key{Enter}
   264 	\item double-clicking with left mouse.
   265 \end{itemize}
   266 Just type the new heading (or edit the old one) and press \key{Enter}.
   267 
   268 \subsubsection*{Move a branch}
   269 The easiest way to move a branch is to select it with left-mouse and
   270 drag it to the destination while keeping the mouse button pressed.
   271 Depending on the branch  it will be
   272 \begin{itemize}
   273 	\item moved to the destination or
   274 	\item {\em linked} to a new {\em parent} (mapcenter or branch)
   275 \end{itemize}
   276 If you drag the branch over another one or over the mapcenter, you will
   277 notice that the  link connecting it to the old parent will be changed to
   278 lead to the  new parent which is now under your mousepointer. 
   279 If you release the button now, the branch will be relinked.
   280 
   281 If you release the button in the middle of nowhere, the result will
   282 depend on the type of branch you are releasing:
   283 \begin{itemize}
   284 	\item A mainbranch is directly connected to the mapcenter.
   285 		It will stay on its new position.
   286 	\item An ordinary branch will "jump" back to its original position.	
   287 \end{itemize}
   288 Thus you can easily rearrange the layout of the mainbranches to avoid
   289 overlapping of their subtrees.
   290 There is another convenient way to move branches, especially if you want
   291 to {\em reorder} a subtree: You can move a branch up or down in a
   292 subtree by
   293 \begin{itemize}
   294 	\item pressing \key{\ua} and \key {\da}
   295 	\item selecting Edit \ra Move branch
   296 	\item clicking on the toolbar buttons:
   297 		\begin{center}
   298 			\includegraphics[width=1.5cm]{move-buttons.png}
   299 		\end{center}	
   300 \end{itemize}
   301 %tipp
   302 There is yet another way to move branches: If you press \key{Shift} or
   303 \key{Ctrl} while moving with the mouse, the branch will be added above
   304 or below the one the mouse pointer is over. This helps also to reorder a
   305 map.
   306 
   307 \subsection{The right side of your brain - colors and images}
   308 \subsubsection*{Change color of a heading}
   309 You can also use colors to put more information into a map, e.g. use
   310 red, green and more colors to prioritize tasks. Again you can
   311 \begin{itemize}
   312 	\item use the menu and choose e.g Format \rq Set Color
   313 	\item use the toolbar
   314 		\begin{center}
   315 			\includegraphics[width=3cm]{color-buttons.png}
   316 		\end{center}	
   317 \end{itemize}
   318 The first button (black in the graphic above) shows the actual color.
   319 Clicking on it let's you choose another color. You can also "pick"
   320 another color by selecting a branch with the desired color and using the
   321 "pick color" button. Both of the buttons showing a bucket actually put
   322 the current color to the selected branch. While the first one just
   323 colors the heading of the selection, the last one also colors all the
   324 childs of the selected branch.
   325 
   326 %tipp
   327 A very useful function is the "copy color" using the mouse: Select the
   328 branch which should get the new color, then press \key{Ctrl} and
   329 simultanously click with left-mouse on another branch to copy its color
   330 to the first one. Here the childs of the selection also will get the new
   331 color, if you just want to color the selection itself, additionally
   332 press \key{Shift}.
   333 
   334 \subsubsection*{Use flags}
   335 \vym provides various flags. You see them in the toolbar on top of the
   336 mapeditor window. (Note: Like all toolbars you can also move them to the
   337 left or the right side of the window or even detach them. Just grab the
   338 very left "dotted" part of the toolbar with your left-mouse button.) 
   339 \begin{center}
   340 	\includegraphics[width=8cm]{default-flags.png}
   341 \end{center}
   342 If you have a branch selected, you can set any number of flags by
   343 clicking them in the toolbar. The toolbar buttons change their state and
   344 always reflect the flags set in the selected branch.
   345 
   346 Presently \vym uses two kinds of flags: {\em System Flags} and {\em
   347 Standard Flags}. The standard flags are those shown in the toolbar.
   348 System flags are set by \vym to indicate e.g. that there is additional
   349 information in a note (more on this in \ref{noteeditor}). Later versions
   350 of \vym may have another kind of flags, which may be edited by the user.
   351 
   352 \subsubsection*{Images}
   353 You can add a image to a branch or the mapcenter by clicking with the
   354 right-mouse button. A context menu will open, choose "Add Image". A
   355 dialog window lets you choose the image to load. 
   356 \footnote{Supported image types are: PNG, BMP, XBM, XPM and PNM. It may
   357 	also support JPEG, MNG and GIF, if specially configured during
   358 	compilation (as done when \vym is part of SUSE LINUX).}
   359 While an image is selected in the dialog, you can see a preview of the
   360 image.	
   361 
   362 You can position the image anywhere you want, just drag it with left
   363 mouse. To relink it to another branch, press \key{Shift} while moving
   364 it. To delete it, press \key{Del}. 
   365 
   366 If you right-click onto an image, a context menu will open which let's
   367 you first choose one of several image formats. Then a file dialog opens
   368 to save the image. Hint: This is used to "export" the image, it will be
   369 saved anyway in the map itself! You can also cut and
   370 copy images, but it is not possible to add objects to an image\footnote{
   371 	Images are regarded as "extra feature". It would make working with
   372 	the map much more complex if e.g. images could be linked to images.}
   373 
   374 The option \lq{\bf Use for export} \rq controls the output of exports
   375 e.g. to HTML: If set to no, the image won't appear in the {\em text}
   376 part of the output. This is useful for large images or if images are
   377 used as a kind of frame e.g. the famous cloud symbol around a part of
   378 the map. Those shouldn't appear in the middle of the text.
   379 
   380 At the moment image support is preliminary: Images will be saved
   381 together with all the other data of a map in the {\tt .vym}-file.
   382 Later versions will include more functionality like resizing the images,
   383 changing its z-value (put it into background) etc.
   384 
   385 \subsubsection*{Frames}
   386 A frame can be added to a branch by clicking with the
   387 right-mouse button.  A context menu will open, where you can choose the
   388 frame. At the moment just a rectangle resp. "No Frame" will be offered,
   389 nevertheless you can use images as frames. Have a look at the demo map
   390 {\tt todo.vym} as an example, where the mapcenter is a cloud. You can
   391 use an external drawing program like {\tt gimp} to create an image,
   392 preferable with an transparency channel, so that you can design frames
   393 which don't use a rectangular borderline, just like the cloud.
   394 
   395 
   396 \subsection{Background design}
   397 The design of the background of a map and also of the links connecting
   398 various parts of the map can be changed by
   399 \begin{itemize}
   400 	\item Selecting Format from the menu
   401 	\item Right clicking onto the canvas, which will open a context menu
   402 \end{itemize}
   403 
   404 \subsubsection*{Background color}
   405 The color is set (and also displayed) as "Set background color".
   406 
   407 \subsubsection*{Link color}
   408 Links connecting branches can be colored in one of the following ways:
   409 \begin{itemize}
   410 	\item use the color of the heading of the branch the links is
   411 	\item use {\em one} color for all links. The default color is blue.
   412 	leading to.
   413 \end{itemize}
   414 The latter can be set with "Set link color". Check or uncheck the "Use
   415 color of heading for link" option to choose one of the two designs for
   416 your map.
   417 
   418 \subsubsection*{Link style}
   419 \vym offers four different styles for the appearences of links:
   420 \begin{itemize}
   421 	\item Line
   422 	\item Parabel
   423 	\item Thick Line
   424 	\item Thick Parabel
   425 \end{itemize}
   426 The "thick" styles only draw links starting at mapcenter thick, the rest
   427 of the map is always painted "thin".
   428 
   429 
   430 \subsection{Link to other documents}
   431 Presently \vym supports two kind of links:
   432 \begin{itemize}
   433 	\item Document, which will be opened in an external webbrowser
   434 	\item \vym map, which will be opened in \vym itself
   435 \end{itemize}
   436 
   437 \subsubsection*{Webbrowser}
   438 Modern Webbrowsers like {\tt konqueror} are able to display various
   439 types of files, both local or in the internet. To enter the URL of
   440 any document, right-click  onto a branch or use the Edit Menu
   441 and choose "Edit URL". Enter the path to your document (or copy and
   442 paste it from your browser). Examples for valid paths are:
   443 \begin{verbatim}
   444 	http://www.insilmaril.de/vym/index.html
   445 	file:/usr/share/doc/packages/vym/doc/vym.pdf
   446 \end{verbatim}
   447 If an URL was entered, a little globe will appear in the branch. By
   448 clicking on the globe in the toolbar or the context menu an external
   449 browser\footnote{
   450 	The browser can be changed in the Settings Menu.}
   451 will be started.
   452 \begin{center}
   453 	\includegraphics[width=0.5cm]{flag-url.png}
   454 \end{center}
   455 If you want to keep bookmarks in a map, you may want to copy the heading
   456 as URL: Right click onto the branch and select "Use heading for URL".
   457 
   458 \subsubsection*{\vym map}
   459 To link to to another map right click on a branch or choose "Edit \ra
   460 Enter \vym link". A file dialog opens where you can choose the map. A
   461 branch with a link is marked with 
   462 \begin{center}
   463 	\includegraphics[width=0.5cm]{flag-vymlink.png}
   464 \end{center}
   465 Clicking this flag in the toolbar or in the context menu of a branch
   466 will open the map in another tab (see \ref{tabs} for working with
   467 multiple maps). To delete an existing link, just press the "Cancel"
   468 button.
   469 
   470 Technical note: Internally \vym uses absolute paths, to avoid opening
   471 several tabs containing the same map. When a map is saved, this path is
   472 converted to a relative one (e.g. {\tt /home/user/vym.map} might become
   473 {\tt ./vym.map}. This makes it fairly easy to use multiple maps on
   474 different computers or export them to HTML in future.
   475 
   476 \subsection{Multiple maps} \label{tabs}
   477 You can work on multiple maps at the same time. Each new map is opened
   478 in another {\em tab}. The available tabs are shown just above the
   479 mapeditor. You can use the normal cut/copy/paste functions to
   480 copy data from one map to another.
   481 
   482 %todo
   483 
   484 %TODO
   485 %\subsubsection{Menus}
   486 %\subsubsection{Keyboard shortcuts}
   487 
   488 % Settings
   489 % Images
   490 % Copy & Paste
   491 % Working with tabs (multiple maps)
   492 % Exporting
   493 % Scrolling
   494 
   495 \section{Noteeditor} \label {noteeditor}
   496 If you want to save more text in a branch e.g. a complete email, a
   497 cooking recipe, or the whole source code of a software project, you can
   498 use the noteeditor. Since version 1.4.7 \vym supports formatted text in
   499 the noteeditor.
   500 
   501 \subsubsection*{States}
   502 Before you can type or paste text into it, you have
   503 to select a branch in the mapeditor. Note that the background color
   504 of the noteeditor indicates its state:
   505 \begin{itemize}
   506 	\item black: no branch selected
   507 	\item grey: no text entered yet
   508 	\item white: text is already available
   509 \end{itemize}	
   510 To show you in the mapeditor itself that there is a note with more
   511 information for a particular branch, a little note flag will appear next
   512 to the heading of the branch. See the lower branch on the right side:
   513 \begin{center}
   514 	\includegraphics[width=8cm]{branches-flags.png}
   515 \end{center}
   516 
   517 \subsubsection*{Import and export notes}
   518 The note is always saved automatically within the \vym file itself.
   519 Nevertheless sometimes it is nice to import a note from an external file
   520 or write it. Use "File\ra~Import" and "File\ra~Export" to do so. 
   521 
   522 \subsubsection*{Edit and print note}
   523 Editing works like in any simple texteditor, including undo and redo
   524 functions. You can delete the complete note by clicking the
   525 trashcan. Only the note itself is printed by clicking the printer icon.
   526 
   527 When pasting into the editor using the X11 copy\&paste mechanism, the
   528 editor will create a paragraph for each new line. Usually this is not
   529 wanted, so there you can convert all paragraphs into linebreaks by using
   530 Edit~\ra~Remove~Paragraphs or \key{ALT-X}.
   531 
   532 \subsubsection*{Fonts}
   533 The noteeditor is ment to be used for simple notes, not really as full
   534 featured text editor. Because of many requests \vym supports now
   535 formatted text in the noteeditor\footnote{
   536 	\vym uses the QRichtText format, which is basically a subset of the
   537 	formatting provided in HTML.}
   538 Two default fonts are supported which can be set in the Settings menu.
   539 One is a fixed width font, the other has variable width. The fixed font
   540 is usually used for emails, source code etc.\ while the variable font is
   541 used for simple notes, where one doesn't need fixed character widths.
   542 Both fonts can easily switched using the following symbol from the
   543 toolbar:
   544 \begin{center}
   545 	\includegraphics[width=0.5cm]{formatfixedfont.png}
   546 \end{center}
   547 In the Settings menu both fonts can be set and also which font should be
   548 used for default. 
   549 
   550 Additionally to the default fonts any font installed on your system can
   551 be used. Please note, that the chosen font also will be used for HTML
   552 exports, so you should only use fonts which are available generally.
   553 
   554 \subsubsection*{Colors and formatted text}
   555 Colors and text attributes (e.g. italic, bold) can 
   556 be set with the buttons above the text. 
   557 The text itself is divided in paragraphs. For each paragraph the format
   558 can be set (e.g. centered, right). A paragraph is ended when a
   559 \key{Return} is entered. If you just want to begin a new line, press
   560 \key{CTRL-Return}.
   561 
   562 \subsubsection*{Finding text}
   563 The noteeditor itself has no Find function, use Find in the mapeditor,
   564 which will also search all notes (see \ref{findwindow}).
   565 
   566 \subsubsection*{Pasting text into note editor}
   567 Often you will paste text into the editor from another application e.g.
   568 an email. Normally \vym will generate a new paragraph for each new line.
   569 This usually is not what you want, so you can choose from the menu
   570 
   571 \paragraph{Edit \ra Convert Paragraphs:}
   572 This turns paragraphs in selected text (or all text, if nothing is
   573 selected) into linebreaks. This is especially useful for snippets of
   574 source code.
   575 
   576 \paragraph{Edit \ra Join Lines:}
   577 Tries to format text, so that empty lines are used to delimit
   578 paragraphs. This is done for selected text (or all text, if nothing is
   579 selected). Especially useful for text like emails, meeting minutes etc.
   580 
   581 \section{Hello world}
   582 \vym can export its maps in various formats and can import data from
   583 outside (though import is still limited at the moment).
   584 Also parts of a map can be exported.
   585 
   586 \subsection{Export}
   587 The format in which the map will be exported can be chosen with
   588 \begin{itemize}
   589 	\item File \ra Export \ra {\em format}
   590 \end{itemize}
   591 \vym offers both HTML and ASCII export.
   592 
   593 \subsubsection*{Image}
   594 \vym supports all image formats which are natively supported by the
   595 QT~toolkit:
   596 BMP, JPEG, PBM, PGM, PNG, PPN, XPM, and XBM.
   597 For use in websites and for sending images by email PNG is a good
   598 recommodation regarding quality and size of the image. \vym uses QTs
   599 default options for compressing the images.
   600 
   601 \subsubsection*{ASCII}
   602 Exporting an image as text is somewhat experimental at the moment. Later
   603 this will probably done using stylesheets. So the output may change in
   604 future versions of \vym.
   605 
   606 \subsubsection*{HTML}
   607 Before a map is exported as HTML, it will be first written as XML into a
   608 directory (see \ref{xmlexport}). Then the external program {\tt
   609 xsltproc}\footnote{On SUSE Linux {\tt xsltproc} is installed by
   610 default.}
   611 will be called to process the XML file and generate HTML code.
   612 %A script then will transform the XML
   613 %version. 
   614 A dialog allows to set various options:
   615 \begin{itemize}
   616 	\item {\bf Include image:} If set, \vym will creat an image map at
   617 	the top of the HTML output. Clicking on a branch in the map will
   618 	jump to the corresponding section in the output.
   619 
   620 	\item {\bf Colored headings:}
   621 	If set to yes, \vym will color the headings in the text part  with the
   622 	same colors like in the map.
   623 	\item {\bf Show Warnings:}
   624 	If set to yes, \vym will ask before overwriting data.
   625 	\item {\bf Show output:}
   626 	This is useful mainly for debugging. It will show how the processing of
   627 	the XML file works by calling the external {\tt xsltproc}.
   628 \end{itemize}
   629 Additionally the paths to the CSS and XSL stylesheets can be set. By
   630 default on SUSE~Linux they will be in {\tt /usr/share/vym/styles}.
   631 
   632 %\paragraph{WIKI style:} This is very useful for easy design of webpages.
   633 %Here is a short overview:
   634 %\begin{verbatim}
   635 %Lines:
   636 %	+ Big headlines start with the '+' character.
   637 %	- Small headlines start with the '-' character.
   638 %	  Normal text doesn't have any starting notation.
   639 %	! Notes start with an exclamation.
   640 %	. Indented text starts with a dot.
   641 %	? Questions start with a question-mark, and
   642 %	= Answers starts with the equal-sign.
   643 %	* Points for a item-list
   644 %	# clues
   645 %	
   646 %Links:
   647 %	use '{...}' or '{(vym homepage) http://www.insilmaril.de/vym/}'
   648 %	for external links.
   649 %	
   650 %Markup:
   651 %	|This is bold| text, while 
   652 %	|/this text is italic|, 
   653 %	|*this is pre-formatted|, and 
   654 %	|!this is a note|
   655 %\end{verbatim}
   656 %
   657 %\paragraph{Show output:} This is used for debugging. \vym uses an
   658 %the external script {\tt vym2html.sh} to preprocess the XML-data. Then
   659 %\vym calls {\tt xsltproc} to generate the HTML page by using various
   660 %{\tt .xsl} stylesheets and {\tt wireframe.css}. If you run into problems
   661 %here, changing paths in {\tt $\sim$/.qt/vymrc} might help.
   662 
   663 \subsubsection*{XML} \label{xmlexport}
   664 The map is written into a directory both as an image and as XML. The
   665 directory is set in a file dialog. If the directory is not empty, you
   666 will be questioned if you risk to overwrite its contents.
   667 
   668 It is possible to export different maps into the same directory. Each
   669 file generated will have the map's name as prefix, e.g. {\tt todo.vym}
   670 becomes {\tt todo.xml}, {\tt todo.png}, {\tt todo-image-1.png} and so
   671 on. This is useful if e.g. for a website several combined maps have to
   672 be stored in the same directory.
   673 
   674 \subsubsection*{Export a part of a map}
   675 Select a branch you want to export together with its childs, than open
   676 the context menu and choose {\em Save Selection}. This will create a
   677 file with the postfix {\tt .vyp}, which is an abbreviation for \lq vym
   678 part\rq.
   679 
   680 \subsection{Import} 
   681 At the moment \vym can read a directory structure. This is mainly for
   682 testing \vym e.g. to easily create huge maps used for benchmarks (yes,
   683 there is still room to optimize \vym ;-)
   684 
   685 Many other applications meanwhile can export their data using XML, so
   686 volunteers to write import filters are welcome.
   687 
   688 Also parts of a vym map ({\tt .vyp}) can be imported.
   689 
   690 \subsection{File format}
   691 \vym maps usually have the postfix "{\tt .vym}" and represent a
   692 compressed archive of data. If you want to have a
   693 closer look into the data structure, just uncompress the map manually
   694 using
   695 \begin{verbatim}
   696 	unzip vymfile.vym
   697 \end{verbatim}
   698 A directory named {\tt vymfile} will be created containing further
   699 directories both for {\tt images} and {\tt flags}. In the {\tt vymfile}
   700 directory you will find the map itself, usually named {\tt vymfile.xml}.
   701 
   702 This file can be loaded directly into \vym, it does not have to be
   703 compressed. If you want to compress all the data yourself, use
   704 \begin{verbatim}
   705 	cd vymfile
   706 	zip -r vymfile.vym .
   707 \end{verbatim}
   708 
   709 \subsubsection*{Importa part of a map}
   710 Select a branch where you want to add a previously save part of a map
   711 ({\tt .vyp}), then open
   712 the context menu and choose {\em Add \ra Import}. For the import you can
   713 choose between {\em Import Add} and {\em Import Replace}: The imported
   714 data will be added after the selection resp. replace the selection.
   715 
   716 %TODO
   717 %\subsubsection{Menus}
   718 %\subsubsection{Keyboard shortcuts}
   719 %Where does vym save its settings? -> ~/.qt/vymrc
   720 
   721 
   722 \section{\vym on Mac OS X}
   723 \subsection{Overview}
   724 Basically there are two ways to run \vym on Macs:
   725 \subsubsection{QT Mac Edition:}
   726 	\vym here provides the well known Mac look and feel.  \vym is
   727 	available as zipped Mac OS X application. It has been compiled and
   728 	tested in Mac~OS~10.3, but should also work on Tiger. It is using
   729 	the Mac version of Trolltechs QT library.  
   730 \subsubsection{X11}
   731 	\vym can also be run using the Linux version, but then menus and
   732 	handling will also be those of the Linux version e.g. The menu bar
   733 	will look different. 
   734 
   735 %TODO  Concept on Mac   context menu, shortcuts...
   736 
   737 \section{History of \vym}
   738 \subsection{Future}
   739 There are lots of features which might find their way into \vym.
   740 Together with \vym you should have received a directory with example
   741 maps e.g. on SUSE~LINUX this is
   742 \begin{center}
   743 	{\tt /usr/share/doc/packages/vym/demos}
   744 \end{center}
   745 where you find the map {\tt todo.vym}. It lists quite a lot of things to
   746 be done in future. If you have more ideas, contact the author at
   747 {\tt vym@insilmaril.de}.
   748 
   749 \subsection{Past}
   750 \input{vym.changelog}
   751 \begin{center}
   752 \begin{longtable}{|lcp{8cm}l|} \hline
   753 Version	&	&	Comment								& Date	\\ \hline \hline \endhead
   754 	\hline \endfoot
   755 1.6.8	& - &	Dramatic speedup in some operations 
   756 				(e.g. move branch up/down) due to extended 
   757 				undo engine							& 2005-06-07 \\ 
   758 1.6.7	& - &	Changed default pdf-reader for Mac OSX & 2005-05-27 \\ 
   759 		& - &	Bugfix: xLinks stopped working in 1.6.6			&\\
   760 		& - &	Bugfix: drawing error when using modModeCopy    &\\
   761 		& - &	Bugfix: replaced lrint by qRound for BSD ports	&\\
   762 1.6.6	& -	&	Exclusive standard flags			& 2005-05-23 \\
   763 1.6.5	& -	&	removing a branch and keeping its childs	& 2005-05-19 \\
   764         & -	&	removing childs of a branch			& \\
   765         & -	&	insert branch and make selection its child& \\
   766         & -	&	restructured branch context menu	
   767 				in a basic version (straight line)	& 2005-04-15\\
   768         & -	&	New shortcuts  for use on Mac OS X	& \\
   769         & -	&	Importing directories generates vymlinks now & \\
   770         & -	&	Bugfix: Changing linkstyle now automatically redraws all
   771 				links again& \\
   772         & -	&	Bugfix: Paste icon is disabled if clipboard is empty &\\
   773 1.6.4	& -	&	xLinks (arbitrary connection between 2 branches) works
   774 				in a basic version (straight line)	& 2005-04-15\\
   775 1.6.3	& -	&	Bugfix: Saving of selection to a vym part (.vyp)	&2005-03-30\\
   776 		& - &	Bugfix: Closing the noteeditor by closing its window now
   777 				also toggles the responding toolbar button. &\\
   778 1.6.2	& -	&	Introduced Modifier modes: color, link, copy &2005-03-24\\
   779       & -	&	Linking branches is basically possible, though it can't
   780 				be edited/saved yet &\\
   781 1.6.1	& -	&	Optimized moving of branches: much faster especially 
   782 				with huge subtrees					&2005-01-30\\
   783 		& -	&	Bugfix: Segfault when loading vym part &\\
   784 		& -	&	Bugfix: ugly unitialized lines, when 
   785 				temporary drawn link was moved from a 
   786 				temporary parent back to canvas		& \\ 
   787 1.6.0 	& -	&	Added saving of xhtml settings in map& 2004-12-14 \\ 
   788 1.5.2 	& -	&	Added Import of maps with two modes: 
   789 				add/replace							& 2004-12-13 \\ 
   790 		& - &	Added export of part of maps		& \\
   791 		& - &	Added joining of paragraphs in text editor		& \\
   792 		& - &	Optimized undo: Only relevant parts are saved, which
   793 				dramatically improves e.g. moving branches up/down 
   794 				in most maps & \\
   795 		& -	&	Bugfix: QTextEdit generates invalid XML code, which
   796 				could lead to a parse error, if font name contains a \& &  \\ 
   797 		& -	&	Bugfix: Wrong order of mainbranches in Export	&  \\ 
   798 		& -	&	Bugfix: zip archive was not deleted before save, which
   799 				could lead to much bigger files, e.g. 
   800 				when working on older \vym maps or deleted images&  \\ 
   801 		& -	&	Bugfix: Printing in Texteditor      &  \\ 
   802 		& -	&	Bugfix: Wrong URLs in xhtml output				&  \\
   803       	& -	&	Bugfix: Segfault fixed at Cursor left/right in empty map&  \\
   804 1.5.1 	& -	&	More options in xhtml export: external scripts 	& 2004-10-01 \\
   805 1.5.0 	& -	&	Public release of all changes since 1.4.1      	& 2004-09-26 \\
   806       	& -	&	New function to replace paragraphs in note editor
   807 				by linebreaks, this makes pasted text much nicer& \\
   808       	& -	&	New option to toggle exporting of of floatimages& \\
   809       	& -	&	z-plane of floatimages can be set (manually only)& \\
   810 		& - &	Bugfix: Wrong ordering of branches, if mainbranch is
   811 				exactly left of center& \\
   812 1.4.7 	& -	&	New Export to XHTML by Thomas Schraitle.	& 2004-09-24 \\
   813 		& - &	Bugfix: vymLink&	\\
   814 		& - &	Bugfix: spaces and dots in filenames	& \\
   815 		& - &	Bugfix: Error message if xsltproc is not installed& \\
   816 1.4.6 	& -	&	New file format: notes are saved as part of the .xml file
   817 			& 2004-09-15	\\
   818 		& - &	Note Editor supports Rich Text now.&\\
   819 		& - &	Parser now also nows {\tt standardflag} (all letters
   820 				lowercase)&\\
   821 1.4.5 	& -	&	Correct handling of font size in Heading			& 2004-08-23	\\
   822 1.4.4 	& -	&	Selecting with cursor now works between subtrees	& 2004-07-29	\\
   823 		& - &	Bugfix: vymLink was set to temporary dir in 1.4.3	& \\
   824 		& - &	Bugfix: & \\
   825 1.4.3 	& -	&	Optimisation: Reduced canvas objects by only
   826 				creating objects for used flags		& 2004-07-19 \\ 
   827 		& - &	Better visualization of moving branch above/below target&\\		
   828 		& - &	Find Window informs with dialog, if the search failed&\\
   829 		& - &	System Flags are clickable now		&\\
   830 		& - &	Reworked CSS and XST stylsheets (comments, indent, browser
   831 				compatibility)						&\\
   832 		& - &	vymLinks are shown in statusbar		&\\
   833 		& - &	current directory is save			&\\
   834 		& - &	Rewritten load/save to improve multimap handling and
   835 				unzipped files&\\
   836 		& - &	Bugfix: vymLinks don't get deleted 
   837 				when Cancel is pressed				&\\		
   838       	& -	&	Bugfix: Fixed a bunch of bugs in XSL for HTML export&            \\ 
   839       	& -	&	Bugfix: More toolbar buttons disabled, if action not
   840 				possible&            \\ 
   841 		& - &	Bugfix: Renaming .vymfile now works&\\		
   842 		& - &	Bugfix: mapChanged set when toggling flags&\\		
   843 		& - &	Bugfix: CTRL-N was used twice		&\\
   844 		& - &	Bugfix: Del didn't work on floatimage &\\
   845 1.4.2 	& -	&	Bugfix: Float image could not be deleted& \\ 
   846 1.4.1 	& -	&	Bugfix: Color of branch not saved	& 2004-05-25 \\ 
   847       	& -	&	Bugfix: wrong path at HTML export	&            \\ 
   848 		& -	&	Bugfix: map is not save with special characters in path&  \\ 
   849 1.4.0 	& -	&	Ask for confirmation before opening 
   850 				a map in multiple editors			& 2004-05-17 \\
   851 		& - &	Save state of note editor (visible/minimized)& \\
   852 		& - &	Export to HTML						& \\
   853 		& - &	Author and Comment is saved in map	& \\
   854 		& - &	Stats are shown in Edit MapInfo		& \\
   855 		& - &	Changes for OS X port (QCursor, QContextMenuEvent)	& \\
   856 		& - &	Bugfix: Fonts from note editor are save now			&\\
   857 		& - &	Bugfix: invisible image when parent is scrolled		&\\
   858 		& - &	Bugfix: Segfault pressing "enter" for floatimage	&\\
   859 		& - &	Bugfix: Images can't be outside of exported area
   860 				anymore.& \\
   861 		& - &	Bugfix: Filenames with blanks		& \\
   862 		& - &	Bugfix: Old maplink is shown when editing maplink& \\
   863 		& - &	Bugfix: always show cursor while editing heading & \\
   864 1.3.5 	& -	&	Export map to dir					& 2004-04-16 \\
   865 		& - &	Export to any of QTs image formats	& \\
   866 		& - &	Also right side of selection is always visible now.& \\
   867 1.3.4 	& -	&	Load last maps in file menu         & 2004-04-07 \\
   868 		& - &	save last image path for loading	& \\
   869 		& - &	Also export standard flags to dir.	& \\
   870 1.3.3 	& -	&	Enabled <br> in headings as manual linebreak	& 2004-03-26 \\
   871 		& -	&	Heading can be copied to URL		&\\
   872 		& -	&	Bugfix: GIFs are automatically converted to PNG now&\\
   873 1.3.2 	& -	&	Add and move branches above/below selection, Texteditor copy all,& 2004-03-26 \\
   874 1.3.1 	& -	&	Export to directory, changed naming in .vym& 2004-03-25 \\
   875 1.3.0 	& -	&	Bugfix: Check if map can be saved at all& 2004-03-23 \\
   876 1.2.12	& -	&	Select image format before saving image	& 2004-03-22 \\
   877 1.2.11	& -	&	Selecting mainbranches by up/down	& 2004-03-18 \\
   878 		& -	&	Export ASCII (experimental)			&			\\
   879 		& -	&	Each map can be saved individually at quit	&	\\
   880 		& -	&	Bugfix: Opening VymLink crashes QT	&			\\
   881 		& -	&	Bugfix: 50\% less objects on canvas	&			\\
   882 		& -	&	Bugfix: Ignoring LANG, now always written as UTF8&\\
   883 1.2.10	& -	&	Sort Mainbranches by angle to y-axis& 2004-03-16 \\
   884 		& -	&	Import directory structure			&			\\
   885 		& - &	Fix: Set FrameType of MapCenter while loading map &\\
   886 1.2.9	& -	&	Jump to another vym map		        & 2004-03-12 \\
   887      	& -	&	Mainbranches are alwas ordered clockwise   &     \\
   888 1.2.8	& -	&	Change frame types in context menu  & 2004-03-03 \\
   889 1.2.7	& -	&	Copy / Paste and save Floatimages & 2004-02-25 \\
   890 1.2.6	& -	&	Closing vym in KDE now asks for save, too	& 2004-02-24 \\
   891 		& -	&	Context menu for branches					&  \\
   892 		& -	&	Selection is saved in .vym file				&  \\
   893 1.2.5	& -	&	URLs to external links can be added & 2004-02-18 \\
   894 		& - &	All actions are deactived if not possible & \\
   895 1.2.4	& -	&	Images: Can be loaded, saved, relinked to other parents
   896 & 2004-02-16 \\
   897 1.2.3	& -	&	Zoom: Reset and finer steps shrinking/enlarging	& 2004-01-27 \\
   898 1.2.2	& -	&	Editing of links (style and color)	& 2004-01-27 \\
   899 1.2.1	& -	&	Bugfix: LineEdit when adding branch has correct position
   900 				again.								& 2004-01-27 \\
   901 1.2.0	& -	&	Scrolled parts are automatically unscrolled when
   902 				selected and scrolled again later.				& 2004-01-23 \\
   903 		& - &	Bugfix: Save flag is updated when multiple maps are opened& \\
   904 		& - &	Bugfix: Moving of branches is faster and more accurat
   905 				when adding to mapcenter& \\
   906 1.1.7	& -	&	Bugfix: Remember filename of note in noteeditor	& 2003-12-04 \\
   907 1.1.6	& -	&	Find Text also in Notes.	& 2003-12-02 \\
   908 1.1.5	& -	&	Bugfix: Correct setting and positioning when relinking branches	& 2003-11-07 \\
   909 1.1.4	& -	&	Scroll mode added (folding of subtrees).		& 2003-11-03 \\
   910 		& - &	Bugfix: Wrong position of linedit in zoomed view& \\
   911 1.1.3	& -	&	Added clear button in find window, bugfixes    & 2003-10-09 \\ 
   912 1.1.2	& -	&	Links can be colored with color of heading     & 2003-10-07 \\ 
   913 1.1.1	& -	&	Improved visualization of linking to new branch& 2003-09-26 \\ 
   914 1.1.0	& -	&	Find Function							& 2003-09-25 \\ 
   915 		& -	&	Selection always stays in view		& \\ \hline
   916 1.0.1	& -	&	Find function scrolls to result now	& 2003-09-18\\
   917      	& -	&	Bugfix: Adding branch with midmouse	&  \\
   918 		& -	&	Bugfix: multiple repositioning of map, 
   919 				when noteeditor was changed (speedup)	& \\
   920 		& -	&	New Linestyles (still hardcoded)		&	\\ \hline
   921 1.0.0	& -	&	First public stable release			& 2003-09-16 \\	 \hline	
   922 0.9.0	& -	&	added quick color picker (CTRL + Left Mouse) & ?	\\ \hline
   923 0.8.0	& - &	added automatic canvas resizer, removed manual resizing of
   924 				canvas & \\
   925 
   926 	& - &	added settings option to paste text into new branch	& \\
   927 	& - &	simplified code	& \\
   928 	& - &	Added heart flag	& \\
   929 	& - &	Choose and switch between fixed and variable width fonts& \\
   930 	& - &	note editor		& \\
   931 	& -	&	Fixed segfault caused by undo and a call of updateNoteFlag of
   932 			note editor	& \\
   933 	& - &	Added settings menu to configure autoselect \& autoedit mode	& \\
   934 	& - &	autoedit \& autoselect mode	& \\
   935 	& - &	Fixed ugly display problem with QT Palette (Klaas Freitag)& \\
   936 	& - &	Reduced temporary directories from 4 to 1	& \\
   937 	& - &	Added wordwrap in printing of notes	& \\
   938 	& - &	New toolbar buttons in texteditor	& \\
   939 	& - &	Set background color	& \\
   940 	& - &	Fixed bug: Flags in toolbar not updated when selecting map center	& \\ \hline
   941 0.7.0	& - & No more segfault, when an object is deleted while being edited & \\
   942 	& - & Keep focus constant when zooming in/out & \\
   943 	& - & Export as png graphic & \\
   944 	& - & Keep Center of map where it is while zooming & \\
   945 	& - & Added Standard Flags (Smiley, Hook, Stopsign, ...) & \\
   946 	& - & MDI: Multi Document Interface enables working on several
   947 		maps simultanously & \\
   948 	& - & Enabled creating a new map via argument on commandline & \\
   949 	& - & Changed file extension from .mmap to .vym & \\
   950 	& - & noteeditor changes color, if empty or nothing is selected & \\
   951 	& - & Changes in NoteEditor window are recognized by main window,
   952 		too, thus preventing loosing data when quitting the program. & \\ \hline
   953 0.6.0	& - &	New rendering engine: Faster, no flickering & \\ \hline
   954 0.5.0	& - & Changed printing to use maximum space on paper& \\ 
   955 	& - & Note editor is hidden, too, when mapeditor is minimized& \\ 
   956 	& - & New (compressed) file format& \\ \hline
   957 0.4.0    & - & Size of map is saved& \\ 
   958     & - & Multi Line Headings & \\ 
   959     & - & Reworked Rendering Engine: Much faster now.& \\ 
   960     & - & Reworked Undo: Much faster now.& \\ 
   961     & - & Enabled moving of map center& \\ 
   962     & - & Multi-line headings & \\ \hline
   963 0.3.0    & - & Introduced Undo& \\ 
   964     & - & Fixed some bugs & \\  \hline
   965 0.2.0    & - & Moving view of map improved:& \\ 
   966 	& - & New handling (acrobat reader style)& \\ 
   967 	& - & New mousepointer& \\ 
   968     & - & Several tools to color a map& \\ \hline
   969 0.1.0 & - & Inital version, basic map layout & \\ 
   970     & - & Data is stored in XML& \\ 
   971 \end{longtable}
   972 \end{center}
   973 
   974 
   975 % INDEX
   976 % mapeditor
   977 % noteditor
   978 % branch
   979 % mapcenter
   980 % heading
   981 % flag
   982 % orientation 
   983 % zoom
   984 % orientation
   985 % Toolbar
   986 % Zoom
   987 % Find
   988 % statusbar
   989 % link
   990 % mainbranch
   991 % subtree
   992 % reorder
   993 % scroll
   994 % fold
   995 % vymlink
   996 % xlink
   997 % context menu
   998 % Mac OS X
   999 
  1000 
  1001 
  1002 \end{document}