Changes between Version 30 and Version 31 of DevelopersGuide/DevelopingPlugins

Timestamp:

2009-11-07T22:58:56+01:00 (16 years ago)

Author:

stoecker

Comment:

Added some info.

DevelopersGuide/DevelopingPlugins

@@ -75 +75 @@
  '''Plugin-Description''' ''(required)''::
    Gives the description of the plugin visible in the preferences page. For line breaks, you have to use <br>, ''not'' <br/> (blame Swing ;).
- '''Plugin-Author'''::
+ '''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-Date'''::
+   The creation date of the plugin in ISO format.
  '''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-Link'''::
+   Informational URL to a webpage or other information source about that plugin. Is also used in the [wiki:Plugins plugins] information page.
+ '''Plugin-Requires'''::
+   A list of other plugins which are required before plugin works. The list is separated by semi colons.
  '''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.
@@ -85 +91 @@
  '''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. Note that all loaded plugins are in the class-path automatically, so don't specify plugin-dependencies here.
+ '''<xxx>_Plugin-Url'''::
+   To support older JOSM version special entries may be added to supply older versions. This information is used by the internal plugin handler to select only matching version when updating. The entries are made like this ''<josm_version>_Plugin-Url: <plugin_version>;<url>''
+   * '''josm_version''' is the minimum version of JOSM this plugin works with,
+   * '''plugin_version''' is the version of this plugin and
+   * '''url''' is the link to the download.
+ '''<lang>_Plugin-Description'''::
+   The translated description text for the plugin. E.g. ''de_Plugin-Description'' contains the German translation.
 
+For SVN managed plugins, the links to old versions and the translation texts are automatically added to the [http://josm.openstreetmap.de/plugin plugin information], so JOSM can use that in plugin dialog.
 
 = Versioning and Dependencies =