Intro Part

Identifier:
org.eclipse.ui.intro

Since:
3.0

Description:

This extension point is used to register implementations of special workbench parts, called intro parts, that are responsible for introducing a product to new users. An intro part is typically shown the first time a product is started up. Rules for associating an intro part implementation with particular products are also contributed via this extension point.

The life cycle is as follows:

Configuration Markup:

<!ELEMENT extension (intro* , introProductBinding*)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT intro EMPTY>

<!ATTLIST intro

id              CDATA #REQUIRED

icon            CDATA #IMPLIED

class           CDATA #REQUIRED

contentDetector CDATA #IMPLIED

label           CDATA #IMPLIED>

Specifies an introduction. An introduction is a product-specific presentation shown to first-time users on product start up.



<!ELEMENT introProductBinding EMPTY>

<!ATTLIST introProductBinding

productId IDREF #REQUIRED

introId   IDREF #REQUIRED>

Specifies a binding between a product and an introduction. These bindings determine which introduction is appropriate for the current product (as defined by org.eclipse.core.runtime.Platform.getProduct()).



Examples:
The following is an example of an intro part extension that contributes an particular introduction and associates it with a particular product:


  <extension point="org.eclipse.ui.intro">
     <intro
        id="com.example.xyz.intro.custom"
        class="com.example.xyz.intro.IntroPart"/>
     <introProductBinding
        productId="com.example.xyz.Product"
        introId="com.example.xyz.intro.custom"/>
  </extension>

API Information:
The value of the class attribute must be the fully qualified name of a class that implements theorg.eclipse.ui.intro.IIntroPart interface by subclassing org.eclipse.ui.part.intro.IntroPart.

Supplied Implementation:
There are no default implementations of the initial user experience. Each Eclipse-based product is responsible for providing one that is closely matched to its branding and function.


Copyright (c) 2004, 2009 IBM Corporation and others.
All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html