Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "Tip of the Day/Startup Options"

(Startup Options)
(Plugin Customization)
 
(7 intermediate revisions by the same user not shown)
Line 11: Line 11:
 
| This is the default tips startup option if the user has not set the startup preference.
 
| This is the default tips startup option if the user has not set the startup preference.
 
|
 
|
* "dialog" - The dialog is shown at startup
+
* "dialog" - Tip providers may do background work and the dialog is shown at startup if there are tips to read.
 
* "background" - Tip providers may do background work but no dialog is shown
 
* "background" - Tip providers may do background work but no dialog is shown
* "manual"- The framework only operates on explicit request of the user
+
* "disable"- The framework does not start. Dialog and fetching is done only when the user opens the dialog through a button or menu.
 
|-
 
|-
 
| org.eclipse.tips.statelocation
 
| org.eclipse.tips.statelocation
Line 22: Line 22:
 
| Puts the framework in debug mode, all messages will be placed in the error log.
 
| Puts the framework in debug mode, all messages will be placed in the error log.
 
|
 
|
* "false" - Debug mode is off
+
* "false" or not specified - Debug mode is off
 
* other value - Debug mode is on
 
* other value - Debug mode is on
 
|-
 
|-
Line 30: Line 30:
 
* "false" or not specified - Console log mode is off
 
* "false" or not specified - Console log mode is off
 
* other value - Console log mode is on
 
* other value - Console log mode is on
 +
|-
 +
| tips.test
 +
| Used by the examples plugin to load additional providers.
 +
|
 +
* any value - Additional providers will be loaded in the examples plugin to overload the provider slider
 
|}
 
|}
 +
 +
=Plugin Customization=
 +
For products there is also the option to supply a plugin customization file. On the command line supply the following parameter:
 +
 +
-pluginCustomization /path/to/file
 +
 +
Inside the file specify disabled providers and/or the default startup option.
 +
 +
org.eclipse.tips.ide/disabled_providers=<comma separated list of provider ID's>
 +
org.eclipse.tips.ide/activate_at_startup=<dialog|background|disable>
 +
 +
[https://www.eclipse.org/eclipse/platform-core/documents/user_settings/plugin_customization.html See here how plugin customizations are processed]

Latest revision as of 07:26, 12 January 2020

Startup Options

These are the options to control the Tips framework.

Property Description Values
org.eclipse.tips.startup.default This is the default tips startup option if the user has not set the startup preference.
  • "dialog" - Tip providers may do background work and the dialog is shown at startup if there are tips to read.
  • "background" - Tip providers may do background work but no dialog is shown
  • "disable"- The framework does not start. Dialog and fetching is done only when the user opens the dialog through a button or menu.
org.eclipse.tips.statelocation The location where the tips framework will save its state. If not specified then ${user.home}/.eclipse/org.eclipse.tips.state a location in the filesystem e.g. /home/user/mystate
org.eclipse.tips.debug Puts the framework in debug mode, all messages will be placed in the error log.
  • "false" or not specified - Debug mode is off
  • other value - Debug mode is on
org.eclipse.tips.consolelog Prints all messages in the console
  • "false" or not specified - Console log mode is off
  • other value - Console log mode is on
tips.test Used by the examples plugin to load additional providers.
  • any value - Additional providers will be loaded in the examples plugin to overload the provider slider

Plugin Customization

For products there is also the option to supply a plugin customization file. On the command line supply the following parameter:

-pluginCustomization /path/to/file

Inside the file specify disabled providers and/or the default startup option.

org.eclipse.tips.ide/disabled_providers=<comma separated list of provider ID's>
org.eclipse.tips.ide/activate_at_startup=<dialog|background|disable>

See here how plugin customizations are processed

Back to the top