Skip to main content
Jump to: navigation, search

Difference between revisions of "Tip of the Day"

(Installing)
(Extending IDE Tips)
Line 21: Line 21:
 
[[file:tipinst01.png|400px]]
 
[[file:tipinst01.png|400px]]
  
==Extending IDE Tips==
+
=Extending IDE Tips=
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.
+
Extenders are able to use and extension point that provides a TipProvider subclass to 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|More information here]]
+
Examples on how each of these work can be found in the tip examples here:
 +
 
 +
== JSon Tip Provider ==
 +
A JSon Tip provider requires a JSon file with information. The TipProvider implementation can be very simple. A JSon file can be placed on the internet and be maintained dynamically. You can pull down this file if the change date was changed (use the HTTP HEAD function) or pull it down every time the provider is started.
 +
 
 +
=== Examples===
 +
* [https://git.eclipse.org/c/platform/eclipse.platform.ua.git/tree/org.eclipse.tips.examples/src/org/eclipse/tips/examples/json/JsonTipProviderPhoton.java JSON Tip Provider]
 +
* [https://git.eclipse.org/c/platform/eclipse.platform.ua.git/tree/org.eclipse.tips.examples/src/org/eclipse/tips/examples/json/provider.json JSon file with the information]
  
 
==Wiki Tips==
 
==Wiki Tips==

Revision as of 10:18, 8 May 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.

The TOTD UI looks like this:

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 IDE Tips

Extenders are able to use and extension point that provides a TipProvider subclass to 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.

Examples on how each of these work can be found in the tip examples here:

JSon Tip Provider

A JSon Tip provider requires a JSon file with information. The TipProvider implementation can be very simple. A JSon file can be placed on the internet and be maintained dynamically. You can pull down this file if the change date was changed (use the HTTP HEAD function) or pull it down every time the provider is started.

Examples

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

Twitter Tips

Tips can be retrieved from Twitter using the embedded link.

Back to the top