Changes between Version 2 and Version 3 of PluginDevelopmentGuide

Timestamp:

06.04.2013 18:28:15 (12 years ago)

Author:

jri

Comment:

Setup for Hot-Deployment

PluginDevelopmentGuide

@@ +1 @@
+[[PageOutline]]
+
 = Plugin Development Guide =
 
@@ -19 +21 @@
 }}}
 
-== A very simple plugin ==
+== A very simple plugin: Tagging ==
 
 Let's start with a very simple plugin. This plugin will just create a new topic type called `Tag`. Once the plugin is installed the topic type will appear in the DeepaMehta webclient's //Create// menu, so you can create instances. And you will be able to fulltext search for tags.
@@ -26 +28 @@
 
 Of course the topic type could be created interactively as well, by using DeepaMehta's type editor. However, being packaged as a plugin you can publish it. When other DeepaMehta users install your plugin they can use your type definitions.
+
+=== Create the plugin ===
 
 You create the plugin just by creating directories and text files. A DeepaMehta plugin project adheres to a certain directory structure and file name conventions.
@@ -43 +47 @@
 Create the file **`pom.xml`** with this content:
 {{{
+#!xml
 <project>
     <modelVersion>4.0.0</modelVersion>
@@ -84 +89 @@
 Create the file **`plugin.properties`**:
 {{{
-requiredPluginMigrationNr = 1
-importModels = de.deepamehta.webclient
+requiredPluginMigrationNr=1
+importModels=de.deepamehta.webclient
 }}}
+
+=== Setup for Hot-Deployment ===
+
+In order to let DeepaMehta hot-deploy the plugin you must include it in DeepaMehta's hot-deployment list.
+
+Add the line `/home/myhome/deepamehta-dev/dm4-tagging` to DeepaMehta's **`pom.xml`**. Impotant: append a comma to the previous line:
+{{{
+#!xml
+<project>
+    ...
+    <felix.fileinstall.dir>
+        <![CDATA[
+            ${project.basedir}/modules/dm4-core/target,
+            ...
+            ${project.basedir}/modules/dm4-storage-neo4j/target,
+            /home/myhome/deepamehta-dev/dm4-tagging
+        ]]>
+    </felix.fileinstall.dir>
+</project>
+}}}
+
+Now start DeepaMehta:
+{{{
+cd deepamehta
+mvn pax:run
+}}}
+
+This starts DeepaMehta in development mode, that is with hot-deployment activated. The terminal gets occupied by the //Gogo// shell now. Type `lb` to see the list of deployed bundles. Your plugin does not yet appear in that list as it is not yet build.
+
+=== Build the plugin ===
+
+In another terminal:
+{{{
+cd dm4-tagging
+mvn clean package
+}}}
+
+This builds the plugin and hot-deploys it.
+