insilmaril@28: \documentclass{article} insilmaril@28: \usepackage{a4} insilmaril@28: \usepackage[latin1]{inputenc} insilmaril@28: \usepackage{verbatim} insilmaril@28: \usepackage{hyperref} insilmaril@28: \usepackage{graphicx} insilmaril@28: \usepackage{longtable} insilmaril@28: insilmaril@28: insilmaril@28: %\input{udmath} insilmaril@28: insilmaril@28: insilmaril@28: \hypersetup{bookmarks, bookmarksopen, insilmaril@28: pdftitle={VYM - a tool for visual thinking }, insilmaril@28: pdfauthor={Uwe Drechsel}, insilmaril@28: pdfsubject={map}, insilmaril@28: pdfkeywords={map, tool}, insilmaril@28: pdfpagemode={UseOutlines}, insilmaril@28: bookmarksopenlevel={1}, insilmaril@28: colorlinks={true}, insilmaril@28: linkcolor={blue}, insilmaril@28: urlcolor={green}, insilmaril@28: citecolor={red}} insilmaril@28: insilmaril@28: insilmaril@28: \newcommand{\vym}{{\sc vym }} insilmaril@28: \newcommand{\ra}{$\longrightarrow$} insilmaril@28: \newcommand{\la}{$\longleftarrow$} insilmaril@28: \newcommand{\ua}{$\uparrow$} insilmaril@28: \newcommand{\da}{$\downarrow$} insilmaril@28: \newcommand{\key}[1]{[#1]} insilmaril@28: insilmaril@28: \begin{document} insilmaril@233: \title{ insilmaril@233: \includegraphics[width=8cm]{vym-logo-new.png} insilmaril@233: \\ insilmaril@369: VYM \\ -- \\View Your Mind\\ {\small Version 1.8.0}} insilmaril@28: \author{\textcopyright Uwe Drechsel } insilmaril@28: insilmaril@233: insilmaril@28: \maketitle insilmaril@28: insilmaril@233: \newpage insilmaril@233: insilmaril@28: \tableofcontents insilmaril@28: insilmaril@28: \newpage insilmaril@28: insilmaril@28: \section{Introduction} insilmaril@28: \subsection{What is a \vym map?} insilmaril@28: A \vym map (in short words {\em map}) is a tree like structure: insilmaril@28: \begin{center} insilmaril@28: \includegraphics[width=12cm]{example1.png} insilmaril@28: \end{center} insilmaril@264: Such maps can be drawn by hand on a paper or flip chart and help to insilmaril@264: structure your thoughts. While a tree like structure like above can be insilmaril@264: drawn manually \vym offers much more features to work with such maps. insilmaril@264: \vym is not another drawing software, but a tool to store and modify insilmaril@264: information in an intuitive way. For example you can reorder parts of insilmaril@264: the map by pressing a key or add various information like a complete insilmaril@264: email by a simple mouse click. insilmaril@264: insilmaril@264: Once you have finished collecting and organizing your ideas, you can insilmaril@264: easily generate for example a presentation in Open~Office based on a insilmaril@264: map. insilmaril@28: insilmaril@28: \subsection{Why should I use maps? Time, Space and your Brain.} insilmaril@28: \subsubsection*{Space} insilmaril@28: A map can concentrate a very complex content on little space e.g. a insilmaril@28: piece of paper. It helps to use both sides of your brain: the logical insilmaril@28: side and also your creative side (e.g. by using pictures, colors and insilmaril@28: keywords in a map, so called {\em anchors}). It is a technique to insilmaril@28: organize the way you think: It can help you by developing, sorting and insilmaril@28: memorizing your thoughts. insilmaril@28: insilmaril@28: \subsubsection*{Time} insilmaril@28: Because you just use keywords and drawings, it is much faster than good insilmaril@28: old fashioned notes. Your brain memorizes things by associating them to insilmaril@28: other things -- a map makes use of those connections and stimulates insilmaril@28: new asccociations. insilmaril@28: insilmaril@125: insilmaril@28: \subsubsection*{Your Brain} insilmaril@28: In 1960 the Prof. {\sc Roger Sperry} discovered that both hemispheres insilmaril@28: of the human brain have different tasks (of course both of them insilmaril@125: basically {\em can} do the same): insilmaril@125: \begin{center} insilmaril@125: \begin{tabular}{|p{5.5cm}|p{5.5cm}|} \hline insilmaril@125: Left side & Right side \\ \hline insilmaril@125: \begin{itemize} insilmaril@125: \item verbal speech and writing insilmaril@125: \item numbers insilmaril@125: \item logical thinking insilmaril@125: \item analyzing and details insilmaril@125: \item science insilmaril@125: \item linear thinking insilmaril@125: \item concept of time insilmaril@125: \end{itemize} & insilmaril@125: \begin{itemize} insilmaril@125: \item body language insilmaril@125: \item visual thinking, day dreams insilmaril@125: \item intuition and emotion insilmaril@125: \item overview of things insilmaril@125: \item creativity insilmaril@125: \item art, music, dancing insilmaril@125: \item non-linear thinking, connecting things insilmaril@125: \item spatial awareness insilmaril@125: \end{itemize} \\ \hline insilmaril@125: \end{tabular} insilmaril@125: \end{center} insilmaril@28: In our science oriented society we have learned to mainly rely on our insilmaril@28: left side of the brain, the "rational" one. In other cultures, insilmaril@28: especially like the native americans and other "old" cultures, the right insilmaril@260: side is much more important. Maps are just one way to stimulate the insilmaril@28: other side and make use of additional ressources we all have. insilmaril@28: insilmaril@28: insilmaril@28: \subsection{Where could I use a map?} insilmaril@28: Here are some examples, how you can use those maps insilmaril@28: \begin{itemize} insilmaril@28: \item to prepare articles, papers, books, talks, \ldots insilmaril@28: \item to sort complex data insilmaril@28: \item to memorize facts, persons, vocabulary, \ldots insilmaril@28: \item to sort emails, files and bookmarks on your computer insilmaril@28: \item to moderate conferences insilmaril@28: \end{itemize} insilmaril@28: insilmaril@28: \subsection{What you shouldn't do with a map...} insilmaril@28: A map drawn by somebody shows the way the author thinks. There is insilmaril@233: no right or wrong in the way it is drawn, so there is no way to criticize insilmaril@28: it. "It is, what it is" ({\sc F.~Lehmann}). insilmaril@28: insilmaril@28: %\section{Tutorials} insilmaril@28: %TODO insilmaril@28: insilmaril@125: \subsection{Internet Ressources} insilmaril@125: A good starting point to learn more about maps in general is Wikipedia: insilmaril@125: \begin{itemize} insilmaril@125: \item English: insilmaril@125: \href{http://en.wikipedia.org/wiki/Mind_map}{http://en.wikipedia.org/wiki/Mind\_map} insilmaril@125: \item German: insilmaril@125: \href{http://de.wikipedia.org/wiki/Mindmap}{http://de.wikipedia.org/wiki/Mindmap} insilmaril@125: \end{itemize} insilmaril@125: insilmaril@28: insilmaril@245: insilmaril@245: insilmaril@245: \section{Concept of \vym} insilmaril@28: %TODO may add a general introduction here... insilmaril@245: \subsection{Windows: mapeditor and noteeditor} insilmaril@28: \vym uses two windows: an editor for the map itself and another one for insilmaril@28: notes, which are part of the map. Let's call them {\em mapeditor} and insilmaril@28: {\em noteeditor}: insilmaril@28: \begin{center} insilmaril@28: \includegraphics[width=8cm]{windows.png} insilmaril@28: \end{center} insilmaril@28: Usually you will work in the {\em mapeditor} by just adding new insilmaril@28: branches, moving around and reordering them. The various ways to do this insilmaril@28: will be explained in \ref{mapeditor}. You can store additional insilmaril@28: information e.g. the content of a email easily in a {\em branch}: Just insilmaril@28: type or copy\&paste it into the {\em noteeditor}. Working with notes is insilmaril@28: explained in \ref{noteeditor} insilmaril@28: insilmaril@245: \subsection{Menus and Context menus} insilmaril@245: On top of each window you find the menubar. The options you find there insilmaril@245: are similar to those you are used from other applications. Note that insilmaril@245: many (and even more) options are availabe via {\em context menus}. Those insilmaril@245: are available if you right-click onto an object in a map (on Mac~OS~X insilmaril@245: Command-Click). insilmaril@245: insilmaril@245: \subsection{Toolbars} insilmaril@245: The toolbars in the mainwindows give quick access to many functions and insilmaril@245: also visualize the state of an object. For example a part of of the map insilmaril@245: can be hidden when the map is exported into an Open~Office presentation. insilmaril@245: To show this the branch in the map will have a little cloud symbol, insilmaril@245: which is also "switched on" in the toolbar. insilmaril@245: insilmaril@245: Note that you can reposition all toolbars by simply grabbing them. For insilmaril@245: example you can move the flags-toolbar from its original horizontal insilmaril@245: position on top of the mapeditor to a vertical position on the right insilmaril@245: side. You can even detach it and make it "float" separate from the other insilmaril@245: windows. Or just insert it again at its original position. insilmaril@245: insilmaril@245: \subsection{Maps} insilmaril@28: The map itself has always a {\em mapcenter}. The insilmaril@28: mapcenter has {\em branches} just like the trunk of a tree. Each branch insilmaril@28: in turn may have branches again. insilmaril@28: \begin{center} insilmaril@28: \includegraphics[width=10cm]{branches.png} insilmaril@28: \end{center} insilmaril@28: We will call a branch directly connected to the mapcenter a {\em insilmaril@28: mainbranch}, because it determines the position of all its child insilmaril@28: branches. insilmaril@28: insilmaril@28: The mapcenter and the branches all have a {\em heading}. This is the insilmaril@28: text you see in the mapeditor. Usually it should just be one or a few insilmaril@28: words, so that one can easily keep track of the whole map. insilmaril@28: insilmaril@28: insilmaril@28: In the toolbar above the mapeditor you see various symbols. insilmaril@28: \begin{center} insilmaril@28: \includegraphics[width=8cm]{default-flags.png} insilmaril@28: \end{center} insilmaril@28: These are called {\em flags} and can be used to mark branches in the insilmaril@28: map, e.g. if something is important or questionable. insilmaril@28: There are also more flags set by \vym automatically to show additional insilmaril@28: information, e.g. when a exists for a particular branch. insilmaril@28: insilmaril@260: By default some of these flags are set exclusively e.g. when the insilmaril@260: "thumb-up" flag is set, then the "thumb down" is unset and vice insilmaril@104: versa. You can change this default behaviour in the settings menu. insilmaril@104: insilmaril@233: %TODO add info about toolbars e.g. undo/redo, ... insilmaril@233: insilmaril@28: \section{Mapeditor} \label {mapeditor} insilmaril@28: \subsection{Start a new map} insilmaril@28: After \vym is started two windows will open: the mapeditor and the insilmaril@28: noteditor. Usually you will work in both windows, but at the moment we insilmaril@28: will just need the mapeditor. insilmaril@28: insilmaril@28: Select the mapcenter "New map" in the middle of the mapeditor by insilmaril@28: left-clicking with the mouse. It will turn yellow to show that is insilmaril@103: selected. There are several ways to add a new branch to the center: insilmaril@28: \begin{itemize} insilmaril@369: \item Using the mouse: Open the context meny by clicking with the insilmaril@103: right mouse button (CTRL-Click on Mac) onto the insilmaril@103: mapcenter and choose Add \ra Add as child insilmaril@103: \item Press \key{Ins} or \key{A} insilmaril@28: \end{itemize} insilmaril@28: A new branch will appear and you will be able to type the heading of the insilmaril@28: branch. Finish adding the new branch by pressing \key{Enter}. insilmaril@28: %tipp insilmaril@28: Sometimes it comes handy to add a new branch above or below the current insilmaril@104: one. Use \key{Ins} together with \key{Shift} or \key{Ctrl}. It is also insilmaril@104: possible to add a branch in such a way, that the current selection insilmaril@104: becomes the child of the new branch, which is like inserting it {\em insilmaril@104: before} the selection. This can be done using the context menu. insilmaril@28: insilmaril@28: \subsection{Navigate through a map} insilmaril@28: \subsubsection*{Select branches} insilmaril@28: To select branches you can use the left button of your mouse or also the insilmaril@28: arrow keys. Depending on the {\em orientation} of a branch type insilmaril@28: \key{\la} or \key{\ra} to get nearer to the mapcenter or deeper insilmaril@28: down into the branches. Within a set of branches, let's call them a insilmaril@28: {\em subtree}, you can use \key{\ua} and \key{\da} to go up and down. You can insilmaril@28: also use \key{Pos1} and \key{End} to select the first and last branch. insilmaril@28: insilmaril@28: insilmaril@28: \subsubsection*{Zoom a map} insilmaril@28: While adding more and more branches the size of the map may become insilmaril@28: bigger than the mapeditor window. You can use the scrollbars on the insilmaril@28: right and the bottom of your mapeditor window to scroll, but it is insilmaril@28: easier to just scroll using the left mouse button: Click onto the {\em insilmaril@28: canvas} itself, the empty space somewhere between the branches. The insilmaril@28: mouse pointer will change from an arrow to a hand, now move the visible insilmaril@28: part of the map to show the desired part. insilmaril@28: insilmaril@28: If you select branches using the arrow keys, the map will scroll insilmaril@28: to ensure that the selected branch is always visible. insilmaril@28: insilmaril@28: Working with huge maps, the {\em zoom}-function comes in handy: You can insilmaril@28: use insilmaril@28: \begin{itemize} insilmaril@28: \item from the menu View \ra Zoom insilmaril@28: \item the toolbar buttons insilmaril@28: \begin{center} insilmaril@28: \includegraphics[width=3cm]{zoom-buttons.png} insilmaril@28: \end{center} insilmaril@28: \end{itemize} insilmaril@28: The crossed magnifying lens resets the zoomed view to its original size. insilmaril@28: insilmaril@28: insilmaril@28: \subsubsection*{Find Function} \label{findwindow} insilmaril@28: With huge maps there is the need to have a insilmaril@28: find function. Choose Edit \ra Find to open the Find Window: insilmaril@28: \begin{center} insilmaril@28: \includegraphics[width=6cm]{find-window.png} insilmaril@28: \end{center} insilmaril@28: The text you enter here will be searched in all the headings and also in insilmaril@28: notes. Everytime you press the "Find"-button it will look for the next insilmaril@28: occurence, which then will be selected automatically. If the search insilmaril@28: fails, there will appear a short message "Nothing found" or a few insilmaril@28: seconds in the {\em statusbar} on the bottom of the mapeditor. insilmaril@28: insilmaril@260: \subsubsection*{Keep the overview -- scroll a part of the map} insilmaril@28: A very big subtree of a map e.g. a branch with hundreds of childs makes insilmaril@28: it very hard to keep an overview over the whole map. You can hide all insilmaril@28: the childs of a branch by {\em scrolling} it -- this function is also insilmaril@28: often called {\em folding}. Think of the whole subtree as painted onto a insilmaril@28: big newspaper. You can scroll the paper to a small roll, leaving just insilmaril@28: the headline readable. insilmaril@28: insilmaril@28: To scroll or unscroll a branch and its childs, press the insilmaril@28: \begin{itemize} insilmaril@103: \item \key{Scroll} key or \key{S} insilmaril@28: \item press the middle-mouse button or insilmaril@28: \item choose the little scroll from the toolbar. insilmaril@28: \end{itemize} insilmaril@28: If you select parts of a scrolled branch e.g. using the find function or insilmaril@28: by using the arrow-keys, it will unscroll temporary. This is shown as a insilmaril@28: scroll with a little hour glass. If the temporary unscrolled part is not insilmaril@28: longer needed, it will be hidden again automatically. It is also insilmaril@28: possible to unscroll all branches using "Edit\ra Unscroll all scrolled insilmaril@28: branches". insilmaril@28: insilmaril@264: You can also hide parts of the map while exporting it e.g. to a webpage insilmaril@264: or a presentation, see \ref{hideexport} for details. insilmaril@28: insilmaril@28: \subsection{Modify and move branches} insilmaril@260: \subsubsection*{Modify the heading} insilmaril@28: You can edit the heading by selecting the branch and then insilmaril@28: \begin{itemize} insilmaril@28: \item pressing \key{Enter} insilmaril@28: \item double-clicking with left mouse. insilmaril@28: \end{itemize} insilmaril@28: Just type the new heading (or edit the old one) and press \key{Enter}. insilmaril@28: insilmaril@28: \subsubsection*{Move a branch} insilmaril@28: The easiest way to move a branch is to select it with left-mouse and insilmaril@28: drag it to the destination while keeping the mouse button pressed. insilmaril@28: Depending on the branch it will be insilmaril@28: \begin{itemize} insilmaril@28: \item moved to the destination or insilmaril@28: \item {\em linked} to a new {\em parent} (mapcenter or branch) insilmaril@28: \end{itemize} insilmaril@28: If you drag the branch over another one or over the mapcenter, you will insilmaril@28: notice that the link connecting it to the old parent will be changed to insilmaril@28: lead to the new parent which is now under your mousepointer. insilmaril@28: If you release the button now, the branch will be relinked. insilmaril@28: insilmaril@28: If you release the button in the middle of nowhere, the result will insilmaril@28: depend on the type of branch you are releasing: insilmaril@28: \begin{itemize} insilmaril@28: \item A mainbranch is directly connected to the mapcenter. insilmaril@28: It will stay on its new position. insilmaril@28: \item An ordinary branch will "jump" back to its original position. insilmaril@28: \end{itemize} insilmaril@28: Thus you can easily rearrange the layout of the mainbranches to avoid insilmaril@28: overlapping of their subtrees. insilmaril@28: There is another convenient way to move branches, especially if you want insilmaril@28: to {\em reorder} a subtree: You can move a branch up or down in a insilmaril@28: subtree by insilmaril@28: \begin{itemize} insilmaril@28: \item pressing \key{\ua} and \key {\da} insilmaril@28: \item selecting Edit \ra Move branch insilmaril@28: \item clicking on the toolbar buttons: insilmaril@28: \begin{center} insilmaril@28: \includegraphics[width=1.5cm]{move-buttons.png} insilmaril@28: \end{center} insilmaril@28: \end{itemize} insilmaril@28: %tipp insilmaril@28: There is yet another way to move branches: If you press \key{Shift} or insilmaril@28: \key{Ctrl} while moving with the mouse, the branch will be added above insilmaril@28: or below the one the mouse pointer is over. This helps also to reorder a insilmaril@28: map. insilmaril@28: insilmaril@28: \subsection{The right side of your brain - colors and images} insilmaril@28: \subsubsection*{Change color of a heading} insilmaril@28: You can also use colors to put more information into a map, e.g. use insilmaril@28: red, green and more colors to prioritize tasks. Again you can insilmaril@28: \begin{itemize} insilmaril@28: \item use the menu and choose e.g Format \rq Set Color insilmaril@28: \item use the toolbar insilmaril@28: \begin{center} insilmaril@28: \includegraphics[width=3cm]{color-buttons.png} insilmaril@28: \end{center} insilmaril@28: \end{itemize} insilmaril@28: The first button (black in the graphic above) shows the actual color. insilmaril@28: Clicking on it let's you choose another color. You can also "pick" insilmaril@28: another color by selecting a branch with the desired color and using the insilmaril@28: "pick color" button. Both of the buttons showing a bucket actually put insilmaril@28: the current color to the selected branch. While the first one just insilmaril@28: colors the heading of the selection, the last one also colors all the insilmaril@28: childs of the selected branch. insilmaril@28: insilmaril@28: %tipp insilmaril@28: A very useful function is the "copy color" using the mouse: Select the insilmaril@28: branch which should get the new color, then press \key{Ctrl} and insilmaril@28: simultanously click with left-mouse on another branch to copy its color insilmaril@28: to the first one. Here the childs of the selection also will get the new insilmaril@28: color, if you just want to color the selection itself, additionally insilmaril@28: press \key{Shift}. insilmaril@28: insilmaril@28: \subsubsection*{Use flags} insilmaril@28: \vym provides various flags. You see them in the toolbar on top of the insilmaril@28: mapeditor window. (Note: Like all toolbars you can also move them to the insilmaril@28: left or the right side of the window or even detach them. Just grab the insilmaril@28: very left "dotted" part of the toolbar with your left-mouse button.) insilmaril@28: \begin{center} insilmaril@28: \includegraphics[width=8cm]{default-flags.png} insilmaril@28: \end{center} insilmaril@28: If you have a branch selected, you can set any number of flags by insilmaril@28: clicking them in the toolbar. The toolbar buttons change their state and insilmaril@28: always reflect the flags set in the selected branch. insilmaril@28: insilmaril@28: Presently \vym uses two kinds of flags: {\em System Flags} and {\em insilmaril@28: Standard Flags}. The standard flags are those shown in the toolbar. insilmaril@28: System flags are set by \vym to indicate e.g. that there is additional insilmaril@28: information in a note (more on this in \ref{noteeditor}). Later versions insilmaril@28: of \vym may have another kind of flags, which may be edited by the user. insilmaril@28: insilmaril@28: \subsubsection*{Images} insilmaril@125: The easiest way to add an image to a branch is by dragging it e.g. from a insilmaril@125: webbrowser to the mapeditor while a branch is selected there. insilmaril@125: insilmaril@125: You can also add a image to a branch by opening the context menu of the insilmaril@125: branch choose "Add Image". A insilmaril@28: dialog window lets you choose the image to load. insilmaril@28: \footnote{Supported image types are: PNG, BMP, XBM, XPM and PNM. It may insilmaril@28: also support JPEG, MNG and GIF, if specially configured during insilmaril@28: compilation (as done when \vym is part of SUSE LINUX).} insilmaril@28: While an image is selected in the dialog, you can see a preview of the insilmaril@233: image. It is also possible to select multiple images. insilmaril@28: insilmaril@28: You can position the image anywhere you want, just drag it with left insilmaril@28: mouse. To relink it to another branch, press \key{Shift} while moving insilmaril@28: it. To delete it, press \key{Del}. insilmaril@28: insilmaril@28: If you right-click onto an image, a context menu will open which let's insilmaril@28: you first choose one of several image formats. Then a file dialog opens insilmaril@28: to save the image. Hint: This is used to "export" the image, it will be insilmaril@28: saved anyway in the map itself! You can also cut and insilmaril@28: copy images, but it is not possible to add objects to an image\footnote{ insilmaril@28: Images are regarded as "extra feature". It would make working with insilmaril@28: the map much more complex if e.g. images could be linked to images.} insilmaril@28: insilmaril@28: The option \lq{\bf Use for export} \rq controls the output of exports insilmaril@28: e.g. to HTML: If set to no, the image won't appear in the {\em text} insilmaril@28: part of the output. This is useful for large images or if images are insilmaril@28: used as a kind of frame e.g. the famous cloud symbol around a part of insilmaril@28: the map. Those shouldn't appear in the middle of the text. insilmaril@28: insilmaril@28: At the moment image support is preliminary: Images will be saved insilmaril@28: together with all the other data of a map in the {\tt .vym}-file. insilmaril@28: Later versions will include more functionality like resizing the images, insilmaril@28: changing its z-value (put it into background) etc. insilmaril@28: insilmaril@28: \subsubsection*{Frames} insilmaril@28: A frame can be added to a branch by clicking with the insilmaril@28: right-mouse button. A context menu will open, where you can choose the insilmaril@28: frame. At the moment just a rectangle resp. "No Frame" will be offered, insilmaril@28: nevertheless you can use images as frames. Have a look at the demo map insilmaril@28: {\tt todo.vym} as an example, where the mapcenter is a cloud. You can insilmaril@28: use an external drawing program like {\tt gimp} to create an image, insilmaril@28: preferable with an transparency channel, so that you can design frames insilmaril@28: which don't use a rectangular borderline, just like the cloud. insilmaril@28: insilmaril@28: insilmaril@28: \subsection{Background design} insilmaril@28: The design of the background of a map and also of the links connecting insilmaril@28: various parts of the map can be changed by insilmaril@28: \begin{itemize} insilmaril@28: \item Selecting Format from the menu insilmaril@28: \item Right clicking onto the canvas, which will open a context menu insilmaril@28: \end{itemize} insilmaril@28: insilmaril@28: \subsubsection*{Background color} insilmaril@28: The color is set (and also displayed) as "Set background color". insilmaril@28: insilmaril@28: \subsubsection*{Link color} insilmaril@28: Links connecting branches can be colored in one of the following ways: insilmaril@28: \begin{itemize} insilmaril@28: \item use the color of the heading of the branch the links is insilmaril@28: \item use {\em one} color for all links. The default color is blue. insilmaril@28: leading to. insilmaril@28: \end{itemize} insilmaril@28: The latter can be set with "Set link color". Check or uncheck the "Use insilmaril@28: color of heading for link" option to choose one of the two designs for insilmaril@28: your map. insilmaril@28: insilmaril@28: \subsubsection*{Link style} insilmaril@28: \vym offers four different styles for the appearences of links: insilmaril@28: \begin{itemize} insilmaril@28: \item Line insilmaril@28: \item Parabel insilmaril@28: \item Thick Line insilmaril@28: \item Thick Parabel insilmaril@28: \end{itemize} insilmaril@28: The "thick" styles only draw links starting at mapcenter thick, the rest insilmaril@28: of the map is always painted "thin". insilmaril@28: insilmaril@28: insilmaril@260: \subsection{Links to other documents and webpages} insilmaril@260: \vym supports two kind of external links: insilmaril@28: \begin{itemize} insilmaril@28: \item Document, which will be opened in an external webbrowser insilmaril@28: \item \vym map, which will be opened in \vym itself insilmaril@28: \end{itemize} insilmaril@260: In addition to the external links there also internal ones, leading from one insilmaril@260: branch in a map toanother one. Those are called {\em XLinks} and are explained insilmaril@260: in section~\ref{xlinks}. insilmaril@28: insilmaril@28: \subsubsection*{Webbrowser} insilmaril@28: Modern Webbrowsers like {\tt konqueror} are able to display various insilmaril@28: types of files, both local or in the internet. To enter the URL of insilmaril@28: any document, right-click onto a branch or use the Edit Menu insilmaril@28: and choose "Edit URL". Enter the path to your document (or copy and insilmaril@28: paste it from your browser). Examples for valid paths are: insilmaril@28: \begin{verbatim} insilmaril@28: http://www.insilmaril.de/vym/index.html insilmaril@28: file:/usr/share/doc/packages/vym/doc/vym.pdf insilmaril@28: \end{verbatim} insilmaril@28: If an URL was entered, a little globe will appear in the branch. By insilmaril@28: clicking on the globe in the toolbar or the context menu an external insilmaril@28: browser\footnote{ insilmaril@28: The browser can be changed in the Settings Menu.} insilmaril@28: will be started. insilmaril@28: \begin{center} insilmaril@28: \includegraphics[width=0.5cm]{flag-url.png} insilmaril@28: \end{center} insilmaril@340: For more information on working with bookmarks and webbrowsers see insilmaril@340: section \ref{bookmarks}. insilmaril@266: insilmaril@28: insilmaril@28: \subsubsection*{\vym map} insilmaril@28: To link to to another map right click on a branch or choose "Edit \ra insilmaril@28: Enter \vym link". A file dialog opens where you can choose the map. A insilmaril@28: branch with a link is marked with insilmaril@28: \begin{center} insilmaril@28: \includegraphics[width=0.5cm]{flag-vymlink.png} insilmaril@28: \end{center} insilmaril@28: Clicking this flag in the toolbar or in the context menu of a branch insilmaril@28: will open the map in another tab (see \ref{tabs} for working with insilmaril@28: multiple maps). To delete an existing link, just press the "Cancel" insilmaril@28: button. insilmaril@28: insilmaril@28: Technical note: Internally \vym uses absolute paths, to avoid opening insilmaril@28: several tabs containing the same map. When a map is saved, this path is insilmaril@28: converted to a relative one (e.g. {\tt /home/user/vym.map} might become insilmaril@28: {\tt ./vym.map}. This makes it fairly easy to use multiple maps on insilmaril@28: different computers or export them to HTML in future. insilmaril@28: insilmaril@28: \subsection{Multiple maps} \label{tabs} insilmaril@28: You can work on multiple maps at the same time. Each new map is opened insilmaril@28: in another {\em tab}. The available tabs are shown just above the insilmaril@28: mapeditor. You can use the normal cut/copy/paste functions to insilmaril@28: copy data from one map to another. insilmaril@28: insilmaril@28: %todo insilmaril@28: insilmaril@28: %TODO insilmaril@28: %\subsubsection{Menus} insilmaril@28: %\subsubsection{Keyboard shortcuts} insilmaril@28: insilmaril@28: % Settings insilmaril@28: % Images insilmaril@28: % Copy & Paste insilmaril@28: % Working with tabs (multiple maps) insilmaril@28: % Exporting insilmaril@28: % Scrolling insilmaril@28: insilmaril@28: \section{Noteeditor} \label {noteeditor} insilmaril@28: If you want to save more text in a branch e.g. a complete email, a insilmaril@28: cooking recipe, or the whole source code of a software project, you can insilmaril@125: use the noteeditor. insilmaril@233: \begin{center} insilmaril@233: \includegraphics[width=8cm]{noteeditor.png} insilmaril@233: \end{center} insilmaril@233: This editor displays text associated to a branch selected in the insilmaril@233: mapeditor. To visualize that there maybe is no text yet, the noteeditor insilmaril@233: shows different background colors depending on its state: insilmaril@28: insilmaril@125: \subsection{States} insilmaril@28: Before you can type or paste text into it, you have insilmaril@28: to select a branch in the mapeditor. Note that the background color insilmaril@28: of the noteeditor indicates its state: insilmaril@28: \begin{itemize} insilmaril@28: \item black: no branch selected insilmaril@28: \item grey: no text entered yet insilmaril@28: \item white: text is already available insilmaril@28: \end{itemize} insilmaril@28: To show you in the mapeditor itself that there is a note with more insilmaril@28: information for a particular branch, a little note flag will appear next insilmaril@28: to the heading of the branch. See the lower branch on the right side: insilmaril@28: \begin{center} insilmaril@28: \includegraphics[width=8cm]{branches-flags.png} insilmaril@28: \end{center} insilmaril@28: insilmaril@125: \subsection{Import and export notes} insilmaril@28: The note is always saved automatically within the \vym file itself. insilmaril@28: Nevertheless sometimes it is nice to import a note from an external file insilmaril@28: or write it. Use "File\ra~Import" and "File\ra~Export" to do so. insilmaril@28: insilmaril@125: \subsection{Edit and print note} insilmaril@28: Editing works like in any simple texteditor, including undo and redo insilmaril@28: functions. You can delete the complete note by clicking the insilmaril@28: trashcan. Only the note itself is printed by clicking the printer icon. insilmaril@28: insilmaril@28: When pasting into the editor using the X11 copy\&paste mechanism, the insilmaril@28: editor will create a paragraph for each new line. Usually this is not insilmaril@28: wanted, so there you can convert all paragraphs into linebreaks by using insilmaril@28: Edit~\ra~Remove~Paragraphs or \key{ALT-X}. insilmaril@28: insilmaril@233: \subsection{RichText: Colors, paragraphs and formatted text} insilmaril@233: \vym supports formatted text (QT Rich Text) in the noteeditor since insilmaril@233: version 1.4.7. Colors and text attributes (e.g. italic, bold) can be insilmaril@233: set with the buttons above the text. The text itself is divided in insilmaril@233: paragraphs. For each paragraph the format can be set (e.g. centered, insilmaril@233: right). A paragraph is ended when a \key{Return} is entered. If you just insilmaril@233: want to begin a new line, press \key{CTRL-Return}. insilmaril@233: insilmaril@233: \subsection{Fonts and how to quickly switch them} insilmaril@28: The noteeditor is ment to be used for simple notes, not really as full insilmaril@28: featured text editor. Because of many requests \vym supports now insilmaril@28: formatted text in the noteeditor\footnote{ insilmaril@28: \vym uses the QRichtText format, which is basically a subset of the insilmaril@28: formatting provided in HTML.} insilmaril@28: Two default fonts are supported which can be set in the Settings menu. insilmaril@28: One is a fixed width font, the other has variable width. The fixed font insilmaril@28: is usually used for emails, source code etc.\ while the variable font is insilmaril@28: used for simple notes, where one doesn't need fixed character widths. insilmaril@28: Both fonts can easily switched using the following symbol from the insilmaril@28: toolbar: insilmaril@28: \begin{center} insilmaril@28: \includegraphics[width=0.5cm]{formatfixedfont.png} insilmaril@28: \end{center} insilmaril@28: In the Settings menu both fonts can be set and also which font should be insilmaril@28: used for default. insilmaril@28: insilmaril@28: Additionally to the default fonts any font installed on your system can insilmaril@28: be used. Please note, that the chosen font also will be used for HTML insilmaril@28: exports, so you should only use fonts which are available generally. insilmaril@28: insilmaril@217: \subsection{Find text} insilmaril@28: The noteeditor itself has no Find function, use Find in the mapeditor, insilmaril@28: which will also search all notes (see \ref{findwindow}). insilmaril@28: insilmaril@217: \subsection{Paste text into note editor} insilmaril@28: Often you will paste text into the editor from another application e.g. insilmaril@28: an email. Normally \vym will generate a new paragraph for each new line. insilmaril@28: This usually is not what you want, so you can choose from the menu insilmaril@28: insilmaril@125: \subsection{Advanced actions} insilmaril@217: \subsubsection*{Edit \ra Convert subsubsections:} insilmaril@125: This turns subsubsections in selected text (or all text, if nothing is insilmaril@28: selected) into linebreaks. This is especially useful for snippets of insilmaril@28: source code. insilmaril@28: insilmaril@217: \subsubsection*{Edit \ra Join Lines:} insilmaril@28: Tries to format text, so that empty lines are used to delimit insilmaril@28: paragraphs. This is done for selected text (or all text, if nothing is insilmaril@28: selected). Especially useful for text like emails, meeting minutes etc. insilmaril@28: insilmaril@28: \section{Hello world} insilmaril@233: This section is about how \vym can interact with other applications. insilmaril@233: Many applications meanwhile can read and write their data using XML, the insilmaril@233: eXtensible Markup Language. \vym also uses XML to save its maps, see insilmaril@233: \ref{fileformat} for a more detailed description. insilmaril@233: insilmaril@233: So if your an application understands XML, chances are good that someone insilmaril@233: could write import/export filters for \vym. Volunteers are always insilmaril@233: welcome ;-) insilmaril@233: insilmaril@340: \subsection{Import} \label{import} insilmaril@233: insilmaril@233: \subsubsection*{KDE Bookmarks} insilmaril@233: The integrated bookmark editor in KDE is somewhat limited, so why not insilmaril@233: use \vym to maintain the bookmark mess? To create a new map containing insilmaril@233: your current KDE bookmarks just choose insilmaril@233: \begin{itemize} insilmaril@233: \item File \ra Import\ra KDE Bookmarks insilmaril@233: \end{itemize} insilmaril@233: insilmaril@233: \subsubsection*{Mind Manager} insilmaril@233: \vym has currently a very basic import filter to convert maps created by insilmaril@233: {\em Mind Manager}\footnote{Mind Manager is a professional software by insilmaril@233: Mindjet. Both names are registered trademarks by Mindjet. For more insilmaril@233: information see their website at insilmaril@233: \href{http://mindjet.de}{http://mindjet.de}} into \vym maps. Notes and insilmaril@233: pictures are not converted at the moment. You can import files with insilmaril@233: \begin{itemize} insilmaril@233: \item File \ra Import\ra Mind Manager insilmaril@233: \end{itemize} insilmaril@233: insilmaril@233: insilmaril@233: \subsubsection*{Directory structure} insilmaril@233: \vym can read a directory structure. This is mainly for insilmaril@233: testing \vym e.g. to easily create huge maps used for benchmarks (yes, insilmaril@233: there is still room to optimize \vym ;-) insilmaril@28: insilmaril@340: insilmaril@340: insilmaril@340: insilmaril@340: \subsection{Export} \label{export} insilmaril@264: \label{hideexport} insilmaril@264: Often you don't want to export the whole map, but just parts of it. For insilmaril@264: example you may have additional info you want to talk about in a insilmaril@264: presentation, while those parts should not be visible to the audience. insilmaril@264: To achieve this you can "hide" parts of the map during exports by insilmaril@291: setting the "hide in export" flag. insilmaril@264: \begin{center} insilmaril@264: \includegraphics[width=0.5cm]{flag-hideexport.png} insilmaril@264: \end{center} insilmaril@291: You can toggle this flag in the toolbar or by pressing \key{H}. insilmaril@264: Note that there is a global option in the settings menu to toggle the insilmaril@264: use of this flag. By default the flag is enabled. insilmaril@233: insilmaril@233: \subsubsection*{Open Office} insilmaril@233: Open Office beginning with version~2 uses the so called "Open Office insilmaril@233: Document Format", which can be written by \vym. The options are insilmaril@233: currently limited, but it possible to export presentations which can be insilmaril@233: opened in Open Office Impress. By selecting insilmaril@28: \begin{itemize} insilmaril@233: \item File \ra Export\ra Open Office insilmaril@28: \end{itemize} insilmaril@233: you get a file dialogue where you can choose the output file and the insilmaril@233: file type: insilmaril@233: \begin{center} insilmaril@233: \includegraphics[width=12cm]{export-oo.png} insilmaril@233: \end{center} insilmaril@233: The file types represent various templates, which can be created with insilmaril@233: some manual work from an existing Open Office document. The structure of insilmaril@233: \vym map is then inserted into a template. insilmaril@233: There are some limitations at the moment: insilmaril@233: \begin{itemize} insilmaril@233: \item \vym can't take care of page lengths, so you have to check and insilmaril@233: probably reedit in Open Office to avoid text running over the end of insilmaril@233: a page insilmaril@233: \item Images and flags are not used at the moment insilmaril@233: \item Notes are just written as plain text, without RichText insilmaril@233: \end{itemize} insilmaril@233: Some of the templates make use of {\em sections} e.g. insert the insilmaril@233: headings of mainbranches as chapters for sections into the presentation. insilmaril@28: insilmaril@28: \subsubsection*{Image} insilmaril@28: \vym supports all image formats which are natively supported by the insilmaril@28: QT~toolkit: insilmaril@28: BMP, JPEG, PBM, PGM, PNG, PPN, XPM, and XBM. insilmaril@28: For use in websites and for sending images by email PNG is a good insilmaril@28: recommodation regarding quality and size of the image. \vym uses QTs insilmaril@28: default options for compressing the images. insilmaril@28: insilmaril@28: \subsubsection*{ASCII} insilmaril@28: Exporting an image as text is somewhat experimental at the moment. Later insilmaril@28: this will probably done using stylesheets. So the output may change in insilmaril@28: future versions of \vym. insilmaril@28: insilmaril@233: \subsubsection*{\LaTeX} insilmaril@233: \vym can generate an input file for \LaTeX. Currently this is considered insilmaril@233: as experimental, there are no options (yet). insilmaril@233: By selecting insilmaril@233: \begin{itemize} insilmaril@233: \item File \ra Export\ra \LaTeX insilmaril@233: \end{itemize} insilmaril@233: you will be asked in a file dialog for the name of the output file. This insilmaril@233: file should be included in a \LaTeX document using command insilmaril@233: \begin{verbatim} insilmaril@233: \include{inputfile.tex} insilmaril@233: \end{verbatim} insilmaril@233: insilmaril@340: \subsubsection*{KDE Bookmarks} insilmaril@340: \vym will overwrite the KDE bookmarks file and then try to notify insilmaril@340: running konquerors via DCOP of the changed file. \vym does not create a insilmaril@340: backup! insilmaril@340: \begin{itemize} insilmaril@340: \item File \ra Export \ra KDE Bookmarks insilmaril@340: \end{itemize} insilmaril@340: insilmaril@340: insilmaril@233: \subsubsection*{XHTML (Webpages)} insilmaril@233: insilmaril@233: This is the format you want to use to create a webpage. For an example insilmaril@233: have a look at the \vym homepage: insilmaril@233: \href{http://www.InSilmaril.de/vym}{www.InSilmaril.de/vym} insilmaril@233: insilmaril@233: Some explanation how this works: insilmaril@233: Before a map is exported as XHTML, it will be first written as XML into a insilmaril@28: directory (see \ref{xmlexport}). Then the external program {\tt insilmaril@28: xsltproc}\footnote{On SUSE Linux {\tt xsltproc} is installed by insilmaril@28: default.} insilmaril@28: will be called to process the XML file and generate HTML code. insilmaril@28: A dialog allows to set various options: insilmaril@28: \begin{itemize} insilmaril@28: \item {\bf Include image:} If set, \vym will creat an image map at insilmaril@28: the top of the HTML output. Clicking on a branch in the map will insilmaril@28: jump to the corresponding section in the output. insilmaril@28: insilmaril@28: \item {\bf Colored headings:} insilmaril@28: If set to yes, \vym will color the headings in the text part with the insilmaril@28: same colors like in the map. insilmaril@28: \item {\bf Show Warnings:} insilmaril@28: If set to yes, \vym will ask before overwriting data. insilmaril@28: \item {\bf Show output:} insilmaril@28: This is useful mainly for debugging. It will show how the processing of insilmaril@28: the XML file works by calling the external {\tt xsltproc}. insilmaril@28: \end{itemize} insilmaril@28: Additionally the paths to the CSS and XSL stylesheets can be set. By insilmaril@28: default on SUSE~Linux they will be in {\tt /usr/share/vym/styles}. insilmaril@28: insilmaril@28: insilmaril@28: \subsubsection*{XML} \label{xmlexport} insilmaril@28: The map is written into a directory both as an image and as XML. The insilmaril@28: directory is set in a file dialog. If the directory is not empty, you insilmaril@28: will be questioned if you risk to overwrite its contents. insilmaril@28: insilmaril@28: It is possible to export different maps into the same directory. Each insilmaril@28: file generated will have the map's name as prefix, e.g. {\tt todo.vym} insilmaril@28: becomes {\tt todo.xml}, {\tt todo.png}, {\tt todo-image-1.png} and so insilmaril@28: on. This is useful if e.g. for a website several combined maps have to insilmaril@28: be stored in the same directory. insilmaril@28: insilmaril@105: \subsubsection*{Export a part of a map} insilmaril@128: Select a branch you want to export together with its childs, then open insilmaril@105: the context menu and choose {\em Save Selection}. This will create a insilmaril@105: file with the postfix {\tt .vyp}, which is an abbreviation for \lq vym insilmaril@105: part\rq. insilmaril@105: insilmaril@125: insilmaril@125: \section{Advanced Editing} insilmaril@340: insilmaril@340: \subsection{How to deal with Bookmarks} \label{bookmarks} insilmaril@340: \subsubsection*{Open new tabs instead of new windows} insilmaril@340: If you use konqueror as browser, \vym will remember the konqueror which insilmaril@340: was opened first by \vym. You can also press \key{Ctrl} and click to insilmaril@340: open the link in a new tab then. insilmaril@340: insilmaril@340: \vym can also open a new tab in Mozilla or Firefox using the remote insilmaril@340: command\footnote{\href{http://www.mozilla.org/unix/remote.html}{http://www.mozilla.org/unix/remote.html}} insilmaril@340: of these. insilmaril@340: insilmaril@340: \subsubsection*{Drag and Drop} insilmaril@340: If you want to keep bookmarks in a map, select a branch where you want insilmaril@340: to add the bookmark, then simply drag the URL from your browser to the insilmaril@340: map. Also you could use an existing heading as URL: Right click onto the insilmaril@340: branch and select "Use heading for URL". insilmaril@340: insilmaril@340: insilmaril@340: \subsubsection*{Directly access bookmark lists of a browser} insilmaril@340: Please see the sections \ref{import} and \ref{export} about insilmaril@340: Import and Export filters. insilmaril@340: insilmaril@340: \subsubsection*{Special URLs} insilmaril@340: \vym can turn an existing heading of a branch into an URL. Currently insilmaril@340: this works for Bugentries in the Novell Bugtracking system: Open the insilmaril@340: context menu of a branch (usually by right-clicking it) and select insilmaril@340: \begin{itemize} insilmaril@340: \item Create URL to Bugzilla insilmaril@340: \end{itemize} insilmaril@340: The URL will be build from the number in the heading. insilmaril@340: insilmaril@340: \subsection{Including images into a branch} insilmaril@340: The default setting of an image is to float "freely". They can be insilmaril@340: positioned everywhere, but they might end up in the same place as other insilmaril@340: parts of the map. insilmaril@340: insilmaril@340: The solution is to include them "into" a branch. This can be done via insilmaril@340: the context menu of their parent branch: insilmaril@340: \begin{itemize} insilmaril@340: \item Include images horizontally insilmaril@340: \item Include images vertically insilmaril@340: \end{itemize} insilmaril@340: The image ist still positioned relatively to its parent branch, but the insilmaril@340: heading and border of the branch adapt to the floating image, see below: insilmaril@340: \begin{center} insilmaril@340: \includegraphics[width=11cm]{includeImages.png} insilmaril@340: \end{center} insilmaril@340: insilmaril@125: \subsection{Modifier Modes} insilmaril@125: Modifiers are for example the \key{Shift}- or the \key{Alt}-keys. When insilmaril@125: pressed while doing actions with the mouse, they will cause \vym to use insilmaril@125: a "modified" action. E.g. you can move branches with mouse. If insilmaril@125: \key{Ctrl} or \key{Alt}is pressed while releasing the branch, it will be insilmaril@125: added above/below the target, not as child of the target. insilmaril@125: insilmaril@125: Without a modifier pressed, the first click on a branch just selects insilmaril@125: it. For the behaviour of the \key{Ctrl} modifier there are several insilmaril@125: options, which can be set from the modifier toolbar: insilmaril@125: \begin{center} insilmaril@125: \includegraphics[width=3cm]{modmodes.png} insilmaril@125: \end{center} insilmaril@125: The default is to copy the color from the clicked branch to the already insilmaril@125: selected branch. In the toolbar shown above the default modifier is insilmaril@125: selected, namely to copy the color of a branch. The second modifier insilmaril@125: let's you easily copy a whole branch with a single click. The third insilmaril@125: modifier lets you create {\em xLinks}, which will be explained in the insilmaril@125: next section. insilmaril@125: insilmaril@264: \subsection{Hide links of unselected objects} insilmaril@264: Sometimes it would be useful to position a branch freely, just like a insilmaril@264: mainbranch or an image. Though this is not possible (yet) for all insilmaril@264: branches, you can use a mainbranch and hide its connecting link to the insilmaril@264: mapcenter. This can be used e.g. for legends or a collection of vymLinks insilmaril@264: pointing to other maps: insilmaril@264: \begin{center} insilmaril@264: \includegraphics[width=9cm]{hiddenlink.png} insilmaril@264: \end{center} insilmaril@264: insilmaril@264: insilmaril@260: \subsection{XLinks} \label{xlinks} insilmaril@125: So far all the data in the \vym map has been treelike. Using xLinks you insilmaril@125: can link one branch to any other, just like attaching a rope between two insilmaril@125: branches in a real tree. This is especially useful in complex maps, insilmaril@125: where you want to have crossreferences which don't fit on the same insilmaril@125: visible area, which fits on your screen. The following example, which is insilmaril@125: part of the \vym package, still fits on one screen, but shows how data insilmaril@125: can be crosslinked. In the graphics there is a link from a task (prepare insilmaril@125: a presentation) to general information: insilmaril@125: \begin{center} insilmaril@125: \includegraphics[width=12cm]{xlink.png} insilmaril@125: \end{center} insilmaril@125: Note that a xLink which points to a branch that is not visible (because insilmaril@125: it is scrolled), is just show as a little horizontal arrow. In the insilmaril@125: screenshot above have a look at the \lq Tuesday\rq\ branch. insilmaril@125: insilmaril@233: \subsubsection*{Create a xLink} insilmaril@125: Choose the link mode from the modifier toolbar (by clicking or pressing insilmaril@125: \key{L}). Select the branch, where the xLink should start. Press the insilmaril@266: modifier key \key{Ctrl} and simultanously click on the branch where the insilmaril@125: link should end. (The link is already drawn before you release the mouse insilmaril@125: key). If you release the mouse over a branch the xLink becomes insilmaril@125: permanent. insilmaril@125: insilmaril@233: \subsubsection*{Modify or delete a xLink} insilmaril@125: Open the context menu of a branch and select \lq Edit xLink\rq. A insilmaril@125: submenu contains all the xLinks of the branch (if there are any). They insilmaril@125: are named like the branches, where they end. Choose one and insilmaril@125: the xLink dialogue opens, where you can set color, width and also delete insilmaril@125: the xLink. insilmaril@125: insilmaril@233: \subsubsection*{Follow a xLink} insilmaril@125: In a complext \vym map it sometimes comes handy to jump to the other end insilmaril@125: of a xLink. You can do this by opening the context menu of the branch insilmaril@125: and clicking on \lq Goto xLink\rq and selecting the xLink you want to insilmaril@125: follow. insilmaril@125: insilmaril@125: insilmaril@125: insilmaril@233: \subsection{Adding and removing branches} insilmaril@125: The context menu of a branch shows some more ways to add and delete data insilmaril@125: e.g. you can delete a branch while keeping its childs. The childs become insilmaril@125: linked to the parent of the previously removed branch. insilmaril@125: Similar branches can be inserted into existing maps. For keyboard insilmaril@125: shortcuts also have a look at the context menu. insilmaril@28: insilmaril@233: \subsection{Adding a whole map or a part of a map} insilmaril@233: Select a branch where you want to add a previously saved map ({\tt .vym})or a part insilmaril@233: of a map ({\tt .vyp}) , then open insilmaril@233: the context menu and choose {\em Add \ra Import}. For the import you can insilmaril@233: choose between {\em Import Add} and {\em Import Replace}: The imported insilmaril@233: data will be added after the selection resp. replace the selection. insilmaril@233: insilmaril@105: insilmaril@105: \section{\vym on Mac OS X} insilmaril@105: \subsection{Overview} insilmaril@105: Basically there are two ways to run \vym on Macs: insilmaril@233: \subsubsection*{QT Mac Edition:} insilmaril@105: \vym here provides the well known Mac look and feel. \vym is insilmaril@105: available as zipped Mac OS X application. It has been compiled and insilmaril@105: tested in Mac~OS~10.3, but should also work on Tiger. It is using insilmaril@105: the Mac version of Trolltechs QT library. insilmaril@233: \subsubsection*{X11} insilmaril@105: \vym can also be run using the Linux version, but then menus and insilmaril@105: handling will also be those of the Linux version e.g. The menu bar insilmaril@105: will look different. insilmaril@105: insilmaril@125: \subsection {Contextmenu and special keys} insilmaril@125: Most Macs unfortunatly just have a single mouse button. In order to show insilmaril@125: the context menu which usually would be opened with the right mouse insilmaril@125: button, you can click while pressing the \key{kommand}-key. insilmaril@125: insilmaril@125: Especially on Laptops some of the keys usually used on PC keyboards seem insilmaril@125: to be missing. The QT-Mac Edition of \vym has its own keyboard insilmaril@125: shortcuts. To find the shortcuts just have a look at all the menu insilmaril@125: entries, the shortcut is visible next to an entry. Toolbar buttons also insilmaril@125: may have shortcuts, just position the mouse pointer over a button and insilmaril@125: wait for the little help window to appear. insilmaril@125: insilmaril@125: \subsection {Viewing external links} insilmaril@125: \vym on Mac uses the system call {\tt /usr/bin/open} to view links. insilmaril@125: Mac~OS determines automatically if the link is a pdf or www page and insilmaril@125: opens the right browser. insilmaril@125: insilmaril@233: insilmaril@233: \begin{appendix} insilmaril@233: insilmaril@291: \section{Starting \vym} insilmaril@291: \subsection{Path to ressources} insilmaril@291: \vym will try to find its ressources (images, stylesheets, filters, insilmaril@291: etc.) in the following places: insilmaril@291: \begin{enumerate} insilmaril@291: \item Path given by the environment variable {\tt VYMHOME}. insilmaril@291: \item If called with the local option (see \ref{options} below), insilmaril@291: \vym will look for its data in the current directory. insilmaril@291: \item {\tt /usr/share/vym} insilmaril@291: \item {\tt /usr/local/share/vym} insilmaril@291: \end{enumerate} insilmaril@291: insilmaril@291: \subsection{Command line options} \label{options} insilmaril@264: \vym has the following options: insilmaril@264: \begin{center} insilmaril@264: \begin{tabular}{ccp{8cm}}\\ insilmaril@264: \bf Option & \bf Comment & \bf Description \\ \hline insilmaril@264: v & version & Show version ov \vym\\ insilmaril@264: l & local & Use local paths to stylesheets, translations, icons, insilmaril@264: etc. instead of system paths. Useful for testing\\ insilmaril@264: h & help & Show help\\ insilmaril@264: q & quit & Quit immediatly after startup. Useful for benchmarks.\\ insilmaril@264: \end{tabular} insilmaril@264: \end{center} insilmaril@264: You can also give several filenames at the commandline to let \vym open insilmaril@264: several maps at once. insilmaril@264: insilmaril@233: \section{Contributing to \vym} insilmaril@260: So far I'd say I have written 98\% of the code on my own. No surprise, insilmaril@260: that \vym exactly fits my own needs. Nevertheless I would like to insilmaril@260: encourage all users of \vym to contribute. Maybe not only with feature insilmaril@260: requests, but also with code, new import/export filters, translations insilmaril@260: etc. In this appendix I'll try to show how easy it is to expand the insilmaril@260: things you can do already with \vym. I really look forward to hear from insilmaril@260: you! insilmaril@233: insilmaril@233: \subsection{Getting help} insilmaril@233: insilmaril@233: \subsubsection*{Frequently asked questions} insilmaril@233: Please refer to the FAQ available on the \vym website: insilmaril@125: \begin{center} insilmaril@125: \href{http://www.InSilmaril.de/vym/faq.html}{http://www.InSilmaril.de/vym/faq.html} insilmaril@125: \end{center} insilmaril@105: insilmaril@233: \subsubsection*{Mailinglists} insilmaril@233: There are two mailinglists: {\tt vym-forum} is the \vym users forum to insilmaril@233: discuss various questions, while {\tt vym-devel} is intended for people insilmaril@233: interested in contributing to \vym. You can view the archives and insilmaril@233: subscribe at insilmaril@233: \begin{center} insilmaril@233: \href{https://sourceforge.net/mail/?group_id=127802}{https://sourceforge.net/mail/?group\_id=127802} insilmaril@233: \end{center} insilmaril@233: insilmaril@264: \subsubsection*{Contacting the author}\label{author} insilmaril@233: Especially for support questions please try the mailinglists first. If insilmaril@233: everything else fails you can contact the Uwe Drechsel at insilmaril@233: \begin{center} insilmaril@260: \href{mailto:vym@InSilmaril.de}{vym@InSilmaril.de} insilmaril@233: \end{center} insilmaril@233: insilmaril@233: insilmaril@264: insilmaril@264: \subsection{How to report bugs} insilmaril@264: Though Sourceforge has its own bugreporting system, I'd rather prefer if insilmaril@264: you contact me directly (see \ref{author}) or even better: You can file insilmaril@264: a bugreport in Bugzilla, the bugtracking system of openSUSE: insilmaril@264: \begin{center} insilmaril@264: \href{http://en.opensuse.org/Submit_a_bug}{http://en.opensuse.org/Submit\_a\_bug} insilmaril@264: \end{center} insilmaril@264: I build \vym regulary for openSUSE, so you may report it against a insilmaril@264: recent version there, even if you use another Operating System. insilmaril@264: Please don't forget to tell insilmaril@264: \begin{itemize} insilmaril@264: \item the exact steps needed to reproduce the bug insilmaril@264: \item the version and build date of \vym (see the Help \ra About insilmaril@264: \vym) insilmaril@264: \item hardware and Operating System insilmaril@264: \end{itemize} insilmaril@264: insilmaril@233: \subsection{Compiling from the sources} insilmaril@252: \subsubsection{Getting the sources} \label{getsources} insilmaril@252: You find the latest version of \vym at the project site: insilmaril@252: \begin{center} insilmaril@252: \href{https://sourceforge.net/projects/vym/}{https://sourceforge.net/projects/vym/} insilmaril@252: \end{center} insilmaril@252: There you can check them out of the source repository (CVS):\\ insilmaril@233: insilmaril@252: \begin{verbatim} insilmaril@252: cvs -d:pserver:anonymous@cvs.sf.net:/cvsroot/vym checkout code insilmaril@252: \end{verbatim} insilmaril@252: insilmaril@252: \subsubsection{The Qt toolkit} insilmaril@233: Qt is C++ toolkit for multiplatform GUI and application development. It insilmaril@233: provides single-source portability across MS~Windows, Mac~OS~X, Linux insilmaril@233: ans all major commercial Unix variants. Qt is also available for insilmaril@252: embedded devices. Qt is a Trolltech product. For more information see insilmaril@252: \begin{center} insilmaril@233: \href{http://www.trolltech.com/qt/}{www.trolltech.com/qt} insilmaril@252: \end{center} insilmaril@233: insilmaril@233: insilmaril@252: \subsubsection{Compiling \vym } insilmaril@233: Make sure you have installed your Qt environment properly, see the Qt insilmaril@233: documentation for details. You need to have the Qt command {\tt qmake} insilmaril@233: in your {\tt PATH}-environment, then run insilmaril@233: \begin{verbatim} insilmaril@233: qmake insilmaril@233: make insilmaril@233: make install insilmaril@233: \end{verbatim} insilmaril@233: The last command {\tt make install} needs root-permissions. Of course it insilmaril@233: may be omitted, if you just want to test \vym. insilmaril@233: insilmaril@260: %\subsubsection*{Compiling \vym on Macs} insilmaril@260: %TODO insilmaril@233: insilmaril@233: \subsection{\vym file format} \label{fileformat} insilmaril@233: \vym maps usually have the postfix "{\tt .vym}" and represent a insilmaril@233: compressed archive of data. If you want to have a insilmaril@233: closer look into the data structure map called "mapname.vym", insilmaril@233: just uncompress the map manually using insilmaril@233: \begin{verbatim} insilmaril@233: unzip mapname.vym insilmaril@233: \end{verbatim} insilmaril@233: This will create directories named {\tt images} and {\tt flags} in your insilmaril@233: current directory and also the map itself, usually named {\tt insilmaril@233: mapname.xml}. insilmaril@233: The XML structure of \vym is pretty self explaining, just have a look at insilmaril@233: {\tt mapname.xml}. insilmaril@233: insilmaril@233: This XML file can be loaded directly into \vym, it does not have to be insilmaril@233: compressed. If you want to compress all the data yourself, use insilmaril@233: \begin{verbatim} insilmaril@233: zip -r mapname.vym . insilmaril@233: \end{verbatim} insilmaril@233: to compress all data in your current directory. insilmaril@233: insilmaril@233: \subsection{New features} insilmaril@28: There are lots of features which might find their way into \vym. insilmaril@233: Together with \vym you should have received a directory with several insilmaril@28: maps e.g. on SUSE~LINUX this is insilmaril@28: \begin{center} insilmaril@28: {\tt /usr/share/doc/packages/vym/demos} insilmaril@28: \end{center} insilmaril@28: where you find the map {\tt todo.vym}. It lists quite a lot of things to insilmaril@233: be done in future. If you have more ideas, contact the development team insilmaril@233: at insilmaril@233: {\tt vym-devel@lists.sourceforge.net}. insilmaril@28: insilmaril@28: insilmaril@233: \subsection{New languages support} insilmaril@252: In order to add a new language to \vym you need insilmaril@252: the sources (see \ref{getsources}) and insilmaril@252: an installation of Trolltechs QT. A part of QT are the development insilmaril@252: tools, from those tools especially the translation tool "Linguist" is insilmaril@252: needed. insilmaril@252: insilmaril@252: In some Linux distributions the development tools are in an extra package, e.g. on SUSE LINUX you should have installed: insilmaril@252: \begin{verbatim} insilmaril@252: qt3-devel.rpm insilmaril@252: qt3-devel-doc.rpm insilmaril@252: qt3-devel-tools.rpm insilmaril@252: qt3-man.rpm insilmaril@252: \end{verbatim} insilmaril@252: If you don't have QT in your system, you can get it from insilmaril@252: \href{http://www.trolltech.com}{http://www.trolltech.com} Once you insilmaril@252: are able to compile vym yourself, you can translate the text in vym insilmaril@252: itself by performing the following steps: insilmaril@252: \begin{itemize} insilmaril@252: \item Let's assume now your encoding is "NEW" instead of for example insilmaril@252: "de" for german or "en" for english insilmaril@252: insilmaril@252: \item Copy the file {\tt lang/vym\_en.ts} to l{\tt ang/vym\_NEW.ts} (The code insilmaril@252: itself contains the english version.) insilmaril@252: insilmaril@252: \item Add {\tt lang/vym\_NEW.ts} to the TRANSLATIONS section of vym.pro insilmaril@252: insilmaril@252: \item Run Linguist on {\tt vym\_NEW.ts} and do the translation insilmaril@252: insilmaril@252: \item Run {\tt lrelease} to create {\tt vym\_NEW.qm} insilmaril@252: insilmaril@252: \item Do a make install to install the new vym and check your translation insilmaril@252: \end{itemize} insilmaril@252: insilmaril@252: If you feel brave, you can also translate the manual. It is written in insilmaril@252: LaTeX, you just have to change the file tex/vym.tex. (Linguist and QT insilmaril@252: are not needed, but it is useful to know how to work with LaTeX and esp. insilmaril@252: pdflatex to create the PDF.) insilmaril@252: insilmaril@252: Please mail me every translation you have done. I can also give you a insilmaril@252: developer access to the project, if you want to provide translations insilmaril@252: regulary. insilmaril@252: insilmaril@233: \subsection{New export/import filters} insilmaril@252: \vym supports various kinds of filters. Data can be written directly, insilmaril@252: inserted into templates or it can be written as XML data and then insilmaril@252: processed by XSL transformations. insilmaril@252: insilmaril@252: Most of the import/export functionality is available in the classes insilmaril@252: ImportBase and ExportBase and subclasses. All of them can be found in insilmaril@252: {\tt imports.h} and {\tt exports.h}. insilmaril@252: insilmaril@264: \subsubsection*{Direct import/export} insilmaril@252: An example for a direct export is the XML export. This method touches insilmaril@252: the implementation of nearly every object of \vym, so whenever possible insilmaril@264: you should better use a XSL transformation instead. insilmaril@252: insilmaril@252: If you still want to know how it is done, start looking at insilmaril@252: {\tt MapEditor::saveToDir} in {\tt mapeditor.cpp}. insilmaril@252: insilmaril@264: \subsubsection*{Templates} insilmaril@264: Templates have been introduced to export to opendoc format used e.g. by insilmaril@264: Open~Office. While I read the spec ($>$ 500 pages) about the format\footnote{ insilmaril@264: \href{http://www.oasis-open.org/}{http://www.oasis-open.org/}}\ insilmaril@264: I had the feeling that I did not want to write the export from scratch. insilmaril@264: It would be too complex to adapt the styles to your own wishes, e.g. the insilmaril@264: layout. insilmaril@252: insilmaril@264: Instead I analyzed existing Open~Office documents. I found out that insilmaril@264: there are lots of redundant bits of information in a standard insilmaril@264: presentation, for example each list item is contained in its own list. insilmaril@264: In the end I came up with the default presentation style, which still insilmaril@264: could be simplified, just in case you have free time\ldots insilmaril@252: insilmaril@264: The existing templates are still work in progress, before you spent too insilmaril@264: much time developing your own style, please contact me. Basically the insilmaril@264: following steps are needed to build your own style: insilmaril@264: \begin{enumerate} insilmaril@264: \item Create an example in Open Office. Use a title, authors name, insilmaril@264: page heading etc.\ which you can easily grep for in the output file. insilmaril@264: insilmaril@264: \item Unzip the Open Office document into a directory. insilmaril@264: insilmaril@264: \item The main file is called {\tt content.xml}. All data is in one insilmaril@264: single line. You can split the XML tags using the script {\tt insilmaril@264: scripts/niceXML}, which is part of the \vym distribution. insilmaril@264: insilmaril@264: \item Copy the output of {\tt niceXML} to {\tt insilmaril@264: content-template.xml}. insilmaril@264: insilmaril@264: \item Looking closer you will find lots of unused definitions, for insilmaril@264: example of styles. You can delete or simply ignore them. insilmaril@264: insilmaril@264: \item Try to find your title, authors name. \vym will replace the insilmaril@264: following strings while exporting: insilmaril@264: \begin{center} insilmaril@264: \begin{tabular}{lp{4cm}} insilmaril@264: {\tt } & title of map \\ insilmaril@264: {\tt } & author \\ insilmaril@264: {\tt } & comment \\ insilmaril@264: {\tt } & content of map \\ insilmaril@264: \end{tabular} insilmaril@264: \end{center} insilmaril@264: The content itself is generated in a similar way by inserting lists insilmaril@264: into {\tt page-template}. Here the following substitutions are made: insilmaril@264: \begin{center} insilmaril@264: \begin{tabular}{lp{7cm}} insilmaril@264: {\tt } & heading of a page insilmaril@264: (mainbranch or child of mainbranch, depending on the use of insilmaril@264: sections) \\ insilmaril@264: {\tt } & all childs of the branch above \\ insilmaril@264: \end{tabular} insilmaril@264: \end{center} insilmaril@264: \end{enumerate} insilmaril@264: Currently images are exported and notes just will appear as text insilmaril@264: without formatting and colors. insilmaril@264: insilmaril@264: insilmaril@264: insilmaril@264: insilmaril@264: \subsubsection*{XSL Transformation} insilmaril@264: \vym uses XSL transformations while exporting (e.g. XHTML) and importing insilmaril@264: data (e.g. KDE bookmarks). There is a little code needed to provide the insilmaril@264: GUI, the rest is done using the {\tt .xsl} stylesheet and calling the insilmaril@264: {\tt xsltproc} processor, which is part of libxslt, the XSLT insilmaril@264: C library for GNOME. insilmaril@233: insilmaril@233: \end{appendix} insilmaril@233: \end{document} insilmaril@28: insilmaril@125: %TODO insilmaril@125: %\subsubsection{Menus} insilmaril@125: %\subsubsection{Keyboard shortcuts} insilmaril@125: %Where does vym save its settings? -> ~/.qt/vymrc insilmaril@125: insilmaril@28: insilmaril@28: % INDEX insilmaril@28: % mapeditor insilmaril@28: % noteditor insilmaril@28: % branch insilmaril@28: % mapcenter insilmaril@28: % heading insilmaril@28: % flag insilmaril@28: % orientation insilmaril@28: % zoom insilmaril@28: % orientation insilmaril@28: % Toolbar insilmaril@28: % Zoom insilmaril@28: % Find insilmaril@28: % statusbar insilmaril@28: % link insilmaril@28: % mainbranch insilmaril@28: % subtree insilmaril@28: % reorder insilmaril@28: % scroll insilmaril@28: % fold insilmaril@104: % vymlink insilmaril@104: % xlink insilmaril@125: % modMode insilmaril@104: % context menu insilmaril@104: % Mac OS X insilmaril@28: insilmaril@28: insilmaril@28: insilmaril@125: \end{document}