Jump to: navigation, search

Difference between revisions of "Tip of the Day"

(Extending Tip of the Day)
 
(27 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.
  
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.
+
[[file:tips_main.png|500px]]
  
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.
 
  
The framework can be installed with this link
+
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/>
  
[https://hudson.eclipse.org/e4/job/org.eclipse.tips/lastSuccessfulBuild/artifact/releng/org.eclipse.tips.site/target/repository/ repository]
 
  
The TOTD UI looks like this:
 
  
[[file:tips_main.png|400px]]
+
==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.
  
==Wiki Tips==
+
Early testing feedback on [https://bugs.eclipse.org/bugs/show_bug.cgi?id=534347 bug 534347]
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]]
+
# Help/Install new software
 +
# Add this repo http://download.eclipse.org/eclipse/updates/4.8-I-builds
 +
# Uncheck "Group Items by Category"
 +
# Search for Tips
 +
# Install and restart.
  
==Twitter Tips==
+
 
Tips can be retrieved from Twitter using the embedded link.
+
 
 +
[[file:tipinst01.png|400px]]
 +
 
 +
==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.
 +
 
 +
* [[Tip of the Day/Extending|Extending the Tips framework]]
 +
 
 +
==Startup Options==
 +
The Tips can be controlled by some startup options.
 +
 
 +
* [[Tip of the Day/Startup Options|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.

Latest revision as of 06:59, 3 June 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 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 bug 534347

  1. Help/Install new software
  2. Add this repo http://download.eclipse.org/eclipse/updates/4.8-I-builds
  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.