Software Development Kit - Revision history

Zji at 16:38, 23 February 2012

2012-02-23T16:38:32Z

2010-04-25T23:49:51Z

‎An Example Plugin (geworkbench 1.7)

2010-04-25T23:49:15Z

‎Configure Plugin

2010-03-22T15:57:46Z

‎Configure Plugin

2009-07-23T20:39:52Z

‎Releasing the Plugin

2009-07-23T20:36:08Z

‎Running the Plugin in geWorkbench

2009-07-23T20:35:57Z

‎Configure Plugin

2009-07-23T20:34:55Z

‎Configure Plugin

2009-07-23T20:33:37Z

‎Configure Plugin

2009-07-23T20:31:39Z

← Older revision		Revision as of 16:38, 23 February 2012
Line 1:		Line 1:
	{{DevelopersTopNav}}		{{DevelopersTopNav}}
		+
		+	* This page is out of date. There is not much value for the developers to have a separate SDK besides the downloadable geWorkbench package and the code base from subversion, which includes an example plug-in. I will remove the link of this page from the Developers section (to avoid confusion) instead of maintainining this page. Feb 23, 2012. - Zhou Ji

	The Development Kit is a self-contained package that facilitates the process of developing plugins for geWorkbench.		The Development Kit is a self-contained package that facilitates the process of developing plugins for geWorkbench.

@@ Line 20: / Line 20: @@
 The next section will illustrate the above steps with an example.
-== An Example Plugin (geworkbench 1.7) ==
+== An Example Plugin (geworkbench 1.7 or later) ==
 We will create an example plugin that is simply called <tt>test</tt>. This will be a very simple visualization plugin that just displays a blank blue region.

@@ Line 70: / Line 70: @@
 Create a .cwb.xml file for your plugin and place it under the same directory as the source file.  In this case, create ''test.cwb.xml'' and place it under ''GEWORKBENCHSDK_HOME/src/org/organization/test''.
-   <geaw-config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="ConfigurationFile Schema.xsd">
+   <component-descriptor  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="ConfigurationFile Schema.xsd">
      <component  name="Test SDK Panel"
        class="org.organization.test.TestComponent"
@@ Line 89: / Line 89: @@
        <gui-area name="VisualArea"/>
      </plugin>
-   </geaw-config>
+   </component-descriptor>
 === Running the Plugin in geWorkbench ===

@@ Line 68: / Line 68: @@
 === Configure Plugin ===
-Create a .ccm.xml file for your plugin and place it under /src.  In this case, create ''test.ccm.xml'' and place it under ''GEWORKBENCHSDK_HOME/src''.
+Create a .cwb.xml file for your plugin and place it under the same directory as the source file.  In this case, create ''test.cwb.xml'' and place it under ''GEWORKBENCHSDK_HOME/src/org/organization/test''.
    <geaw-config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="ConfigurationFile Schema.xsd">

@@ Line 105: / Line 105: @@
   ant gear
-This creates the file <tt>test.gear</tt>. A .gear file is the geWorkbench analogue of a .war file for a web application. Is a bundled  plugin that can deployed to a geWorkbench install by placing the file in the <tt>components</tt> directory. A configuration directive (such as the one above) would also need to be added to the configuration file to activate the plugin.
+This creates the file <tt>test.gear</tt>. This gear file is a bundled  plugin that can deployed to a geWorkbench installation by placing the file in the <tt>components</tt> directory, then unzipping it.
 == An Example Plugin (Pre geworkbench 1.7) ==

@@ Line 93: / Line 93: @@
 === Running the Plugin in geWorkbench ===
-To run the plugn and see it appear in geWorkbench (a blue visual), do the following:
+To run the plugin and see it appear in geWorkbench (a blue visual), do the following:
   ant run

@@ Line 80: / Line 80: @@
        visualizer="true">
        <license>
-<![CDATA[
+      <![CDATA[
-			<html><head><meta http-equiv=Content-Type content="text/html; charset=windows-1252"></head>
+        <html><head><meta http-equiv=Content-Type content="text/html; charset=windows-1252"></head>
-				<body>----</body>
+          <body>----</body>
-			</html>
+        </html>
-		]]></license>
+      ]]></license>
-	</component>
+    </component>
-	<plugin id="TestSDKPanel" name="Test SDK" class="org.organization.test.TestComponent" source="test">
+    <plugin id="TestSDKPanel" name="Test SDK" class="org.organization.test.TestComponent" source="test">
-		<gui-area name="VisualArea"/>
+      <gui-area name="VisualArea"/>
-	</plugin>
+    </plugin>
    </geaw-config>

@@ Line 72: / Line 72: @@
    <geaw-config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="ConfigurationFile Schema.xsd">
      <component  name="Test SDK Panel"
-				class="org.organization.test.TestComponent"
+      class="org.organization.test.TestComponent"
-				version="1.0"
+      version="1.0"
-				author="C2B2"
+      author="C2B2"
-				authorURL=""
+      authorURL=""
-				toolURL=""
+      toolURL=""
-				description="test SDK"
+      description="test SDK"
-				visualizer="true"
+      visualizer="true">
+      <license>
-		<license><![CDATA[
+<![CDATA[
 			<html><head><meta http-equiv=Content-Type content="text/html; charset=windows-1252"></head>
 				<body>----</body>