Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAndrew Ferguson2007-09-17 14:17:15 +0000
committerAndrew Ferguson2007-09-17 14:17:15 +0000
commit90b276e9c0625ceeddebed7776776c836ba8d49f (patch)
tree26443cea0d23cb8b0c026d96f1b74d629692f1a0 /core/org.eclipse.cdt.core/schema
parent02e0e771fe04f953c63dffb45fd339de21bb8783 (diff)
downloadorg.eclipse.cdt-90b276e9c0625ceeddebed7776776c836ba8d49f.tar.gz
org.eclipse.cdt-90b276e9c0625ceeddebed7776776c836ba8d49f.tar.xz
org.eclipse.cdt-90b276e9c0625ceeddebed7776776c836ba8d49f.zip
203553: Apply patch plus additional docs improvements on behalf on Beth Tibbitts. Remove unused usageDescription attribute.
Diffstat (limited to 'core/org.eclipse.cdt.core/schema')
-rw-r--r--core/org.eclipse.cdt.core/schema/templates.exsd66
1 files changed, 26 insertions, 40 deletions
diff --git a/core/org.eclipse.cdt.core/schema/templates.exsd b/core/org.eclipse.cdt.core/schema/templates.exsd
index b2a62c32360..8bb637eece8 100644
--- a/core/org.eclipse.cdt.core/schema/templates.exsd
+++ b/core/org.eclipse.cdt.core/schema/templates.exsd
@@ -6,14 +6,14 @@
<meta.schema plugin="org.eclipse.cdt.core" id="templates" name="Template Extension point"/>
</appInfo>
<documentation>
- This templates extension point facilitates the users to contribute their Template XMLs to the Template Engine plugin.
+ This templates extension point facilitates the users to contribute their Template XMLs to the Template Engine plug-in.
</documentation>
</annotation>
<element name="extension">
<annotation>
<documentation>
- Extension point added to Template Engine plugin. Any plugin, which intends to contribute XML templates to Temaplate Engine has to extend this extension point, and add template element.
+ Extension point added to Template Engine plugin. Any plugin, which intends to contribute XML templates to Template Engine has to extend this extension point, and add template element.
</documentation>
</annotation>
<complexType>
@@ -57,62 +57,52 @@
<sequence>
<element ref="toolChain" minOccurs="0" maxOccurs="unbounded"/>
</sequence>
- <attribute name="location" type="string" use="required">
- <annotation>
- <documentation>
- The location of the template(relative within the extender plugin).
-This is a must enter, attribute.
- </documentation>
- <appInfo>
- <meta.attribute kind="resource"/>
- </appInfo>
- </annotation>
- </attribute>
- <attribute name="filterPattern" type="string">
+ <attribute name="id" type="string" use="required">
<annotation>
<documentation>
- Any filterPatter associated with this Template to be used by TemplateEngine.
-This is an optional attribute.
+ A unique identifier for this template contribution. This does not need to be the same as the id of the template (as defined in template.xml) it is contributing. This allows contributing the same template.xml more than once (for example for multiple project types, or with alternate page sequences).
</documentation>
</annotation>
</attribute>
- <attribute name="usageDescription" type="string">
+ <attribute name="location" type="string" use="required">
<annotation>
<documentation>
- A notation describing how this template is used. Usually used to filter the list of templates on offer depending on other wizard attributes.
-This is an optional attribute.
+ The path of template.xml (relative to the base of the containing plug-in). For example &quot;templates/TemplateOne/template.xml&quot;. This attribute is mandatory.
</documentation>
+ <appInfo>
+ <meta.attribute kind="resource"/>
+ </appInfo>
</annotation>
</attribute>
- <attribute name="pagesAfterTemplateSelectionProvider" type="string">
+ <attribute name="projectType" type="string" use="required">
<annotation>
<documentation>
- A class that implements org.eclipse.cdt.templateengine.IPagesAfterTemplateSelectionProvider interface to create pages that will be appended to the pages returned from TemplatesChoiceWizard.getPagesAfterTemplateSelection().
+ This id refers to the cdt project type that the template will be associated with. Project types are contributed to the org.eclipse.cdt.managedbuilder.core.buildDefinitions extension-point. See the CDT Build System documentation in the developer guide for built-in project type ids.
</documentation>
- <appInfo>
- <meta.attribute kind="java" basedOn="org.eclipse.cdt.ui.templateengine.IPagesAfterTemplateSelectionProvider"/>
- </appInfo>
</annotation>
</attribute>
<attribute name="isCategory" type="boolean">
<annotation>
<documentation>
-
+ If true this template contribution should appear as a folder. Defaults to false.
</documentation>
</annotation>
</attribute>
- <attribute name="projectType" type="string" use="required">
+ <attribute name="filterPattern" type="string">
<annotation>
<documentation>
-
+ filterPattern is a java.util.regex.Pattern format string which is used to match against build configuration ids. This is an optional attribute, if absent will all configurations will match.
</documentation>
</annotation>
</attribute>
- <attribute name="id" type="string">
+ <attribute name="pagesAfterTemplateSelectionProvider" type="string">
<annotation>
<documentation>
-
+ A class that implements org.eclipse.cdt.templateengine.IPagesAfterTemplateSelectionProvider interface to create pages that will be appended to the pages returned from TemplatesChoiceWizard.getPagesAfterTemplateSelection().
</documentation>
+ <appInfo>
+ <meta.attribute kind="java" basedOn="org.eclipse.cdt.ui.templateengine.IPagesAfterTemplateSelectionProvider"/>
+ </appInfo>
</annotation>
</attribute>
</complexType>
@@ -147,17 +137,13 @@ This is an optional attribute.
The following is an example of the extension point usage:
&lt;p&gt;
&lt;pre&gt;
- &lt;extension
- id=&quot;simpleEXETemplateExample&quot;
- name=&quot;Simple EXE Template Example&quot;
- point=&quot;org.eclipse.cdt.templateengine.templates&quot;&gt;
- &lt;template
- filterPattern=&quot;.*&quot;
- usageDescription=&quot;Simple EXE&quot;
- location=&quot;templates/org/eclipse/cdt/templates/projecttemplates/Simple EXE/template.xml&quot;
- projectType=&quot;org.eclipse.cdt.build.projectType.exe&quot;
- wizardId=&quot;org.eclipse.cdt.templates.ui.NewManagedProjectWizard&quot;&gt;
- &lt;/template&gt;
+ &lt;extension point=&quot;org.eclipse.cdt.core.templates&quot;&gt;
+ &lt;template
+ id=&quot;org.foobar.templates.MyExampleTemplate&quot;
+ location=&quot;templates/MyExampleTemplate/template.xml&quot;
+ projectType=&quot;org.eclipse.cdt.build.core.buildArtefactType.exe&quot;
+ filterPattern=&quot;.*&quot;&gt;
+ &lt;/template&gt;
&lt;/extension&gt;
&lt;/pre&gt;

Back to the top