Show first_steps.html syntax highlighted
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta name="copyright" content="Copyright (c) Wolfgang Möstl 2006-2007. This page is made available under the GNU public license." >
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=ISO-8859-1">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<meta name="DESCRIPTION" content="PovClipse online help">
<meta name="AUTHOR" content="Wolfgang Möstl">
<meta name="KEYWORDS" content="PovClipse,Documentation,Development,First Steps">
<meta http-equiv="CONTENT-LANGUAGE" content="en">
<meta name="ROBOTS" content=" index,follow ">
<meta name="REVISIT-AFTER" content="10 DAYS">
<meta http-equiv="EXPIRES" content="86400">
<title>PovClipse: Project documentation</title>
<link rel="stylesheet" type="text/css" href="../style/docs.css">
</head>
<body>
<h1>Development - First Steps</h1>
<p>This document describes how to set up the PovClipse development environment.<p>
<p>This document targets two different development roles:
<ol>
<li><b>Developers</b> in order to speed up the starting process</li>
<li><b>Translators</b> in order to enable a translator to test their work</li>
</ol>
</p>
<h2>Eclipse requirements</h2>
<p>You need an Eclipse 3.2 or later with PDE (Plug-in development) support in order to run PovClipse in
development or debug mode.<br>
The following Eclipse versions are suitable:
<ul>
<li><a href="http://download.eclipse.org/eclipse/downloads/drops/R-3.2.2-200702121330/download.php?dropFile=eclipse-SDK-3.2.2-win32.zip">
<b>Eclipse SDK 3.2.2 for Windows</b></a> (or for any other supported OS, please check the Eclipse download site)</li>
<li><a href="http://download.eclipse.org/eclipse/downloads/drops/R-3.2.1-200609210945/download.php?dropFile=eclipse-SDK-3.2.1-win32.zip">
<b>Eclipse SDK 3.2.1 for Windows</b></a> (or for any other supported OS, please check the Eclipse download site)</li>
<li><a href="http://download.eclipse.org/eclipse/downloads/drops/R-3.2-200606291905/download.php?dropFile=eclipse-SDK-3.2-win32.zip">
<b>Eclipse SDK 3.2 for Windows</b></a> (or for any other supported OS, please check the Eclipse download site)</li>
</ul>
</p>
<p>
<h2>Source Code check out</h2>
<p>Please check the document <a href="../description/svn.html">Subversion access</a>
on howto configure the Subversion ("SVN" for short) repository.
The SVN repository contains all the PovClipse source code and resources.</p>
<p>In order to have a working source code version you will need to check out at least
the following Projects from the SVN repository:</p>
<ol>
<li><b>Logging-Plugin</b></li>
<li><b>PovClipse-Plugin</b></li>
<li>Optional: <b>MegaPovDocumentation_1_2_1-Plugin</b> if you want to have the
MegaPOV 1.2.1 Documentation plugin debugable</li>
<li>Optional: <b>PovrayDocumentation_3_6-Plugin</b> if you want to have the
Povray 3.6 Documentation plugin debugable</li>
</ol>
All other Projects are needed only if you want to create an installable PovClipse build.
<h2>Starting PovClipse from the Eclipse workbench</h2>
<p>At first open the file <code>PovClipse-Plugin/META-INF/MANIFEST.MF</code> using a
double-click. Eclipse opens the file using the "Plug-in Manifest Editor".
If not already selected click on the <b>"Overview"</b> tab.</p>
<p>In the <b>"Testing"</b> section you will see two entries allowing to
run PovClipse either in normal or debug mode:</p>
<ul>
<li><b>"Launch an Eclipse application"</b></li>
<li><b>"Launch an Eclipse application in Debug mode"</b></li>
</ul>
Click on one of them in order to start a new Eclipse Workbench having
PovClipse installed.
<h3>Starting PovClipse using the Launcher</h3>
<p>After you have run PovClipse the very first time using the mechanism above you
will find a new "Eclipse Application" entry in the Eclipse
<b>"Run"</b> and <b>"Debug"</b> launchers.</p>
<p>You can use this launcher configuration to start PovClipse the next time.</p>
<h3>Configuring the PovClipse Launcher, e.g. setting the Language to be used</h3>
<p>In order to configure the PovClipse launcher created above (e.g. telling PovClipse the
Language to use...) expand the either the "Run" or "Debug" launcher
and select <b>"Run..."</b> or <b>"Debug..."</b>.</p>
<p>Select the "Eclipse Application" entry created in order to edit it.</p>
<p>At first I suggest to rename the entry, e.g. "PovClipse".</p>
<p>If you want to change the language used you have to add an <code>nl</code> parameter
to the "Program Arguments". Select the "Arguments" tab and
enter the following in the "Program Arguments" text field in order
let PovClipse use the Portuguese language:<br>
<code>-nl pt</code><br>
The next time you start PovClipse using this launcher you will see Eclipse and PovClipse
using the Portuguese language (Eclipse can use Portuguese only if you have installed the
Portuguese language pack!)</p>
<p class="note">If you are translator you will probably use this option to test your
translations!</p>
<p class="note">Please note that there is no way to separate the Eclipse and PovClipse
language! The <code>"nl"</code> argument is used by both, Eclipse and PovClipse!</p>
</body>
</html>
See more files for this project here