1.1 --- a/tex/vym.tex Mon Mar 27 20:21:58 2006 +0000
1.2 +++ b/tex/vym.tex Mon Mar 27 20:21:58 2006 +0000
1.3 @@ -52,13 +52,17 @@
1.4 \begin{center}
1.5 \includegraphics[width=12cm]{example1.png}
1.6 \end{center}
1.7 -Such maps can be drawn by hand on paper or a flip chart and help to
1.8 -structure your thoughs. While a tree like structure like above can be
1.9 -drawn by hand or any drawing software \vym offers
1.10 -much more features to work with such maps. \vym is not another drawing
1.11 -software, but a tool to store and modify information in an intuitive
1.12 -way. For example you can reorder parts of the map by pressing a key or
1.13 -add various information like a complete email by a simple mouse click.
1.14 +Such maps can be drawn by hand on a paper or flip chart and help to
1.15 +structure your thoughts. While a tree like structure like above can be
1.16 +drawn manually \vym offers much more features to work with such maps.
1.17 +\vym is not another drawing software, but a tool to store and modify
1.18 +information in an intuitive way. For example you can reorder parts of
1.19 +the map by pressing a key or add various information like a complete
1.20 +email by a simple mouse click.
1.21 +
1.22 +Once you have finished collecting and organizing your ideas, you can
1.23 +easily generate for example a presentation in Open~Office based on a
1.24 +map.
1.25
1.26 \subsection{Why should I use maps? Time, Space and your Brain.}
1.27 \subsubsection*{Space}
1.28 @@ -299,7 +303,8 @@
1.29 possible to unscroll all branches using "Edit\ra Unscroll all scrolled
1.30 branches".
1.31
1.32 -
1.33 +You can also hide parts of the map while exporting it e.g. to a webpage
1.34 +or a presentation, see \ref{hideexport} for details.
1.35
1.36 \subsection{Modify and move branches}
1.37 \subsubsection*{Modify the heading}
1.38 @@ -675,7 +680,17 @@
1.39 there is still room to optimize \vym ;-)
1.40
1.41 \subsection{Export}
1.42 -\vym supports various formats to help other applications.
1.43 +\label{hideexport}
1.44 +Often you don't want to export the whole map, but just parts of it. For
1.45 +example you may have additional info you want to talk about in a
1.46 +presentation, while those parts should not be visible to the audience.
1.47 +To achieve this you can "hide" parts of the map during exports by
1.48 +setting the "hide in export" flag:
1.49 +\begin{center}
1.50 + \includegraphics[width=0.5cm]{flag-hideexport.png}
1.51 +\end{center}
1.52 +Note that there is a global option in the settings menu to toggle the
1.53 +use of this flag. By default the flag is enabled.
1.54
1.55 \subsubsection*{Open Office}
1.56 Open Office beginning with version~2 uses the so called "Open Office
1.57 @@ -802,6 +817,17 @@
1.58 modifier lets you create {\em xLinks}, which will be explained in the
1.59 next section.
1.60
1.61 +\subsection{Hide links of unselected objects}
1.62 +Sometimes it would be useful to position a branch freely, just like a
1.63 +mainbranch or an image. Though this is not possible (yet) for all
1.64 +branches, you can use a mainbranch and hide its connecting link to the
1.65 +mapcenter. This can be used e.g. for legends or a collection of vymLinks
1.66 +pointing to other maps:
1.67 +\begin{center}
1.68 + \includegraphics[width=9cm]{hiddenlink.png}
1.69 +\end{center}
1.70 +
1.71 +
1.72 \subsection{XLinks} \label{xlinks}
1.73 So far all the data in the \vym map has been treelike. Using xLinks you
1.74 can link one branch to any other, just like attaching a rope between two
1.75 @@ -889,6 +915,21 @@
1.76
1.77 \begin{appendix}
1.78
1.79 +\section{Command line options}
1.80 +\vym has the following options:
1.81 +\begin{center}
1.82 +\begin{tabular}{ccp{8cm}}\\
1.83 +\bf Option & \bf Comment & \bf Description \\ \hline
1.84 +v & version & Show version ov \vym\\
1.85 +l & local & Use local paths to stylesheets, translations, icons,
1.86 + etc. instead of system paths. Useful for testing\\
1.87 +h & help & Show help\\
1.88 +q & quit & Quit immediatly after startup. Useful for benchmarks.\\
1.89 +\end{tabular}
1.90 +\end{center}
1.91 +You can also give several filenames at the commandline to let \vym open
1.92 +several maps at once.
1.93 +
1.94 \section{Contributing to \vym}
1.95 So far I'd say I have written 98\% of the code on my own. No surprise,
1.96 that \vym exactly fits my own needs. Nevertheless I would like to
1.97 @@ -915,7 +956,7 @@
1.98 \href{https://sourceforge.net/mail/?group_id=127802}{https://sourceforge.net/mail/?group\_id=127802}
1.99 \end{center}
1.100
1.101 -\subsubsection*{Contacting the author}
1.102 +\subsubsection*{Contacting the author}\label{author}
1.103 Especially for support questions please try the mailinglists first. If
1.104 everything else fails you can contact the Uwe Drechsel at
1.105 \begin{center}
1.106 @@ -923,6 +964,24 @@
1.107 \end{center}
1.108
1.109
1.110 +
1.111 +\subsection{How to report bugs}
1.112 +Though Sourceforge has its own bugreporting system, I'd rather prefer if
1.113 +you contact me directly (see \ref{author}) or even better: You can file
1.114 +a bugreport in Bugzilla, the bugtracking system of openSUSE:
1.115 +\begin{center}
1.116 +\href{http://en.opensuse.org/Submit_a_bug}{http://en.opensuse.org/Submit\_a\_bug}
1.117 +\end{center}
1.118 +I build \vym regulary for openSUSE, so you may report it against a
1.119 +recent version there, even if you use another Operating System.
1.120 +Please don't forget to tell
1.121 +\begin{itemize}
1.122 + \item the exact steps needed to reproduce the bug
1.123 + \item the version and build date of \vym (see the Help \ra About
1.124 + \vym)
1.125 + \item hardware and Operating System
1.126 +\end{itemize}
1.127 +
1.128 \subsection{Compiling from the sources}
1.129 \subsubsection{Getting the sources} \label{getsources}
1.130 You find the latest version of \vym at the project site:
1.131 @@ -1046,20 +1105,80 @@
1.132 ImportBase and ExportBase and subclasses. All of them can be found in
1.133 {\tt imports.h} and {\tt exports.h}.
1.134
1.135 -\subsubsection{Direct import/export}
1.136 +\subsubsection*{Direct import/export}
1.137 An example for a direct export is the XML export. This method touches
1.138 the implementation of nearly every object of \vym, so whenever possible
1.139 -it should be tried to use for example a XSL transformation instead.
1.140 +you should better use a XSL transformation instead.
1.141
1.142 If you still want to know how it is done, start looking at
1.143 {\tt MapEditor::saveToDir} in {\tt mapeditor.cpp}.
1.144
1.145 +\subsubsection*{Templates}
1.146 +Templates have been introduced to export to opendoc format used e.g. by
1.147 +Open~Office. While I read the spec ($>$ 500 pages) about the format\footnote{
1.148 +\href{http://www.oasis-open.org/}{http://www.oasis-open.org/}}\
1.149 +I had the feeling that I did not want to write the export from scratch.
1.150 +It would be too complex to adapt the styles to your own wishes, e.g. the
1.151 +layout.
1.152
1.153 -%\subsubsection{Templates}
1.154 -%TODO
1.155 -%\subsubsection{XSL Transformation}
1.156 -%TODO
1.157 +Instead I analyzed existing Open~Office documents. I found out that
1.158 +there are lots of redundant bits of information in a standard
1.159 +presentation, for example each list item is contained in its own list.
1.160 +In the end I came up with the default presentation style, which still
1.161 +could be simplified, just in case you have free time\ldots
1.162
1.163 +The existing templates are still work in progress, before you spent too
1.164 +much time developing your own style, please contact me. Basically the
1.165 +following steps are needed to build your own style:
1.166 +\begin{enumerate}
1.167 + \item Create an example in Open Office. Use a title, authors name,
1.168 + page heading etc.\ which you can easily grep for in the output file.
1.169 +
1.170 + \item Unzip the Open Office document into a directory.
1.171 +
1.172 + \item The main file is called {\tt content.xml}. All data is in one
1.173 + single line. You can split the XML tags using the script {\tt
1.174 + scripts/niceXML}, which is part of the \vym distribution.
1.175 +
1.176 + \item Copy the output of {\tt niceXML} to {\tt
1.177 + content-template.xml}.
1.178 +
1.179 + \item Looking closer you will find lots of unused definitions, for
1.180 + example of styles. You can delete or simply ignore them.
1.181 +
1.182 + \item Try to find your title, authors name. \vym will replace the
1.183 + following strings while exporting:
1.184 + \begin{center}
1.185 + \begin{tabular}{lp{4cm}}
1.186 + {\tt <!-- INSERT TITLE -->} & title of map \\
1.187 + {\tt <!-- INSERT AUTHOR--> } & author \\
1.188 + {\tt <!-- INSERT COMMENT -->} & comment \\
1.189 + {\tt <!-- INSERT PAGES-->} & content of map \\
1.190 + \end{tabular}
1.191 + \end{center}
1.192 + The content itself is generated in a similar way by inserting lists
1.193 + into {\tt page-template}. Here the following substitutions are made:
1.194 + \begin{center}
1.195 + \begin{tabular}{lp{7cm}}
1.196 + {\tt <!-- INSERT PAGE HEADING-->} & heading of a page
1.197 + (mainbranch or child of mainbranch, depending on the use of
1.198 + sections) \\
1.199 + {\tt <!-- INSERT LIST --> } & all childs of the branch above \\
1.200 + \end{tabular}
1.201 + \end{center}
1.202 +\end{enumerate}
1.203 +Currently images are exported and notes just will appear as text
1.204 +without formatting and colors.
1.205 +
1.206 +
1.207 +
1.208 +
1.209 +\subsubsection*{XSL Transformation}
1.210 +\vym uses XSL transformations while exporting (e.g. XHTML) and importing
1.211 +data (e.g. KDE bookmarks). There is a little code needed to provide the
1.212 +GUI, the rest is done using the {\tt .xsl} stylesheet and calling the
1.213 +{\tt xsltproc} processor, which is part of libxslt, the XSLT
1.214 +C library for GNOME.
1.215
1.216 \end{appendix}
1.217 \end{document}