diff -r 27b71695d690 -r 174dd40bf06a tex/vym.tex --- a/tex/vym.tex Tue Mar 14 14:27:16 2006 +0000 +++ b/tex/vym.tex Wed Mar 15 15:54:32 2006 +0000 @@ -914,18 +914,28 @@ \subsection{Compiling from the sources} -\subsubsection*{Get the sources} +\subsubsection{Getting the sources} \label{getsources} +You find the latest version of \vym at the project site: +\begin{center} +\href{https://sourceforge.net/projects/vym/}{https://sourceforge.net/projects/vym/} +\end{center} +There you can check them out of the source repository (CVS):\\ -\subsubsection*{The Qt toolkit} +\begin{verbatim} +cvs -d:pserver:anonymous@cvs.sf.net:/cvsroot/vym checkout code +\end{verbatim} + +\subsubsection{The Qt toolkit} Qt is C++ toolkit for multiplatform GUI and application development. It provides single-source portability across MS~Windows, Mac~OS~X, Linux ans all major commercial Unix variants. Qt is also available for -embedded devices. Qt is a Trolltech product. See +embedded devices. Qt is a Trolltech product. For more information see +\begin{center} \href{http://www.trolltech.com/qt/}{www.trolltech.com/qt} -for more information +\end{center} -\subsubsection*{Compiling \vym } +\subsubsection{Compiling \vym } 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 @@ -974,7 +984,69 @@ \subsection{New languages support} +In order to add a new language to \vym you need +the sources (see \ref{getsources}) and +an installation of Trolltechs QT. A part of QT are the development +tools, from those tools especially the translation tool "Linguist" is +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} +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 + itself by performing the following steps: +\begin{itemize} + \item Let's assume now your encoding is "NEW" instead of for example + "de" for german or "en" for english + + \item Copy the file {\tt lang/vym\_en.ts} to l{\tt ang/vym\_NEW.ts} (The code + itself contains the english version.) + + \item Add {\tt lang/vym\_NEW.ts} to the TRANSLATIONS section of vym.pro + + \item Run Linguist on {\tt vym\_NEW.ts} and do the translation + + \item Run {\tt lrelease} to create {\tt vym\_NEW.qm} + + \item Do a make install to install the new vym and check your translation +\end{itemize} + +If you feel brave, you can also translate the manual. It is written in +LaTeX, you just have to change the file tex/vym.tex. (Linguist and QT +are not needed, but it is useful to know how to work with LaTeX and esp. +pdflatex to create the PDF.) + +Please mail me every translation you have done. I can also give you a +developer access to the project, if you want to provide translations +regulary. + \subsection{New export/import filters} +\vym supports various kinds of filters. Data can be written directly, +inserted into templates or it can be written as XML data and then +processed by XSL transformations. + +Most of the import/export functionality is available in the classes +ImportBase and ExportBase and subclasses. All of them can be found in +{\tt imports.h} and {\tt exports.h}. + +\subsubsection{Direct import/export} +An example for a direct export is the XML export. This method touches +the implementation of nearly every object of \vym, so whenever possible +it should be tried to use for example a XSL transformation instead. + +If you still want to know how it is done, start looking at +{\tt MapEditor::saveToDir} in {\tt mapeditor.cpp}. + + +\subsubsection{Templates} +\subsubsection{XSL Transformation} + \end{appendix} \end{document}