1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-04-29 19:45:01 +02:00

201087: add additional description for the templateAssociations extension point

This commit is contained in:
Andrew Ferguson 2007-09-17 16:02:16 +00:00
parent 8141e8a02c
commit 30f802ec61

View file

@ -6,14 +6,14 @@
<meta.schema plugin="org.eclipse.cdt.core" id="templateAssociations" name="Template Associations"/>
</appInfo>
<documentation>
This extension point facilitates adding new toolchains generated from a different plugin to already defined template without modifying template definition.
This extension-point allows developers to specify toolchains that should be enabled for selection for use with a pre-existing template. This solves the problem over how ISV&apos;s can have templates defined and shipped with CDT support their own toolchains, without having to modify CDT itself.
</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.
Each extension consists of a sequence of template elements, each of which define child elements for the new toolchains that should be enabled for selection during new project creation.
</documentation>
</annotation>
<complexType>
@ -30,7 +30,7 @@
<attribute name="id" type="string">
<annotation>
<documentation>
Id for the extension in the extender plugin.
The unique identifier for this extension
</documentation>
</annotation>
</attribute>
@ -48,11 +48,16 @@
</element>
<element name="toolChain">
<annotation>
<documentation>
This element is used to reference an existing toolchain by its unique identifier.
</documentation>
</annotation>
<complexType>
<attribute name="id" type="string" use="required">
<annotation>
<documentation>
The unique identifier of a toolchain contributed to the org.eclipse.cdt.managedbuilder.core.buildDefinitions extension point.
</documentation>
</annotation>
</attribute>
@ -60,6 +65,11 @@
</element>
<element name="template">
<annotation>
<documentation>
This element references an existing template contribution&apos;s unique identifier in order that toolchains contributed separately to the template can be made selectable on project creation.
</documentation>
</annotation>
<complexType>
<sequence>
<element ref="toolChain" minOccurs="0" maxOccurs="unbounded"/>
@ -67,7 +77,7 @@
<attribute name="id" type="string" use="required">
<annotation>
<documentation>
The unique identifier of the template-contribution (the id in plugin.xml rather than the template.xml) that should have the specified additional toolchains enabled for selection during new project creation.
</documentation>
</annotation>
</attribute>
@ -88,7 +98,16 @@
<meta.section type="examples"/>
</appInfo>
<documentation>
If you developed toolchain&apos;s with ids &quot;com.foobar.toolchain1.base&quot; and &quot;com.foobar.toolchain2.base&quot;, which you wanted enabled for the empty project type built into the cdt core, you could use the following to achieve this:
&lt;pre&gt;
&lt;extension point=&quot;org.eclipse.cdt.core.templateAssociations&quot;&gt;
&lt;template id=&quot;org.eclipse.cdt.build.core.templates.EmptyProject&quot;&gt;
&lt;toolChain id=&quot;com.foobar.toolchain1.base&quot;/&gt;
&lt;toolChain id=&quot;com.foobar.toolchain2.base&quot;/&gt;
&lt;/template&gt;
&lt;/extension&gt;
&lt;/pre&gt;
</documentation>
</annotation>