Changes between Version 32 and Version 51 of Help/Preferences/Plugins


Ignore:
Timestamp:
(multiple changes)
Author:
(multiple changes)
Comment:
(multiple changes)

Legend:

Unmodified
Added
Removed
Modified

  • Help/Preferences/Plugins

    v32 v51  
    11[[TranslatedPages]]
     2[[PageOutline(2-10,Table of contents)]]
     3
    24= Preferences > Plugins =
     5[[JOSMImage(preferences/plugin,48,link=,middle,margin-right=20,margin-bottom=10)]] **Configure available plugins.** \\
     6This register of the Preferences dialog has two tabs to [#Plugins install plugins] and to configure the policy [#PluginUpdatePolicy automatic updates].
    37
    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.   
     8Plugins can extend the core functionality of JOSM.
     9The list [wikitr:/Plugins Plugins for JOSM] shows the official plugins and their kinds of functionality.
     10It is common that users install some plugins.
    511
    6 Most JOSM users don't work with the bare JOSM core only. They usually install a set of at least 3-5 plugins.
    7 
    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.
    9 
    10 [[TOC(inline)]]
    11 
    12 == Automatically via Preferences menu ==
    13 
    14 Common steps:
    15 1. Launch the [[Image(source:/trunk/images/preference.png,15)]] **Preferences** dialog.
    16 1. Select the tab [[Image(source:trunk/images/preferences/plugin.png,15)]] **Plugins**.
    17 
    18 === Installing plugins ===
    19 
    20 1. (optionally) click on [[Image(source:trunk/images/download.png,15)]] **Download list** to download the list of available plugins (if nothing was shown)
     12== Installing plugins ==#Plugins
     131. (Optionally) Click on [[JOSMImage(download)]] **Download list** to download the list of available plugins (if nothing was shown).
     141. (Optionally) Use the checkboxes and the Search text field on top to filter the list.
    21151. Tick the checkbox for every plugin you want to install.
    22161. Click on  **OK**.
    2317
    24 JOSM will download and install the plugins. Some plugins doesn't require rests of the JOSM, you will be prompted only if there need for this.
     18JOSM will download and install the plugins.\\
     19Some plugins require a restart of JOSM to get fully installed.
     20A confirmation will appear if needed.
    2521
     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]  ||
     29
     30Please, install only the plugins you need.
     31Plugins will probably rise the chance of code errors and some combinations might even not been tested.
     32As a plugin could be a file from ''Somewhere in the Internet'' keep the security related issues in mind.
     33
     34=== Manual installation ===
     35If 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.
     36Now restart and the plugins should show up in the plugin list.
     37Tick the checkboxes of these manually placed plugins for finally installing them.
     38
     39
     40== Plugin update policy == #PluginUpdatePolicy
    2641=== Updating plugins === #AutomaticUpdate
     42[[Image(automatic-update.png,link=,right,margin-left=10,margin-bottom=10)]]
     43On start-up, JOSM attempts to update the plugins
    2744
    28 On start-up, JOSM attempts to update the plugins
    2945* if JOSM itself has been updated since the last plugin update. This is called the **version based update mode**.
    30 * if a certain periode of 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**.
    3147
    3248In 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.
    3349
    34 [[Image(wiki:Plugins:automatic-update.png)]]
     50Select **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.
    3551
    36 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.
    37 
    38 In the preferences you can define the policy for both updating plugins modes.
    39 
    40 1. same ''common steps'' as above
    41 1. Click the tab **Plugin update policy**.
    42 
    43 [[Image(plugin_update_policy_preferences.png,450)]]
    44 
    45 * 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.
    4655* Select the radio button **Always update without asking** if JOSM shall automatically update plugins without asking.
    4756* 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.
    … …  
    4958The interval in days for the **time based updated mode** can be set below the radio buttons (''default=30'').
    5059
    51 == Manual installation ==
     60**Note:** There will be not restart required if plugins are updated on start-up.
    5261
    53 In most cases users don't need to do this.
    54 
    55 === Manually installing plugins ===
    56 If the automatic way does not work, you can install plugins manually by putting the .jar files in the **plugins** directory under {{{josm}}} directory.
    57 
    58 {{{josm}}} location was covered at [[Help/Preferences#Defaultlocation]].
    59 
    60 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.
    6162
    6263=== Manually updating plugins ===
    63 1. Launch the [[Image(source:trunk/images/preference.png,15)]] **Preferences** dialog.
    64 1. Select the tab [[Image(source:trunk/images/preferences/plugin.png,15)]] **Plugins**.
    65 1. Click on [[Image(source:trunk/images/download.png,15)]] **Download list** do download the list of available plugins.
    66 1. Tick the checkbox for every plugin you want to update.
    67 1. Click on [[Image(source:trunk/images/dialogs/refresh.png,15)]] **Update plugins**.
     641. Launch the [[JOSMImage(preference)]] **Preferences** dialog.
     651. Select the tab [[JOSMImage(preferences/plugin,24,middle,link=)]] **Plugins**.
     661. Click on [[JOSMImage(download)]] **Download list** to download the list of available plugins.
     671. Your installed plugins are already selected at the checkboxes
     681. Click on [[JOSMImage(dialogs/refresh)]] **Update plugins**.
    6869
    69 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.
     70JOSM will update the selected plugins. You have to [[JOSMImage(restart)]] [wikitr:/Help/Action/Restart restart] JOSM to complete the update process.
    7071
    7172
    7273== See also ==
    73 * [wiki:/Plugins List of JOSM plugins]
    74 * [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]
    7577
    7678----
    77 Back to [Action/Preferences Preferences][[BR]]
    78 Back to [Help/Plugins Plugin Help][[BR]]
    79 Back to [wiki:/Help Main Help]
     79Back to [wikitr:/Help/Action/Preferences Preferences Dialog] \\
     80Back to [wikitr:/Help/Menu/Edit Edit Menu] \\
     81Back to [wikitr:/Help Main Help]