Attachment 78599 Details for Bug 203553 – replacement for org_eclipse_cdt_core_templates.html

replacement for org_eclipse_cdt_core_templates.html

org_eclipse_cdt_core_templates.html (text/html), 6.65 KB, created by Beth Tibbitts

on 2007-09-17 22:01:21 EDT

(hide)

Description:

Filename:

MIME Type:

Creator: Beth Tibbitts

Created: 2007-09-17 22:01:21 EDT

Size: 6.65 KB

patch

obsolete

><!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
><HTML>
><HEAD><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
><title>Template Extension point</title>
><style>@import url("../../book.css");</style>
><style>@import url("../../schema.css");</style>
></HEAD>
><BODY>
><H1><CENTER>Template Extension point</CENTER></H1>
>
><h6 class=CaptionFigColumn id=header>Identifier: </h6>org.eclipse.cdt.core.templates
><h6 class=CaptionFigColumn id=header>Since: </h6>This extension point was added in CDT 4.0
>
>
>
><h6 class=CaptionFigColumn id=header>Description: </h6>
>This template extension point allows users to contribute their 
>Template XMLs to the Template Engine plugin.
><h6 class=CaptionFigColumn id=header>Configuration Markup:</h6>
>&lt;!ELEMENT <a name="e.extension">extension</a> (<a href="#e.template">template</a>+)&gt;
>&lt;!ATTLIST extension
>point&nbsp;CDATA #REQUIREDid&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIEDname&nbsp;&nbsp;CDATA #IMPLIED&gt;
>
>
>Extension point added to Template Engine plugin. Any plugin, which intends to contribute XML templates to the Template Engine 
>must extend this extension point, and add the template element.
> 
><ul class=ConfigMarkup id=attlistDesc>
><li>id - Id for the extension in the extender plugin.</li>
><li>name - Optional name attribute.</li>
></ul>
> &lt;!ELEMENT <a name="e.template">template</a> (<a href="#e.toolChain">toolChain</a>*)&gt;
>&lt;!ATTLIST template
>location&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIREDfilterPattern&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED
>pagesAfterTemplateSelectionProvider&nbsp;CDATA #IMPLIED
>isCategory&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(true | false) 
>projectType&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED
>id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED&gt;
>
>
>By adding the template extension point the users can contribute their Template XMLs to the Template Engine plugin.
> 
><ul class=ConfigMarkup id=attlistDesc>
><li>location - The location of the template (relative to the extender plugin).
>This is a required attribute.</li>
><li>filterPattern - Any filterPattern associated with this Template to be used by TemplateEngine.
>This is an optional attribute.</li>
><li>pagesAfterTemplateSelectionProvider - A class that implements the
>org.eclipse.cdt.ui.templateengine.IPagesAfterTemplateSelectionProvider interface to create pages that will be appended to the pages returned from 
>TemplatesChoiceWizard.getPagesAfterTemplateSelection()</code>.</li>
><li>isCategory - </li>
><li>projectType - The project type; this is a required attribute.
>CDT pre-defines the following values of the build artifact type property:
><ul><li>
>"org.eclipse.cdt.build.core.buildArtefactType.exe" - to represent executable
><li>
>"org.eclipse.cdt.build.core.buildArtefactType.staticLib" - to represent static library
><li>
>"org.eclipse.cdt.build.core.buildArtefactType.sharedLib" - to represent shared library
><li>
>ISVs can define their own custom build artifact values by contributing to the org.eclipse.cdt.managedbuilder.core.buildProperties extension point.
></ul>
>
>
>
></li>
><li>id - A unique id for this template; this is a required attribute.
>Note that the same template.xml can be contributed multiple times through
>templates with different IDs.
></li>
></ul>
> &lt;!ELEMENT <a name="e.toolChain">toolChain</a> EMPTY&gt;
>&lt;!ATTLIST toolChain
>id&nbsp;CDATA #REQUIRED&gt;
>
>The toolchain
><ul class=ConfigMarkup id=attlistDesc>
><li>id - </li>
></ul>
> <h6 class=CaptionFigColumn id=header>Examples: </h6>The following is an example of the extension point usage:
>
><pre>
> &lt;extension
> point=&quot;org.eclipse.cdt.core.templates&quot;
> id=&quot;simpleEXETemplateExample&quot;
> name=&quot;Simple EXE Template Example&quot;&gt;
> &lt;template 
> filterPattern=&quot;.*&quot;
> location=&quot;templates/SimpleEXE/template.xml&quot;
> projectType=&quot;org.eclipse.cdt.build.core.buildArtefactType.exe&quot;
> id=&quot;com.foobar.templates.myWizardID&quot;&gt;
> &lt;/template&gt; 
> &lt;/extension&gt;
></pre> 
>
>For more details on how to define your own templates, please check examples provided under
><samp>org.eclipse.cdt.ui.templateengine</samp>
>
>
><h6 class=CaptionFigColumn id=header>Supplied Implementation: </h6>An implementation of this extension point is supplied in <samp>org.eclipse.cdt.core.templateengine</samp>
>
>
> 
>
>Copyright (c) 2007 Symbian Software Limited 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:
>Symbian - Initial API and implementation
>
>
>
></BODY>
></HTML>

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<title>Template Extension point</title>
<style>@import url("../../book.css");</style>
<style>@import url("../../schema.css");</style>
</HEAD>
<BODY>
<H1><CENTER>Template Extension point</CENTER></H1>
<p></p>
<h6 class=CaptionFigColumn id=header>Identifier: </h6>org.eclipse.cdt.core.templates<p></p>
<h6 class=CaptionFigColumn id=header>Since: </h6>This extension point was added in CDT 4.0
<p></p>

<p>
<h6 class=CaptionFigColumn id=header>Description: </h6>
This template extension point allows users to contribute their 
Template XMLs to the Template Engine plugin.</p>
<p><h6 class=CaptionFigColumn id=header>Configuration Markup:</h6></p>
<p class=code id=dtd>&lt;!ELEMENT <a name="e.extension">extension</a> (<a href="#e.template">template</a>+)&gt;</p>
<p class=code id=dtd>&lt;!ATTLIST extension</p>
<p class=code id=dtdAttlist>point&nbsp;CDATA #REQUIRED<p class=code id=dtdAttlist>id&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED<p class=code id=dtdAttlist>name&nbsp;&nbsp;CDATA #IMPLIED&gt;</p>
<p></p>
<p class=ConfigMarkup id=elementDesc>
Extension point added to Template Engine plugin.  Any plugin, which intends to contribute XML templates to the Template Engine 
must extend this extension point, and add the template element.</p>
<br>
<ul class=ConfigMarkup id=attlistDesc>
<li><b>id</b> - Id for the extension in the extender plugin.</li>
<li><b>name</b> - Optional name attribute.</li>
</ul>
<br><p class=code id=dtd>&lt;!ELEMENT <a name="e.template">template</a> (<a href="#e.toolChain">toolChain</a>*)&gt;</p>
<p class=code id=dtd>&lt;!ATTLIST template</p>
<p class=code id=dtdAttlist>location&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED<p class=code id=dtdAttlist>filterPattern&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED
<p class=code id=dtdAttlist>pagesAfterTemplateSelectionProvider&nbsp;CDATA #IMPLIED
<p class=code id=dtdAttlist>isCategory&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(true | false) 
<p class=code id=dtdAttlist>projectType&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED
<p class=code id=dtdAttlist>id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED&gt;</p>
<p></p>
<p class=ConfigMarkup id=elementDesc>
By adding the template  extension point the users can contribute their Template XMLs to the Template Engine plugin.</p>
<br>
<ul class=ConfigMarkup id=attlistDesc>
<li><b>location</b> - The location of the template (relative to the extender plugin).
This is a required attribute.</li>
<li><b>filterPattern</b> - Any filterPattern associated with this Template to be used by TemplateEngine.
This is an optional attribute.</li>
<li><b>pagesAfterTemplateSelectionProvider</b> - A class that implements the
<p class=code>org.eclipse.cdt.ui.templateengine.IPagesAfterTemplateSelectionProvider</p> interface to create pages that will be appended to the pages returned from 
<p class=code>TemplatesChoiceWizard.getPagesAfterTemplateSelection()</code>.</li>
<li><b>isCategory</b> - </li>
<li><b>projectType</b> - The project type; this is a required attribute.
CDT pre-defines the following values of the build artifact type property:
<ul><li>
"org.eclipse.cdt.build.core.buildArtefactType.exe" - to represent executable
<li>
"org.eclipse.cdt.build.core.buildArtefactType.staticLib" - to represent static library
<li>
"org.eclipse.cdt.build.core.buildArtefactType.sharedLib" - to represent shared library
<li>
ISVs can define their own custom build artifact values by contributing to the org.eclipse.cdt.managedbuilder.core.buildProperties extension point.
</ul>



</li>
<li><b>id</b> - A unique id for this template; this is a required attribute.
Note that the same template.xml can be contributed multiple times through
templates with different IDs.
</li>
</ul>
<br><p class=code id=dtd>&lt;!ELEMENT <a name="e.toolChain">toolChain</a> EMPTY&gt;</p>
<p class=code id=dtd>&lt;!ATTLIST toolChain</p>
<p class=code id=dtdAttlist>id&nbsp;CDATA #REQUIRED&gt;</p>
<p class=ConfigMarkup id=elementDesc>
The toolchain</p>
<ul class=ConfigMarkup id=attlistDesc>
<li><b>id</b> - </li>
</ul>
<br><h6 class=CaptionFigColumn id=header>Examples: </h6>The following is an example of the extension point usage:
<p>
<pre>
   <p class=code id=tag>&lt;extension</p>
         <p class=code id=tag>point=</p><p class=code id=cstring>&quot;org.eclipse.cdt.core.templates&quot;</p>
         <p class=code id=tag>id=</p><p class=code id=cstring>&quot;simpleEXETemplateExample&quot;</p>
         <p class=code id=tag>name=</p><p class=code id=cstring>&quot;Simple EXE Template Example&quot;</p><p class=code id=tag>&gt;</p>
      <p class=code id=tag>&lt;template </p>
            <p class=code id=tag>filterPattern=</p><p class=code id=cstring>&quot;.*&quot;</p>
            <p class=code id=tag>location=</p><p class=code id=cstring>&quot;templates/SimpleEXE/template.xml&quot;</p><p class=code id=tag>
            projectType=<p class=code id=cstring>&quot;org.eclipse.cdt.build.core.buildArtefactType.exe&quot;</p><p class=code id=tag>
            id=<p class=code id=cstring>&quot;com.foobar.templates.myWizardID&quot;</p><p class=code id=tag>&gt;</p>
      <p class=code id=tag>&lt;/template&gt;</p> 
   <p class=code id=tag>&lt;/extension&gt;</p>
</pre>            

For more details on how to define your own templates, please check examples provided under
<samp>org.eclipse.cdt.ui.templateengine</samp>
<p></p>

<h6 class=CaptionFigColumn id=header>Supplied Implementation: </h6>An implementation of this extension point is supplied in <samp>org.eclipse.cdt.core.templateengine</samp>
<p></p>

<br>
<p class=note id=copyright>
Copyright (c) 2007 Symbian Software Limited 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:
Symbian - Initial API and implementation
<p></p>

</p>
</BODY>
</HTML>

Flags:

bjorn.freeman-benson: iplog+

Actions: View

Attachments on bug 203553: 78528 | 78548 | 78599