Difference between revisions of ".GEAR files"

 
(7 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 +
__NOEDITSECTION__
 +
{{DevelopersTopNav}}
 +
 +
 
== Overview ==
 
== Overview ==
  
.GEAR files are essentially zipped versions of geWorkBench visual plugins. They make it easy to distribute reasonably sized upgrades to specific parts of the application.
+
.GEAR files are essentially zipped versions of geWorkBench component plugins. They make it easy to distribute reasonably sized upgrades to specific parts of the application. They are the geWorkbench analogue of .WAR files for web applications.
  
 
== Creating a .GEAR file ==
 
== Creating a .GEAR file ==
  
There is an ant task that will create a .GEAR file automatically. Run ant with something like “ant –Dcomponent=alignment” which will create a .gear file from the alignment component directory. Then put the resulting alignment.gear in a directory called “gears” and the next time the program is run it’ll load the component out of that file.
+
There is an ant task that will create a .GEAR file automatically. Run ant with “ant –Dcomponent=NAME” which will create a .gear file from the specified component directory. You can also run the Windows batch file “makeGear NAME” instead. Put the resulting .gear file in the components directory of a geWorkbench installation and it will be loaded by the application.
  
 
== Viewing loaded versions of components ==
 
== Viewing loaded versions of components ==
  
The version menu item, under help will list all the loaded versions of plugins, and will indicate which ones are loading from .GEAR files, an example is below.
+
The menu item "Tools->Component Configuration" will list all the loaded versions of component plugins. The subdirectories and gear files under the component directory are loaded similarly.
 
 
[[Image:versionDialog.jpg]]
 

Latest revision as of 11:11, 23 March 2010

Developers Home | A Simple Plugin | geWorkbench Archive Files | Collaborative Development | Design Documentation | Javadocs | gForge Page | Report Defects



Overview

.GEAR files are essentially zipped versions of geWorkBench component plugins. They make it easy to distribute reasonably sized upgrades to specific parts of the application. They are the geWorkbench analogue of .WAR files for web applications.

Creating a .GEAR file

There is an ant task that will create a .GEAR file automatically. Run ant with “ant –Dcomponent=NAME” which will create a .gear file from the specified component directory. You can also run the Windows batch file “makeGear NAME” instead. Put the resulting .gear file in the components directory of a geWorkbench installation and it will be loaded by the application.

Viewing loaded versions of components

The menu item "Tools->Component Configuration" will list all the loaded versions of component plugins. The subdirectories and gear files under the component directory are loaded similarly.