\usepackage{hyperref}
\usepackage{graphicx}
+%https://de.overleaf.com/learn/latex/Code_listing
+\usepackage{listings}
+\lstdefinestyle{mystyle}{
+ backgroundcolor=\color{backcolour},
+ commentstyle=\color{codegreen},
+ keywordstyle=\color{magenta},
+ numberstyle=\tiny\color{codegray},
+ stringstyle=\color{codepurple},
+ basicstyle=\ttfamily\tiny,
+ breakatwhitespace=false,
+ breaklines=true,
+ captionpos=b,
+ keepspaces=true,
+ numbers=left,
+ numbersep=5pt,
+ showspaces=false,
+ showstringspaces=false,
+ showtabs=false,
+ tabsize=2
+}
+
\setlength{\headheight}{0cm}
\setlength{\headsep}{0cm}
\setlength{\topskip}{0cm}
\setlength{\parindent}{0cm}
\setlength{\oddsidemargin}{0cm}
\setlength{\textwidth}{16cm}
-\setlength{\textheight}{27cm}
+\setlength{\textheight}{25cm}
\newlength{\maximgwidth}
\setlength{\maximgwidth}{14cm}
\newenvironment{code}[1] { \verbatim #1}{\endverbatim }
+\pagestyle{plain}
+\pagenumbering{arabic}
+
\hypersetup{bookmarks, bookmarksopen,
pdftitle={VYM - a tool for visual thinking },
pdfauthor={Uwe Drechsel},
colorlinks={true},
linkcolor={blue},
urlcolor={green},
- citecolor={red}}
+ citecolor={red}}
+
\begin{document}
\title{
\includegraphics[width=8cm]{images/vym-logo-new.png} \\
VYM -- View Your Mind \\
- {\small Version 2.6.3} \\
- {\b Usermanual }
+ {\small Version 2.9.0} \\
+ { Usermanual }
\author{\textcopyright Uwe Drechsel }
}
\item {\em Peter Adamson} for lots of feedback and proofreading of my
far from perfect english
\item The team of {\em AClibre (Academia y Conocimiento Libre)}
- in Colombia for their translation of
+ in Colombia for their initial translation of
the manual to spanish:
\begin{center}
\begin{tabular}{|p{7cm}|p{5.5cm}|} \hline
%TODO
\subsection{Internet Ressources}
+There are a few tutorial vides on youtube:
+\begin{itemize}
+ \item Youtube:
+ \href{https://www.youtube.com/c/ViewYourMind}{https://www.youtube.com/c/ViewYourMind}
+\end{itemize}
A good starting point to learn more about Mindmaps in general is Wikipedia:
\begin{itemize}
\item English:
+
+\newpage
\section{The Concept of the \vym application}
%FIXME-3 maybe add a general introduction here...
\subsection{The Mainwindow and its satellites} \label{satellite}
\vym comes with several windows, the central one is called {\em
mainwindow}. It contains one or more
-tabs, each of these tabs has a {\em mapeditor} and optionionally a {\em
+tabs, each of these tabs has a {\em mapeditor} and optionally a {\em
tree editor}, representing a different view of the same data:
\maximage{images/mainwindow.png}
The (currently visible) main areas of the mainwindow are the {\em tree
Here is a list of the available satellite windows, the {\em dockable}
feature is explained in next section \ref{dockable}:
\begin{itemize}
- \item
- Branch Property Window (see section \ref{propwindow})
- \item
- \includegraphics[width=0.5cm]{../icons/find.png}
- Find window to search for text (dockable)
- \item
- \includegraphics[width=0.5cm]{../icons/headingeditor.png}
- Heading editor (dockable, features are the same as in the
- noteeditor, see section \ref {noteeditor})
- \item
- \includegraphics[width=0.5cm]{../icons/history.png}
- Historywindow (see section \ref{historywindow})
- \item
- \includegraphics[width=0.5cm]{../flags/flag-note.png}
- Noteeditor (dockable, see section \ref {noteeditor})
- \item
- \includegraphics[width=0.5cm]{../icons/scripteditor.png}
- Scripteditor (dockable, see section \ref {scripteditor})
- \item
- \includegraphics[width=0.5cm]{../icons/slideeditor.png}
- Slideeditor (dockable, see section \ref {slideeditor})
- \item
- \includegraphics[width=0.5cm]{../icons/taskeditor.png}
- Taskeditor (dockable, see section \ref {taskeditor})
+ \item Branch Property Window (see section \ref{propwindow})
+ \item \includegraphics[width=0.5cm]{../icons/find.png}
+ Find window to search for text (dockable)
+ \item \includegraphics[width=0.5cm]{../icons/headingeditor.png}
+ Heading editor (dockable, features are the same as in the
+ noteeditor, see section \ref {noteeditor})
+ \item \includegraphics[width=0.5cm]{../icons/history.png}
+ Historywindow (see section \ref{historywindow})
+ \item \includegraphics[width=0.5cm]{images/flags/system/note.png}
+ Noteeditor (dockable, see section \ref {noteeditor})
+ \item \includegraphics[width=0.5cm]{../icons/scripteditor.png}
+ Scripteditor (dockable, see section \ref {scripteditor})
+ \item \includegraphics[width=0.5cm]{../icons/slideeditor.png}
+ Slideeditor (dockable, see section \ref {slideeditor})
+ \item \includegraphics[width=0.5cm]{../icons/taskeditor.png}
+ Taskeditor (dockable, see section \ref {taskeditor})
\end{itemize}
\subsection{Dockable windows} \label{dockable}
The text you enter here will be searched in all the
branch headings and also in the associated notes. Just click on one of
the results shown to select the found heading or an occurance in a note.
-In above example we searched for \lq opensuse\rq, which had a number of
-occurences in this map, e.g. in the note of \lq HowTo check into in
-editors on Factory\rq\ branch.
+In above example we searched for "opensuse", which had a number of
+occurences in this map, e.g. in the note of "HowTo check into in
+editors on Factory"\ branch.
Press \key{CTRL+F} again to hide the widget once it's no longer needed.
Or you could also undock it (see \ref{dockable}).
flag from a branch, select the branch and then click the highlighted
flag on the toolbar.
-At present \vym uses two kinds of flags: {\em System Flags} and {\em
-Standard Flags}. The standard flags are those shown in the toolbar.
-System flags are set by \vym to indicate e.g. that there is additional
-information in a note (more on this in \ref{noteeditor}). Later versions
-of \vym may have another kind of flags, which may be edited by the user.
+\vym uses three kinds of flags:
+\begin{itemize}
+ \item {\em System Flags}
+ are set by \vym to indicate e.g. that there is additional
+ information in a note (more on this in \ref{noteeditor}) or
+ that there is a task associated (see the \ref{taskeditor})
+ \item {\em Standard Flags}
+ \item {\em User Flags}
+\end{itemize}
+Standard flags can be toggled by clicking in the toolbar
+ \maximage{images/default-flags.png}
+User flags are similar, but can be added to their own toolbar when clicking the edit icon
\subsubsection*{Images}
The easiest way to add an image to a branch is by dragging it e.g. from a
make working with the map much more complex if e.g. images could be
linked to images.
-The option \lq{\bf Use for export} \rq controls the output of exports
+The option "{\bf Use for export}" controls the output of exports
e.g. to HTML: If set to no, the image won't appear in the {\em text}
part of the output. This is useful for large images or if images are
used as a kind of frame e.g. the famous cloud symbol around a part of
\subsubsection*{Background }
The colour is set (and also displayed) as "Set background colour".
-Alternatevily you can set an background image, though this is not
+Alternativily you can set a background image, though this is not
recommended in general. Working on the map becomes slow and the image
currently cannot be positioned freely.
\begin{center}
\includegraphics[width=0.5cm]{images/flag-url.png}
\end{center}
- A special type of URLs are those pointing to Novell Bugzilla, they have
- the Bugzilla bug instead of the globe:
- \begin{center}
- \includegraphics[width=0.5cm]{images/flag-url-bugzilla-novell.png}
- \end{center}
- \vym even can get data from Novell Bugzilla, for details see
- \ref{bugzilla}.
-
\item \vym maps, viewed in \vym itself. References are called
a {\em vymlinks} and marked with the \vym flag:
Use one of the following:
\begin{itemize}
\item{Drag and drop URL from a webbrowser}
-\item{Use the "URLs and vymlinks toolbal:}
+\item{Use the "URLs and vymlinks toolbar:}
\begin{center}
\includegraphics[width=0.5cm]{images/flag-urlnew.png}
\end{center}
For more information on working with bookmarks and webbrowsers see
section \ref{bookmarks}.
-If support for Bugzilla is enabled (see \ref{bugzilla}), all Bugzilla
-references in a subtree can be updated automatically e.g. by pressing
-\key{CTRL-B}.
-
+If your \vym installation supports accessing external tools like JIRA or
+Confluence, \vym might update the branch after retrieving information
+from the tool, e.g. replacing the complete URL of a Confluence by its
+concrete page name.
\subsubsection{How to create a vymlink}
Creation is possible both from the "URLs and vymlinks" toolbar or from
the context menu of a branch:
Once you are done adding new items, you can start to sort them and
arrange them by moving and relinking them to create a new map.
-\hint{If you have enabled \lq Automatic Layout\rq\ in the Settings menu,
+\hint{If you have enabled "Automatic Layout"\ in the Settings menu,
the new parts will move around to avoid overlapping}
%TODO
\subsection{States}
Before you can type or paste text into it, you have
-to select a branch in the mapeditor. Note that the background colour\footnote{
-The backround colours can be changed in settings, e.g. if you use a dark
-theme and don't want to see a bright background in the editor}
-of the noteeditor indicates its state:
-\begin{itemize}
- \item grey: no text entered yet
- \item white: some text has been entered
-\end{itemize}
-In the mapeditor itself, to signal that there is a note with more
-information for a particular branch, a little "note" flag will appear
-next to the heading of the branch. This is illustrated in the lower
+to select a branch in the mapeditor.
+In the mapeditor a little "notepad" flag will appear
+next to the heading of the branch, once you have entered some text in
+the noteeditor. This is illustrated in the lower
branch on the right hand side:
\maximage{images/branches-flags.png}
an email.
\section{Task editor} \label{taskeditor}
-Tasks are used to easily create and maintain a \lq Todo-list\rq.
+Tasks are used to easily create and maintain a "Todo-list".
The taskeditor is visible on the left side in the image below.
\begin{center}
\includegraphics[width=13cm]{images/taskeditor.png}
\end{center}
+The default columns in the taskeditor list are:
+\begin{itemize}
+ \item Delta: This value can be manually added to the priority to change the automated priorization
+ \item Status: Shows the state and if the task is currently sleeping
+% \item Age total: Days, since the task has been created
+% \item Age modified: Days, since the task has been changed
+% \item Sleep: Days, which will pass until task will wake up
+% \item Position of tasks branch in its subtree (higher priority if further up)
+ \item Flags: Lists flags, which affect the priority (see above)
+ \item The name of task (identical to heading of branch in the map)
+\end{itemize}
+Priorities can be adjusted manually in the taskeditor, either by entering a
+delta value or by dragging the task to a new position (more on priorities below).
+
+
\subsection{Creating tasks}
To create a task press \key{Shift + W}. The branch will get an
additional flag and its name will be visible in the taskeditor.
-A task can have three different states:
+A task can have different states:
\begin{itemize}
- \item Not started \includegraphics[width=0.5cm]{../flags/flag-task-new.png}
- \item Work in progress
- \includegraphics[width=0.5cm]{../flags/flag-task-wip.png}
- \item Finished
- \includegraphics[width=0.5cm]{../flags/flag-task-finished.png}
+ \item New task or just awakened task \includegraphics[width=0.5cm]{images/flags/system/task-new.png}
+ \item Not started \includegraphics[width=0.5cm]{images/flags/system/task-not-started.png}
+ \item Work in progress \includegraphics[width=0.5cm]{images/flags/system/task-wip.png}
+ \item Finished \includegraphics[width=0.5cm]{images/flags/system/task-finished.png}
\end{itemize}
You can cycle these states by pressing \key{W}.
-\subsection{Sleeping tasks for later reminders}
-A task may be set to \lq sleep\rq, which can be used to get a reminder
+\subsection{Reminders - let a task sleep for a while}
+A task may be set to "sleep", which can be used to get a reminder
after a certain amount of time. The flag will change to one of these:
\begin{itemize}
\item Not started - sleeping
- \includegraphics[width=0.5cm]{../flags/flag-task-new-sleeping.png}
+ \includegraphics[width=0.5cm]{images/flags/system/task-new-sleeping.png}
\item Work in progress - sleeping
- \includegraphics[width=0.5cm]{../flags/flag-task-wip-sleeping.png}
-\end{itemize}
-You can set the amount of days a task should sleep by right clicking on the task flag in the
-mapeditor or the task in the taskeditor. \lq Reset sleep\rq will wake up
-a currently sleeping task. These tasks will get a new flag and status
-in the taskeditor:
-\begin{itemize}
- \item Not started -
- morning\includegraphics[width=0.5cm]{../flags/flag-task-new-morning.png}
- \item Work in progress - morning
- \includegraphics[width=0.5cm]{../flags/flag-task-wip-morning.png}
+ \includegraphics[width=0.5cm]{images/flags/system/task-wip-sleeping.png}
\end{itemize}
-Additionally these poor tasks, which have just been woken up, will get a
-way higher priority, so that they pop up on top of your list in the
-taskeditor, see next section.
+You can set the sleep time of a task should right clicking on the task flag in the
+mapeditor or the task in the taskeditor. "Reset sleep" will wake up
+a currently sleeping task.
+
+Alternatively you can press \key{Shift-Q} and manually enter the sleep time, here are some examples:
+
+\begin{center}
+ \begin{tabular}{|c|p{11cm}|} \hline
+ {\bf Input } & {\bf Sleep} \\ \hline
+ 1 & 1 day, postpone until tomorrow morning\\
+ 365 & 365 days \\
+ 1w & 1 week \\
+ 3h & 3 hours \\
+ 10s & 10 seconds \\
+ 18:00 & Postpone until 6pm \\
+ 24.12.2024 & Postpone until Dec 24 in 2024 \\
+ 2024-12-24 & Postpone until Dec 24 in 2024 \\
+ 2038-12-24T21:34 & Postpone until December 24 in 2038, 9:34 pm (ISO format) \\ \hline
+ \end{tabular}
+\end{center}
+
+%These tasks will get a new flag and status
+%in the taskeditor:
+%\begin{itemize}
+% \item Not started - morning %\includegraphics[width=0.5cm]{../flags/flag-task-new-morning.png}
+% \item Work in progress - morning % \includegraphics[width=0.5cm]{../flags/flag-task-wip-morning.png}
+% \item New tasks - only show new freshly "woken up" tasks
+% \item Various filters for priorty flags
+% \includegraphics[width=0.5cm]{../flags/flag-arrow-up.png}
+% \includegraphics[width=0.5cm]{../flags/flag-2arrow-up.png}
+% \includegraphics[width=0.5cm]{../flags/flag-no-arrow-up.png}
+% \ldots
+%\end{itemize}
\subsection{Priority of tasks}
The tasks visible in the taskeditor are ordered by their {\em
-priorities}, listed on the left side of the editor. The lower(!) the
-priority, the more important is a task.
+priorities}, listed on the left side of the editor. The lower the
+priority number, the more important is a task: The most important task always has priority~1.
There are several principles that influence the priority of a task:
\begin{itemize}
\item
- Old tasks tend to bubble up: If you have a task named \lq water the
- flowers\rq\ and you have postponed it since 187 days, better delete
- the task. And create a new task to dump the remains of the flowers.
+ Old tasks tend to bubble up, meaning theyget a higher priority over
+ time. Rationale: If you have a task named "water the flowers"\ and
+ you have postponed it now for 187 days, better delete the task. (And
+ create a new task to dump the remains of the flowers.)
\item
- Colors in the map: If you use the Function keys to assigne the
- colors red, amber, green, etc. the tasks will get a different
- priority accordingly
+ Colors in the map: If you use the Function keys to assign the
+ colors red, amber, green, etc. the tasks will get a different
+ priority accordingly
\item
- The stopsign flag
- \includegraphics[width=0.5cm]{../flags/flag-stopsign.png}
- will increase the priority. Use it for your shipstoppers\ldots
+ The stopsign flag
+ \includegraphics[width=0.5cm]{images/flags/stopsign.png}
+ will increase the priority. Use it for your shipstoppers\ldots
\item
- Sleeping tasks and finished tasks will tend to fall to the bottom of
- your task list.
+ The arrow up flags also move tasks up in the list
+ %FIXME add flag
\item
- The freshly woken up \lq morning tasks\rq\ will tend to pop up right
- at the top, so that they cannot be missed. Remove the \lq
- morning\rq\
- state by pressing \key{W} once.
-\end{itemize}
+ Sleeping tasks and finished tasks will tend to fall to the bottom of
+ your task list.
-The priorities are calculated based on the next visible columns:
-\begin{itemize}
- \item Status: Shows the state and if the task is currently sleeping
- \item Age total: Days, since the task has been created
- \item Age modified: Days, since the task has been changed
- \item Sleep: Days, which will pass until task will wake up
- \item Position of tasks branch in its subtree (higher priority if
- further up)
-\end{itemize}
-Note that the priorities cannot be set manually, but e.g. you can reset
-the \lq Age modified\rq\ by pressing \key{W} three times to cycle
-through the states. Also the priorites are maintained for all currently
-opened maps, so if the top priority in your current map is a sleeping
-2034, then there is another open map, which certainly has a priority~1
-task.
-
-\subsection{Keeping the overview}
-The taskeditor has filters:
-\begin{itemize}
- \item Current map: Show only tasks from current active map
- \item Active tasks: Show only the tasks, which are neither finished
- nor sleeping
+ \item
+ The freshly woken up "morning tasks"\ will tend to pop up right
+ at the top, so that they cannot be missed. Remove the "morning"\ state by pressing \key{W} once.
\end{itemize}
+\subsection{Filter tasks - keeping the overview}
+The taskeditor has filters: %FIXME add flag icons
+\begin{center}
+ \begin{tabular}{|c|p{11cm}|} \hline
+ {\bf Icon} & {\bf Filter } \\ \hline
+ \includegraphics[width=0.4cm]{../icons/taskfilter-currentmap.png} &
+ Current map only, hide tasks from other maps \\
+ \includegraphics[width=0.4cm]{../icons/taskfilter-activetask.png} &
+ Active tasks only, hide finished nor sleeping \\
+ \includegraphics[width=0.5cm]{../icons/taskfilter-newtask.png} &
+ New tasks only \\
+ \includegraphics[width=0.4cm]{images/flags/arrow-up.png}
+ \includegraphics[width=0.4cm]{images/flags/arrow2-up.png} &
+ Tasks with "arrow up" flags only \\
+ \includegraphics[width=0.4cm]{../flags/system/no-arrow-up.png} &
+ Only tasks without "arrow up" flags \\ \hline
+ \end{tabular}
+\end{center}
+
\section{Slideeditor - presentations}\label{slideeditor}
\vym can be used to do animated presentations using the slideeditor as
\includegraphics[width=0.5cm]{../icons/down.png}
Move current slide down in slidedeck
\end{itemize}
+In the {\em View-menu} or it's toolbar you can also toggle the
+presentation mode to hide most of the toolbars and buttons
\section{Hello world - vym and other applications}
\subsection{Import} \label{import}
-\subsubsection*{Mind Manager}
+\subsubsection{Mozilla Firefox bookmarks}
+Currently \vym supports an experimental import of Firefox bookmarks:
+Firefox can backup bookmkarks in a file in JSON format. This file can be
+imported into an existing \vym map.
+
+Future \vym versions might be able to export this bookmark map again to JSON, so
+that it could be restored in Firefox.
+
+\subsubsection{Freemind and Freeplane}
+Freemind is no longer actively developed, the project is continued in
+the Freeplane project, see also
+\href{https://www.freeplane.org/}{https://www.freeplane.org/}.
+
+\vym supports reading the general structure of a Freeplane map and some
+of its flags. Also notes are read.
+
+\subsubsection{Mind Manager}
\vym has currently a very basic import filter to convert maps created by
{\em Mind Manager}\footnote{Mind Manager is a commercial i.e. non free,
software application by Mindjet for Windows and the Mac. Both names are
\end{itemize}
-\subsubsection*{Directory structure}
+\subsubsection{Directory structure}
\vym can read a directory structure. This is mainly for
testing \vym e.g. to easily create huge maps used for benchmarks (yes,
there is still room to optimize \vym ;-)
that there is a global option in the settings menu ( \ref{settings}) to
toggle the use of this flag. By default the flag is enabled.
-\subsubsection*{Last used format}
+\subsubsection{Last used format}
Repeats the last export action without further dialogs like asking for
directories. The associated export type and filepaths are stored within
the map and thus map specific. Note: Not all export types support this
feature yet.
-\subsubsection*{Image}
+\subsubsection{Image}
\vym supports all image formats which are natively supported by the
QT~toolkit:
BMP, JPEG, PBM, PGM, PNG, PPN, XPM, and XBM.
recommodation regarding quality and size of the image. \vym uses QTs
default options for compressing the images.
-\subsubsection*{PDF}
+\subsubsection{PDF}
Exports to Portable Document Format.
-\subsubsection*{SVG}
+\subsubsection{SVG}
Exports to Scalable Vector Graphics.
-\subsubsection*{Open Office}
+\subsubsection{Open Office}
Open Office beginning with version~2 uses the so called "Open Document
Format", which can be written by \vym. The options are currently
limited, but it possible to export presentations which can be opened in
Some of the templates make use of {\em sections} i.e sections insert the
headings of mainbranches as chapters for sections into the presentation.
-\subsubsection*{HTML (Webpages)}
+\subsubsection{HTML (Webpages)}
This is the format to use if you wish to create a webpage. To see an example
visit the \vym homepage:
\href{http://www.InSilmaril.de/vym}{www.InSilmaril.de/vym}
If set to yes, \vym will save above settings in the map.
\end{itemize}
-\subsubsection*{A \& O -- Achievements and Objectives}
+\subsubsection{A \& O -- Achievements and Objectives}
A specialized form of ASCII export (see next section), which is used for
workreports. Currently it is considered experimental.
%FIXME-3 Details
-\subsubsection*{ASCII}
+\subsubsection{ASCII}
Exporting a map as text is somewhat experimental at the moment. Later
this will probably be done using stylesheets. So the output may change
in future versions of \vym.
-\subsubsection*{CSV}
+\subsubsection{CSV}
Exports map into a Comma Separated Value file, which can be used to
import into all kinds spreadsheet software.
-\subsubsection*{Taskjuggler}
+\subsubsection{Taskjuggler}
Used to export to Taskjuggler project management software. Currently
considered experimental.
-\subsubsection*{\LaTeX}
+\subsubsection{\LaTeX}
\vym can generate an input file for \LaTeX. Currently this is considered
as experimental, there are no options (yet).
By selecting
/export/latex/sectionName-4=paragraph
\end{verbatim}
+\subsubsection{Markdown}
+Used to export to Markdown, see also
+\href{https://daringfireball.net/projects/markdown/}{https://daringfireball.net/projects/markdown/}
+Currently considered experimental.
+
+\subsubsection{OrgMode}
+Used to export to Emacs OrgMode, see also
+\href{https://orgmode.org/}{https://orgmode.org/}
+Currently considered experimental.
+
-\subsubsection*{XML} \label{xmlexport}
+\subsubsection{XML} \label{xmlexport}
The map is written into a directory both as an image and as an XML file.
The directory is set in a file dialog. If the directory is not empty,
you will be warned and offered choices if you are at risk of overwriting
on. This is useful if, for example, a website comprises several combined
maps that have to be stored in the same directory.
-\subsubsection*{Export a part of a map}
+\subsubsection{Export a part of a map}
Select a branch you want to export together with its children, then open
the context menu and choose {\em Save Selection}. This will create a
-file with the suffix {\tt .vyp}, which is an abbreviation for \lq vym
-part\rq.
+file with the suffix {\tt .vyp}, which is an abbreviation for "vym
+part".
+
+\subsection{Connect vym to the cloud} \label{cloud}
+Starting with \vym 2.8.16 some exchange with cloud applications is
+possible. So far this is limited to cloud applications from the company
+Atlassian\footnote{Atlassian, Confluence and JIRA are registered
+trademarks}. You find the related features and settings in the "Connect"
+settings in the menubar on top of the main window.
+\subsubsection{Confluence}
+\vym so far can
+\begin{itemize}
+ \item Get Confluence user name and insert it into map. (This will
+ create a link to the user profile during export to Confluence)
+ \item Export a map to a Confluence page
+ \item Get the name of a Confluence page and the space name and use
+ it as heading when pasting an URL. (Happens automatically, if
+ Confluence is configured)
+\end{itemize}
+\subsubsection{JIRA}
+\begin{itemize}
+ \item Get description of a JIRA ticket and use it as heading
+ \item Get additional information, e.g. color branch if ticket is
+ already closed
+\end{itemize}
+
+\subsection{Connect vym using DBUS}
+If you don't know what DBUS is, you probably want to skip this section,
+this is about remote controling \vym using the DBUS protocol on Linux.
+
+Currently this is used to
+\begin{itemize}
+ \item Run the development tests, see also
+
+ \href{https://github.com/insilmaril/vym/blob/develop/test/vym-test.rb}
+ {https://github.com/insilmaril/vym/blob/develop/test/vym-test.rb}
+ \item Add content from other applications, e.g. paste an email from
+ the mutt client, see also
+
+ \href{https://github.com/insilmaril/vym/blob/develop/scripts/vym-addmail.rb}
+ {https://github.com/insilmaril/vym/blob/develop/scripts/vym-addmail.rb}
+\end{itemize}
+For more details see also \ref{dbus}.
\section{Advanced usage}
below: \maximage{images/includeImages.png}
\subsection{Modifier Modes}
-Modifiers are for example the \key{Shift}- the \key{Ctrl}- ot the
-\key{Alt}-keys. When pressed while applying mouse actions, they will
-cause \vym to use a "modified" version of the action which usually would
-be done.
-
-%\key{Ctrl} or \key{Alt}is pressed while releasing the branch, it will be
-%added above/below the target, not as child of the target.
-
-Without a modifier key pressed, the first mouse click on a branch just selects
-it. For the behaviour of the \key{Shift} modifier there are several
-options, which can be set from the modifier toolbar:
+The modifier mode can be selected in the toolbar
\begin{center}
\includegraphics[width=3cm]{images/modmodes.png}
\end{center}
-The default mode is to copy the colour from the clicked branch to the
-already selected branch. The figure above shows the toolbar with the
-default modifier selected. If press both \key{Shift}~$+$~\key{Ctrl} only
-the selected branch will change color, instead of the whole subtree.
-
-The second modifier lets you create links between branches called {\em
-xLinks}. They will be explained in the next section \ref{xlinks}.
+or also using the adjacent keys \key{L}, \key{K} and \key{L}.
+The selected mode influences mouse behaviour when the \key{Shift}-modifier is
+used:
+\begin{itemize}
+ \item Multiple selection: Press Shift and click to select multiple objects
+ \item Colorpicker: Pick from another branch and apply to currently
+ selected branch
+ \item XLink: Draw a connecting XLink between two branches. See also
+ \ref{xlinks}
+ \item Move object: Move an object, but when releasing it over another one, do not relink.
+ (Useful for positioning branches in other branches for presentations.)
+ \item Move view: Only move view without selecting an object
+\end{itemize}
\subsection{Hide links of unselected objects} \label{hidelink}
Sometimes it would be useful to position a branch freely, just like a
\maximage{images/xlink-control.png}
Note that a xLink which points to a branch, that is not visible (because
it is scrolled), is just shown as a little horizontal arrow. In the
-image above have a look at the \lq Screenshot\rq\ branch.
+image above have a look at the "Screenshot"\ branch.
\subsubsection*{Create a xLink}
Choose the link mode from the modifier toolbar (by clicking the toolbar
\subsubsection*{Follow a xLink}
In a complex \vym map it sometimes comes in handy to be able to jump to
the other end of a xLink. You can do this by opening the context menu of
-the branch and clicking on \lq Goto xLink\rq and selecting the xLink you
+the branch and clicking on "Goto xLink" and selecting the xLink you
want to follow. Even easier is to click on the lower right end of a
branch -- a popup menu will show up with all xLinked branches. Click one
of them to jump to it.
between {\em Add Map (Insert)} and {\em Add Map (Replace)}: The imported
data will be added after the selected branch.
-\subsection{Connecting \vym with Bugzilla} \label{bugzilla}
-\vym can get data from SUSE Bugzilla, if you install an
-additional package. Make sure you have the ruby programming language and
-rubygems installed and get bicho\footnote{
- \href{http://rubygems.org/gems/bicho}{http://rubygems.org/gems/bicho} }:
-\begin{verbatim}
- gem install bicho
-\end{verbatim}
-
-Once you have the {\tt bicho} installed, you can just
-enter a bug\ ID into a heading and press \key{B}: \vym will create the
-URL from the ID and try to get the heading directly from Bugzilla.
-
-Also drag and drop of a URL from your webbrowser into \vym will trigger
-retrieving the data. You can can also update a subtree of Bugzilla URLs
-by pressing \key{Ctrl+B}.
-
-
\section{\vym on Mac OS X}
%FIXME-3 Currently not yet supported on Mac OS X in 1.13.x
your system.
\subsubsection*{Set application to open external links}
- Choose your favourite webbrowser here.
+ Choose your favourite application, this usually depends on your
+ platform, e.g.
+ \begin{enumerate}
+ \item Windows: {\tt explorer}
+ \item Linux: {\tt xdg-open} or {\tt mimeopen}
+ \item Mac: {\tt /usr/bin/open}
+ \end{enumerate}
+ Defaults should be set by \vym automatically.
\subsubsection*{Set path for macros}
Set the default search path for macros, which will be executed when
\end{enumerate}
\subsection{Command line options} \label{options}
-\begin{verbatim}
-Usage: vym [OPTION]... [FILE]...
-Open FILEs with vym
-
--b batch batch mode: hide windows
--c commands List all available commands
--d debug Show debugging output
--h help Show this help text
--l local Run with ressources in current directory
---locale locale Override system locale setting to select language
--n STRING name Set name of instance for DBus access
--q quit Quit immediatly after start for benchmarking
--r FILE run Run script
--R restore Restore last session
--s shortcuts Show Keyboard shortcuts on start
--sl LaTeX Show Keyboard shortcuts in LaTeX format on start
--t testmode Test mode, e.g. no autosave and changing of its setting
--v version Show vym version
-\end{verbatim}
+\lstinputlisting{help.tex}
You can also give several filenames at the commandline to let \vym open
several maps at once.
\section{Scripts} \label{scripts}
\subsection{Overview}
-Scripts within \vym are so far just a set of instructions, telling \vym
-what to do. Scripts are internally used for
+Beginning with version 2.7.0 \vym is fully scriptable, though the
+scripting support is still considered a {\em technical preview}. Some
+parts still might change and improve in later versions.
+Scripts are internally used for
\begin{itemize}
\item Undo and Redo
\item Macros on function keys
\item Slideshow
\end{itemize}
-So far the scripts have no loop constructs, conditionals, variables,
-etc. The good news: You can use external ruby scripts to get all that,
-see the examples in \ref{examplescripts}.
+In addition to the internal scriptengine, which is using QScript,
+you can also use external ruby scripts, which communicate with \vym via
+DBUS. Please note that the latter is currently only possible on Linux.
+See also the examples in \ref{examplescripts}.
The scripts within \vym are edited using the {\em script editor}:
\begin{center} \label{scripteditor}
\includegraphics[width=13cm]{images/scripteditor.png}
\end{center}
Open the scripteditor by pressing \key{Alt + S} or from the {\em
-View}-menu.
+View}-menu. The output of of scripts cans be seen in the script output
+window with \key{Alt + Shift + S}
\subsection{Example scripts} \label{examplescripts}
+A set of example scripts is installed together with \vym, see the
+installation directory and the subfolder {\tt demos/scripts/} and the
+macros in the macro tab of the script editor.
\subsubsection{Macro to create a rounded rectangle frame}
\begin{code}
-\# Macro F12
-setFrameType ("RoundedRectangle");
-setFramePadding (10);
-setFrameIncludeChildren (true);
+// Macro Shift + F1: Frame background light red
+function macro_shift_f1()
+{
+ map = vym.currentMap();
+ status = "Background off";
+ if (map.getFrameType() == "NoFrame") {
+ status = "Background light red";
+ }
+ toggle_frame ( map );
+ map.setFrameBrushColor("#ffb3b4");
+ statusMessage(status);
+}
\end{code}
\subsubsection{Batch script to export all maps as images}
\$ vym --quit --run export-image.vys *.vym
\end{code}
-\subsubsection{Full scripting using ruby and DBUS}
+\subsubsection{Full scripting using ruby and DBUS} \label{dbus}
Nearly every action in \vym can be controlled via DBUS (on Linux
machines). You can have several \vym instances running at the same time,
e.g. for production and development. Before controlling one, you need to
-give it a name, here \lq test\rq\ is used:
+give it a name, here "test"\ is used:
\begin{verbatim}
vym -n test
\end{verbatim}
\end{verbatim}
\subsection{Available commands}
-Start vym with the \lq command\rq\ option to get a listing of available
+Start vym with the "command"\ option to get a listing of available
commands:
\begin{verbatim}
vym --commands --quit
\subsection{How to report bugs}
-Though Sourceforge has its own bugreporting system, I'd rather prefer if
-you contact me directly (see \ref{author}) or even better: You can file
-a bugreport in Bugzilla, the bugtracking system of openSUSE:
+Please file bugs and issues in github:
\begin{center}
-\href{http://en.opensuse.org/Submit_a_bug}{http://en.opensuse.org/Submit\_a\_bug}
+ \href{ https://github.com/insilmaril/vym/issues}{https://github.com/insilmaril/vym/issues}
\end{center}
-I build \vym regulary for openSUSE, so you may report it against a
+
+I build \vym regulary for openSUSE and Windows, so you may report it against a
recent version there, even if you use another Operating System.
Please don't forget to tell me what you are using:
\begin{itemize}
\subsection{Compiling from the sources}
\subsubsection{Getting the sources} \label{getsources}
-You find the latest version of \vym at the project site:
+You find the latest code of \vym in the {\tt develop} branch on Github:
\begin{center}
-\href{https://sourceforge.net/projects/vym/}{https://sourceforge.net/projects/vym/}
-\end{center}
-There you can check them out of the source repository:\\
-
-\begin{verbatim}
-git clone git://vym.git.sourceforge.net/gitroot/vym/vym
-\end{verbatim}
-or access the git repository directly:
-\begin{center}
-\href{http://vym.git.sourceforge.net/git/gitweb-index.cgi}{http://vym.git.sourceforge.net/git/gitweb-index.cgi}
+ \href{ https://github.com/insilmaril/vym}{https://github.com/insilmaril/vym}
\end{center}
\subsubsection{The Qt toolkit}
Qt is C++ toolkit for multiplatform GUI and application development. It
provides single-source portability across MS~Windows, Mac~OS~X, Linux
-and all major commercial Unix variants. Qt is also available for
+and many more. Qt is also available for
embedded devices. Qt is a product of the Qt Company. For more information see
\begin{center}
\href{https://www.qt.io}{https://www.qt.io}
\subsection{\vym file format} \label{fileformat}
\vym maps usually have the suffix "{\tt .vym}" and represent a
-compressed archive of data. If you want to have a closer look into the
+compressed archive of data. Actually the widely used "zip" format
+is used\footnote{zip is meanwhile available on all major platforms,
+including Windows~10: either in the file explorer or on the command line
+e.g.~ as part of the "tar" command}.
+
+If you want to have a closer look into the
data structure map called "mapname.vym", just edit the XML data
-by using the {\tt vivym} script or by uncompressing manually by calling
+by using the {\tt vivym} script or by uncompressing manually. In a shell
+on Linux or Mac OS you can do this by calling
\begin{code}
\$ unzip mapname.vym
\end{code}
There are lots of features which might find their way into \vym.
Together with \vym you should have received a directory with several
example maps. You find them by clicking Help \ra Open~vym~example~maps.
+%FIXME outdated example
There you will find the map {\tt vym-projectplan.vym}. It lists quite a
-lot of things to be done in future. If you have more ideas, contact the
-development team at {\tt vym-devel@lists.sourceforge.net}.
+lot of things to be done in future. If you have more ideas, open
+enhancement tickets
+team at
+\href{https://github.com/insilmaril/vym/issues}{https://github.com/insilmaril/vym/issues}
\subsection{New languages support}
In some Linux distributions the development tools are in an extra
package, e.g. on SUSE LINUX you should have installed:
\begin{code}
-libqt4-devel.rpm
-libqt4-devel-doc.rpm
-libqt4-devel-tools.rpm
+libqt5-devel.rpm
+libqt5-devel-doc.rpm
+libqt5-devel-tools.rpm
\end{code}
-If you don't have QT in your system, you can get it from
- \href{http://www.qt.nokia.com}{http://www.qt.nokia.com} Once you
- are able to compile vym yourself, you can translate the text in vym
+If you don't have Qt in your system, you can get it from
+ \href{https://qt.io}{https://qt.nio}
+ You can translate the text in vym
itself by performing the following steps:
\begin{itemize}
\item Let's assume now your encoding is "NEW" instead of for example
projects / sven / vym.git / blobdiff