Changes between Version 40 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

    v40 v51  
    11[[TranslatedPages]]
    2 [[PageOutline(2,Tabs)]]
     2[[PageOutline(2-10,Table of contents)]]
    33
    4 = [wikitr:/Help/Preferences Preferences] > Plugins =
    5 Plugins extend the core functionality of JOSM. The [wikitr:/Plugins list of JOSM plugins] explains which plugins are available and with what kind of functionality they extend JOSM.   
     4= 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].
    67
    7 Most JOSM users don't work with the bare JOSM core only. They usually install several plugins.
     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.
    811
    9 **Please, install only the plugins you need.** Plugins will probably rise the chance of code errors and some combinations might even not been tested.
    10 
    11 == Automatic installation via Preferences menu ==
    12 Common steps:
    13 1. Launch the [[Image(source:/trunk/images/preference.png,16,middle)]] **Preferences** dialog.
    14 1. Select the tab [[Image(source:trunk/images/preferences/plugin.png,16,middle)]] **Plugins**.
    15 
    16 === Installing plugins ===
    17 1. (Optionally) Click on [[Image(source:trunk/images/download.png,16,middle)]] **Download list** to download the list of available plugins (if nothing was shown).
    18 1. (Optionally) Use the checkboxes and the text field on top to filter the list.
     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.
    19151. Tick the checkbox for every plugin you want to install.
    20161. Click on  **OK**.
    2117
    2218JOSM will download and install the plugins.\\
    23 Some plugins require a restart of JOSM, you will be prompted if you need to.
     19Some plugins require a restart of JOSM to get fully installed.
     20A confirmation will appear if needed.
    2421
     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
    2541=== Updating plugins === #AutomaticUpdate
     42[[Image(automatic-update.png,link=,right,margin-left=10,margin-bottom=10)]]
    2643On start-up, JOSM attempts to update the plugins
     44
    2745* if JOSM itself has been updated since the last plugin update. This is called the **version based update mode**.
    2846* if a certain period of time has elapsed since the last plugin update. This is called the **time based updated mode**.
    … …  
    3048In 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.
    3149
    32 [[Image(wiki:Plugins:automatic-update.png)]]
    33 
    3450Select **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 
    37 == Plugin update policy ==#PluginUpdatePolicy
    38 [[Image(plugin_update_policy_preferences_macOS.png)]]
    39 
     52==== Options ====
     53[[Image(plugin_update_policy_preferences.png,link=,right,,margin-left=20,margin-bottom=10)]]
    4054* Select the radio button **Ask before updating** if JOSM shall ask before updating plugins in version and/or time-based update mode.
    4155* Select the radio button **Always update without asking** if JOSM shall automatically update plugins without asking.
    … …  
    4458The interval in days for the **time based updated mode** can be set below the radio buttons (''default=30'').
    4559
     60**Note:** There will be not restart required if plugins are updated on start-up.
    4661
    47 == Manual installation ==
    48 In most cases, users don't need to do this.
    49 
    50 === Manually installing plugins ===
    51 If the automatic way does not work, you can install plugins manually by putting the .jar files in the **plugins** directory under {{{josm}}} directory.
    52 
    53 {{{josm}}} location is explained under Preferences, see [wikitr:/Help/Preferences#JOSMpreferencedatacachedirectories JOSM preference/data/cache directories].
    54 
    55 Now restart JOSM and the plugins should show up in the plugin list under **''Edit -> Preferences -> [[Image(source:trunk/images/preferences/plugin.png,16,middle)]] [wikitr:/Help/Preferences/Plugins Plugins]''**.[[BR]]
    56 Activate the Plugins, click on [[Image(source:/trunk/images/ok.png,16,middle)]] **OK** to save the preferences and restart JOSM once more.
    5762
    5863=== Manually updating plugins ===
    59 1. Launch the [[Image(source:trunk/images/preference.png,16,middle)]] **Preferences** dialog.
    60 1. Select the tab [[Image(source:trunk/images/preferences/plugin.png,16,middle)]] **Plugins**.
    61 1. Click on [[Image(source:trunk/images/download.png,16,middle)]] **Download list** do download the list of available 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.
    62671. Your installed plugins are already selected at the checkboxes
    63 1. Click on [[Image(source:trunk/images/dialogs/refresh.png,16,middle)]] **Update plugins**.
     681. Click on [[JOSMImage(dialogs/refresh)]] **Update plugins**.
    6469
    65 JOSM will update the selected plugins. You have to restart JOSM to complete the update process.
     70JOSM will update the selected plugins. You have to [[JOSMImage(restart)]] [wikitr:/Help/Action/Restart restart] JOSM to complete the update process.
    6671
    6772
    6873== See also ==
    69 * [wikitr:/Plugins List of JOSM plugins]
     74* [wikitr:/Plugins Plugins for JOSM] as list
    7075* [wikitr:/Help/Plugins Plugin Help]
     76* [[JOSMImage(preference)]] [wikitr:/Help/Preferences Preferences Overview]
    7177
    7278----
    73 Back to [wikitr:/Help/Action/Preferences Preferences Dialog]\\
    74 Back to [wikitr:/Help/Menu/Edit Edit Menu]\\
     79Back to [wikitr:/Help/Action/Preferences Preferences Dialog] \\
     80Back to [wikitr:/Help/Menu/Edit Edit Menu] \\
    7581Back to [wikitr:/Help Main Help]