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"

(Installing)
(Installing)
 
(19 intermediate revisions by the same user not shown)
Line 1: Line 1:
The Eclipse Tip of the Day framework enables users to see Eclipse Tips during startup and enable extenders to provide tips for their specific bundles.
+
<big>'''The Eclipse Tip of the Day framework'''</big> enables users to see Eclipse Tips during startup and enable extenders to provide tips for their specific bundles.
  
The TOTD UI looks like this:
+
[[file:tips_main.png|500px]]
 
+
[[file:tips_main.png|600px]]
+
  
  
 
TipProviders are selected based on their importance in the current context. For example, if the Java perspective is open, you are likely to get Java tips. If the PDE perspective is open, you are likely to get PDE tips.<br/><br/>
 
TipProviders are selected based on their importance in the current context. For example, if the Java perspective is open, you are likely to get Java tips. If the PDE perspective is open, you are likely to get PDE tips.<br/><br/>
  
==Installing==
 
The Tip of the Day feature is available in the nightly builds. After restart the framework should fetch some data from the downloads area and present 4 tip providers with new tips.
 
  
Early testing feedback on [https://bugs.eclipse.org/bugs/show_bug.cgi?id=534347 bug 534347]
+
 
 +
==Installing==
 +
The Tip of the Day feature is available in product updates repository. After restart the framework will be available in the bottom left corner as an light-bulb icon.
  
 
# Help/Install new software
 
# Help/Install new software
# Add this repo http://download.eclipse.org/eclipse/updates/4.8-I-builds
+
# Add this repo http://download.eclipse.org/eclipse/updates/4.10 (4.10 or higher)
 
# Uncheck "Group Items by Category"
 
# Uncheck "Group Items by Category"
 
# Search for Tips
 
# Search for Tips
 
# Install and restart.
 
# Install and restart.
 +
  
 
[[file:tipinst01.png|400px]]
 
[[file:tipinst01.png|400px]]
  
==Extending IDE Tips==
+
==Extending Tip of the Day==
Extenders are able to provide a TipProvider class that can serve Tip objects. Each Tip can provide a link to a website OR a HTML description and an Image URL.
+
You can use an extension point to point to your TipProvider subclass. TipProviders serve Tip objects. Tips can be read from a JSon file or can be manually crafted. In the latter case you create tips from HTML, and URL or have complete freedom by providing an SWT tip.
 +
 
 +
* [[Tip of the Day/Extending|Extending the Tips framework]]
 +
 
 +
==Startup Options==
 +
The Tips can be controlled by some startup options.  
  
* [[Tip of the Day/Extending|More information here]]
+
* [[Tip of the Day/Startup Options|Startup Options]]
  
==Wiki Tips==
 
Tips can be retrieved from the Eclipse Wiki. The TipProvider may read tip URLs from a page and create Tip objects from a link. Examples in the framework provide tips from the following page:
 
  
[[Tip of the Day/Eclipse Tips]]
+
==Cache==
 +
The read state of the tips is maintained in the ${user.home}/.eclipse directory. You will find multiple files per provider that contain the read tips. You may edit these files manually, erase them or erase the whole directory.
  
==Twitter Tips==
+
Dialog settings are maintained in the configuration area of the workspace. These can be set through the Tip dialog. We do not maintain a preference page.
Tips can be retrieved from Twitter using the embedded link.
+

Latest revision as of 05:31, 25 December 2018

The Eclipse Tip of the Day framework enables users to see Eclipse Tips during startup and enable extenders to provide tips for their specific bundles.

Tips main.png


TipProviders are selected based on their importance in the current context. For example, if the Java perspective is open, you are likely to get Java tips. If the PDE perspective is open, you are likely to get PDE tips.


Installing

The Tip of the Day feature is available in product updates repository. After restart the framework will be available in the bottom left corner as an light-bulb icon.

  1. Help/Install new software
  2. Add this repo http://download.eclipse.org/eclipse/updates/4.10 (4.10 or higher)
  3. Uncheck "Group Items by Category"
  4. Search for Tips
  5. Install and restart.


Tipinst01.png

Extending Tip of the Day

You can use an extension point to point to your TipProvider subclass. TipProviders serve Tip objects. Tips can be read from a JSon file or can be manually crafted. In the latter case you create tips from HTML, and URL or have complete freedom by providing an SWT tip.

Startup Options

The Tips can be controlled by some startup options.


Cache

The read state of the tips is maintained in the ${user.home}/.eclipse directory. You will find multiple files per provider that contain the read tips. You may edit these files manually, erase them or erase the whole directory.

Dialog settings are maintained in the configuration area of the workspace. These can be set through the Tip dialog. We do not maintain a preference page.

Back to the top