Changes between Version 13 and Version 14 of DevelopersGuide/DevelopingPlugins

Timestamp:

2007-06-15T00:50:22+02:00 (18 years ago)

Author:

imi

Comment:

--

DevelopersGuide/DevelopingPlugins

@@ -13 +13 @@
  * create a new plugin-directory osm/utils/josm/plugins/''yourpluginname''
  * copy an ant script (build.xml) from an other plugin ('''TODO:''' Someone familar with ant could be so nice and setup a template plugin with an almost complete configured ant script and then change this here)
- * The important thing of your build script is, that it places two attributes into the MANIFEST.MF of the jar file:
-   * Plugin-Class points to the main plugin file (see below)
-   * Plugin-Description gives the description of the plugin visible in the preferences page. Currently, you have to enter some <br> (not <br/>) by yourself (blame Swing ;)
+ * The important thing of your build script is, that it places some attributes into the MANIFEST.MF of the jar file. See below.
 
 = The ''Plugin'' class =
@@ -65 +63 @@
 == Plugin.getPluginDir() ==
 If you subclass from the plugin class (see above), then you can call this function to retrieve your plugin directory where you can freely store/read data from. It is located at ~/.josm/plugins/''youpluginname''
+
+
+= The MANIFEST.MF =
+
+You have to put some information into the manifest file of your jar. If you use ant, you can set these values within the build.xml file.
+
+ '''Plugin-Class'''::
+   Points to the main plugin file ('''required''')
+ '''Plugin-Description'''::
+   Gives the description of the plugin visible in the preferences page. For line breaks, you have to use <br>, ''not'' <br/> (blame Swing ;). ('''required''')
+ '''Plugin-Author'''::
+   An Email-Adress of the author of this plugin. This is used in the error report window, if an error is detected within the plugin code (there is a strange heuristic to guess whether an exception comes from a plugin).
+ '''Plugin-Early'''::
+   Can be set to {{{true}}}, in which case the plugin is loaded as early as possible, more specific before the GUI classes are loaded. This is usefull if your plugin alters the GUI or the JOSM-startup process in any way.
+ '''Plugin-Stage'''::
+   An number of the order relative to other plugins, when the plugin is loaded. Smaller numbers gets loaded first, so if you have conflicts with other plugins, you can increase or decrease this number to get some control on the loading order. Defaults to 50.
+ '''Class-Path'''::
+   An space-seperated list of additional classpaths your plugin wants to use when looking for ressources and classes. The plugin itself is added automatically. Don't forget to provide the additional jar's as well, if you add dependencies here.
+
+
+= Legal stuff (Imis opinion) =
+
+Just because I have been asked: JOSM is licensed under GPL and if any code is a "derived work" of JOSM, then it has to be under GPL too. It is my believe, that any JOSM-Plugin is a derived work of JOSM, so GPL is the only possible license for a JOSM-Plugin. If you want to include non-GPL code into a plugin, it has to be seperated from the classes that use JOSM. "Use" as in "import org.openstreetmap.josm...". See the 'Class-Path' - MANIFEST.MF attribute for a way to include other jar files.