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