diff -r b7447adddc9a -r f4aae4fdc1bc tex/vym.tex
--- a/tex/vym.tex Wed Jan 10 13:26:12 2007 +0000
+++ b/tex/vym.tex Wed Apr 25 16:02:54 2007 +0000
@@ -32,9 +32,9 @@
\begin{document}
\title{
- \includegraphics[width=8cm]{vym-logo-new.png}
+ \includegraphics[width=8cm]{images/vym-logo-new.png}
\\
-VYM \\ -- \\View Your Mind\\ {\small Version 1.8.0}}
+VYM \\ -- \\View Your Mind\\ {\small Version 1.8.71}}
\author{\textcopyright Uwe Drechsel }
@@ -50,7 +50,7 @@
\subsection{What is a \vym map?}
A \vym map (in short words {\em map}) is a tree like structure:
\begin{center}
- \includegraphics[width=12cm]{example1.png}
+ \includegraphics[width=12cm]{images/example1.png}
\end{center}
Such maps can be drawn by hand on a paper or flip chart and help to
structure your thoughts. While a tree like structure like above can be
@@ -152,7 +152,7 @@
notes, which are part of the map. Let's call them {\em mapeditor} and
{\em noteeditor}:
\begin{center}
- \includegraphics[width=8cm]{windows.png}
+ \includegraphics[width=8cm]{images/windows.png}
\end{center}
Usually you will work in the {\em mapeditor} by just adding new
branches, moving around and reordering them. The various ways to do this
@@ -190,7 +190,7 @@
mapcenter has {\em branches} just like the trunk of a tree. Each branch
in turn may have branches again.
\begin{center}
- \includegraphics[width=10cm]{branches.png}
+ \includegraphics[width=10cm]{images/branches.png}
\end{center}
We will call a branch directly connected to the mapcenter a {\em
mainbranch}, because it determines the position of all its child
@@ -203,7 +203,7 @@
In the toolbar above the mapeditor you see various symbols.
\begin{center}
- \includegraphics[width=8cm]{default-flags.png}
+ \includegraphics[width=8cm]{images/default-flags.png}
\end{center}
These are called {\em flags} and can be used to mark branches in the
map, e.g. if something is important or questionable.
@@ -215,6 +215,7 @@
versa. You can change this default behaviour in the settings menu.
%TODO add info about toolbars e.g. undo/redo, ...
+%TODO or reference to advanced editing undo/redo
\section{Mapeditor} \label {mapeditor}
\subsection{Start a new map}
@@ -268,7 +269,7 @@
\item from the menu View \ra Zoom
\item the toolbar buttons
\begin{center}
- \includegraphics[width=3cm]{zoom-buttons.png}
+ \includegraphics[width=3cm]{images/zoom-buttons.png}
\end{center}
\end{itemize}
The crossed magnifying lens resets the zoomed view to its original size.
@@ -278,7 +279,7 @@
With huge maps there is the need to have a
find function. Choose Edit \ra Find to open the Find Window:
\begin{center}
- \includegraphics[width=6cm]{find-window.png}
+ \includegraphics[width=6cm]{images/find-window.png}
\end{center}
The text you enter here will be searched in all the headings and also in
notes. Everytime you press the "Find"-button it will look for the next
@@ -349,7 +350,7 @@
\item selecting Edit \ra Move branch
\item clicking on the toolbar buttons:
\begin{center}
- \includegraphics[width=1.5cm]{move-buttons.png}
+ \includegraphics[width=1.5cm]{images/move-buttons.png}
\end{center}
\end{itemize}
%tipp
@@ -366,7 +367,7 @@
\item use the menu and choose e.g Format \rq Set Color
\item use the toolbar
\begin{center}
- \includegraphics[width=3cm]{color-buttons.png}
+ \includegraphics[width=3cm]{images/color-buttons.png}
\end{center}
\end{itemize}
The first button (black in the graphic above) shows the actual color.
@@ -391,7 +392,7 @@
left or the right side of the window or even detach them. Just grab the
very left "dotted" part of the toolbar with your left-mouse button.)
\begin{center}
- \includegraphics[width=8cm]{default-flags.png}
+ \includegraphics[width=8cm]{images/default-flags.png}
\end{center}
If you have a branch selected, you can set any number of flags by
clicking them in the toolbar. The toolbar buttons change their state and
@@ -510,7 +511,7 @@
The browser can be changed in the Settings Menu.}
will be started.
\begin{center}
- \includegraphics[width=0.5cm]{flag-url.png}
+ \includegraphics[width=0.5cm]{images/flag-url.png}
\end{center}
For more information on working with bookmarks and webbrowsers see
section \ref{bookmarks}.
@@ -521,7 +522,7 @@
Enter \vym link". A file dialog opens where you can choose the map. A
branch with a link is marked with
\begin{center}
- \includegraphics[width=0.5cm]{flag-vymlink.png}
+ \includegraphics[width=0.5cm]{images/flag-vymlink.png}
\end{center}
Clicking this flag in the toolbar or in the context menu of a branch
will open the map in another tab (see \ref{tabs} for working with
@@ -558,7 +559,7 @@
cooking recipe, or the whole source code of a software project, you can
use the noteeditor.
\begin{center}
- \includegraphics[width=8cm]{noteeditor.png}
+ \includegraphics[width=8cm]{images/noteeditor.png}
\end{center}
This editor displays text associated to a branch selected in the
mapeditor. To visualize that there maybe is no text yet, the noteeditor
@@ -577,7 +578,7 @@
information for a particular branch, a little note flag will appear next
to the heading of the branch. See the lower branch on the right side:
\begin{center}
- \includegraphics[width=8cm]{branches-flags.png}
+ \includegraphics[width=8cm]{images/branches-flags.png}
\end{center}
\subsection{Import and export notes}
@@ -616,7 +617,7 @@
Both fonts can easily switched using the following symbol from the
toolbar:
\begin{center}
- \includegraphics[width=0.5cm]{formatfixedfont.png}
+ \includegraphics[width=0.5cm]{images/formatfixedfont.png}
\end{center}
In the Settings menu both fonts can be set and also which font should be
used for default.
@@ -682,7 +683,7 @@
To achieve this you can "hide" parts of the map during exports by
setting the "hide in export" flag.
\begin{center}
- \includegraphics[width=0.5cm]{flag-hideexport.png}
+ \includegraphics[width=0.5cm]{images/flag-hideexport.png}
\end{center}
You can toggle this flag in the toolbar or by pressing \key{H}.
Note that there is a global option in the settings menu to toggle the
@@ -699,7 +700,7 @@
you get a file dialogue where you can choose the output file and the
file type:
\begin{center}
- \includegraphics[width=12cm]{export-oo.png}
+ \includegraphics[width=12cm]{images/export-oo.png}
\end{center}
The file types represent various templates, which can be created with
some manual work from an existing Open Office document. The structure of
@@ -804,6 +805,19 @@
\subsection{Changing the history: Undo and Redo}
%FIXME
+\subsection{Macros} \label{macros}
+Macros have been added to \vym in version~1.9.0. Each function key
+\key{F1} to \key{F12} holds a macro, which is executed on the current
+selection if the key is pressed. The default macros change the color of
+a subtree or set the frame of a branch:
+\begin{center}
+ \includegraphics[width=8cm]{images/macros.png}
+\end{center}
+Each macro is a \vym script, which is executed when the associated key
+is pressed. The default location of the scripts can be changed in the
+Settings menu. More information on using scripts in \vym is found in
+appendix~\ref{scripts}.
+
\subsection{How to deal with Bookmarks} \label{bookmarks}
\subsubsection*{Open new tabs instead of new windows}
If you use konqueror as browser, \vym will remember the konqueror which
@@ -848,7 +862,7 @@
The image ist still positioned relatively to its parent branch, but the
heading and border of the branch adapt to the floating image, see below:
\begin{center}
- \includegraphics[width=11cm]{includeImages.png}
+ \includegraphics[width=11cm]{images/includeImages.png}
\end{center}
\subsection{Modifier Modes}
@@ -862,7 +876,7 @@
it. For the behaviour of the \key{Ctrl} modifier there are several
options, which can be set from the modifier toolbar:
\begin{center}
- \includegraphics[width=3cm]{modmodes.png}
+ \includegraphics[width=3cm]{images/modmodes.png}
\end{center}
The default is to copy the color from the clicked branch to the already
selected branch. In the toolbar shown above the default modifier is
@@ -878,8 +892,10 @@
mapcenter. This can be used e.g. for legends or a collection of vymLinks
pointing to other maps:
\begin{center}
- \includegraphics[width=9cm]{hiddenlink.png}
+ \includegraphics[width=9cm]{images/hiddenlink.png}
\end{center}
+Change hiding of the links in the property window (opened in context
+menu or with \key{CTRL-I} on the "links"-tab.
\subsection{XLinks} \label{xlinks}
@@ -892,7 +908,7 @@
can be crosslinked. In the graphics there is a link from a task (prepare
a presentation) to general information:
\begin{center}
- \includegraphics[width=12cm]{xlink.png}
+ \includegraphics[width=12cm]{images/xlink.png}
\end{center}
Note that a xLink which points to a branch that is not visible (because
it is scrolled), is just show as a little horizontal arrow. In the
@@ -1000,18 +1016,27 @@
\subsection{Command line options} \label{options}
\vym has the following options:
\begin{center}
-\begin{tabular}{ccp{8cm}}\\
-\bf Option & \bf Comment & \bf Description \\ \hline
-v & version & Show version ov \vym\\
-l & local & Use local paths to stylesheets, translations, icons,
- etc. instead of system paths. Useful for testing\\
-h & help & Show help\\
-q & quit & Quit immediatly after startup. Useful for benchmarks.\\
+\begin{tabular}{cccp{8cm}}\\
+\bf Option & \bf Comment & \bf Argument & \bf Description \\ \hline
+v & version & & Show version ov \vym\\
+l & local & & Use local paths to stylesheets, translations, icons,
+ etc. instead of system paths. Useful for testing\\
+h & help & & Show help\\
+r & run & filename & Run script\\
+q & quit & & Quit immediatly after startup. Useful for benchmarks.\\
\end{tabular}
\end{center}
You can also give several filenames at the commandline to let \vym open
several maps at once.
+
+ \section{Scripts} \label{scripts}
+ %FIXME
+
+
+
+
+
\section{Contributing to \vym}
So far I'd say I have written 98\% of the code on my own. No surprise,
that \vym exactly fits my own needs. Nevertheless I would like to
@@ -1099,7 +1124,7 @@
may be omitted, if you just want to test \vym.
%\subsubsection*{Compiling \vym on Macs}
-%TODO
+%FIXME
\subsection{\vym file format} \label{fileformat}
\vym maps usually have the postfix "{\tt .vym}" and represent a