Changes between Version 24 and Version 51 of Help/Preferences/Plugins
- Timestamp:
- (multiple changes)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
Help/Preferences/Plugins
v24 v51 1 1 [[TranslatedPages]] 2 [[PageOutline(2-10,Table of contents)]] 3 2 4 = Preferences > Plugins = 5 [[JOSMImage(preferences/plugin,48,link=,middle,margin-right=20,margin-bottom=10)]] **Configure available plugins.** \\ 6 This register of the Preferences dialog has two tabs to [#Plugins install plugins] and to configure the policy [#PluginUpdatePolicy automatic updates]. 3 7 4 Plugins extend the core functionality of JOSM. The [wiki:/Plugins list of JOSM plugins] explains which plugins are available and with what kind of functionality they extend JOSM. 8 Plugins can extend the core functionality of JOSM. 9 The list [wikitr:/Plugins Plugins for JOSM] shows the official plugins and their kinds of functionality. 10 It is common that users install some plugins. 5 11 6 Most JOSM users don't work with the bare JOSM core only. They usually install a set of at least 3-5 plugins. 12 == Installing plugins ==#Plugins 13 1. (Optionally) Click on [[JOSMImage(download)]] **Download list** to download the list of available plugins (if nothing was shown). 14 1. (Optionally) Use the checkboxes and the Search text field on top to filter the list. 15 1. Tick the checkbox for every plugin you want to install. 16 1. Click on **OK**. 7 17 8 **Please, install only the plugins you need.** Plugins will probably rise the chance of code errors and some combinations might even not been tested. 18 JOSM will download and install the plugins.\\ 19 Some plugins require a restart of JOSM to get fully installed. 20 A confirmation will appear if needed. 9 21 10 [[TOC(inline)]] 22 || [#TextFilter Filter by text] ||\ 23 || [#List Plugin list] ||\ 24 || [#StatusFilter Filter by status] || 25 |||||| [[Image(PreferencesPluginsPlugins.png,link=)]] || 26 || Reload list \\ data from server ||\ 27 || Update the selected \\ plugins manually ||\ 28 || Only visible in \\ [wikitr:/Help/ExpertMode Expert mode] || 11 29 12 == Installing plugins == 30 Please, install only the plugins you need. 31 Plugins will probably rise the chance of code errors and some combinations might even not been tested. 32 As a plugin could be a file from ''Somewhere in the Internet'' keep the security related issues in mind. 13 33 14 1. Launch the [[Image(source:/trunk/images/preference.png,15)]] **Preferences** dialog. 15 1. Select the tab [[Image(source:trunk/images/preferences/plugin.png,15)]] **Plugins**. 16 1. Click on [[Image(source:trunk/images/download.png,15)]] **Download list** to download the list of available plugins. 17 1. Tick the checkbox for every plugin you want to install. 18 1. Click on [[Image(source:trunk/images/dialogs/refresh.png,15)]] **Update plugins**. 34 === Manual installation === 35 If a manual installation is really needed, you can put the .jar files in the `plugins` directory under JOSM [wikitr:/Help/Preferences#JOSMpreferencedatacachedirectories user-data] directory. 36 Now restart and the plugins should show up in the plugin list. 37 Tick the checkboxes of these manually placed plugins for finally installing them. 19 38 20 JOSM will download and install the plugins. You have to restart JOSM to **load and activate** the newly downloaded plugins.21 39 22 == Manually updating plugins == 23 1. Launch the [[Image(source:trunk/images/preference.png,15)]] **Preferences** dialog. 24 1. Select the tab [[Image(source:trunk/images/preferences/plugin.png,15)]] **Plugins**. 25 1. Click on [[Image(source:trunk/images/download.png,15)]] **Download list** do download the list of available plugins. 26 1. Tick the checkbox for every plugin you want to update. 27 1. Click on [[Image(source:trunk/images/dialogs/refresh.png,15)]] **Update plugins**. 40 == Plugin update policy == #PluginUpdatePolicy 41 === Updating plugins === #AutomaticUpdate 42 [[Image(automatic-update.png,link=,right,margin-left=10,margin-bottom=10)]] 43 On start-up, JOSM attempts to update the plugins 28 44 29 JOSM will download and install the most recent version of the selected plugins. You have to restart JOSM to **load and activate** the newly downloaded plugins.30 31 == Automatically updating plugins == #AutomaticUpdate32 33 On start-up, JOSM attempts to update the plugins34 45 * if JOSM itself has been updated since the last plugin update. This is called the **version based update mode**. 35 * if a certain period eof time has elapsed since the last plugin update. This is called the **time based updated mode**.46 * if a certain period of time has elapsed since the last plugin update. This is called the **time based updated mode**. 36 47 37 48 In both cases, JOSM offers to update the currently active plugins and you are advised to run the updates by clicking on **Update plugins**. You may also skip updating, but be warned, that installed plugins could be incompatible with the new JOSM version and that they might either fail to load or fail to work as expected. 38 49 39 [[Image(wiki:Plugins:automatic-update.png)]] 50 Select **Do not ask again and remember my decision** if JOSM should always try the selected action without asking for confirmation. If you select this checkbox, JOSM won't display this dialog anymore. 40 51 41 Select **Do not ask again and remember my decision** if JOSM should always try the selected action without asking for confirmation. If you select this checkbox, JOSM won't display this dialogue any more. 42 43 In the preferences you can define the policy for both updating plugins modes. 44 45 1. Launch the [[Image(source:trunk/images/preference.png,15)]] **Preferences** dialog. 46 1. Select the tab [[Image(source:trunk/images/preferences/plugin.png,15)]] **Plugins**. 47 1. Click the tab **Plugin update policy**. 48 49 [[Image(plugin_update_policy_preferences.png,450)]] 50 51 * Select the radio button **Ask before updating** if JOSM shall ask before updating plugins in version and/or time based update mode. 52 ==== Options ==== 53 [[Image(plugin_update_policy_preferences.png,link=,right,,margin-left=20,margin-bottom=10)]] 54 * Select the radio button **Ask before updating** if JOSM shall ask before updating plugins in version and/or time-based update mode. 52 55 * Select the radio button **Always update without asking** if JOSM shall automatically update plugins without asking. 53 56 * Select the radio button **Never update** to disable version or time based automatic update. JOSM will skip automatic update at startup if this policy is selected. … … 55 58 The interval in days for the **time based updated mode** can be set below the radio buttons (''default=30''). 56 59 57 == Manually installing plugins == 58 If the automatic way does not work, you can install plugins manually by putting the .jar files in the **plugins** directory under the JOSM directory 60 **Note:** There will be not restart required if plugins are updated on start-up. 59 61 60 * Under **Windows 7 and Vista**, the plugins are located in {{{C:\Users\}}}''username''{{{\AppData\Roaming\JOSM\plugins}}}.61 * Under **Windows**, this is in {{{C:\Documents and Settings\}}}''username''{{{\Application Data\JOSM\plugins}}}.62 * On a **Mac** you will find the JOSM directory in the user directory {{{/Users/}}}''username''{{{/.josm/plugins}}}. The point "." in front of ".josm" indicates that this folder is invisible. To show the contents of this hidden folder, use the Finders Go to folder menu command ({{{Cmd+Shift+G}}}), and enter "~/.josm") in the dialog that pops up. Drag any plugins you'd like to install into the {{{plugins}}} folder.[[BR]] (You can also copy the plugin files using the command line.)63 * On a **Linux** system you will find the JOSM directory in the user directory {{{/home/}}}''username''{{{/.josm/plugins}}}. The point "." in front of ".josm" indicates that this folder is invisible. To show the contents of this hidden folder, use the file manager and enter "~/.josm" in the address line (if no address line is visible just try to enter a letter and hopefully a popup to enter the address will open). Alternatively it is possible to "show hidden" files and folders in the file manager, using the keyboard shortcut ''Ctrl+H''. Drag any plugins you'd like to install into the {{{plugins}}} folder.[[BR]] (You can also copy the plugin files using the command line.)64 62 65 Now restart JOSM and the plugins should show up in the plugin list under **''Edit -> Preferences -> [[Image(source:trunk/images/preferences/plugin.png,15)]] [wiki:Help/Preferences/Plugins Plugins]''**.[[BR]] Activate the Plugins, click on [[Image(source:/trunk/images/ok.png,15)]] **OK** to save the preferences and restart JOSM once more. 63 === Manually updating plugins === 64 1. Launch the [[JOSMImage(preference)]] **Preferences** dialog. 65 1. Select the tab [[JOSMImage(preferences/plugin,24,middle,link=)]] **Plugins**. 66 1. Click on [[JOSMImage(download)]] **Download list** to download the list of available plugins. 67 1. Your installed plugins are already selected at the checkboxes 68 1. Click on [[JOSMImage(dialogs/refresh)]] **Update plugins**. 69 70 JOSM will update the selected plugins. You have to [[JOSMImage(restart)]] [wikitr:/Help/Action/Restart restart] JOSM to complete the update process. 66 71 67 72 68 73 == See also == 69 * [wiki:/Plugins List of JOSM plugins] 70 * [Help/Plugins Plugin Help] 74 * [wikitr:/Plugins Plugins for JOSM] as list 75 * [wikitr:/Help/Plugins Plugin Help] 76 * [[JOSMImage(preference)]] [wikitr:/Help/Preferences Preferences Overview] 71 77 72 78 ---- 73 Back to [ Action/Preferences Preferences][[BR]]74 Back to [ Help/Plugins Plugin Help][[BR]]75 Back to [wiki :/Help Main Help]79 Back to [wikitr:/Help/Action/Preferences Preferences Dialog] \\ 80 Back to [wikitr:/Help/Menu/Edit Edit Menu] \\ 81 Back to [wikitr:/Help Main Help]
