Changes between Version 20 and Version 21 of PLATFORM_DEPLOYMENT_BUILD_ECLIPSE

Timestamp:

12/21/08 16:51:58 (16 years ago)

Author:

boyan

Comment:

--

PLATFORM_DEPLOYMENT_BUILD_ECLIPSE

@@ -31 +31 @@
 These are not the real OSGi containers but only emulations for running the application under Eclipse IDE - otherwise, you have to wait at least two minutes for Maven to build for every little change in the source code.
 
-= Additional information =
- * You have to be careful making new modules for the project. These are the steps:
-  * make new empty directory with org.sophie2.modulename name in sophie2-platform/modules and create its pom.xml file
-  * add it to repository and commit it. Also add it to base pom.xml of sophie2-platform in modules section.
-  * right click - '''Import...''' - Maven projects - choose the new created module
+== Creating a new module ==
 
- * Keep in mind to use Maven options '''Update Project Configuration''' and '''Update Dependencies''' when you change the pom.xml files. They are available in Maven section when you right click on the project you want to update.
- * If you don't see the working sets, use 
-  * View Menu(in upper right corner of Package Tree) and Configure working sets option.
-  * Top Level Elements - choose Working Sets
-
-= How to create a new module =
+When you have to create a new module, follow these steps:
  * Copy sophie2-platform/dev-tools/org.sophie2.proto.project to sophie2-platform/modules
- * Edit pom.xml
+ * Right-click on the module in the new location, choose '''Refactor''' -> '''Rename''' and enter the name of the new module.
+ * Edit the following part of the pom.xml file of the new module:
 {{{
         <artifactId>org.sophie2.proto.project</artifactId>
@@ -51 +43 @@
         <packaging>bundle</packaging>
         <description>Copy from this one to create a sophie2 module</description>
+        ... (some more lines)
+        <Export-Package>org.sophie2.proto.project.*</Export-Package>
 }}}
-and 
-{{{
-<instructions>
-        <Main-Class>org.sophie2.proto.project.ProtoModule</Main-Class>
-        <Export-Package>org.sophie2.proto.project.*</Export-Package>
-        <!-- <Private-Package>org.apache.felix.moduleloader.*,org.apache.felix.framework.*,org.apache.felix.main,org.osgi.*,org.apache.log4j.*</Private-Package>-->
-        <Bundle-Activator>org.sophie2.author.Activator</Bundle-Activator>
-        <Embed-Dependency>*;scope=compile|runtime</Embed-Dependency>
-        <Import-Package>*;resolution:=optional</Import-Package>
-</instructions>
-}}}
- If you don't have main class you should remove <Main-Class>
- * Rename the project - artifactId and the name of the project should be the same
- * right click at sophie-working-set - '''Import...''' - Maven projects - choose the new created module
+The <artifactId> should be the same as the module name. All other occurencies of org.sophie2.proto.project (for example in the <Export-Package> should be replaced with the new module name. You should also edit the <name> and <description> tags. You can look at the <instructions> tag if your module reqires a main class or a class extending SophieModule.
+ * Edit the pom.xml of sophie2-platform and add the name of the new module in the <modules> section.
 
-= Comments =
- * boyan
-  * There is duplicate information about creating a new module and the one in the Additional Information section is not correct.
+== Updating the project with newly created modules ==
+
+ * Keep in mind to use Maven options '''Update Project Configuration''' and '''Update Dependencies''' when you change the pom.xml files. They are available in Maven section when you right click on the project you want to update.
+ * If you don't see the working sets, use 
+  * View Menu(in upper right corner of Package Tree) and Configure working sets option.
+  * Top Level Elements - choose Working Sets