0ct0pu5/wesnoth
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

eclipse plugin: refactor documentation

Browse source
This commit is contained in:
Timotei Dolean 2010-06-11 11:52:53 +00:00
parent d9fc08492f
commit ef1ffee5eb
1 changed files with 45 additions and 39 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

84
utils/java/eclipse_plugin/README.tex
View file

@ -1,5 +1,5 @@
\documentclass[10pt]{article}
\usepackage[top=1cm, bottom=1cm, left=1cm, right=1cm]{geometry}
\usepackage[top=1cm, bottom=1cm, left=1cm, right=1cm]{geometry}
%opening
\title{Eclipse UMC Plugin Readme}
@ -13,69 +13,75 @@
\newcommand{\icnt}{ \stepcounter{cnt} \thecnt }
\section{Common prerequisites}
\icnt) Download and install Eclipse ({\bf http://eclipse.org/downloads/}) \\
\icnt) Install the library "EMF". \\
For that, in Eclipse: Help menu - Install new software, insert the link \\
({\bf http://download.eclipse.org/modeling/emf/updates/releases/}) in that textbox, and press enter.
Check the "Group items by category", and select: \\
- {\bf "EMF SDK 2.5.0 (EMF + XDS)} - select "EMF - Eclipse Modeling Framework Core Runtime"\\
\icnt) Install the library "XText". \\
The download link: http://download.itemis.com/updates/releases.
After that, select the latest version of the following packages and
install them (Don't forget to have checked the "Group items by category" checkbox): \\
- {\bf "TMF XTEXT SDK (incubation) x.x.x"} \\
- {\bf "Xtext antlr Support x.x.x"} \\
\begin{enumerate}
\item Download and install Eclipse (\textbf{http://eclipse.org/downloads/})
\item Install the library "EMF". For that, in Eclipse: Help menu - Install new software, insert the link \\
(\textbf{http://download.eclipse.org/modeling/emf/updates/releases/}) in that textbox, and press enter.
Check the "Group items by category", and select: \\
\indent - \textbf{"EMF SDK 2.5.0 (EMF + XDS)} - select "EMF - Eclipse Modeling Framework Core Runtime"
\item Install the library "XText". \\
The download link: http://download.itemis.com/updates/releases.
After that, select the latest version of the following packages and
install them (Don't forget to have checked the "Group items by category" checkbox): \\
\indent - \textbf{"TMF XTEXT SDK (incubation) x.x.x"} \\
\indent - \textbf{"Xtext antlr Support x.x.x"}
\end{enumerate}
\section{Developer}
\subsection{Setup the environment}
\setcounter{cnt}{0}
\icnt) Checkout plugin's folder from the svn (http://svn.gna.org/svn/wesnoth/trunk/utils/java/) \\
\icnt) In Eclipse, right click in Package Explorer/Project Navigator and then select
Import - General- Existing projects into Workspace \\
\icnt) Select the path where you downloaded the java folder, and check all the 4 projects
(the eclipse plugin + the other 3 xtext projects) \\
\icnt) Build the projects.
\begin{enumerate}
\item Checkout plugin's folder from the svn (http://svn.gna.org/svn/wesnoth/trunk/utils/java/)
\item In Eclipse, right click in Package Explorer/Project Navigator and then select
Import - General- Existing projects into Workspace
\item Select the path where you downloaded the java folder, and check all the 4 projects
(the eclipse plugin + the other 3 xtext projects)
\item Build the projects.
\end{enumerate}
\subsection{Running the plugin}
After you've setup the environment and built the plugin you can run it. \\
\setcounter{cnt}{0}
\icnt) Open the file plugin.xml \\
\icnt) In the {\bf Testing} section, select the desired method of launching the plugin
(non-debug/debug mode).
After you've setup the environment and built the plugin you can run it.
\begin{enumerate}
\item Open the file plugin.xml
\item In the \textbf{Testing} section, select the desired method of launching the plugin
(non-debug/debug mode).
\end{enumerate}
\section{User}
\subsection{Installing the plugin}
\setcounter{cnt}{0}
\icnt) Install the plugin from ({\bf http://eclipse.wesnoth.org/ } \\
\icnt) Select {\bf "Wesnoth UMC Plugin"} and press finish.
\begin{enumerate}
\item Install the plugin from (\textbf{http://eclipse.wesnoth.org/}
\item Select \textbf{"Wesnoth UMC Plugin"} and press finish.
\end{enumerate}
\section{Everybody}
\subsection{Using the plugin}
Ok. So, after you have your plugin installed(user) or running(developer), you can use its features.
Ok. So, after you have your plugin installed(user) or running(developer), you can use its features.
But before of all, you must update the preferences. For this, go in "Window - Preferences - Wesnoth UMC Plugin".
Here you should set all options. Should the working directory be empty, it will be computed automatically
Here you should set all options. Should the working directory be empty, it will be computed automatically
based on wesnoth's executable
\subsubsection{Wizards}
To create a new {\bf Campaign}, open the "New..." menu (either from File - New menu, or right click in the
To create a new \textbf{Campaign}, open the "New..." menu (either from File - New menu, or right click in the
project navigator and select "New..." ). After that select "Wesnoth Campaign". Fill in the information needed,
and press finish. Your campaign project is created in the workspace. \\
To create a new {\bf Scenario}, open the "New..." menu, and select "Wesnoth scenario".
To create a new \textbf{Scenario}, open the "New..." menu, and select "Wesnoth scenario".
Complete the information needed and press finish.
\subsubsection{Menus}
There are currently 2 types of menus: the context menus for different file/folder types and the toolbar menus. \\
{\bf Project context menus} - right click on the campaign projects created with the plugin\\
There are currently 2 types of menus: the context menus for different file/folder types and the toolbar menus.
\begin{description}
\item{\textbf{Project context menus}} - right click on the campaign projects created with the plugin\\
{\it Wesnoth project report} - will show a simple report with the numer of maps, scenarios and units.
{\bf .cfg files context menus} - right click on any .cfg file\\
\item{\textbf{.cfg files context menus}} - right click on any .cfg file\\
{\it Open scenario in game} - opens the selected file's scenario (if it contains one) in wesnoth \\
{\it WML Tools} - provides some options for using the wmltools with the specified file
{\it WML Tools} - provides some options for using the wmltools with the specified file
(e.g. run wmllint against the file and see the output in the console) \\
{\it Preprocessor} - provides ways of preprocessing and showing the result in an editor inside eclipse.
{\bf "maps" folder} - right click on the "maps" folder\\
\item{\textbf{"maps" folder}} - right click on the "maps" folder\\
{\it Import map} - Shows a file selection window that let's you select a .map file that will be copied in your campaign project.
\end{description}
\end{document}