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