Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "Riena/Getting Started"

(New section: Quick Setup)
m (Jordan.dukadinov.compeople.de moved page Riena/GettingStarted to Riena/Getting Started: added space for better readability)
 
(34 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{#eclipseproject:rt.riena}}
 
 
{|
 
| __TOC__
 
|}
 
 
 
 
== Set up target platform for Riena apps  ==
 
 
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 a [http://help.eclipse.org/galileo/topic/org.eclipse.pde.doc.user/concepts/target.htm target platform]. Follow the steps outlined in either of the following two sections to set up the target platform for Riena applications (based on Riena 4.0.0). Windows users can just download the complete targetplatform, unzip it and activate it under Window => Preferences => Plugin Development => Target Platform.
 
 
'''Quick Setup'''
 
 
* Download Eclipse IDE 3.8.x for your platform and start with a blank workspace. [http://download.eclipse.org/eclipse/downloads/eclipse3x.html Eclipse 3.x downloads]
 
* Download the [http://git.eclipse.org/c/riena/org.eclipse.riena.setup.git/snapshot/RienaSetup_4.0.0.0.zip RienaSetup] project and import it into your workspace.
 
[[Image:import_project_RienaSetup.png]]
 
* In the imported project, open the file "Riena_<version>.target" and set the target Platform
 
[[Image:target_platform_editor_RienaSetup.png]]
 
* Open the "Plug-Ins" view and import "org.eclipse.riena.example.client" as source project.
 
[[Image:import_source_project_RienaSetup.png]]
 
* Select launch configuration "SWT ExampleApplication" and add required plug-ins, then Run it.
 
 
* Now explore the code and plugin.xml in the example project
 
 
'''Manual Setup'''
 
 
*Download Eclipse IDE 3.8.x for your platform and start with a blank workspace. [http://download.eclipse.org/eclipse/downloads/eclipse3x.html Eclipse 3.x downloads]
 
*Create a new target platform under Window =&gt; Preferences =&gt; Target Platform =&gt; Add =&gt; Nothing: Start with an empty target platform =&gt; Next
 
*Provide a name like Riena 4.0.0
 
*Click Add =&gt; Software Site
 
*Select the Indigo Repository: http://download.eclipse.org/eclipse/updates/3.8
 
*Uncheck "Group by Category" otherwise you can't see all 3 RCP Target Components.
 
*Uncheck "Include required software".
 
*Select "Equinox Target Components", "Eclipse RCP", "Eclipse RCP SDK" and "Eclipse RCP Plug-in Developer Resources"
 
*Go back to Add =&gt; Software Site
 
*Select http://download.eclipse.org/rt/riena/4.0.0.0/update
 
*Uncheck "Group by Category"
 
*Select "Riena Target Components" and optional the "Riena Samples Target Components"
 
 
The result should look like this:
 
(the screenshot shows the version from 3.7, but 3.8 is very similar)
 
 
[[Image:Riena Targetplatform RCP.png]]
 
 
*Activate the platform.
 
*Done.
 
 
'''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 target platform for Riena on RAP apps  ==
 
 
For a Riena on RAP-based application to compile, a certain set of bundles (plug-ins) must be available at compile time. This set of bundles is known as a [http://help.eclipse.org/galileo/topic/org.eclipse.pde.doc.user/concepts/target.htm target platform]. Follow the steps outlined in either of the following two sections to set up the target platform for Riena on RAP applications (based on Riena 3.0.0).
 
 
'''Setup'''
 
 
*Download Eclipse IDE 3.7.x for your platform and start with a blank workspace.
 
*Create a new target platform under Window =&gt; Preferences =&gt; Target Platform =&gt; Add =&gt; Nothing: Start with an empty target platform =&gt; Next
 
*Provide a name like Riena 3.0.0
 
*Click Add =&gt; Software Site
 
*Select the Indigo Repository: http://download.eclipse.org/releases/indigo/
 
*Uncheck "Group by Category" otherwise you can't see all 3 RCP Target Components.
 
*Uncheck "Include required software".
 
*Select "Equinox Target Components", "Rich Ajax Platform (RAP) Target Components"
 
*Go back to "Add =&gt; Software Site
 
*Select http://download.eclipse.org/rt/riena/3.0.0.0/rap/
 
*Select "Riena Target Components" from here: . The result should look like this:
 
 
[[Image:Riena_RAP_Targetplatform_Screenshot.png]]
 
 
*Activate the platform.
 
*Done.
 
 
<br> '''Next Step'''
 
 
Now you are ready to start writing Riena applications (ensure that in such a launch configuration the bundle '''org.eclipse.riena.ui.swt.rap''' is selected as required bundle). 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]]. Make sure that you click on "Add Required bundles" before you start any of the examples that come with Riena.
 
 
== Set up Riena Toolbox  ==
 
 
There is a IDE Support for Riena for Eclipse 3.6. It consists of Wizards for generating some simple Riena Apps, a treebased Editor for the Assembly-Extensionpoints and an Previewer for RCP-Views and SWT-Composites.
 
 
'''Note: Make sure that you use the same Java-version to start your Eclipse-IDE and for compiling your workspace, because the Riena Toolbox uses classloaders to dynamically load and instantiate classes. That doesn't work if you run the Eclipse IDE with Java 1.5 and in your workspace have classes that were compiled with Java 1.6.'''
 
 
'''Setup'''
 
 
#install and run Eclipse &gt;= 3.6
 
#install new software from http://download.eclipse.org/rt/riena/toolbox/20120424 (make sure that you DISABLE the checkbox "Contact all update sites during install to find required software". That is currently important because of bug 306279 (https://bugs.eclipse.org/bugs/show_bug.cgi?id=306279).
 
 
So now you are all setup. To see it running:
 
 
#Create a new Plug-in Project (Would you like to create a rich client application = yes) 
 
#Select "Riena Hello World" or "Riena Mail Template" from the list of templates and finish creating the new template
 
#Show View -&gt; Other -&gt; Riena Toolbox -&gt; AssemblyEditor
 
#The Assembly Editor now shows the assemblies from all projects in the workspace.
 
 
 
For more details about the Riena Toolbox, look here http://wiki.eclipse.org/Riena/Toolbox.
 
 
==Build your own Riena-Targetplatform==
 
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 13:21, 27 November 2014

Setting up the IDE

  • Install a Eclipse for Commiters. Download from Eclipse

Clone with SSH

  • Generate a new SSH-Key pair.
  • Go to your github account and paste your key there.
  • Goto Window->Preferences->...->SSH2 and add your private key there
  • Clone the Riena repository:git@github.com:eclipse/org.eclipse.riena.git
  • Clone the Riena repository:git@github.com:eclipse/org.eclipse.riena.3xtargets.git

Clone with HTTPS

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.

Copyright © Eclipse Foundation, Inc. All Rights Reserved.