diff options
Diffstat (limited to 'org.eclipse.mylyn.commons.repositories.ui/schema/newWizards.exsd')
| -rw-r--r-- | org.eclipse.mylyn.commons.repositories.ui/schema/newWizards.exsd | 362 |
1 files changed, 362 insertions, 0 deletions
diff --git a/org.eclipse.mylyn.commons.repositories.ui/schema/newWizards.exsd b/org.eclipse.mylyn.commons.repositories.ui/schema/newWizards.exsd new file mode 100644 index 00000000..5a722e0a --- /dev/null +++ b/org.eclipse.mylyn.commons.repositories.ui/schema/newWizards.exsd @@ -0,0 +1,362 @@ +<?xml version='1.0' encoding='UTF-8'?> +<!-- Schema file written by PDE --> +<schema targetNamespace="org.eclipse.mylyn.commons.repositories.ui" xmlns="http://www.w3.org/2001/XMLSchema"> +<annotation> + <appinfo> + <meta.schema plugin="org.eclipse.mylyn.commons.repositories.ui" id="newWizards" name="Creation Wizards"/> + </appinfo> + <documentation> + This extension point is used to register repository creation wizard extensions. Creation wizards appear as choices within the "New Dialog", and are typically used to create folders and files. +<p> +In the "New Dialog", wizards are organized into categories which usually reflect a particular problem domain. For instance, a Java oriented plugin may define a category called "Java" which is appropriate for "Class" or "Package" creation wizards. The categories defined by one plug-in can be referenced by other plug-ins using the category attribute. Uncategorized wizards, as well as wizards with invalid category paths, will end up in an "Other" category. +</p> + +<p> +Wizards may optionally specify a description subelement whose body should contain short text about the wizard. +</p> + </documentation> + </annotation> + + <element name="extension"> + <annotation> + <appinfo> + <meta.element /> + </appinfo> + </annotation> + <complexType> + <choice minOccurs="0" maxOccurs="unbounded"> + <element ref="category"/> + <element ref="wizard"/> + <element ref="primaryWizard"/> + </choice> + <attribute name="point" type="string" use="required"> + <annotation> + <documentation> + a fully qualified identifier of the target extension point + </documentation> + </annotation> + </attribute> + <attribute name="id" type="string"> + <annotation> + <documentation> + an optional identifier of the extension instance + </documentation> + </annotation> + </attribute> + <attribute name="name" type="string"> + <annotation> + <documentation> + an optional name of the extension instance + </documentation> + <appinfo> + <meta.attribute translatable="true"/> + </appinfo> + </annotation> + </attribute> + </complexType> + </element> + + <element name="category"> + <complexType> + <attribute name="id" type="string" use="required"> + <annotation> + <documentation> + a unique name that can be used to identify this category + </documentation> + </annotation> + </attribute> + <attribute name="name" type="string" use="required"> + <annotation> + <documentation> + a translatable name of the category that will be used in the dialog box + </documentation> + <appinfo> + <meta.attribute translatable="true"/> + </appinfo> + </annotation> + </attribute> + <attribute name="parentCategory" type="string"> + <annotation> + <documentation> + a path to another category if this category should be added as a child + </documentation> + <appinfo> + <meta.attribute kind="identifier" basedOn="org.eclipse.mylyn.commons.repositories.ui.newWizards/category/@id"/> + </appinfo> + </annotation> + </attribute> + </complexType> + </element> + + <element name="wizard"> + <complexType> + <sequence> + <element ref="description" minOccurs="0" maxOccurs="1"/> + <element ref="selection" minOccurs="0" maxOccurs="unbounded"/> + <element ref="keywordReference" minOccurs="0" maxOccurs="unbounded"/> + </sequence> + <attribute name="id" type="string" use="required"> + <annotation> + <documentation> + a unique name that can be used to identify this wizard + </documentation> + </annotation> + </attribute> + <attribute name="name" type="string" use="required"> + <annotation> + <documentation> + a translatable name of the wizard that will be used in the dialog box + </documentation> + <appinfo> + <meta.attribute translatable="true"/> + </appinfo> + </annotation> + </attribute> + <attribute name="icon" type="string"> + <annotation> + <documentation> + a relative path of an icon that will be used together with the name to represent the wizard +as one of the choices in the creation dialog box. + </documentation> + <appinfo> + <meta.attribute kind="resource"/> + </appinfo> + </annotation> + </attribute> + <attribute name="category" type="string"> + <annotation> + <documentation> + a slash-delimited path ('/') of category IDs. Each token in the +path must represent a valid category ID previously defined +by this or some other plug-in. If omitted, the wizard will be +added to the "Other" category. + </documentation> + </annotation> + </attribute> + <attribute name="class" type="string" use="required"> + <annotation> + <documentation> + a fully qualified name of the Java class implementing <samp>org.eclipse.ui.INewWizard</samp>. + </documentation> + <appinfo> + <meta.attribute kind="java" basedOn="org.eclipse.jface.wizard.Wizard:org.eclipse.ui.INewWizard"/> + </appinfo> + </annotation> + </attribute> + <attribute name="project" type="boolean"> + <annotation> + <documentation> + an optional attribute indicating the wizard will create an IProject resource. +Also causes the wizard to appear as a choice within the "New Project Dialog". + </documentation> + </annotation> + </attribute> + <attribute name="finalPerspective" type="string"> + <annotation> + <documentation> + an optional attribute which identifies a perspective to activate when IProject resource creation is finished. + </documentation> + <appinfo> + <meta.attribute kind="identifier" basedOn="org.eclipse.ui.perspectives/perspective/@id"/> + </appinfo> + </annotation> + </attribute> + <attribute name="preferredPerspectives" type="string"> + <annotation> + <documentation> + an optional attribute specifying a comma-separated list of perspective IDs. If the current perspective is in this list, then no perspective activation occurs when IProject resource creation is finished. + </documentation> + </annotation> + </attribute> + <attribute name="helpHref" type="string"> + <annotation> + <documentation> + a help url that can describe this wizard in detail. +<p> +Since 3.0 +</p> + </documentation> + </annotation> + </attribute> + <attribute name="descriptionImage" type="string"> + <annotation> + <documentation> + a larger image that can help describe this wizard. +<p> +Since 3.0 +</p> + </documentation> + <appinfo> + <meta.attribute kind="resource"/> + </appinfo> + </annotation> + </attribute> + <attribute name="canFinishEarly" type="boolean"> + <annotation> + <documentation> + whether the wizard is capable of finishing without ever showing pages to the user. + </documentation> + </annotation> + </attribute> + <attribute name="hasPages" type="boolean"> + <annotation> + <documentation> + whether the wizard provides any pages. + </documentation> + </annotation> + </attribute> + </complexType> + </element> + + <element name="description" type="string"> + <annotation> + <appinfo> + <meta.element translatable="true"/> + </appinfo> + <documentation> + an optional subelement whose body contains a short text describing what the wizard will do when started + </documentation> + </annotation> + </element> + + <element name="selection"> + <complexType> + <attribute name="class" type="string" use="required"> + <annotation> + <documentation> + a fully qualified class name. If each object in the workbench selection implements this interface the selection will be passed to the wizard. Otherwise, an empty selection is passed + </documentation> + <appinfo> + <meta.attribute kind="java"/> + </appinfo> + </annotation> + </attribute> + <attribute name="name" type="string"> + <annotation> + <documentation> + an optional name filter. Each object in the workbench selection must match the name filter to be passed to the wizard + </documentation> + </annotation> + </attribute> + </complexType> + </element> + + <element name="primaryWizard"> + <annotation> + <documentation> + a means of declaring that a wizard is "primary" in the UI. A primary wizard is emphasized in the new wizard dialog. Please note that this element is not intended to be used by plug in developers! This element exists so that product managers may emphasize a set of wizards for their products. + </documentation> + </annotation> + <complexType> + <attribute name="id" type="string" use="required"> + <annotation> + <documentation> + the id of a wizard that should be made primary. + </documentation> + <appinfo> + <meta.attribute kind="identifier" basedOn="org.eclipse.mylyn.commons.repositories.ui.newWizards/wizard/@id"/> + </appinfo> + </annotation> + </attribute> + </complexType> + </element> + + <element name="keywordReference"> + <annotation> + <documentation> + A reference by a New Wizard to a keyword. See the keywords extension point. + </documentation> + </annotation> + <complexType> + <attribute name="id" type="string" use="required"> + <annotation> + <documentation> + The id of the keyword being referred to. + </documentation> + <appinfo> + <meta.attribute kind="identifier" basedOn="org.eclipse.mylyn.commons.repositories.ui.keywords/keyword/@id"/> + </appinfo> + </annotation> + </attribute> + </complexType> + </element> + + <annotation> + <appinfo> + <meta.section type="examples"/> + </appinfo> + <documentation> + Following is an example of creation wizard configuration: +<p> +<pre> + <extension point="org.eclipse.ui.newWizards"> + <category + id="com.xyz.XYZ" + name="XYZ Wizards"> + </category> + <category + id="com.xyz.XYZ.Web" + name="Web Wizards" + parentCategory="com.xyz.XYZ"> + </category> + <wizard + id="com.xyz.wizard1" + name="XYZ artifact" + category="com.xyz.XYZ/com.xyz.XYZ.Web" + icon="./icons/XYZwizard1.gif" + class="com.xyz.XYZWizard1"> + <description> + Create a simple XYZ artifact and set initial content + </description> + <selection class="org.eclipse.core.resources.IResource"/> + </wizard> + </extension> +</pre> +</p> + </documentation> + </annotation> + + <annotation> + <appinfo> + <meta.section type="apiInfo"/> + </appinfo> + <documentation> + The value of the class attribute must represent a class +that implements <samp>org.eclipse.ui.INewWizard</samp>. +If the wizard is created from within the +New Wizard it will be inserted into the existing wizard. +If the wizard is launched as a shortcut +(from the File New menu or a toolbar button) it will +appear standalone as a separate dialog box. + </documentation> + </annotation> + + + <annotation> + <appinfo> + <meta.section type="implementation"/> + </appinfo> + <documentation> + The workbench comes with wizards for creating empty +resources of the following types: +project, folder and file. These wizards are registered +using the same mechanism as described above. +Additional wizards may also appear, subject to +particular platform installation. + </documentation> + </annotation> + + <annotation> + <appinfo> + <meta.section type="copyright"/> + </appinfo> + <documentation> + Copyright (c) 2002, 2005 IBM Corporation and others.<br> +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 <a +href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a> + </documentation> + </annotation> + +</schema> |