tex/vym.tex
changeset 514 497fab7d1404
parent 509 218b0e2c8bfd
child 519 24691cdacc02
     1.1 --- a/tex/vym.tex	Tue Jun 19 14:20:29 2007 +0000
     1.2 +++ b/tex/vym.tex	Tue Jun 19 14:20:30 2007 +0000
     1.3 @@ -24,12 +24,12 @@
     1.4  	\end{center}
     1.5  }
     1.6  \newcommand{\hint}[1]{
     1.7 -	\begin{center}
     1.8 +	\begin{center} 
     1.9  		\begin{tabular}{|rp{12cm}|} \hline
    1.10 -			
    1.11  			{\bf Hint}:& #1\\	\hline
    1.12  		\end{tabular}
    1.13 -	\end{center}
    1.14 +			\marginpar{\Huge !} 
    1.15 +	\end{center} 
    1.16  }
    1.17  
    1.18  \newcommand{\vym}{{\sc vym }}
    1.19 @@ -39,6 +39,8 @@
    1.20  \newcommand{\da}{$\downarrow$}
    1.21  \newcommand{\key}[1]{[#1]}
    1.22  
    1.23 +\newenvironment{code}[1] { \verbatim #1}{\endverbatim  }
    1.24 +
    1.25  \hypersetup{bookmarks, bookmarksopen,
    1.26    pdftitle={VYM - a tool for visual thinking },
    1.27    pdfauthor={Uwe Drechsel},    
    1.28 @@ -1078,11 +1080,21 @@
    1.29  several maps at once.
    1.30   
    1.31  
    1.32 - \section{Scripts} \label{scripts}
    1.33 - %FIXME
    1.34 +\section{Scripts} \label{scripts}   %FIXME
    1.35  
    1.36 +TODO: This section of the \vym manual is not complete yet, sorry.
    1.37  
    1.38 -
    1.39 +\subsection{Example scripts}
    1.40 +\subsubsection{Export a set of maps}
    1.41 +\begin{code}
    1.42 +\# Simple vym script to export images of various maps simultanously
    1.43 +export ("image");
    1.44 +\end{code}
    1.45 +The script above can be used to export all maps in a directory
    1.46 +automatically. If the script is named {\tt export-image.vys}, call \vym with
    1.47 +\begin{code}
    1.48 +\$ vym --quit --run export-image.vys *.vym
    1.49 +\end{code}
    1.50  
    1.51  
    1.52  \section{Contributing to \vym}
    1.53 @@ -1163,11 +1175,11 @@
    1.54  Make sure you have installed your Qt environment properly, see the Qt
    1.55  documentation for details. You need to have the Qt command {\tt qmake}
    1.56  in your {\tt PATH}-environment, then run
    1.57 -\begin{verbatim}
    1.58 -qmake
    1.59 -make  
    1.60 -make install
    1.61 -\end{verbatim}
    1.62 +\begin{code}
    1.63 +\$ qmake
    1.64 +$ make  
    1.65 +$ make install
    1.66 +\end{code}
    1.67  The last command {\tt make install} needs root-permissions. Of course it
    1.68  may be omitted, if you just want to test \vym.
    1.69  
    1.70 @@ -1179,9 +1191,9 @@
    1.71  compressed archive of data. If you want to have a
    1.72  closer look into the data structure map called "mapname.vym", 
    1.73  just uncompress the map manually using
    1.74 -\begin{verbatim}
    1.75 -	unzip mapname.vym
    1.76 -\end{verbatim}
    1.77 +\begin{code}
    1.78 +\$ unzip mapname.vym
    1.79 +\end{code}
    1.80  This will create directories named {\tt images} and {\tt flags} in your
    1.81  current directory and also the map itself, usually named {\tt
    1.82  mapname.xml}.
    1.83 @@ -1190,22 +1202,18 @@
    1.84  
    1.85  This XML file can be loaded directly into \vym, it does not have to be
    1.86  compressed. If you want to compress all the data yourself, use
    1.87 -\begin{verbatim}
    1.88 -	zip -r mapname.vym .
    1.89 -\end{verbatim}
    1.90 +\begin{code}
    1.91 +\$ zip -r mapname.vym .
    1.92 +\end{code}
    1.93  to compress all data in your current directory.
    1.94  
    1.95  \subsection{New features}
    1.96  There are lots of features which might find their way into \vym.
    1.97  Together with \vym you should have received a directory with several
    1.98 -maps e.g. on SUSE~LINUX this is
    1.99 -\begin{center}
   1.100 -	{\tt /usr/share/doc/packages/vym/demos}
   1.101 -\end{center}
   1.102 -where you find the map {\tt todo.vym}. It lists quite a lot of things to
   1.103 -be done in future. If you have more ideas, contact the development team
   1.104 -at
   1.105 -{\tt vym-devel@lists.sourceforge.net}.
   1.106 +example maps. You find them by clicking Help \ra Open~vym~example~maps.
   1.107 +There you will find the map {\tt vym-projectplan.vym}. It lists quite a
   1.108 +lot of things to be done in future. If you have more ideas, contact the
   1.109 +development team at {\tt vym-devel@lists.sourceforge.net}.
   1.110  
   1.111  
   1.112  \subsection{New languages support}
   1.113 @@ -1216,12 +1224,11 @@
   1.114  needed. 
   1.115  
   1.116  In some Linux distributions the development tools are in an extra package, e.g. on SUSE LINUX you should have installed:
   1.117 -\begin{verbatim}
   1.118 -    qt3-devel.rpm
   1.119 -    qt3-devel-doc.rpm
   1.120 -    qt3-devel-tools.rpm
   1.121 -    qt3-man.rpm
   1.122 -\end{verbatim}
   1.123 +\begin{code}
   1.124 +libqt4-devel.rpm
   1.125 +libqt4-devel-doc.rpm
   1.126 +libqt4-devel-tools.rpm
   1.127 +\end{code}
   1.128  If you don't have QT in your system, you can get it from 
   1.129  	\href{http://www.trolltech.com}{http://www.trolltech.com} Once you
   1.130  	are able to compile vym yourself, you can translate the text in vym