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

eclipse plugin: Update the dev manual with suggestions...

Browse source 
...from fendrin. Also bump the eclipse version to indigo as we're
gonna upgrade xtext to 2.0 as well
This commit is contained in:
Timotei Dolean 2011-07-15 21:05:57 +00:00
parent fb7939c2e9
commit 25cd35c30e
1 changed files with 9 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
utils/umc_dev/manual/dev_manual.tex
View file

@ -45,7 +45,7 @@ A quick list before getting into details:
\begin{enumerate}
\item Java 6
\item Python 2.x
\item Eclipse 3.5 or newer
\item Eclipse 3.7 ( Indigo ) or newer
\item Wesnoth 1.9.x, trunk or newer
\end{enumerate}
@ -66,7 +66,7 @@ Now for getting all those items:
\end{enumerate}
\textit{Note:} Please ensure you install the 2.x versions. Versions 3.x are \textbf{not} yet supported by the Wesnoth's WML Tools.
\item Download ``Eclipse" (The download links are in the right. Please ensure you are downloading at least the \textbf{3.5} version, otherwise the plugin will not work.): \href{http://eclipse.org/downloads/packages/eclipse-rcp-and-rap-developers/heliosr}{Download Eclipse for RCP and RAP Developers}
\item Download ``Eclipse" (The download links are in the right. Please ensure you are downloading at least the \textbf{3.7} version, otherwise the plugin will not work. Also, \textbf{don't} download a \textbf{64 bit version} unless you are sure you have Java JDK on 64 bit. If you are unsure, select the 32 bit version): \href{http://eclipse.org/downloads/packages/eclipse-rcp-and-rap-developers/indigor}{Download Eclipse for RCP and RAP Developers}
\item Extract the downloaded archive in a known location and launch the executable (eclipse / eclipse.exe)
@ -77,7 +77,7 @@ Now for getting all those items:
After you got all the prerequisites, you need to setup the eclipse installation.
\begin{enumerate}
\item Open up the ``Install new software" menu, and select from the list: ``Helios - http://download.eclipse.org/releases/helios"
\item Open up the ``Install new software" menu, and select from the list: ``Indigo - http://download.eclipse.org/releases/indigo"
\item In the list populated with items, select from the ``Modelling" category: ``Xtext SDK", and install it. Restart eclipse after that.
@ -85,7 +85,7 @@ After you got all the prerequisites, you need to setup the eclipse installation.
\item In Eclipse, right click in \textbf{Package Explorer/Navigator} and then select \textbf{Import - General - Existing projects into Workspace}
\item Select the path where you downloaded the ``umc\_dev" folder, and check all the projects: ``org.wesnoth", ``org.wesnoth.ui", ``org.wesnoth.feature".
\item Select the path where you downloaded the ``umc\_dev" folder, and check all the projects: ``org.wesnoth", ``org.wesnoth.ui", ``org.wesnoth.feature". \textbf{Don't} check the "Copy projects into workspace.
\item The projects will be compiled automatically. Just to be sure, as in each Java project, verify that the ``Build automatically" entry in the ``Project" menu is checked.
\end{enumerate}
@ -98,7 +98,7 @@ After you've setup the environment you can run the plugin.
\item Click the ``Launch an Eclipse application" or ``Launch an Eclipse application in Debug mode" from the right part of the file, to launch the plugin.
\end{enumerate}
\begin{center}
\includegraphics[scale=0.7]{launch_plugin.png}
\includegraphics[scale=0.6]{launch_plugin.png}
\end{center}
If you want to know how you can use the plugin, please consult the User's Manual.
@ -107,7 +107,7 @@ If you want to know how you can use the plugin, please consult the User's Manual
The plugin can be built as a zip archive (usually) for different operating systems. The built application can be launched without any Eclipse prerequisites. This plugin's version is called \textbf{Standalone}. To build the plugin, you need to follow the specified steps:
\begin{enumerate}
\item Download the ``eclipse\_3.6.2.zip" archive, that contains an already existing eclipse installation and deltapack (used for building against other OSes than the native one). The link for the download is: \href{http://sourceforge.net/projects/wesnoth/files/wesnoth-umcplugin/build\_utils/eclipse\_3.6.2.zip/download}{Download}
\item Download the ``eclipse\_3.7.zip" archive, that contains an already existing eclipse installation and deltapack (used for building against other OSes than the native one). The link for the download is: \href{http://sourceforge.net/projects/wesnoth/files/wesnoth-umcplugin/build\_utils/eclipse\_3.7.zip/download}{Download}
\item Extract the archive in the favorite location
@ -120,7 +120,7 @@ The plugin can be built as a zip archive (usually) for different operating syste
\item Select the \textbf{Running Platform (Active)} item and press ``Edit..." in the left buttons lane.
\item A new window with tabs will be opened. Select the ``Locations" tab, and in the right buttons lane, select ``Add..."
\item Select ``Directory" in the new windows, then press Next.
\item Browse to the previous location where you have extracted the ``eclipse\_3.6.2.zip" archive.
\item Browse to the previous location where you have extracted the ``eclipse\_3.7.zip" archive.
\item Press Finish and Ok until you exist all windows.
\item Now, go into the ``org.wesnoth" project, and open the file ``org.wesnoth.product".
\item In the bottom right part of the opened file, in section ``Exporting" there is a link: ``Eclipse Product export wizard". Click that.
@ -132,7 +132,7 @@ The plugin can be built as a zip archive (usually) for different operating syste
\item If you want to build the plugin using the scripts, do the following:
\begin{enumerate}
\item Go to the ``org.wesnoth.build" in the checked-out directory from the SVN.
\item Go to the ``build" directory in the checked-out directory from the SVN.
\item There are 2 files that are important: \textbf{build.sh} - For UNIX systems - and \textbf{build.cmd} - For Windows systems.
\item Both files need a one argument that specifies the path to a valid Eclipse + deltapack installation. The file you have previously downloaded contains this.
\item You can invoke the script with the 1st parameter as the path to the location where you have extracted the archive.
@ -144,7 +144,7 @@ The plugin can be built as a zip archive (usually) for different operating syste
The WML Editor uses the Xtext (\href{http://www.eclipse.org/Xtext/}{http://www.eclipse.org/Xtext/}) framework for getting the functionality an editor should have. The editor is based on the WML grammar defined in the ``org.wesnoth/src/org.wesnoth/WML.xtext" file.
The file is written in some EBNF variant (\href{http://www.eclipse.org/Xtext/documentation/2\_0\_0/020-grammar-language.php}{http://www.eclipse.org/Xtext/documentation/2\_0\_0/020-grammar-language.php} )
To (re-)generate the wml grammar that supports the WML Editor, right click the ``org.wesnoth/src/org.wesnoth/GenerateWML.mwe2", and select ``Run as" and after that ``MWE2 Workflow". If this is your first time running the MWE2 Workflow, you'll be prompted to download the ANTLR generator jar file. Press (y) and that will continue.
To (re-)generate the wml grammar, right click the ``org.wesnoth/src/org.wesnoth/GenerateWML.mwe2", and select ``Run as" and after that ``MWE2 Workflow". If this is your first time running the MWE2 Workflow, you'll be prompted to download the ANTLR generator jar file. Press (y) and that will continue.
\section{Frequently Asked Questions}
\subsection{Where can I submit any bugs found?}