Quicklinks Configuration

Identifier:
org.eclipse.ui.intro.quicklinks.org.eclipse.ui.intro.quicklinks

Since:
Quicklinks first appeared in the Eclipse Platform 4.6, part of the Neon release train.

Description:
This extension point is used to configure the Quicklinks Welcome/Intro viewer component. Quicklinks are useful actions to be shown to a user in the Intro/Welcome. The Quicklinks use the Eclipse Core Commands framework (see the org.eclipse.ui.commands extension point), but supports overriding the icon and text to be used for an item. The Quicklinks is experimental component and is not yet considered API.

Configuration Markup:

<!ELEMENT extension (command | override | url)+>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT command EMPTY>

<!ATTLIST command

id          IDREF #REQUIRED

label       CDATA #IMPLIED

description CDATA #IMPLIED

icon        CDATA #IMPLIED

importance  (high|medium|low)

resolution  (standby|launchbar|close|full) >

Defines a Quicklink component. One of "command" or "url" must be specified.



<!ELEMENT url EMPTY>

<!ATTLIST url

location    CDATA #REQUIRED

label       CDATA #REQUIRED

description CDATA #REQUIRED

icon        CDATA #IMPLIED

importance  (high|medium|low) >

Defines a URL Quicklink component. URL Quicklinks must provide a label and it is recommended to provide an icon and description



<!ELEMENT override EMPTY>

<!ATTLIST override

command IDREF #REQUIRED

theme   IDREF #REQUIRED

icon    CDATA #REQUIRED>

Provide a mechanism for a theme to override the icons used to represent a command in a quicklink.



Examples:
Here is an example of configuring a Quicklink:

   <extension
         point="org.eclipse.ui.intro.quicklinks">
      <!-- Reuses command definition label and icons -->
      <quicklink
            command="org.eclipse.epp.mpc.ui.command.showMarketplaceWizard"
            icon="icons/mpcdrag.png">
      </quicklink>
      
      <!-- Invoke a particular new wizard; place the Welcome/Intro in Standby mode on success -->
      <quicklink
            command="org.eclipse.ui.newWizard(newWizardId=org.eclipse.jdt.ui.wizards.JavaProjectWizard)"
            description="Create a new Java Eclipse project"
            label="Create a new Java project"
            standby="true">
      </quicklink>
      
      <!-- Allow overriding theme and icons for all newWizard-related commands -->
      <override
            command="org.eclipse.ui.newWizard*"
            icon="icons/solstice/new-project.png"
            theme="org.eclipse.ui.intro.universal.solstice">
      </override>
   </extension>

Quicklinks are shown using the Quicklinks Viewer Component in a introContent.xml definition.


 <extensionContent id="quicklinks" name="Quick Actions" path="root/extra-group2/anchor">
        <contentProvider 
         pluginId="org.eclipse.ui.intro.quicklinks"
         class="org.eclipse.ui.intro.quicklinks.QuicklinksViewer"
         id="quick-links">
        </contentProvider>
    </extensionContent>

API Information:
Quicklinks are still experimental and not yet considered API.

Supplied Implementation:
Quicklinks are still experimental and not yet considered API.


Copyright (c) 2016 Manumitting Technologies Inc 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 Contributors: Manumitting Technologies Inc - initial API and implementation