carbidesdk/com.nokia.carbide.cpp.sdk.doc.user/html/reference/extension-points/com_nokia_carbide_templatewizard_wizardTemplate.html
author fturovic <frank.turovich@nokia.com>
Tue, 21 Apr 2009 10:33:39 -0500
changeset 106 aa8d5ca0cab2
parent 2 d760517a8095
child 130 825355d51766
permissions -rw-r--r--
removed splash screen commit
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
106
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
     1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
     2
<HTML>
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
     3
<HEAD><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
     4
<title>Wizard Template</title>
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
     5
<link rel="StyleSheet" href="../../../book.css" type="text/css"/>
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
     6
</HEAD>
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
     7
<BODY>
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
     8
<H1 style="text-align:center">Wizard Template</H1>
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
     9
<p></p>
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
    10
<h6 class="CaptionFigColumn SchemaHeader">Identifier: </h6>com.nokia.carbide.templatewizard.wizardTemplate<p></p>
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
    11
<h6 class="CaptionFigColumn SchemaHeader">Since: </h6>Carbide.c++ 1.2
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
    12
<p></p>
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
    13
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
    14
<h6 class="CaptionFigColumn SchemaHeader">Description: </h6>The wizard template extension point registers a template with the Carbide.c++ template wizard. Templates may create projects or classes.
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
    15
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
    16
See the the documentation under Tasks > Creating Wizard Templates for more information.<p></p>
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
    17
<h6 class="CaptionFigColumn SchemaHeader">Configuration Markup:</h6>
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
    18
<p></p>
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
    19
<p class="code SchemaDtd">&lt;!ELEMENT <a name="e.extension">extension</a> (<a href="#e.template">template</a>+)&gt;</p>
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
    20
<p class="code SchemaDtd">&lt;!ATTLIST extension</p>
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
    21
<p class="code SchemaDtdAttlist">point&nbsp;CDATA #REQUIRED<p class="code SchemaDtdAttlist">id&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED<p class="code SchemaDtdAttlist">name&nbsp;&nbsp;CDATA #IMPLIED&gt;</p>
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
    22
<p></p>
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
    23
<ul class="ConfigMarkupAttlistDesc">
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
    24
</ul>
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
    25
<br><p class="code SchemaDtd">&lt;!ELEMENT <a name="e.template">template</a> EMPTY&gt;</p>
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
    26
<p class="code SchemaDtd">&lt;!ATTLIST template</p>
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
    27
<p class="code SchemaDtdAttlist">templateId&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED<p class="code SchemaDtdAttlist">location&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED<p class="code SchemaDtdAttlist">wizardId&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED<p class="code SchemaDtdAttlist">groupLabel&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED<p class="code SchemaDtdAttlist">filterArguments&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED<p class="code SchemaDtdAttlist">image&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED<p class="code SchemaDtdAttlist">extraPagesProvider&nbsp;CDATA #IMPLIED&gt;</p>
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
    28
<p></p>
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
    29
<p class="ConfigMarkupElementDesc">
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
    30
The template element registers a single template with the template wizard.</p>
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
    31
<br>
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
    32
<ul class="ConfigMarkupAttlistDesc">
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
    33
<li><b>templateId</b> - The unique id for this template</li>
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
    34
<li><b>location</b> - The plugin-relative path to the template xml file</li>
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
    35
<li><b>wizardId</b> - The id of the wizard in which this template is used</li>
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
    36
<li><b>groupLabel</b> - The group label under which this template will appear in the template choice page of the appropriate template wizard</li>
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
    37
<li><b>filterArguments</b> - The optional wizard-specific data available for the IFilter implementing a filter checkbox, optionally shown in some template wizards</li>
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
    38
<li><b>image</b> - The optional plugin-relative location of a 16x16 pixel image file to use when showing this template in the choose template wizard page</li>
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
    39
<li><b>extraPagesProvider</b> - An optional provider of extra wizard pages</li>
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
    40
</ul>
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
    41
<br><h6 class="CaptionFigColumn SchemaHeader">Examples: </h6><pre class="Example"><span class="code SchemaTag">
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
    42
</span><span class="code">&lt;extension point=&quot;com.nokia.carbide.templatewizard.wizardTemplate&quot;&gt;
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
    43
  &lt;template
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
    44
   templateId=&quot;com.nokia.cdt.templates.s60.controlapplication&quot;
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
    45
   location=&quot;templates/projecttemplates/S60-ControlApplication/template.xml&quot;
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
    46
   wizardId=&quot;com.nokia.carbide.cpp.project.ui.wizards.NewSymbianOSCppProjectWizard&quot; 
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
    47
   groupLabel=&quot;S60&quot;
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
    48
   filterArguments=&quot;S60:1.2;2.0-2.9&quot;
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
    49
   image=&quot;icons/icon_S60.png&quot;
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
    50
  /&gt;
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
    51
&lt;/extension&gt;
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
    52
</span></pre>
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
    53
<p></p>
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
    54
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
    55
<h6 class="CaptionFigColumn SchemaHeader">Supplied Implementation: </h6>This extension point registers an XML template. Implementation is not required.
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
    56
<p></p>
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
    57
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
    58
<br>
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
    59
<div id="footer">Copyright &copy; 2009 Nokia Corporation and/or its subsidiary(-ies). All rights reserved. <br>
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
    60
License: <a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a></div>
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
    61
</BODY>
aa8d5ca0cab2 removed splash screen commit
fturovic <frank.turovich@nokia.com>
parents: 2
diff changeset
    62
</HTML>