Template Extension point

Identifier:

Since:

Description:

Configuration Markup:

<!ELEMENT extension (template+)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>

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.

• id - Id for the extension in the extender plugin.
• name - Optional name attribute.

<!ELEMENT template (toolChain*)>

<!ATTLIST template

location                            CDATA #REQUIRED

filterPattern                       CDATA #IMPLIED

pagesAfterTemplateSelectionProvider CDATA #IMPLIED

isCategory                          (true | false)

projectType                         CDATA #REQUIRED

id                                  CDATA #IMPLIED>

By adding the template extension point the users can contribute their Template XMLs to the Template Engine plugin.

• location - The location of the template (relative to the extender plugin). This is a required attribute.
• filterPattern - Any filterPattern associated with this Template to be used by TemplateEngine. This is an optional attribute.
• 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().

• isCategory -
• projectType - The project type; this is a required attribute. CDT pre-defines the following values of the build artifact type property:
  • "org.eclipse.cdt.build.core.buildArtefactType.exe" - to represent executable
  • "org.eclipse.cdt.build.core.buildArtefactType.staticLib" - to represent static library
  • "org.eclipse.cdt.build.core.buildArtefactType.sharedLib" - to represent shared library
  • ISVs can define their own custom build artifact values by contributing to the org.eclipse.cdt.managedbuilder.core.buildProperties extension point.
• 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.

<!ELEMENT toolChain EMPTY>

<!ATTLIST toolChain

id CDATA #REQUIRED>

The toolchain

• id -

Examples:

   
<extension
         
point=
"org.eclipse.cdt.core.templates"
         
id=
"simpleEXETemplateExample"
         
name=
"Simple EXE Template Example"
>
      
<template 
            
filterPattern=
".*"
            
location=
"templates/SimpleEXE/template.xml"

            projectType=
"org.eclipse.cdt.build.core.buildArtefactType.exe"

            id=
"com.foobar.templates.myWizardID"
>
      
</template>
 
   
</extension>

Supplied Implementation:

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