diff options
Diffstat (limited to 'org.eclipse.ui.intro.quicklinks/schema/quicklinks.exsd')
| -rw-r--r-- | org.eclipse.ui.intro.quicklinks/schema/quicklinks.exsd | 257 |
1 files changed, 257 insertions, 0 deletions
diff --git a/org.eclipse.ui.intro.quicklinks/schema/quicklinks.exsd b/org.eclipse.ui.intro.quicklinks/schema/quicklinks.exsd new file mode 100644 index 000000000..cf14b5327 --- /dev/null +++ b/org.eclipse.ui.intro.quicklinks/schema/quicklinks.exsd @@ -0,0 +1,257 @@ +<?xml version='1.0' encoding='UTF-8'?> +<!-- Schema file written by PDE --> +<schema targetNamespace="org.eclipse.ui.intro.quicklinks" xmlns="http://www.w3.org/2001/XMLSchema"> +<annotation> + <appinfo> + <meta.schema plugin="org.eclipse.ui.intro.quicklinks" id="org.eclipse.ui.intro.quicklinks" name="Quicklinks Configuration"/> + </appinfo> + <documentation> + 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 <tt>org.eclipse.ui.commands</tt> 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. + </documentation> + </annotation> + + <element name="extension"> + <annotation> + <appinfo> + <meta.element /> + </appinfo> + </annotation> + <complexType> + <choice minOccurs="1" maxOccurs="unbounded"> + <element ref="quicklink"/> + <element ref="override"/> + </choice> + <attribute name="point" type="string" use="required"> + <annotation> + <documentation> + + </documentation> + </annotation> + </attribute> + <attribute name="id" type="string"> + <annotation> + <documentation> + + </documentation> + </annotation> + </attribute> + <attribute name="name" type="string"> + <annotation> + <documentation> + + </documentation> + <appinfo> + <meta.attribute translatable="true"/> + </appinfo> + </annotation> + </attribute> + </complexType> + </element> + + <element name="quicklink"> + <annotation> + <documentation> + Defines a Quicklink component + </documentation> + </annotation> + <complexType> + <attribute name="command" type="string" use="required"> + <annotation> + <documentation> + The command identifier to be invoked. The command can also be a serialized command to encode command parameters (see ParameterizedCommand#serialize() for details). + </documentation> + <appinfo> + <meta.attribute kind="identifier" basedOn="org.eclipse.ui.commands/command/@id"/> + </appinfo> + </annotation> + </attribute> + <attribute name="label" type="string"> + <annotation> + <documentation> + The label to be displayed. If unspecified, the command name is used instead. + </documentation> + <appinfo> + <meta.attribute translatable="true"/> + </appinfo> + </annotation> + </attribute> + <attribute name="description" type="string"> + <annotation> + <documentation> + A description for the quicklink. If unspecified, use the command's description. + </documentation> + <appinfo> + <meta.attribute translatable="true"/> + </appinfo> + </annotation> + </attribute> + <attribute name="icon" type="string"> + <annotation> + <documentation> + The icon to be used for the quicklink. If unspecified, the command's associated image is used instead. + </documentation> + <appinfo> + <meta.attribute kind="resource"/> + </appinfo> + </annotation> + </attribute> + <attribute name="importance"> + <annotation> + <documentation> + Define the level of importance of this item. If unspecified, defaults to "low". + </documentation> + </annotation> + <simpleType> + <restriction base="string"> + <enumeration value="high"> + </enumeration> + <enumeration value="medium"> + </enumeration> + <enumeration value="low"> + </enumeration> + </restriction> + </simpleType> + </attribute> + <attribute name="standby" type="boolean"> + <annotation> + <documentation> + If true (the default), the Welcome/Intro part should be put into standby mode after executing the command. +If false, the Welcome/Intro will remain open. + </documentation> + </annotation> + </attribute> + </complexType> + </element> + + <element name="override"> + <annotation> + <documentation> + Provide a mechanism for a theme to override the icons used to represent a command in a quicklink. + </documentation> + </annotation> + <complexType> + <attribute name="command" type="string" use="required"> + <annotation> + <documentation> + The command identifier as referenced in a &lt;quicklink&gt; element. The command can also be a serialized command to encode command parameters (see ParameterizedCommand#serialize() for details). The command may include simple '*' wildcards to match any substring. For example, <code>org.eclipse.ui.newWizard*</code> will match any "New" wizard definitions. + </documentation> + <appinfo> + <meta.attribute kind="identifier" basedOn="org.eclipse.ui.commands/command/@id"/> + </appinfo> + </annotation> + </attribute> + <attribute name="theme" type="string" use="required"> + <annotation> + <documentation> + The theme identifier. May be a comma-separated set of values. + </documentation> + <appinfo> + <meta.attribute kind="identifier" basedOn="org.eclipse.ui.intro.configExtension/theme/@id"/> + </appinfo> + </annotation> + </attribute> + <attribute name="icon" type="string" use="required"> + <annotation> + <documentation> + The icon to be used for representing this command. + </documentation> + <appinfo> + <meta.attribute kind="resource"/> + </appinfo> + </annotation> + </attribute> + </complexType> + </element> + + <annotation> + <appinfo> + <meta.section type="since"/> + </appinfo> + <documentation> + Quicklinks first appeared in the Eclipse Platform 4.6, part of the Neon release train. + </documentation> + </annotation> + + <annotation> + <appinfo> + <meta.section type="examples"/> + </appinfo> + <documentation> + Here is an example of configuring a Quicklink: +<pre> + <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> +</pre> +<p> +Quicklinks are shown using the Quicklinks Viewer Component in a <tt>introContent.xml</tt> definition. +</p> +<pre> + <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> +</pre> + </documentation> + </annotation> + + <annotation> + <appinfo> + <meta.section type="apiinfo"/> + </appinfo> + <documentation> + Quicklinks are still experimental and not yet considered API. + </documentation> + </annotation> + + <annotation> + <appinfo> + <meta.section type="implementation"/> + </appinfo> + <documentation> + Quicklinks are still experimental and not yet considered API. + </documentation> + </annotation> + + <annotation> + <appinfo> + <meta.section type="copyright"/> + </appinfo> + <documentation> + 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 + </documentation> + </annotation> + +</schema> |