1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336
|
<?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 Welcome/Intro. 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="command"/>
<element ref="override"/>
<element ref="url"/>
</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="command">
<annotation>
<documentation>
Defines a Quicklink component. One of "command" or "url" must be specified.
</documentation>
</annotation>
<complexType>
<attribute name="id" 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="resolution">
<annotation>
<documentation>
What should happen to the Welcome view after executing the command.
If "full" or unspecified, the Welcome/Intro part will be put into full visual mode.
If "standby" (the default), the Welcome/Intro part will be put into standby mode.
If "launchbar", the Welcome/Intro will be put into 'launchbar' mode in the status area.
If "close" then the Welcome/Intro will be closed.
</documentation>
</annotation>
<simpleType>
<restriction base="string">
<enumeration value="standby">
</enumeration>
<enumeration value="launchbar">
</enumeration>
<enumeration value="close">
</enumeration>
<enumeration value="full">
</enumeration>
</restriction>
</simpleType>
</attribute>
</complexType>
</element>
<element name="url">
<annotation>
<documentation>
Defines a URL Quicklink component. URL Quicklinks must provide a label and it is recommended to provide an icon and description
</documentation>
</annotation>
<complexType>
<attribute name="location" type="string" use="required">
<annotation>
<documentation>
The URL to be invoked. The URL can either be an Intro URL or an external URL.
</documentation>
</annotation>
</attribute>
<attribute name="label" type="string" use="required">
<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" use="required">
<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>
</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, 2017 Manumitting Technologies Inc and others.
This program and the accompanying materials are made
available under the terms of the Eclipse Public License 2.0 which accompanies
this distribution, and is available at <a href="https://www.eclipse.org/legal/epl-2.0">https://www.eclipse.org/legal/epl-v20.html</a>/
SPDX-License-Identifier: EPL-2.0
</documentation>
</annotation>
</schema>
|