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.

Configuration Markup:

<!ELEMENT extension (configExtension+ , standbyContentPart* , action*)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>

• point - a fully qualified identifier of the target extension point

• id - an optional identifier of the extension instance

• name - an optional name of the extension instance

<!ELEMENT configExtension EMPTY>

<!ATTLIST configExtension

configId CDATA #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.

• configId - the id of an intro contribution that will be extended

• content - an intro content file. The content file is an XML file that contains the specifics of the intro (intro content file format specification). The content file is parsed at run time by the intro framework. Based on the settings in this file, a certain number of pages, groups, and links are shown to the user when the intro is opened.

<!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=
<id of standbyContentPart>

• id - a unique id that identifies this standbyContentPart.

• pluginId - the name of the plugin that holds the class defined in the "class" attribute.

• class - the fully qualified class name of the class that implements org.eclipse.ui.intro.config.IStandbyContentPart to handle displaying alternative standby content, such as a cheat sheet.

<!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.

• name - a unique name that identifies this action.

• replaces - the macro which replaces the action name in the Intro URL.

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"
/>
  

    
<standbyPart
         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"
/>
</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:

• org.eclipse.jdt, makes use of configExtension

• org.eclipse.pde, makes use of configExtension

• org.eclipse.platform, makes use of standbyPoint

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