You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@karaf.apache.org by jb...@apache.org on 2012/12/19 08:30:06 UTC
svn commit: r1423773 - in /karaf/eik/trunk/manual/src/main/webapp:
developers-guide/ images/ user-guide/
Author: jbonofre
Date: Wed Dec 19 07:29:53 2012
New Revision: 1423773
URL: http://svn.apache.org/viewvc?rev=1423773&view=rev
Log:
[KARAF-1800] Improve EIK documentation
Added:
karaf/eik/trunk/manual/src/main/webapp/developers-guide/example.conf
karaf/eik/trunk/manual/src/main/webapp/developers-guide/prerequisites.conf
karaf/eik/trunk/manual/src/main/webapp/images/createproject_1.png
karaf/eik/trunk/manual/src/main/webapp/images/createproject_2.png
karaf/eik/trunk/manual/src/main/webapp/images/createproject_3.png
karaf/eik/trunk/manual/src/main/webapp/images/devexample_1.png
karaf/eik/trunk/manual/src/main/webapp/images/devexample_4.png
karaf/eik/trunk/manual/src/main/webapp/images/devexample_5.png
karaf/eik/trunk/manual/src/main/webapp/images/devexample_6.png
karaf/eik/trunk/manual/src/main/webapp/images/installation_1.png
karaf/eik/trunk/manual/src/main/webapp/images/installation_2.png
karaf/eik/trunk/manual/src/main/webapp/images/installation_3.png
karaf/eik/trunk/manual/src/main/webapp/images/installation_4.png
karaf/eik/trunk/manual/src/main/webapp/images/launchconf_1.png
karaf/eik/trunk/manual/src/main/webapp/images/launchconf_2.png
karaf/eik/trunk/manual/src/main/webapp/images/loadbundle_1.png
karaf/eik/trunk/manual/src/main/webapp/images/loadbundle_2.png
karaf/eik/trunk/manual/src/main/webapp/user-guide/createproject.conf
karaf/eik/trunk/manual/src/main/webapp/user-guide/launchconf.conf
karaf/eik/trunk/manual/src/main/webapp/user-guide/loadbundle.conf
Modified:
karaf/eik/trunk/manual/src/main/webapp/developers-guide/index.conf
karaf/eik/trunk/manual/src/main/webapp/images/devcomponent_1.png
karaf/eik/trunk/manual/src/main/webapp/images/devcomponent_2.png
karaf/eik/trunk/manual/src/main/webapp/user-guide/devcomponent.conf
karaf/eik/trunk/manual/src/main/webapp/user-guide/index.conf
karaf/eik/trunk/manual/src/main/webapp/user-guide/installation.conf
karaf/eik/trunk/manual/src/main/webapp/user-guide/prerequisites.conf
karaf/eik/trunk/manual/src/main/webapp/user-guide/uninstall.conf
Added: karaf/eik/trunk/manual/src/main/webapp/developers-guide/example.conf
URL: http://svn.apache.org/viewvc/karaf/eik/trunk/manual/src/main/webapp/developers-guide/example.conf?rev=1423773&view=auto
==============================================================================
--- karaf/eik/trunk/manual/src/main/webapp/developers-guide/example.conf (added)
+++ karaf/eik/trunk/manual/src/main/webapp/developers-guide/example.conf Wed Dec 19 07:29:53 2012
@@ -0,0 +1,30 @@
+h1. How to modify code
+
+With this example we want to show how to modify EIK.
+To do this we start by an example, we try to solve together a issue [https://issues.apache.org/jira/browse/KARAF-1855].
+
+h3. Import EIK in eclipse
+
+From File > Import > Maven > Existing Maven Projects
+
+!/images/devexample_1.png!
+
+After the development environment is ready, the class to change for resolve the issue is *NewKarafProjectWizard*.
+Goal is to advise user that the project has been created successfully and close the wizard.
+
+For do that I added a messageDialog as outlined in the code:
+
+!/images/devexample_4.png!
+
+To see if the change has its effect select
+*Right click on org.apache.karaf.eik.ui > Debug As > EclipseApplication*
+
+Create a new project as see in [installation|../user-guide/installation.html].
+
+!/images/devexample_5.png!
+
+Click Finish and message and wizard will be closed.
+
+!/images/devexample_6.png!
+
+This minor change doesn't resolve the issue, but it illustrates how to test our changes on the code.
Modified: karaf/eik/trunk/manual/src/main/webapp/developers-guide/index.conf
URL: http://svn.apache.org/viewvc/karaf/eik/trunk/manual/src/main/webapp/developers-guide/index.conf?rev=1423773&r1=1423772&r2=1423773&view=diff
==============================================================================
--- karaf/eik/trunk/manual/src/main/webapp/developers-guide/index.conf (original)
+++ karaf/eik/trunk/manual/src/main/webapp/developers-guide/index.conf Wed Dec 19 07:29:53 2012
@@ -1,2 +1,4 @@
!/images/karaf-logo.png!
h1. Eclipse Integration Karaf Developer Guide
+* [Prerequisites|/developers-guide/prerequisites]
+* [How to modify code|/developers-guide/example]
Added: karaf/eik/trunk/manual/src/main/webapp/developers-guide/prerequisites.conf
URL: http://svn.apache.org/viewvc/karaf/eik/trunk/manual/src/main/webapp/developers-guide/prerequisites.conf?rev=1423773&view=auto
==============================================================================
--- karaf/eik/trunk/manual/src/main/webapp/developers-guide/prerequisites.conf (added)
+++ karaf/eik/trunk/manual/src/main/webapp/developers-guide/prerequisites.conf Wed Dec 19 07:29:53 2012
@@ -0,0 +1,19 @@
+h1. Prerequisites
+
+For import eik project in eclipse without error we need follow the following point
+
+*Environment:*
+* Java SE Development Kit 1.6.x or greater ([http://www.oracle.com/technetwork/java/javase/]).
+* Apache Maven 3.0.3 ([http://maven.apache.org/download.html]).
+* Eclipse IDE for Java EE Developers (Helios (Eclipse 3.6.x) or Galileo (Eclipse 3.5.x))([http://www.eclipse.org/downloads/]).
+* Apache KARAF 2.2.x ([http://karaf.apache.org/index/community/download.html]);
+* m2e(clipse) plugins ([http://eclipse.org/m2e/])
+* Tycho Project Configurators it is downloaded automatically when inport EIK in eclipse with m2e version 0.6.0 or higher
+* WST server tools download from *Install Manager* version 3.2.100.v20110303-51EoAkF77g8HBSc or higher
+* JST Enterprise Core from *Install Manager* 3.3.0.v201102200555 or higher
+* JST Enterprise User Documentation from *Install Manager* version 3.3.100.v201105122000-62FUGBgJ9EA9aEeHRHc or higher
+* JST Server Adapters from *Install Manager* version 3.3.0.v201102200555 or higher
+* JST Server UI from *Install Manager* version 3.3.0.v201102200555 or higher
+* JST Server User Documentation from *Install Manager* version 3.3.100.v20110303-2-Eo7w3121162A3329 or higher
+* JST Web Core from *Install Manager* version 3.3.0.v201103310009 or higher
+* JST Web User Documentation from *Install Manager* version 3.3.0.v201102200555-2107w31211938 or higher
Added: karaf/eik/trunk/manual/src/main/webapp/images/createproject_1.png
URL: http://svn.apache.org/viewvc/karaf/eik/trunk/manual/src/main/webapp/images/createproject_1.png?rev=1423773&view=auto
==============================================================================
Files karaf/eik/trunk/manual/src/main/webapp/images/createproject_1.png (added) and karaf/eik/trunk/manual/src/main/webapp/images/createproject_1.png Wed Dec 19 07:29:53 2012 differ
Added: karaf/eik/trunk/manual/src/main/webapp/images/createproject_2.png
URL: http://svn.apache.org/viewvc/karaf/eik/trunk/manual/src/main/webapp/images/createproject_2.png?rev=1423773&view=auto
==============================================================================
Files karaf/eik/trunk/manual/src/main/webapp/images/createproject_2.png (added) and karaf/eik/trunk/manual/src/main/webapp/images/createproject_2.png Wed Dec 19 07:29:53 2012 differ
Added: karaf/eik/trunk/manual/src/main/webapp/images/createproject_3.png
URL: http://svn.apache.org/viewvc/karaf/eik/trunk/manual/src/main/webapp/images/createproject_3.png?rev=1423773&view=auto
==============================================================================
Files karaf/eik/trunk/manual/src/main/webapp/images/createproject_3.png (added) and karaf/eik/trunk/manual/src/main/webapp/images/createproject_3.png Wed Dec 19 07:29:53 2012 differ
Modified: karaf/eik/trunk/manual/src/main/webapp/images/devcomponent_1.png
URL: http://svn.apache.org/viewvc/karaf/eik/trunk/manual/src/main/webapp/images/devcomponent_1.png?rev=1423773&r1=1423772&r2=1423773&view=diff
==============================================================================
Files karaf/eik/trunk/manual/src/main/webapp/images/devcomponent_1.png (original) and karaf/eik/trunk/manual/src/main/webapp/images/devcomponent_1.png Wed Dec 19 07:29:53 2012 differ
Modified: karaf/eik/trunk/manual/src/main/webapp/images/devcomponent_2.png
URL: http://svn.apache.org/viewvc/karaf/eik/trunk/manual/src/main/webapp/images/devcomponent_2.png?rev=1423773&r1=1423772&r2=1423773&view=diff
==============================================================================
Files karaf/eik/trunk/manual/src/main/webapp/images/devcomponent_2.png (original) and karaf/eik/trunk/manual/src/main/webapp/images/devcomponent_2.png Wed Dec 19 07:29:53 2012 differ
Added: karaf/eik/trunk/manual/src/main/webapp/images/devexample_1.png
URL: http://svn.apache.org/viewvc/karaf/eik/trunk/manual/src/main/webapp/images/devexample_1.png?rev=1423773&view=auto
==============================================================================
Files karaf/eik/trunk/manual/src/main/webapp/images/devexample_1.png (added) and karaf/eik/trunk/manual/src/main/webapp/images/devexample_1.png Wed Dec 19 07:29:53 2012 differ
Added: karaf/eik/trunk/manual/src/main/webapp/images/devexample_4.png
URL: http://svn.apache.org/viewvc/karaf/eik/trunk/manual/src/main/webapp/images/devexample_4.png?rev=1423773&view=auto
==============================================================================
Files karaf/eik/trunk/manual/src/main/webapp/images/devexample_4.png (added) and karaf/eik/trunk/manual/src/main/webapp/images/devexample_4.png Wed Dec 19 07:29:53 2012 differ
Added: karaf/eik/trunk/manual/src/main/webapp/images/devexample_5.png
URL: http://svn.apache.org/viewvc/karaf/eik/trunk/manual/src/main/webapp/images/devexample_5.png?rev=1423773&view=auto
==============================================================================
Files karaf/eik/trunk/manual/src/main/webapp/images/devexample_5.png (added) and karaf/eik/trunk/manual/src/main/webapp/images/devexample_5.png Wed Dec 19 07:29:53 2012 differ
Added: karaf/eik/trunk/manual/src/main/webapp/images/devexample_6.png
URL: http://svn.apache.org/viewvc/karaf/eik/trunk/manual/src/main/webapp/images/devexample_6.png?rev=1423773&view=auto
==============================================================================
Files karaf/eik/trunk/manual/src/main/webapp/images/devexample_6.png (added) and karaf/eik/trunk/manual/src/main/webapp/images/devexample_6.png Wed Dec 19 07:29:53 2012 differ
Added: karaf/eik/trunk/manual/src/main/webapp/images/installation_1.png
URL: http://svn.apache.org/viewvc/karaf/eik/trunk/manual/src/main/webapp/images/installation_1.png?rev=1423773&view=auto
==============================================================================
Files karaf/eik/trunk/manual/src/main/webapp/images/installation_1.png (added) and karaf/eik/trunk/manual/src/main/webapp/images/installation_1.png Wed Dec 19 07:29:53 2012 differ
Added: karaf/eik/trunk/manual/src/main/webapp/images/installation_2.png
URL: http://svn.apache.org/viewvc/karaf/eik/trunk/manual/src/main/webapp/images/installation_2.png?rev=1423773&view=auto
==============================================================================
Files karaf/eik/trunk/manual/src/main/webapp/images/installation_2.png (added) and karaf/eik/trunk/manual/src/main/webapp/images/installation_2.png Wed Dec 19 07:29:53 2012 differ
Added: karaf/eik/trunk/manual/src/main/webapp/images/installation_3.png
URL: http://svn.apache.org/viewvc/karaf/eik/trunk/manual/src/main/webapp/images/installation_3.png?rev=1423773&view=auto
==============================================================================
Files karaf/eik/trunk/manual/src/main/webapp/images/installation_3.png (added) and karaf/eik/trunk/manual/src/main/webapp/images/installation_3.png Wed Dec 19 07:29:53 2012 differ
Added: karaf/eik/trunk/manual/src/main/webapp/images/installation_4.png
URL: http://svn.apache.org/viewvc/karaf/eik/trunk/manual/src/main/webapp/images/installation_4.png?rev=1423773&view=auto
==============================================================================
Files karaf/eik/trunk/manual/src/main/webapp/images/installation_4.png (added) and karaf/eik/trunk/manual/src/main/webapp/images/installation_4.png Wed Dec 19 07:29:53 2012 differ
Added: karaf/eik/trunk/manual/src/main/webapp/images/launchconf_1.png
URL: http://svn.apache.org/viewvc/karaf/eik/trunk/manual/src/main/webapp/images/launchconf_1.png?rev=1423773&view=auto
==============================================================================
Files karaf/eik/trunk/manual/src/main/webapp/images/launchconf_1.png (added) and karaf/eik/trunk/manual/src/main/webapp/images/launchconf_1.png Wed Dec 19 07:29:53 2012 differ
Added: karaf/eik/trunk/manual/src/main/webapp/images/launchconf_2.png
URL: http://svn.apache.org/viewvc/karaf/eik/trunk/manual/src/main/webapp/images/launchconf_2.png?rev=1423773&view=auto
==============================================================================
Files karaf/eik/trunk/manual/src/main/webapp/images/launchconf_2.png (added) and karaf/eik/trunk/manual/src/main/webapp/images/launchconf_2.png Wed Dec 19 07:29:53 2012 differ
Added: karaf/eik/trunk/manual/src/main/webapp/images/loadbundle_1.png
URL: http://svn.apache.org/viewvc/karaf/eik/trunk/manual/src/main/webapp/images/loadbundle_1.png?rev=1423773&view=auto
==============================================================================
Files karaf/eik/trunk/manual/src/main/webapp/images/loadbundle_1.png (added) and karaf/eik/trunk/manual/src/main/webapp/images/loadbundle_1.png Wed Dec 19 07:29:53 2012 differ
Added: karaf/eik/trunk/manual/src/main/webapp/images/loadbundle_2.png
URL: http://svn.apache.org/viewvc/karaf/eik/trunk/manual/src/main/webapp/images/loadbundle_2.png?rev=1423773&view=auto
==============================================================================
Files karaf/eik/trunk/manual/src/main/webapp/images/loadbundle_2.png (added) and karaf/eik/trunk/manual/src/main/webapp/images/loadbundle_2.png Wed Dec 19 07:29:53 2012 differ
Added: karaf/eik/trunk/manual/src/main/webapp/user-guide/createproject.conf
URL: http://svn.apache.org/viewvc/karaf/eik/trunk/manual/src/main/webapp/user-guide/createproject.conf?rev=1423773&view=auto
==============================================================================
--- karaf/eik/trunk/manual/src/main/webapp/user-guide/createproject.conf (added)
+++ karaf/eik/trunk/manual/src/main/webapp/user-guide/createproject.conf Wed Dec 19 07:29:53 2012
@@ -0,0 +1,37 @@
+h1. Create a new Apache Karaf Project
+
+Create new karaf runtime with *Select File > New > Apache Karaf Installation* and add *project_name*
+
+!/images/createproject_1.png!
+
+Select runtime *karaf_installation_dir* of your karaf or Servicemix runtime
+
+!/images/createproject_2.png!
+
+Doubleclick on <project_name>.target and select target platform.
+Target platform corresponds to the set of OSGi components used for development and any OSGi components defined as projects within the workspace for Example (Karaf , Servicemix, Camel , CXF ).
+For example Eclipse PDE uses these components for compilation and checks if imports can be resolved.
+Basically is based on a directory containing these components.
+By default, this is the plugins directory under the Eclipse installation directory, which contains all plug-ins associated with Eclipse.
+
+!/images/createproject_3.png!
+
+To configure target platform there can be two approch:
+* Using the facilities provided by Eclipse PDE to specify all the components you need selecting directory ecc.ecc.
+* EIK provides preconfigured target platforms for Karaf based runtime
+
+choose the most convenient for you
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Modified: karaf/eik/trunk/manual/src/main/webapp/user-guide/devcomponent.conf
URL: http://svn.apache.org/viewvc/karaf/eik/trunk/manual/src/main/webapp/user-guide/devcomponent.conf?rev=1423773&r1=1423772&r2=1423773&view=diff
==============================================================================
--- karaf/eik/trunk/manual/src/main/webapp/user-guide/devcomponent.conf (original)
+++ karaf/eik/trunk/manual/src/main/webapp/user-guide/devcomponent.conf Wed Dec 19 07:29:53 2012
@@ -1,31 +1,103 @@
h1. Developing OSGi components with EIK
-This chapter describes how to develop an OSGi component with EIK.
-We use [M2E Maven plugin|http://eclipse.org/m2e/] which provides different archetypes.
+This chapter describes how to develop a osgi component with EIK.
+Now we have a functional karaf environment in Eclipse, and we will illustrate howto develop a debug simple Camel route
-h3. Create The project
+For this example we use apache servicemix 4.4.2.
-From EIK perspective *File->New->Other...* in the wizard select *Maven->Maven Project*
-!/images/devcomponent_1.png!
-
-Insert the location where you want to save your project, let not selected "Create a simple project (skip archetype Selection)"
-
-!/images/devcomponent_2.png!
+Using command line, we can create our project:
+{noformat}
+mvn archetype:generate \
+ -DarchetypeGroupId=org.apache.karaf.eik.archetypes \
+ -DarchetypeArtifactId=camel-osgi-pde-plugin \
+ -DarchetypeVersion=3.0.0-SNAPSHOT \
+ -DgroupId=org.apache \
+ -DartifactId=eik-camel-osgi-project \
+ -Dversion=1.0.0-SNAPSHOT
+{noformat}
+as soon as possible this archetype will be available for m2e
+
+
+*Additional parameters*
+
+During the maven creation process, additional questions will be asked on the console :
+
+* Define value for property 'camel-version':
+ The version of camel we want to use
+
+* Define value for property 'slf4j-version':
+ The version of slf4j we want to use
+
+*Result of Maven command execution*
+
+{noformat}
+[INFO] Scanning for projects...
+[INFO]
+[INFO] ------------------------------------------------------------------------
+[INFO] Building Maven Stub Project (No POM) 1
+[INFO] ------------------------------------------------------------------------
+[INFO]
+[INFO] >>> maven-archetype-plugin:2.2:generate (default-cli) @ standalone-pom >>>
+[INFO]
+[INFO] <<< maven-archetype-plugin:2.2:generate (default-cli) @ standalone-pom <<<
+[INFO]
+[INFO] --- maven-archetype-plugin:2.2:generate (default-cli) @ standalone-pom ---
+[INFO] Generating project in Interactive mode
+[INFO] Archetype repository missing. Using the one from [org.apache.karaf.eik.archetypes:camel-osgi-pde-plugin:3.0.0-SNAPSHOT] found in catalog local
+[INFO] Using property: groupId = org.apache
+[INFO] Using property: artifactId = eik-camel-osgi-project
+[INFO] Using property: version = 1.0.0-SNAPSHOT
+[INFO] Using property: package = org.apache
+Define value for property 'camel-version': ${camel-version}: : 2.8.5
+Define value for property 'slf4j-version': ${slf4j-version}: : 1.6.1
+Confirm properties configuration:
+groupId: org.apache
+artifactId: eik-camel-osgi-project
+version: 1.0.0-SNAPSHOT
+package: org.apache
+camel-version: 2.8.5
+slf4j-version: 1.6.1
+ Y: :
+[INFO] ----------------------------------------------------------------------------
+[INFO] Using following parameters for creating project from Archetype: camel-osgi-pde-plugin:3.0.0-SNAPSHOT
+[INFO] ----------------------------------------------------------------------------
+[INFO] Parameter: groupId, Value: org.apache
+[INFO] Parameter: artifactId, Value: eik-camel-osgi-project
+[INFO] Parameter: version, Value: 1.0.0-SNAPSHOT
+[INFO] Parameter: package, Value: org.apache
+[INFO] Parameter: packageInPathFormat, Value: org/apache
+[INFO] Parameter: camel-version, Value: 2.8.5
+[INFO] Parameter: package, Value: org.apache
+[INFO] Parameter: version, Value: 1.0.0-SNAPSHOT
+[INFO] Parameter: groupId, Value: org.apache
+[INFO] Parameter: slf4j-version, Value: 1.6.1
+[INFO] Parameter: artifactId, Value: eik-camel-osgi-project
+[INFO] project created from Archetype in dir: /projects/formazione/manual/test/eik-camel-osgi-project
+[INFO] ------------------------------------------------------------------------
+[INFO] BUILD SUCCESS
+[INFO] ------------------------------------------------------------------------
+[INFO] Total time: 13.551s
+[INFO] Finished at: Wed Oct 10 13:54:28 CEST 2012
+[INFO] Final Memory: 7M/118M
+[INFO] ------------------------------------------------------------------------
+{noformat}
+
+*Import project in eclipse*
+
+To import project Using command line
+mvn clean install -DskipTests=true
+then inport project in eclipse and add in MANIFEST and save
-Filter archetype by karaf name and choose *karaf-blueprint-archetype*.
-Continue to fill the wizard until the process is complete and Project Explorer will display your new project.
+* Bundle ID :
+* Name
-!/images/devcomponent_4.png!
-
-Now if you check your *RunConfiguration* you well see your new bundle ready to be run.
-
-!/images/devcomponent_6.png!
+!/images/devcomponent_1.png!
-Using Eclipse IDE with PDETools we can import package for for our needs in the project, the package available are those present in target platform.
-To do that we need right click on the *Project that we create -> PDETools -> Open Manifest*
-If you click on *Dependencies* you can use UI to import package
-If we launch our *Run configuration* we can see your bundle installed
+Using Eclipse IDE we can import package for our needs in the project, the package available are those present in target platform.
+To do that we need do double click on the MANIFEST.MF > Dependencies you can use UI to import package
-!/images/devcomponent_8.png!
+Eik feature allows Automatic deployment of workspace plugin projects.
+If you check Run configurations or in Debug configurations. You will see your project
+!/images/devcomponent_2.png!
Modified: karaf/eik/trunk/manual/src/main/webapp/user-guide/index.conf
URL: http://svn.apache.org/viewvc/karaf/eik/trunk/manual/src/main/webapp/user-guide/index.conf?rev=1423773&r1=1423772&r2=1423773&view=diff
==============================================================================
--- karaf/eik/trunk/manual/src/main/webapp/user-guide/index.conf (original)
+++ karaf/eik/trunk/manual/src/main/webapp/user-guide/index.conf Wed Dec 19 07:29:53 2012
@@ -2,5 +2,8 @@
h1. Eclipse Integration Karaf User Guide
* [Prerequisites |/user-guide/prerequisites]
* [Installation |/user-guide/installation]
+* [Create EIK Project |/user-guide/createproject]
+* [Create Launch configuration |/user-guide/launchconf]
+* [View loaded bundle |/user-guide/loadbundle]
* [Uninstalling |/user-guide/uninstall]
* [Developing OSGi components|/user-guide/devcomponent]
Modified: karaf/eik/trunk/manual/src/main/webapp/user-guide/installation.conf
URL: http://svn.apache.org/viewvc/karaf/eik/trunk/manual/src/main/webapp/user-guide/installation.conf?rev=1423773&r1=1423772&r2=1423773&view=diff
==============================================================================
--- karaf/eik/trunk/manual/src/main/webapp/user-guide/installation.conf (original)
+++ karaf/eik/trunk/manual/src/main/webapp/user-guide/installation.conf Wed Dec 19 07:29:53 2012
@@ -1,58 +1,51 @@
-h1. EIK Installation
-This chapter describes how to install EIK by using the update manager feature of Eclipse.
-Then show ho to startup Karaf runtime from Eclipse IDE.
+h1. Eik Installation
-h3. Load EIK from updateManager
+EIK can be installed in two ways.
-From eclipse menu we need *Select Help -> Install new Software ...*,
-please unchecked the flag "Group items by category". Follow procedure the step by step and then restart IDE
+* from update site
+* Installing a Plug-in Manually
-!/images/eikupdatemanager_l.png!
+h3. From Update site
-h3. Setting the OSGi Framework
-With this step we specify to Eclipse which OSGi framework we need to use
-*Select Window -> Preferences -> OSGI Frameworks*
-!/images/osgiframework_l.png!
+From eclipse menu we need *Select Help > Install new Software ...*,
+Add Eik URL <tobe defined> Follow procedure the step by step and then restart IDE.
+!/images/installation_1.png!
-h3. Switch on the the Apache Karaf perspective
-
-To Switch perspective we need *Select Window -> Open Perspective -> Other -> Select Apache Karaf*
-!/images/apachekarafperspective_l.png!
+h3. Installing a Plug-in Manually
-h3. Create a new Apache Karaf Project
+From eik trunk doing a quick build.
+{noformat}
-Create new karaf runtime with *Select File -> New -> Apache Karaf Installation* and add *project_name*
-!/images/eik-karaf-new-project_l.png!
+The following avoids running all the unit test cases, we just skip the test running phase and not the building part
+mvn -Dmaven.test.skip=true clean install
+or
+mvn -DskipTests clean install
+{noformat}
-Select the installation of your karaf/Servicemix runtime KARAF_HOME
-!/images/karaflocation_l.png!
+*Select Help > Install new software > Add.. > Archive...*
+select zip file under
+<path_to_source>/features/org.apache.karaf.eik.update/target/org.apache.karaf.eik.update.zip
-Doubleclick on <project_name>.target and select target platform.
-!/images/selecttargetplatform_l.png!
+!/images/installation_2.png!
-The target platform corresponds to the set of OSGi components used for development and any OSGi components defined as projects within the workspace for Example (Karaf , Servicemix, Camel , CXF ).
-For example Eclipse PDE uses these components for compilation and checks if imports can be resolved.
-Basically is based on a directory containing these components.
-By default, this is the plugins directory under the Eclipse installation directory, which contains all plug-ins associated with Eclipse.
-To configure target platform there can be two approch:
-* Using the facilities provided by Eclipse PDE to specify all the components you need selecting directory ecc.ecc.
-* EIK provides preconfigured target platforms for Karaf based runtime
+h3. Setting the OSGi Framework
+With this step we specify to Eclipse which OSGi framework we need to use
+*Select Window > Preferences > OSGI Frameworks*
-h3. Create an OSGi Framework Launcher
+!/images/installation_3.png!
-The last step to for use Karaf runtime in eclipse is to define launch configuration *Select Run -> Run Configurations -> Osgi Framework -> new ..
-!/images/Runkaraf229_l.png!
+h3. Switch on the the Apache Karaf perspective
-* Select *Add Required Bundles* -> Apply and the *Select Run*
-!/images/karafConsole_l.png!
+To Switch perspective we need *Select Window > Open Perspective > Other > Select Apache Karaf*
-Now we have our Karaf up and Running
+!/images/installation_4.png!
+Now EIK is installed correctly
Added: karaf/eik/trunk/manual/src/main/webapp/user-guide/launchconf.conf
URL: http://svn.apache.org/viewvc/karaf/eik/trunk/manual/src/main/webapp/user-guide/launchconf.conf?rev=1423773&view=auto
==============================================================================
--- karaf/eik/trunk/manual/src/main/webapp/user-guide/launchconf.conf (added)
+++ karaf/eik/trunk/manual/src/main/webapp/user-guide/launchconf.conf Wed Dec 19 07:29:53 2012
@@ -0,0 +1,25 @@
+h1. Create an OSGi Framework Launcher
+
+To define launch configuration we need *Select Run > Run Configurations > Osgi Framework > new ..*
+
+!/images/launchconf_1.png!
+
+From *Karaf tab* in Launch configuration is possible to chance which features need to load.
+By Default the feature that loaded are those listed in the file *<karaf_installation_dir>/etc/org.apache.karaf.features.cfg*.
+Note that all changes modify the org.apache.karaf.features.cfg file present in the runtime installation. To Run karaf runtime Select *Add Required Bundles* > Apply and the *Select Run*
+
+!/images/launchconf_2.png!
+
+When the Karaf runtime runs, its output appears in Eclipse Console view at the bottom of the window.
+With console we can interact with Karaf console. [ Please see here to found useful karaf console commands|http://karaf.apache.org/manual/latest-2.2.x/commands/commands.html]
+
+
+
+
+
+
+
+
+
+
+
Added: karaf/eik/trunk/manual/src/main/webapp/user-guide/loadbundle.conf
URL: http://svn.apache.org/viewvc/karaf/eik/trunk/manual/src/main/webapp/user-guide/loadbundle.conf?rev=1423773&view=auto
==============================================================================
--- karaf/eik/trunk/manual/src/main/webapp/user-guide/loadbundle.conf (added)
+++ karaf/eik/trunk/manual/src/main/webapp/user-guide/loadbundle.conf Wed Dec 19 07:29:53 2012
@@ -0,0 +1,22 @@
+h1. View Bundle Loaded
+
+From Apache Karaf perspective it's possible to see in a view the bundles that are currently loaded at runtime.
+Before launch runtime we need create new Launch Configuration : from *Run > Debug Configuration or Run Configuration > Apache Felix Karaf new Launch Configuration*
+
+!/images/loadbundle_1.png!
+
+and after lanching Karaf runtime from *Bundles view* we can understanding the Runtime Properties of Apache Karaf without use karaf console
+
+!/images/loadbundle_2.png!
+
+
+
+
+
+
+
+
+
+
+
+
Modified: karaf/eik/trunk/manual/src/main/webapp/user-guide/prerequisites.conf
URL: http://svn.apache.org/viewvc/karaf/eik/trunk/manual/src/main/webapp/user-guide/prerequisites.conf?rev=1423773&r1=1423772&r2=1423773&view=diff
==============================================================================
--- karaf/eik/trunk/manual/src/main/webapp/user-guide/prerequisites.conf (original)
+++ karaf/eik/trunk/manual/src/main/webapp/user-guide/prerequisites.conf Wed Dec 19 07:29:53 2012
@@ -1,18 +1,17 @@
h1. Prerequisites
-Environment:
+*Environment:*
* Java SE Development Kit 1.6.x or greater ([http://www.oracle.com/technetwork/java/javase/]).
* Apache Maven 3.0.3 ([http://maven.apache.org/download.html]).
* Eclipse IDE for Java EE Developers (Helios (Eclipse 3.6.x) or Galileo (Eclipse 3.5.x))([http://www.eclipse.org/downloads/]).
* Apache KARAF 2.2.x ([http://karaf.apache.org/index/community/download.html]);
-Sun JDK 6.0 can be downloaded from Oracle J2SE 6.0 Downloads site. The Eclipse IDE for Java EE Developers can be downloaded from the Eclipse Downloads site.
Download and extract the Eclipse IDE for Java EE Developers archives to a directory of your choice (for e.g. $HOME/eclipse).
-The archive will be extracted to a directory named eclipse under the directory you specified (for e.g. $HOME/tools/eclipse/eclipse), referred to as *<ECLIPSE_HOME>* from now on.
+The archive will be extracted to a directory named eclipse under the directory you specified (for e.g. $HOME/tools/eclipse/eclipse), referred to as *<eclipse_installation_dir>* from now on.
Make sure that the JDK in the PATH is Sun JDK 6.0.
-Launch Eclipse by running <ECLIPSE_HOME>/eclipse.
+Launch Eclipse by running <eclipse_installation_dir>/eclipse.
To install the Karaf, download the Karaf 2.2.x runtime from Apache Karaf downloads and extract the archive to a directory of your choice (for e.g. $HOME/tools/karaf).
The archive will be extracted to a directory apache-karaf-2.2.* (for e.g. $HOME/tools/karaf/apache-karaf-2.2.*).
-We will refer to this directory as *<KARAF_HOME>* from now on.
+We will refer to this directory as *<karaf_installation_dir>* from now on.
Modified: karaf/eik/trunk/manual/src/main/webapp/user-guide/uninstall.conf
URL: http://svn.apache.org/viewvc/karaf/eik/trunk/manual/src/main/webapp/user-guide/uninstall.conf?rev=1423773&r1=1423772&r2=1423773&view=diff
==============================================================================
--- karaf/eik/trunk/manual/src/main/webapp/user-guide/uninstall.conf (original)
+++ karaf/eik/trunk/manual/src/main/webapp/user-guide/uninstall.conf Wed Dec 19 07:29:53 2012
@@ -1,8 +1,15 @@
h1. Uninstall EIK from your Eclipse IDE
This chapter describes how to unInstall EIK through the Update Manager
-From menu we need *Select Help -> About Eclipse -> Installation Details*. Select plugins as shown in image.
-
+From menu we need *Select Help > About Eclipse > Installation Details*. Select plugins as shown in image.
Select Uninstall
+
!/images/uninstall.png!
+
+
+
+
+
+
+