# HG changeset patch
# User insilmaril
# Date 1143490918 0
# Node ID 4ee885c3b72c7b47774d4e16a837c7701684ad98
# Parent 0b843ab9fd7a4662e42eb9e4dc32934a1ee5fe6d
More documentation, fixed small bug where links of unselected objects where visible again
diff -r 0b843ab9fd7a -r 4ee885c3b72c tex/hiddenlink.png
Binary file tex/hiddenlink.png has changed
diff -r 0b843ab9fd7a -r 4ee885c3b72c tex/vym.tex
--- a/tex/vym.tex Mon Mar 27 20:21:58 2006 +0000
+++ b/tex/vym.tex Mon Mar 27 20:21:58 2006 +0000
@@ -52,13 +52,17 @@
\begin{center}
\includegraphics[width=12cm]{example1.png}
\end{center}
-Such maps can be drawn by hand on paper or a flip chart and help to
-structure your thoughs. While a tree like structure like above can be
-drawn by hand or any drawing software \vym offers
-much more features to work with such maps. \vym is not another drawing
-software, but a tool to store and modify information in an intuitive
-way. For example you can reorder parts of the map by pressing a key or
-add various information like a complete email by a simple mouse click.
+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
+drawn manually \vym offers much more features to work with such maps.
+\vym is not another drawing software, but a tool to store and modify
+information in an intuitive way. For example you can reorder parts of
+the map by pressing a key or add various information like a complete
+email by a simple mouse click.
+
+Once you have finished collecting and organizing your ideas, you can
+easily generate for example a presentation in Open~Office based on a
+map.
\subsection{Why should I use maps? Time, Space and your Brain.}
\subsubsection*{Space}
@@ -299,7 +303,8 @@
possible to unscroll all branches using "Edit\ra Unscroll all scrolled
branches".
-
+You can also hide parts of the map while exporting it e.g. to a webpage
+or a presentation, see \ref{hideexport} for details.
\subsection{Modify and move branches}
\subsubsection*{Modify the heading}
@@ -675,7 +680,17 @@
there is still room to optimize \vym ;-)
\subsection{Export}
-\vym supports various formats to help other applications.
+\label{hideexport}
+Often you don't want to export the whole map, but just parts of it. For
+example you may have additional info you want to talk about in a
+presentation, while those parts should not be visible to the audience.
+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}
+\end{center}
+Note that there is a global option in the settings menu to toggle the
+use of this flag. By default the flag is enabled.
\subsubsection*{Open Office}
Open Office beginning with version~2 uses the so called "Open Office
@@ -802,6 +817,17 @@
modifier lets you create {\em xLinks}, which will be explained in the
next section.
+\subsection{Hide links of unselected objects}
+Sometimes it would be useful to position a branch freely, just like a
+mainbranch or an image. Though this is not possible (yet) for all
+branches, you can use a mainbranch and hide its connecting link to the
+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}
+\end{center}
+
+
\subsection{XLinks} \label{xlinks}
So far all the data in the \vym map has been treelike. Using xLinks you
can link one branch to any other, just like attaching a rope between two
@@ -889,6 +915,21 @@
\begin{appendix}
+\section{Command line 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.\\
+\end{tabular}
+\end{center}
+You can also give several filenames at the commandline to let \vym open
+several maps at once.
+
\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
@@ -915,7 +956,7 @@
\href{https://sourceforge.net/mail/?group_id=127802}{https://sourceforge.net/mail/?group\_id=127802}
\end{center}
-\subsubsection*{Contacting the author}
+\subsubsection*{Contacting the author}\label{author}
Especially for support questions please try the mailinglists first. If
everything else fails you can contact the Uwe Drechsel at
\begin{center}
@@ -923,6 +964,24 @@
\end{center}
+
+\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:
+\begin{center}
+\href{http://en.opensuse.org/Submit_a_bug}{http://en.opensuse.org/Submit\_a\_bug}
+\end{center}
+I build \vym regulary for openSUSE, so you may report it against a
+recent version there, even if you use another Operating System.
+Please don't forget to tell
+\begin{itemize}
+ \item the exact steps needed to reproduce the bug
+ \item the version and build date of \vym (see the Help \ra About
+ \vym)
+ \item hardware and Operating System
+\end{itemize}
+
\subsection{Compiling from the sources}
\subsubsection{Getting the sources} \label{getsources}
You find the latest version of \vym at the project site:
@@ -1046,20 +1105,80 @@
ImportBase and ExportBase and subclasses. All of them can be found in
{\tt imports.h} and {\tt exports.h}.
-\subsubsection{Direct import/export}
+\subsubsection*{Direct import/export}
An example for a direct export is the XML export. This method touches
the implementation of nearly every object of \vym, so whenever possible
-it should be tried to use for example a XSL transformation instead.
+you should better use a XSL transformation instead.
If you still want to know how it is done, start looking at
{\tt MapEditor::saveToDir} in {\tt mapeditor.cpp}.
+\subsubsection*{Templates}
+Templates have been introduced to export to opendoc format used e.g. by
+Open~Office. While I read the spec ($>$ 500 pages) about the format\footnote{
+\href{http://www.oasis-open.org/}{http://www.oasis-open.org/}}\
+I had the feeling that I did not want to write the export from scratch.
+It would be too complex to adapt the styles to your own wishes, e.g. the
+layout.
-%\subsubsection{Templates}
-%TODO
-%\subsubsection{XSL Transformation}
-%TODO
+Instead I analyzed existing Open~Office documents. I found out that
+there are lots of redundant bits of information in a standard
+presentation, for example each list item is contained in its own list.
+In the end I came up with the default presentation style, which still
+could be simplified, just in case you have free time\ldots
+The existing templates are still work in progress, before you spent too
+much time developing your own style, please contact me. Basically the
+following steps are needed to build your own style:
+\begin{enumerate}
+ \item Create an example in Open Office. Use a title, authors name,
+ page heading etc.\ which you can easily grep for in the output file.
+
+ \item Unzip the Open Office document into a directory.
+
+ \item The main file is called {\tt content.xml}. All data is in one
+ single line. You can split the XML tags using the script {\tt
+ scripts/niceXML}, which is part of the \vym distribution.
+
+ \item Copy the output of {\tt niceXML} to {\tt
+ content-template.xml}.
+
+ \item Looking closer you will find lots of unused definitions, for
+ example of styles. You can delete or simply ignore them.
+
+ \item Try to find your title, authors name. \vym will replace the
+ following strings while exporting:
+ \begin{center}
+ \begin{tabular}{lp{4cm}}
+ {\tt <!-- INSERT TITLE -->} & title of map \\
+ {\tt <!-- INSERT AUTHOR--> } & author \\
+ {\tt <!-- INSERT COMMENT -->} & comment \\
+ {\tt <!-- INSERT PAGES-->} & content of map \\
+ \end{tabular}
+ \end{center}
+ The content itself is generated in a similar way by inserting lists
+ into {\tt page-template}. Here the following substitutions are made:
+ \begin{center}
+ \begin{tabular}{lp{7cm}}
+ {\tt <!-- INSERT PAGE HEADING-->} & heading of a page
+ (mainbranch or child of mainbranch, depending on the use of
+ sections) \\
+ {\tt <!-- INSERT LIST --> } & all childs of the branch above \\
+ \end{tabular}
+ \end{center}
+\end{enumerate}
+Currently images are exported and notes just will appear as text
+without formatting and colors.
+
+
+
+
+\subsubsection*{XSL Transformation}
+\vym uses XSL transformations while exporting (e.g. XHTML) and importing
+data (e.g. KDE bookmarks). There is a little code needed to provide the
+GUI, the rest is done using the {\tt .xsl} stylesheet and calling the
+{\tt xsltproc} processor, which is part of libxslt, the XSLT
+C library for GNOME.
\end{appendix}
\end{document}
diff -r 0b843ab9fd7a -r 4ee885c3b72c version.h
--- a/version.h Mon Mar 27 20:21:58 2006 +0000
+++ b/version.h Mon Mar 27 20:21:58 2006 +0000
@@ -3,6 +3,6 @@
#define __VYM "VYM"
#define __VYM_VERSION "1.7.12"
-#define __BUILD_DATE "March 23, 2006"
+#define __BUILD_DATE "March 27, 2006"
#endif