diff -r 218b0e2c8bfd -r 07f35022646d tex/vym.tex --- a/tex/vym.tex Mon Jun 18 15:10:19 2007 +0000 +++ b/tex/vym.tex Wed Jun 20 10:51:45 2007 +0000 @@ -24,12 +24,12 @@ \end{center} } \newcommand{\hint}[1]{ - \begin{center} + \begin{center} \begin{tabular}{|rp{12cm}|} \hline - {\bf Hint}:& #1\\ \hline \end{tabular} - \end{center} + \marginpar{\Huge !} + \end{center} } \newcommand{\vym}{{\sc vym }} @@ -39,6 +39,8 @@ \newcommand{\da}{$\downarrow$} \newcommand{\key}[1]{[#1]} +\newenvironment{code}[1] { \verbatim #1}{\endverbatim } + \hypersetup{bookmarks, bookmarksopen, pdftitle={VYM - a tool for visual thinking }, pdfauthor={Uwe Drechsel}, @@ -1078,11 +1080,21 @@ several maps at once. - \section{Scripts} \label{scripts} - %FIXME +\section{Scripts} \label{scripts} %FIXME +TODO: This section of the \vym manual is not complete yet, sorry. - +\subsection{Example scripts} +\subsubsection{Export a set of maps} +\begin{code} +\# Simple vym script to export images of various maps simultanously +export ("image"); +\end{code} +The script above can be used to export all maps in a directory +automatically. If the script is named {\tt export-image.vys}, call \vym with +\begin{code} +\$ vym --quit --run export-image.vys *.vym +\end{code} \section{Contributing to \vym} @@ -1163,11 +1175,11 @@ Make sure you have installed your Qt environment properly, see the Qt documentation for details. You need to have the Qt command {\tt qmake} in your {\tt PATH}-environment, then run -\begin{verbatim} -qmake -make -make install -\end{verbatim} +\begin{code} +\$ qmake +$ make +$ make install +\end{code} The last command {\tt make install} needs root-permissions. Of course it may be omitted, if you just want to test \vym. @@ -1179,9 +1191,9 @@ compressed archive of data. If you want to have a closer look into the data structure map called "mapname.vym", just uncompress the map manually using -\begin{verbatim} - unzip mapname.vym -\end{verbatim} +\begin{code} +\$ unzip mapname.vym +\end{code} This will create directories named {\tt images} and {\tt flags} in your current directory and also the map itself, usually named {\tt mapname.xml}. @@ -1190,22 +1202,18 @@ This XML file can be loaded directly into \vym, it does not have to be compressed. If you want to compress all the data yourself, use -\begin{verbatim} - zip -r mapname.vym . -\end{verbatim} +\begin{code} +\$ zip -r mapname.vym . +\end{code} to compress all data in your current directory. \subsection{New features} There are lots of features which might find their way into \vym. Together with \vym you should have received a directory with several -maps e.g. on SUSE~LINUX this is -\begin{center} - {\tt /usr/share/doc/packages/vym/demos} -\end{center} -where you find the map {\tt todo.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}. +example maps. You find them by clicking Help \ra Open~vym~example~maps. +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}. \subsection{New languages support} @@ -1216,12 +1224,11 @@ needed. In some Linux distributions the development tools are in an extra package, e.g. on SUSE LINUX you should have installed: -\begin{verbatim} - qt3-devel.rpm - qt3-devel-doc.rpm - qt3-devel-tools.rpm - qt3-man.rpm -\end{verbatim} +\begin{code} +libqt4-devel.rpm +libqt4-devel-doc.rpm +libqt4-devel-tools.rpm +\end{code} If you don't have QT in your system, you can get it from \href{http://www.trolltech.com}{http://www.trolltech.com} Once you are able to compile vym yourself, you can translate the text in vym