Intro Part Configuration Extension

Identifier:
org.eclipse.ui.intro.configExtension

Since:
3.0

Description:

This extension point is used to extend an existing intro configuration by providing more content, additional StandbyContentParts or additional IntroUrl actions.

Since 3.2, this extension point is also used to contribute a presentation theme that can be used by welcome implementations to separate presentation and content.

Configuration Markup:

<!ELEMENT extension (configExtension | standbyContentPart | action | theme)*>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED

>


<!ELEMENT configExtension EMPTY>

<!ATTLIST configExtension

configId IDREF #REQUIRED

content  CDATA #REQUIRED

>

Defines an extension to an intro configuration. Any page or group in an intro part configuration can be extended, if it has declared extensability by defining anchors.



<!ELEMENT standbyContentPart EMPTY>

<!ATTLIST standbyContentPart

id       CDATA #REQUIRED

pluginId CDATA #REQUIRED

class    CDATA #REQUIRED

>

standbyContentPart registration. Once registered, standby parts can be launched through an introURL action of the following format:

 
http://org.eclipse.ui.intro/showStandby?partId=&lt;id of standbyContentPart&gt;



<!ELEMENT action EMPTY>

<!ATTLIST action

name     CDATA #REQUIRED

replaces CDATA #REQUIRED

>

custom Intro URL action registration. This can be used to create new Intro URL actions or a shortCut to predefined actions.



<!ELEMENT theme (property*)>

<!ATTLIST theme

id           CDATA #REQUIRED

name         CDATA #REQUIRED

path         CDATA #REQUIRED

default      (true | false) "false"

previewImage CDATA #IMPLIED

scalable     (true | false) "false"

>


<!ELEMENT property EMPTY>

<!ATTLIST property

name  CDATA #REQUIRED

value CDATA #REQUIRED

>

an optional theme property that can be used by intro configurers to further customize intro presentation.



Examples:
Here is an example implementation of this extension point:


<extension point="org.eclipse.ui.intro.configExtension">
    <configExtension
         configId="com.org.xyz.introConfig" 
         content="extensionContent.xml"/>  

    <standbyContentPart
         id="com.org.xyz.myStandbyPart"
         class="com.org.xyz.internal.MyStandbyContent"
         pluginId="com.org.xyz"/>

    <action
         name="shortcutAction"
         replaces="http://org.eclipse.ui.intro/showStandby?partId=com.org.xyz.myStandbyPart"/>

    <action
         name="customAction"
         replaces="runAction?pluginId=com.org.xyz&amp;class=com.org.xyz.CustomAction&amp;param1=value1"/>

    <theme
         id="com.example.intro.flowers"
         name="A Nice Flowers Welcome"
         path="$nl$/themes/flowers"
         previewImage="$nl$/themes/flowers/preview.png">
    </theme>
</extension>

API Information:
For further details see the spec for the org.eclipse.ui.intro.config API package.

Supplied Implementation:
There are three supplied implementations:


Copyright (c) 2004, 2006 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