1.1 Binary file tex/hiddenlink.png has changed

     2.1 --- a/tex/vym.tex	Mon Mar 27 20:21:58 2006 +0000
     2.2 +++ b/tex/vym.tex	Mon Mar 27 20:21:58 2006 +0000
     2.3 @@ -52,13 +52,17 @@
     2.4  \begin{center}
     2.5  	\includegraphics[width=12cm]{example1.png}
     2.6  \end{center}
     2.7 -Such maps can be drawn by hand on paper or a flip chart and help to
     2.8 -structure your thoughs. While a tree like structure like above can be
     2.9 -drawn by hand or any drawing software \vym offers
    2.10 -much more features to work with such maps. \vym is not another drawing
    2.11 -software, but a tool to store and modify information in an intuitive
    2.12 -way. For example you can reorder parts of the map by pressing a key or
    2.13 -add various information like a complete email by a simple mouse click.
    2.14 +Such maps can be drawn by hand on a paper or flip chart and help to
    2.15 +structure your thoughts. While a tree like structure like above can be
    2.16 +drawn manually \vym offers much more features to work with such maps.
    2.17 +\vym is not another drawing software, but a tool to store and modify
    2.18 +information in an intuitive way. For example you can reorder parts of
    2.19 +the map by pressing a key or add various information like a complete
    2.20 +email by a simple mouse click.
    2.21 +
    2.22 +Once you have finished collecting and organizing your ideas, you can
    2.23 +easily generate for example a presentation in Open~Office based on a
    2.24 +map.
    2.25  
    2.26  \subsection{Why should I use maps? Time, Space and your Brain.}
    2.27  \subsubsection*{Space}
    2.28 @@ -299,7 +303,8 @@
    2.29  possible to unscroll all branches using "Edit\ra Unscroll all scrolled
    2.30  branches".
    2.31  
    2.32 -
    2.33 +You can also hide parts of the map while exporting it e.g. to a webpage
    2.34 +or a presentation, see \ref{hideexport} for details.
    2.35  
    2.36  \subsection{Modify and move branches}
    2.37  \subsubsection*{Modify the heading}
    2.38 @@ -675,7 +680,17 @@
    2.39  there is still room to optimize \vym ;-)
    2.40  
    2.41  \subsection{Export}
    2.42 -\vym supports various formats to help other applications.
    2.43 +\label{hideexport}
    2.44 +Often you don't want to export the whole map, but just parts of it. For
    2.45 +example you may have additional info you want to talk about in a
    2.46 +presentation, while those parts should not be visible to the audience.
    2.47 +To achieve this you can "hide" parts of the map during exports by
    2.48 +setting the "hide in export" flag:
    2.49 +\begin{center}
    2.50 +	\includegraphics[width=0.5cm]{flag-hideexport.png}
    2.51 +\end{center}
    2.52 +Note that there is a global option in the settings menu to toggle the
    2.53 +use of this flag. By default the flag is enabled.
    2.54  
    2.55  \subsubsection*{Open Office}
    2.56  Open Office beginning with version~2 uses the so called "Open Office
    2.57 @@ -802,6 +817,17 @@
    2.58  modifier lets you create {\em xLinks}, which will be explained in the
    2.59  next section.
    2.60  
    2.61 +\subsection{Hide links of unselected objects}
    2.62 +Sometimes it would be useful to position a branch freely, just like a
    2.63 +mainbranch or an image. Though this is not possible (yet) for all
    2.64 +branches, you can use a mainbranch and hide its connecting link to the
    2.65 +mapcenter. This can be used e.g. for legends or a collection of vymLinks
    2.66 +pointing to other maps:
    2.67 +\begin{center}
    2.68 +	\includegraphics[width=9cm]{hiddenlink.png}
    2.69 +\end{center}
    2.70 +
    2.71 +
    2.72  \subsection{XLinks} \label{xlinks}
    2.73  So far all the data in the \vym map has been treelike. Using xLinks you
    2.74  can link one branch to any other, just like attaching a rope between two
    2.75 @@ -889,6 +915,21 @@
    2.76  
    2.77  \begin{appendix}
    2.78  
    2.79 +\section{Command line options}
    2.80 +\vym has the following options:
    2.81 +\begin{center}
    2.82 +\begin{tabular}{ccp{8cm}}\\ 
    2.83 +\bf Option	& \bf Comment & \bf Description \\ \hline
    2.84 +v & version & Show version ov \vym\\
    2.85 +l & local	& Use local paths to stylesheets, translations, icons, 
    2.86 +              etc. instead of system paths. Useful for testing\\
    2.87 +h & help	& Show help\\
    2.88 +q & quit	& Quit immediatly after startup. Useful for benchmarks.\\
    2.89 +\end{tabular}
    2.90 +\end{center}
    2.91 +You can also give several filenames at the commandline to let \vym open
    2.92 +several maps at once.
    2.93 + 
    2.94  \section{Contributing to \vym}
    2.95  So far I'd say I have written 98\% of the code on my own. No surprise,
    2.96  that \vym exactly fits my own needs. Nevertheless I would like to
    2.97 @@ -915,7 +956,7 @@
    2.98  \href{https://sourceforge.net/mail/?group_id=127802}{https://sourceforge.net/mail/?group\_id=127802}
    2.99  \end{center}
   2.100  
   2.101 -\subsubsection*{Contacting the author}
   2.102 +\subsubsection*{Contacting the author}\label{author}
   2.103  Especially for support questions please try the mailinglists first. If
   2.104  everything else fails you can contact the Uwe Drechsel at
   2.105  \begin{center}
   2.106 @@ -923,6 +964,24 @@
   2.107  \end{center}
   2.108  
   2.109  
   2.110 +
   2.111 +\subsection{How to report bugs}
   2.112 +Though Sourceforge has its own bugreporting system, I'd rather prefer if
   2.113 +you contact me directly (see \ref{author}) or even better: You can file
   2.114 +a bugreport in Bugzilla, the bugtracking system of openSUSE:
   2.115 +\begin{center}
   2.116 +\href{http://en.opensuse.org/Submit_a_bug}{http://en.opensuse.org/Submit\_a\_bug}
   2.117 +\end{center}
   2.118 +I build \vym regulary for openSUSE, so you may report it against a
   2.119 +recent version there, even if you  use another Operating System.
   2.120 +Please don't forget to tell 
   2.121 +\begin{itemize}
   2.122 +	\item the exact steps needed to reproduce the bug
   2.123 +	\item the version and build date of \vym (see the Help \ra About
   2.124 +	\vym)
   2.125 +	\item hardware and Operating System
   2.126 +\end{itemize}
   2.127 +
   2.128  \subsection{Compiling from the sources}
   2.129  \subsubsection{Getting the sources} \label{getsources}
   2.130  You find the latest version of \vym at the project site:
   2.131 @@ -1046,20 +1105,80 @@
   2.132  ImportBase and ExportBase and subclasses. All of them can be found in
   2.133  {\tt imports.h} and {\tt exports.h}.
   2.134  
   2.135 -\subsubsection{Direct import/export}
   2.136 +\subsubsection*{Direct import/export}
   2.137  An example for a direct export is the XML export. This method touches
   2.138  the implementation of nearly every object of \vym, so whenever possible
   2.139 -it should be tried to use for example a XSL transformation instead.
   2.140 +you should better use a XSL transformation instead.
   2.141  
   2.142  If you still want to know how it is done, start looking at 
   2.143  {\tt MapEditor::saveToDir} in {\tt mapeditor.cpp}.
   2.144  
   2.145 +\subsubsection*{Templates}
   2.146 +Templates have been introduced to export to opendoc format used e.g. by
   2.147 +Open~Office. While I read the spec ($>$ 500 pages) about the format\footnote{
   2.148 +\href{http://www.oasis-open.org/}{http://www.oasis-open.org/}}\ 
   2.149 +I had the feeling that I did not want to write the export from scratch. 
   2.150 +It would be too complex to adapt the styles to your own wishes, e.g. the
   2.151 +layout.
   2.152  
   2.153 -%\subsubsection{Templates}
   2.154 -%TODO
   2.155 -%\subsubsection{XSL Transformation}
   2.156 -%TODO
   2.157 +Instead I analyzed existing Open~Office documents. I found out that
   2.158 +there are lots of redundant bits of information in a standard
   2.159 +presentation, for example each list item is contained in its own list.
   2.160 +In the end I came up with the default presentation style, which still
   2.161 +could be simplified, just in case you have free time\ldots
   2.162  
   2.163 +The existing templates are still work in progress, before you spent too
   2.164 +much time developing your own style, please contact me.  Basically the
   2.165 +following steps are needed to build your own style:
   2.166 +\begin{enumerate}
   2.167 +	\item Create an example in Open Office. Use a title, authors name,
   2.168 +	page heading etc.\ which you can easily grep for in the output file.
   2.169 +	
   2.170 +	\item Unzip  the Open Office document into a directory.
   2.171 +
   2.172 +	\item The main file is called {\tt content.xml}. All data is in one
   2.173 +	single line. You can split the XML tags using the script {\tt
   2.174 +	scripts/niceXML}, which is part of the \vym distribution.
   2.175 +
   2.176 +	\item Copy the output of {\tt niceXML} to {\tt
   2.177 +	content-template.xml}.
   2.178 +
   2.179 +	\item Looking closer you will find lots of unused definitions, for
   2.180 +	example of styles. You can delete or simply ignore them.
   2.181 +
   2.182 +	\item Try to find your title, authors name. \vym will replace the
   2.183 +	following strings while exporting:
   2.184 +	\begin{center}
   2.185 +	\begin{tabular}{lp{4cm}}
   2.186 +		{\tt <!-- INSERT TITLE -->}		& title of map \\
   2.187 +		{\tt <!-- INSERT AUTHOR-->	}	& author \\
   2.188 +		{\tt <!-- INSERT COMMENT -->}	& comment \\
   2.189 +		{\tt <!-- INSERT PAGES-->}		& content of map \\
   2.190 +	\end{tabular}
   2.191 +	\end{center}
   2.192 +	The content itself is generated in a similar way by inserting lists
   2.193 +	into {\tt page-template}. Here the following substitutions are made:
   2.194 +	\begin{center}
   2.195 +	\begin{tabular}{lp{7cm}}
   2.196 +		{\tt <!-- INSERT PAGE HEADING-->}		& heading of a page
   2.197 +		(mainbranch or child of mainbranch, depending on the use of
   2.198 +		sections) \\
   2.199 +		{\tt <!-- INSERT LIST -->	}	& all childs of the branch above \\
   2.200 +	\end{tabular}
   2.201 +	\end{center}
   2.202 +\end{enumerate}
   2.203 +Currently images are exported and notes just will appear as text
   2.204 +without formatting and colors.
   2.205 +
   2.206 +
   2.207 +
   2.208 +
   2.209 +\subsubsection*{XSL Transformation}
   2.210 +\vym uses XSL transformations while exporting (e.g. XHTML) and importing
   2.211 +data (e.g. KDE bookmarks). There is a little code needed to provide the
   2.212 +GUI, the rest is done using the {\tt .xsl} stylesheet and calling the
   2.213 +{\tt xsltproc} processor, which is part of libxslt, the XSLT
   2.214 +C  library  for  GNOME. 
   2.215  
   2.216  \end{appendix}
   2.217  \end{document}

     3.1 --- a/version.h	Mon Mar 27 20:21:58 2006 +0000
     3.2 +++ b/version.h	Mon Mar 27 20:21:58 2006 +0000
     3.3 @@ -3,6 +3,6 @@
     3.4  
     3.5  #define __VYM "VYM"
     3.6  #define __VYM_VERSION "1.7.12"
     3.7 -#define __BUILD_DATE "March 23, 2006"
     3.8 +#define __BUILD_DATE "March 27, 2006"
     3.9  
    3.10  #endif