tex/vym.tex
changeset 258 42c8cf6dd1c3
parent 245 27b71695d690
child 260 69d648a0a15b
     1.1 --- a/tex/vym.tex	Tue Mar 14 14:27:16 2006 +0000
     1.2 +++ b/tex/vym.tex	Thu Mar 23 12:38:54 2006 +0000
     1.3 @@ -914,18 +914,28 @@
     1.4  
     1.5  
     1.6  \subsection{Compiling from the sources}
     1.7 -\subsubsection*{Get the sources}
     1.8 +\subsubsection{Getting the sources} \label{getsources}
     1.9 +You find the latest version of \vym at the project site:
    1.10 +\begin{center}
    1.11 +\href{https://sourceforge.net/projects/vym/}{https://sourceforge.net/projects/vym/}
    1.12 +\end{center}
    1.13 +There you can check them out of the source repository (CVS):\\
    1.14  
    1.15 -\subsubsection*{The Qt toolkit}
    1.16 +\begin{verbatim}
    1.17 +cvs -d:pserver:anonymous@cvs.sf.net:/cvsroot/vym checkout code
    1.18 +\end{verbatim}
    1.19 +
    1.20 +\subsubsection{The Qt toolkit}
    1.21  Qt is C++ toolkit for multiplatform GUI and application development. It
    1.22  provides single-source portability across MS~Windows, Mac~OS~X, Linux
    1.23  ans all major commercial Unix variants. Qt is also available for
    1.24 -embedded devices. Qt is a Trolltech product. See 
    1.25 +embedded devices. Qt is a Trolltech product. For more information see 
    1.26 +\begin{center}
    1.27  \href{http://www.trolltech.com/qt/}{www.trolltech.com/qt} 
    1.28 -for more information
    1.29 +\end{center}
    1.30  
    1.31  
    1.32 -\subsubsection*{Compiling \vym }
    1.33 +\subsubsection{Compiling \vym }
    1.34  Make sure you have installed your Qt environment properly, see the Qt
    1.35  documentation for details. You need to have the Qt command {\tt qmake}
    1.36  in your {\tt PATH}-environment, then run
    1.37 @@ -974,7 +984,69 @@
    1.38  
    1.39  
    1.40  \subsection{New languages support}
    1.41 +In order to add a new language to \vym you need 
    1.42 +the sources (see \ref{getsources}) and
    1.43 +an installation of Trolltechs QT. A part of QT are the development
    1.44 +tools, from those tools especially the translation tool "Linguist" is
    1.45 +needed. 
    1.46 +
    1.47 +In some Linux distributions the development tools are in an extra package, e.g. on SUSE LINUX you should have installed:
    1.48 +\begin{verbatim}
    1.49 +    qt3-devel.rpm
    1.50 +    qt3-devel-doc.rpm
    1.51 +    qt3-devel-tools.rpm
    1.52 +    qt3-man.rpm
    1.53 +\end{verbatim}
    1.54 +If you don't have QT in your system, you can get it from 
    1.55 +	\href{http://www.trolltech.com}{http://www.trolltech.com} Once you
    1.56 +	are able to compile vym yourself, you can translate the text in vym
    1.57 +	itself by performing the following steps:
    1.58 +\begin{itemize}
    1.59 +	\item Let's assume now your encoding is "NEW" instead of for example
    1.60 +	"de" for german or "en" for english
    1.61 +	
    1.62 +	\item Copy the file {\tt lang/vym\_en.ts} to l{\tt ang/vym\_NEW.ts} (The code
    1.63 +	itself contains the english version.)
    1.64 +		
    1.65 +	\item Add {\tt lang/vym\_NEW.ts} to the TRANSLATIONS section of vym.pro
    1.66 +
    1.67 +	\item Run Linguist on {\tt vym\_NEW.ts} and do the translation
    1.68 +
    1.69 +	\item Run {\tt lrelease} to create {\tt vym\_NEW.qm}
    1.70 +
    1.71 +	\item Do a make install to install the new vym and check your translation
    1.72 +\end{itemize}
    1.73 +
    1.74 +If you feel brave, you can also translate the manual. It is written in
    1.75 +LaTeX, you just have to change the file tex/vym.tex. (Linguist and QT
    1.76 +are not needed, but it is useful to know how to work with LaTeX and esp.
    1.77 +pdflatex to create the PDF.) 
    1.78 +
    1.79 +Please mail me every translation you have done. I can also give you a
    1.80 +developer access to the project, if you want to provide translations
    1.81 +regulary.  
    1.82 +
    1.83  \subsection{New export/import filters}
    1.84 +\vym supports various kinds of filters. Data can be written directly,
    1.85 +inserted into templates or it can be written as XML data and then
    1.86 +processed by XSL transformations. 
    1.87 +
    1.88 +Most of the import/export functionality is available in the classes
    1.89 +ImportBase and ExportBase and subclasses. All of them can be found in
    1.90 +{\tt imports.h} and {\tt exports.h}.
    1.91 +
    1.92 +\subsubsection{Direct import/export}
    1.93 +An example for a direct export is the XML export. This method touches
    1.94 +the implementation of nearly every object of \vym, so whenever possible
    1.95 +it should be tried to use for example a XSL transformation instead.
    1.96 +
    1.97 +If you still want to know how it is done, start looking at 
    1.98 +{\tt MapEditor::saveToDir} in {\tt mapeditor.cpp}.
    1.99 +
   1.100 +
   1.101 +\subsubsection{Templates}
   1.102 +\subsubsection{XSL Transformation}
   1.103 +
   1.104  
   1.105  \end{appendix}
   1.106  \end{document}