Jump to: navigation, search

Difference between revisions of "Riena/Getting Started"

m
m (Jordan.dukadinov.compeople.de moved page Riena/GettingStarted to Riena/Getting Started: added space for better readability)
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{#eclipseproject:rt.riena}}
 
 
{|
 
| __TOC__
 
|}
 
 
 
 
For a Riena-based application to compile, a certain set of bundles (plug-ins) must be available at compile time. This set of bundles is known as [http://help.eclipse.org/galileo/topic/org.eclipse.pde.doc.user/concepts/target.htm target platform]. Follow the steps below to set up the target platform for Riena applications.
 
 
 
== Running the code samples and example client ==
 
 
 
'''1.''' Download [http://www.eclipse.org/downloads/packages/eclipse-rcp-and-rap-developers/junosr2 Eclipse for RCP and RAP Developers] and start with a blank workspace.
 
 
 
'''2.''' Download the <code>[http://git.eclipse.org/c/riena/org.eclipse.riena.setup.git/snapshot/RienaSetup_5.0.0.0.zip RienaSetup]</code> project and import it into your workspace.
 
[[Image:import_project_RienaSetup.png]]
 
 
 
'''3.''' In the imported project, open the file <code>Riena_on_4x.target</code> and set the target platform.
 
Note: If you want to use Riena on an Eclipse 3.x or [[RAP]] basis, select the appropriate target definition.
 
[[Image:target_platform_editor_RienaSetup.png]]
 
 
 
'''4.''' Open the "Plug-Ins" view and import as source project:
 
* <code>org.eclipse.riena.example.client</code>
 
* <code>org.eclipse.riena.sample.snippets</code> (not relevant for Riena on RAP)
 
[[Image:import_source_project_RienaSetup.png]]
 
 
 
'''5.''' In the project <code>RienaSetup</code>, select the launch configuration "SWT ExampleApplication E4" and add required plug-ins, then Run it. For Riena on Eclipse 3.x or RAP, use the appropriate launch configuration.
 
* Explore the code and plugin.xml in the example project
 
 
 
'''5.1''' For Riena on RAP comment the extension to <code>org.eclipse.rap.ui.entrypoint</code> on the bottom of the plugin.xml, ignore the displayed error.
 
 
 
'''6.''' Some specific techniques are demonstrated in the snippets project, imported in step 4.
 
 
== Manual target platform setup ==
 
 
If you do not like to use the target definition files in the <code>RienaSetup</code> project like described in the above section, you can manually create a target platform description with Eclipse:
 
 
* Create a new target platform definition under Window =&gt; Preferences =&gt; Target Platform =&gt; Add =&gt; Nothing: Start with an empty target platform =&gt; Next
 
* Provide a name like "Riena Target Platform"
 
* Click Add =&gt; Software Site
 
* Select the p2 repository which contains the target components to install (see below)
 
* Select the target components (see below)
 
* Uncheck "Group by Category" otherwise you can't see all components
 
* Uncheck "Include required software" if you are setting up Riena on RAP
 
 
The result should look like this:
 
[[Image:Riena Targetplatform RCP.png]]
 
 
<br>
 
 
The Riena components are contained in the [http://download.eclipse.org/releases/kepler Eclipse Kepler p2 repository]. From there, you can also install the RCP and Equinox target components, which a Riena application needs to run.
 
 
Target components to install:
 
 
* <code>Riena Target Components for E4</code> or <code>Riena Target Components for RAP
 
* Riena Core Target Components for E4 and RAP
 
* Riena Samples Target Components
 
* Eclipse RCP
 
* Eclipse RCP Plug-in Developer Resources
 
* Eclipse RCP SDK
 
* Equinox Target Components</code>
 
 
 
=== Setting up Riena for Eclipse 3.8 ===
 
 
Eclipse 3.8 is the last version of the Eclipse 3.x stream. Riena 5 comes with full support for Eclipse 3.8.
 
 
Riena for Eclipse 3.8 is in a separate p2 Repository - <code>http://download.eclipse.org/rt/riena/5.0.0.0/e3</code>.
 
 
RCP 3.8 and Equinox can be installed from
 
<code>http://download.eclipse.org/eclipse/updates/3.8</code>.
 
 
 
'''Next Step'''
 
 
Now you are ready to start writing Riena applications. To get a feeling of the Riena framework, take a look at Riena's [[Riena Example Applications and Code Templates|Example Applications and Code Templates]].
 
 
== Set up Riena Toolbox  ==
 
 
 
 
 
For more details about the Riena Toolbox, look here http://wiki.eclipse.org/Riena/Toolbox.
 
 
==Build your own Riena-Targetplatform (deprecated)==
 
 
'''This section is currently deprecated'''
 
 
Riena provides a tycho-build to build a targetplatform from cvs head. Follows these steps:
 
 
'''Prerequisites:'''
 
* Install  [http://ant.apache.org/ ant]
 
* Install  [http://maven.apache.org/maven maven 3]
 
 
'''Start the build:'''
 
* Checkout the bundle org.eclipse.riena.build.tycho from cvs (:pserver:anonymous@dev.eclipse.org:/cvsroot/rt)
 
* Open a shell and go to the directory org.eclipse.riena.build.tycho
 
* Checkout the sources by executing: ant -f checkout.xml -DCHECKOUT_DIR=checkout -DTARGET_DIR=target
 
* Go to target/org.eclipse.riena.build.tycho
 
* Execute: mvn clean install -P all-modules -Dmaven.test.skip=true
 
 
At the moment Tycho can't handle the package import to javax.servlet, so we had to replace this with a dependencie. We accomplished this by patching the MANIFEST.MF from the bundle org.eclipse.communication.core after the checkout.
 
There may be other issues with the result of this build or the buildprocess itself, so be aware that this is not yet production ready.
 
  
 +
{{Riena/Setting up the IDE}}
  
 
[[Category:Riena]]
 
[[Category:Riena]]
 
[[Category:EclipseRT]]
 
[[Category:EclipseRT]]

Latest revision as of 12:21, 27 November 2014

Setting up the IDE

To get started with Riena, it's recommended to set up Eclipse with the Riena Toolbox installed.

Eclipse

Download Eclipse for RCP and RAP Developers and start with a blank workspace.

Riena Toolbox

Start Eclipse and install the Riena Toolbox:

  • Open the Eclipse Install dialog from the main menu (Help > Install New Software...).
  • Select all components from http://download.eclipse.org/rt/riena/toolbox/20120424
    • IMPORTANT: Uncheck "Contact all update sites during install to find required software"
  • Complete the installation (Eclipse will ask you to restart)

Next Step

Next you need to install the Riena runtime. This is done by setting Riena as the Target Platform. The Target Platform is the foundation for your Riena based application.

Note: The Target Platform version is not related to the IDE version you are using.