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/10/05 16:06:08 UTC
svn commit: r1394535 - in /karaf/eik/trunk/manual/src/main/webapp: ./
developers-guide/ images/ user-guide/
Author: jbonofre
Date: Fri Oct 5 14:06:07 2012
New Revision: 1394535
URL: http://svn.apache.org/viewvc?rev=1394535&view=rev
Log:
Update the EIK manual
Added:
karaf/eik/trunk/manual/src/main/webapp/developers-guide/
karaf/eik/trunk/manual/src/main/webapp/developers-guide/index.conf
karaf/eik/trunk/manual/src/main/webapp/images/Runkaraf229_l.png
karaf/eik/trunk/manual/src/main/webapp/images/apachekarafperspective_l.png
karaf/eik/trunk/manual/src/main/webapp/images/eik-karaf-new-project_l.png
karaf/eik/trunk/manual/src/main/webapp/images/eik-karaf-osgi-framework_l.png
karaf/eik/trunk/manual/src/main/webapp/images/eikupdatemanager_l.png
karaf/eik/trunk/manual/src/main/webapp/images/karafConsole_l.png
karaf/eik/trunk/manual/src/main/webapp/images/karaflocation_l.png
karaf/eik/trunk/manual/src/main/webapp/images/osgiframework_l.png
karaf/eik/trunk/manual/src/main/webapp/images/projectName_l.png
karaf/eik/trunk/manual/src/main/webapp/images/selecttargetplatform_l.png
karaf/eik/trunk/manual/src/main/webapp/images/uninstall.png
karaf/eik/trunk/manual/src/main/webapp/user-guide/devcomponent.conf
karaf/eik/trunk/manual/src/main/webapp/user-guide/installation.conf
karaf/eik/trunk/manual/src/main/webapp/user-guide/uninstall.conf
Removed:
karaf/eik/trunk/manual/src/main/webapp/images/eikupdatemanager.png
karaf/eik/trunk/manual/src/main/webapp/user-guide/updatemanager.conf
Modified:
karaf/eik/trunk/manual/src/main/webapp/index.conf
karaf/eik/trunk/manual/src/main/webapp/overview.conf
karaf/eik/trunk/manual/src/main/webapp/user-guide/index.conf
karaf/eik/trunk/manual/src/main/webapp/user-guide/manualinstallation.conf
karaf/eik/trunk/manual/src/main/webapp/user-guide/prerequisites.conf
Added: 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=1394535&view=auto
==============================================================================
--- karaf/eik/trunk/manual/src/main/webapp/developers-guide/index.conf (added)
+++ karaf/eik/trunk/manual/src/main/webapp/developers-guide/index.conf Fri Oct 5 14:06:07 2012
@@ -0,0 +1,2 @@
+!/images/karaf-logo.png!
+h1. Eclipse Integration Karaf Developer Guide
Added: karaf/eik/trunk/manual/src/main/webapp/images/Runkaraf229_l.png
URL: http://svn.apache.org/viewvc/karaf/eik/trunk/manual/src/main/webapp/images/Runkaraf229_l.png?rev=1394535&view=auto
==============================================================================
Files karaf/eik/trunk/manual/src/main/webapp/images/Runkaraf229_l.png (added) and karaf/eik/trunk/manual/src/main/webapp/images/Runkaraf229_l.png Fri Oct 5 14:06:07 2012 differ
Added: karaf/eik/trunk/manual/src/main/webapp/images/apachekarafperspective_l.png
URL: http://svn.apache.org/viewvc/karaf/eik/trunk/manual/src/main/webapp/images/apachekarafperspective_l.png?rev=1394535&view=auto
==============================================================================
Files karaf/eik/trunk/manual/src/main/webapp/images/apachekarafperspective_l.png (added) and karaf/eik/trunk/manual/src/main/webapp/images/apachekarafperspective_l.png Fri Oct 5 14:06:07 2012 differ
Added: karaf/eik/trunk/manual/src/main/webapp/images/eik-karaf-new-project_l.png
URL: http://svn.apache.org/viewvc/karaf/eik/trunk/manual/src/main/webapp/images/eik-karaf-new-project_l.png?rev=1394535&view=auto
==============================================================================
Files karaf/eik/trunk/manual/src/main/webapp/images/eik-karaf-new-project_l.png (added) and karaf/eik/trunk/manual/src/main/webapp/images/eik-karaf-new-project_l.png Fri Oct 5 14:06:07 2012 differ
Added: karaf/eik/trunk/manual/src/main/webapp/images/eik-karaf-osgi-framework_l.png
URL: http://svn.apache.org/viewvc/karaf/eik/trunk/manual/src/main/webapp/images/eik-karaf-osgi-framework_l.png?rev=1394535&view=auto
==============================================================================
Files karaf/eik/trunk/manual/src/main/webapp/images/eik-karaf-osgi-framework_l.png (added) and karaf/eik/trunk/manual/src/main/webapp/images/eik-karaf-osgi-framework_l.png Fri Oct 5 14:06:07 2012 differ
Added: karaf/eik/trunk/manual/src/main/webapp/images/eikupdatemanager_l.png
URL: http://svn.apache.org/viewvc/karaf/eik/trunk/manual/src/main/webapp/images/eikupdatemanager_l.png?rev=1394535&view=auto
==============================================================================
Files karaf/eik/trunk/manual/src/main/webapp/images/eikupdatemanager_l.png (added) and karaf/eik/trunk/manual/src/main/webapp/images/eikupdatemanager_l.png Fri Oct 5 14:06:07 2012 differ
Added: karaf/eik/trunk/manual/src/main/webapp/images/karafConsole_l.png
URL: http://svn.apache.org/viewvc/karaf/eik/trunk/manual/src/main/webapp/images/karafConsole_l.png?rev=1394535&view=auto
==============================================================================
Files karaf/eik/trunk/manual/src/main/webapp/images/karafConsole_l.png (added) and karaf/eik/trunk/manual/src/main/webapp/images/karafConsole_l.png Fri Oct 5 14:06:07 2012 differ
Added: karaf/eik/trunk/manual/src/main/webapp/images/karaflocation_l.png
URL: http://svn.apache.org/viewvc/karaf/eik/trunk/manual/src/main/webapp/images/karaflocation_l.png?rev=1394535&view=auto
==============================================================================
Files karaf/eik/trunk/manual/src/main/webapp/images/karaflocation_l.png (added) and karaf/eik/trunk/manual/src/main/webapp/images/karaflocation_l.png Fri Oct 5 14:06:07 2012 differ
Added: karaf/eik/trunk/manual/src/main/webapp/images/osgiframework_l.png
URL: http://svn.apache.org/viewvc/karaf/eik/trunk/manual/src/main/webapp/images/osgiframework_l.png?rev=1394535&view=auto
==============================================================================
Files karaf/eik/trunk/manual/src/main/webapp/images/osgiframework_l.png (added) and karaf/eik/trunk/manual/src/main/webapp/images/osgiframework_l.png Fri Oct 5 14:06:07 2012 differ
Added: karaf/eik/trunk/manual/src/main/webapp/images/projectName_l.png
URL: http://svn.apache.org/viewvc/karaf/eik/trunk/manual/src/main/webapp/images/projectName_l.png?rev=1394535&view=auto
==============================================================================
Files karaf/eik/trunk/manual/src/main/webapp/images/projectName_l.png (added) and karaf/eik/trunk/manual/src/main/webapp/images/projectName_l.png Fri Oct 5 14:06:07 2012 differ
Added: karaf/eik/trunk/manual/src/main/webapp/images/selecttargetplatform_l.png
URL: http://svn.apache.org/viewvc/karaf/eik/trunk/manual/src/main/webapp/images/selecttargetplatform_l.png?rev=1394535&view=auto
==============================================================================
Files karaf/eik/trunk/manual/src/main/webapp/images/selecttargetplatform_l.png (added) and karaf/eik/trunk/manual/src/main/webapp/images/selecttargetplatform_l.png Fri Oct 5 14:06:07 2012 differ
Added: karaf/eik/trunk/manual/src/main/webapp/images/uninstall.png
URL: http://svn.apache.org/viewvc/karaf/eik/trunk/manual/src/main/webapp/images/uninstall.png?rev=1394535&view=auto
==============================================================================
Files karaf/eik/trunk/manual/src/main/webapp/images/uninstall.png (added) and karaf/eik/trunk/manual/src/main/webapp/images/uninstall.png Fri Oct 5 14:06:07 2012 differ
Modified: karaf/eik/trunk/manual/src/main/webapp/index.conf
URL: http://svn.apache.org/viewvc/karaf/eik/trunk/manual/src/main/webapp/index.conf?rev=1394535&r1=1394534&r2=1394535&view=diff
==============================================================================
--- karaf/eik/trunk/manual/src/main/webapp/index.conf (original)
+++ karaf/eik/trunk/manual/src/main/webapp/index.conf Fri Oct 5 14:06:07 2012
@@ -4,3 +4,4 @@ h1. Apache Karaf EIK
Welcome to Apache Eclipse Intergration Karaf (EIK) Subproject.
* [Overview|overview]
* [User Guide|user-guide/index]
+* [Developers guide|developers-guide/index]
Modified: karaf/eik/trunk/manual/src/main/webapp/overview.conf
URL: http://svn.apache.org/viewvc/karaf/eik/trunk/manual/src/main/webapp/overview.conf?rev=1394535&r1=1394534&r2=1394535&view=diff
==============================================================================
--- karaf/eik/trunk/manual/src/main/webapp/overview.conf (original)
+++ karaf/eik/trunk/manual/src/main/webapp/overview.conf Fri Oct 5 14:06:07 2012
@@ -6,3 +6,20 @@ EIK supports nearly all Apache Karaf com
* Apache ServiceMix
* Talend ESB
* FUSE ESB
+
+
+Notable features include:
+
+* Custom Eclipse perspective for Apache Karaf development:
+** places valuable Karaf runtime information in one location
+* Apache Karaf installation management in your workspace:
+** Karaf installations are managed as workspace projects giving the developer visibility in to the runtime
+** each Karaf installation is automatically synchronized with your workspace, including additional bundles, configuration files
+* Run and debug Karaf installations with a single Eclipse Launcher:
+** the launch configuration allows developers to fine tune how Karaf will launch
+* Automatic deployment of workspace plugin projects:
+* create plugin-projects and have them deployed automatically
+* Advanced instrumentation of the running Karaf instance:
+** watch bundles deploy in real time and examine the OSGi service registry from within the Eclipse IDE
+* Access Eclipse platform IDE plugins from within a running Karaf instance:
+** all Eclipse plugins are presented as an OBR
Added: 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=1394535&view=auto
==============================================================================
--- karaf/eik/trunk/manual/src/main/webapp/user-guide/devcomponent.conf (added)
+++ karaf/eik/trunk/manual/src/main/webapp/user-guide/devcomponent.conf Fri Oct 5 14:06:07 2012
@@ -0,0 +1,9 @@
+h1. Developing OSGi components with EIK
+
+TODO
+
+This chapter describes how to develop a osgi component with EIK,now we have a functional karaf environment in Eclipse.
+For convenience in this example we will use the M2E [http://eclipse.org/m2e/] plugins which provides different archetype
+
+Right click on the project -> PDETools -> Open Manifest
+
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=1394535&r1=1394534&r2=1394535&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 Fri Oct 5 14:06:07 2012
@@ -1,8 +1,6 @@
!/images/karaf-logo.png!
h1. Eclipse Integration Karaf User Guide
* [Prerequisites |/user-guide/prerequisites]
-* [Installing EIK using Eclipse update manager|/user-guide/updatemanager]
-* [Manual Installation|/user-guide/manualinstallation]
-* [Uninstalling EIK|/]
-* [How to Use EIK Eclipse Plugin|/]
-* [Tutorial on Karaf/ServiceMix Development with Eclipse and EIK|/]
+* [Installation |/user-guide/installation]
+* [Uninstalling |/user-guide/uninstall]
+* [Developing OSGi components|/user-guide/devcomponent]
Added: 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=1394535&view=auto
==============================================================================
--- karaf/eik/trunk/manual/src/main/webapp/user-guide/installation.conf (added)
+++ karaf/eik/trunk/manual/src/main/webapp/user-guide/installation.conf Fri Oct 5 14:06:07 2012
@@ -0,0 +1,58 @@
+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.
+
+h3. Load EIK from updateManager
+
+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
+
+!/images/eikupdatemanager_l.png!
+
+
+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!
+
+
+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. Create a new Apache Karaf Project
+
+Create new karaf runtime with *Select File -> New -> Apache Karaf Installation* and add *project_name*
+!/images/eik-karaf-new-project_l.png!
+
+
+Select the installation of your karaf/Servicemix runtime KARAF_HOME
+!/images/karaflocation_l.png!
+
+
+Doubleclick on <project_name>.target and select target platform.
+!/images/selecttargetplatform_l.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. Create an OSGi Framework Launcher
+
+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!
+
+* Select *Add Required Bundles* -> Apply and the *Select Run*
+!/images/karafConsole_l.png!
+
+Now we have our Karaf up and Running
+
Modified: karaf/eik/trunk/manual/src/main/webapp/user-guide/manualinstallation.conf
URL: http://svn.apache.org/viewvc/karaf/eik/trunk/manual/src/main/webapp/user-guide/manualinstallation.conf?rev=1394535&r1=1394534&r2=1394535&view=diff
==============================================================================
--- karaf/eik/trunk/manual/src/main/webapp/user-guide/manualinstallation.conf (original)
+++ karaf/eik/trunk/manual/src/main/webapp/user-guide/manualinstallation.conf Fri Oct 5 14:06:07 2012
@@ -1,10 +1,4 @@
-h1. Eik Manual Installation
+h1. EIK Manual Installation
-This chapter describes how to install EIK from sourcecode.
-
-h2. Download and Compile
-
-* checkout code
-
-svn co https://svn.apache.org/repos/asf/karaf/eik/trunk eik
+This chapter describes how to install EIK from source code.
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=1394535&r1=1394534&r2=1394535&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 Fri Oct 5 14:06:07 2012
@@ -1,5 +1,6 @@
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/]).
Added: 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=1394535&view=auto
==============================================================================
--- karaf/eik/trunk/manual/src/main/webapp/user-guide/uninstall.conf (added)
+++ karaf/eik/trunk/manual/src/main/webapp/user-guide/uninstall.conf Fri Oct 5 14:06:07 2012
@@ -0,0 +1,8 @@
+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.
+
+Select Uninstall
+!/images/uninstall.png!
+