core/com.nokia.carbide.templatewizard/schema/wizardTemplate.exsd
author timkelly
Tue, 14 Apr 2009 10:18:48 -0500
changeset 91 2010205bb971
parent 2 d760517a8095
permissions -rw-r--r--
deprecate public API for new one that uses progress monitor (bug 7351)
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
cawthron
parents:
diff changeset
     1
<?xml version='1.0' encoding='UTF-8'?>
cawthron
parents:
diff changeset
     2
<!-- Schema file written by PDE -->
cawthron
parents:
diff changeset
     3
<schema targetNamespace="com.nokia.carbide.templatewizard" xmlns="http://www.w3.org/2001/XMLSchema">
cawthron
parents:
diff changeset
     4
<annotation>
cawthron
parents:
diff changeset
     5
      <appinfo>
cawthron
parents:
diff changeset
     6
         <meta.schema plugin="com.nokia.carbide.templatewizard" id="wizardTemplate" name="Wizard Template"/>
cawthron
parents:
diff changeset
     7
      </appinfo>
cawthron
parents:
diff changeset
     8
      <documentation>
cawthron
parents:
diff changeset
     9
         The wizard template extension point registers a template with the Carbide.c++ template wizard. Templates may create projects or classes.
cawthron
parents:
diff changeset
    10
cawthron
parents:
diff changeset
    11
See the the documentation under Tasks &gt; Creating Wizard Templates for more information.
cawthron
parents:
diff changeset
    12
      </documentation>
cawthron
parents:
diff changeset
    13
   </annotation>
cawthron
parents:
diff changeset
    14
cawthron
parents:
diff changeset
    15
   <element name="extension">
cawthron
parents:
diff changeset
    16
      <annotation>
cawthron
parents:
diff changeset
    17
         <appinfo>
cawthron
parents:
diff changeset
    18
            <meta.element />
cawthron
parents:
diff changeset
    19
         </appinfo>
cawthron
parents:
diff changeset
    20
      </annotation>
cawthron
parents:
diff changeset
    21
      <complexType>
cawthron
parents:
diff changeset
    22
         <sequence>
cawthron
parents:
diff changeset
    23
            <element ref="template" minOccurs="1" maxOccurs="unbounded"/>
cawthron
parents:
diff changeset
    24
         </sequence>
cawthron
parents:
diff changeset
    25
         <attribute name="point" type="string" use="required">
cawthron
parents:
diff changeset
    26
            <annotation>
cawthron
parents:
diff changeset
    27
               <documentation>
cawthron
parents:
diff changeset
    28
                  
cawthron
parents:
diff changeset
    29
               </documentation>
cawthron
parents:
diff changeset
    30
            </annotation>
cawthron
parents:
diff changeset
    31
         </attribute>
cawthron
parents:
diff changeset
    32
         <attribute name="id" type="string">
cawthron
parents:
diff changeset
    33
            <annotation>
cawthron
parents:
diff changeset
    34
               <documentation>
cawthron
parents:
diff changeset
    35
                  
cawthron
parents:
diff changeset
    36
               </documentation>
cawthron
parents:
diff changeset
    37
            </annotation>
cawthron
parents:
diff changeset
    38
         </attribute>
cawthron
parents:
diff changeset
    39
         <attribute name="name" type="string">
cawthron
parents:
diff changeset
    40
            <annotation>
cawthron
parents:
diff changeset
    41
               <documentation>
cawthron
parents:
diff changeset
    42
                  
cawthron
parents:
diff changeset
    43
               </documentation>
cawthron
parents:
diff changeset
    44
               <appinfo>
cawthron
parents:
diff changeset
    45
                  <meta.attribute translatable="true"/>
cawthron
parents:
diff changeset
    46
               </appinfo>
cawthron
parents:
diff changeset
    47
            </annotation>
cawthron
parents:
diff changeset
    48
         </attribute>
cawthron
parents:
diff changeset
    49
      </complexType>
cawthron
parents:
diff changeset
    50
   </element>
cawthron
parents:
diff changeset
    51
cawthron
parents:
diff changeset
    52
   <element name="template">
cawthron
parents:
diff changeset
    53
      <annotation>
cawthron
parents:
diff changeset
    54
         <documentation>
cawthron
parents:
diff changeset
    55
            The template element registers a single template with the template wizard.
cawthron
parents:
diff changeset
    56
         </documentation>
cawthron
parents:
diff changeset
    57
      </annotation>
cawthron
parents:
diff changeset
    58
      <complexType>
cawthron
parents:
diff changeset
    59
         <sequence minOccurs="0" maxOccurs="unbounded">
cawthron
parents:
diff changeset
    60
            <element ref="metadata"/>
cawthron
parents:
diff changeset
    61
         </sequence>
cawthron
parents:
diff changeset
    62
         <attribute name="templateId" type="string" use="required">
cawthron
parents:
diff changeset
    63
            <annotation>
cawthron
parents:
diff changeset
    64
               <documentation>
cawthron
parents:
diff changeset
    65
                  The unique id for this template
cawthron
parents:
diff changeset
    66
               </documentation>
cawthron
parents:
diff changeset
    67
            </annotation>
cawthron
parents:
diff changeset
    68
         </attribute>
cawthron
parents:
diff changeset
    69
         <attribute name="displayName" type="string">
cawthron
parents:
diff changeset
    70
            <annotation>
cawthron
parents:
diff changeset
    71
               <documentation>
cawthron
parents:
diff changeset
    72
                  The display name (label) for the template.
cawthron
parents:
diff changeset
    73
cawthron
parents:
diff changeset
    74
This attribute is STRONGLY RECOMMENDED, but not required, in order to avoid API breakage.  If not specified, the template XML is loaded early and causes the wizard to delay at startup.
cawthron
parents:
diff changeset
    75
               </documentation>
cawthron
parents:
diff changeset
    76
            </annotation>
cawthron
parents:
diff changeset
    77
         </attribute>
cawthron
parents:
diff changeset
    78
         <attribute name="location" type="string" use="required">
cawthron
parents:
diff changeset
    79
            <annotation>
cawthron
parents:
diff changeset
    80
               <documentation>
cawthron
parents:
diff changeset
    81
                  The plugin-relative path to the template xml file
cawthron
parents:
diff changeset
    82
               </documentation>
cawthron
parents:
diff changeset
    83
            </annotation>
cawthron
parents:
diff changeset
    84
         </attribute>
cawthron
parents:
diff changeset
    85
         <attribute name="wizardId" type="string">
cawthron
parents:
diff changeset
    86
            <annotation>
cawthron
parents:
diff changeset
    87
               <documentation>
cawthron
parents:
diff changeset
    88
                  The id of the wizard in which this template is used
cawthron
parents:
diff changeset
    89
               </documentation>
cawthron
parents:
diff changeset
    90
            </annotation>
cawthron
parents:
diff changeset
    91
         </attribute>
cawthron
parents:
diff changeset
    92
         <attribute name="groupLabel" type="string" use="required">
cawthron
parents:
diff changeset
    93
            <annotation>
cawthron
parents:
diff changeset
    94
               <documentation>
cawthron
parents:
diff changeset
    95
                  The group label under which this template will appear in the template choice page of the appropriate template wizard
cawthron
parents:
diff changeset
    96
               </documentation>
cawthron
parents:
diff changeset
    97
            </annotation>
cawthron
parents:
diff changeset
    98
         </attribute>
cawthron
parents:
diff changeset
    99
         <attribute name="filterArguments" type="string">
cawthron
parents:
diff changeset
   100
            <annotation>
cawthron
parents:
diff changeset
   101
               <documentation>
cawthron
parents:
diff changeset
   102
                  The optional wizard-specific data available for the IFilter implementing a filter checkbox, optionally shown in some template wizards
cawthron
parents:
diff changeset
   103
               </documentation>
cawthron
parents:
diff changeset
   104
            </annotation>
cawthron
parents:
diff changeset
   105
         </attribute>
cawthron
parents:
diff changeset
   106
         <attribute name="image" type="string">
cawthron
parents:
diff changeset
   107
            <annotation>
cawthron
parents:
diff changeset
   108
               <documentation>
cawthron
parents:
diff changeset
   109
                  The optional plugin-relative location of a 16x16 pixel image file to use when showing this template in the choose template wizard page
cawthron
parents:
diff changeset
   110
               </documentation>
cawthron
parents:
diff changeset
   111
               <appinfo>
cawthron
parents:
diff changeset
   112
                  <meta.attribute kind="resource"/>
cawthron
parents:
diff changeset
   113
               </appinfo>
cawthron
parents:
diff changeset
   114
            </annotation>
cawthron
parents:
diff changeset
   115
         </attribute>
cawthron
parents:
diff changeset
   116
         <attribute name="extraPagesProvider" type="string">
cawthron
parents:
diff changeset
   117
            <annotation>
cawthron
parents:
diff changeset
   118
               <documentation>
cawthron
parents:
diff changeset
   119
                  An optional provider of extra wizard pages
cawthron
parents:
diff changeset
   120
               </documentation>
cawthron
parents:
diff changeset
   121
               <appinfo>
cawthron
parents:
diff changeset
   122
                  <meta.attribute kind="java" basedOn="com.nokia.carbide.internal.api.templatewizard.ui.IExtraPagesProvider"/>
cawthron
parents:
diff changeset
   123
               </appinfo>
cawthron
parents:
diff changeset
   124
            </annotation>
cawthron
parents:
diff changeset
   125
         </attribute>
cawthron
parents:
diff changeset
   126
      </complexType>
cawthron
parents:
diff changeset
   127
   </element>
cawthron
parents:
diff changeset
   128
cawthron
parents:
diff changeset
   129
   <element name="metadata">
cawthron
parents:
diff changeset
   130
      <annotation>
cawthron
parents:
diff changeset
   131
         <documentation>
cawthron
parents:
diff changeset
   132
            This element allows attaching metadata to templates for use by other wizards.
cawthron
parents:
diff changeset
   133
         </documentation>
cawthron
parents:
diff changeset
   134
      </annotation>
cawthron
parents:
diff changeset
   135
      <complexType>
cawthron
parents:
diff changeset
   136
         <attribute name="name" type="string" use="required">
cawthron
parents:
diff changeset
   137
            <annotation>
cawthron
parents:
diff changeset
   138
               <documentation>
cawthron
parents:
diff changeset
   139
                  Name of a metadata element
cawthron
parents:
diff changeset
   140
               </documentation>
cawthron
parents:
diff changeset
   141
            </annotation>
cawthron
parents:
diff changeset
   142
         </attribute>
cawthron
parents:
diff changeset
   143
         <attribute name="value" type="string">
cawthron
parents:
diff changeset
   144
            <annotation>
cawthron
parents:
diff changeset
   145
               <documentation>
cawthron
parents:
diff changeset
   146
                  Value of a metadata element.
cawthron
parents:
diff changeset
   147
               </documentation>
cawthron
parents:
diff changeset
   148
            </annotation>
cawthron
parents:
diff changeset
   149
         </attribute>
cawthron
parents:
diff changeset
   150
      </complexType>
cawthron
parents:
diff changeset
   151
   </element>
cawthron
parents:
diff changeset
   152
cawthron
parents:
diff changeset
   153
   <annotation>
cawthron
parents:
diff changeset
   154
      <appinfo>
cawthron
parents:
diff changeset
   155
         <meta.section type="since"/>
cawthron
parents:
diff changeset
   156
      </appinfo>
cawthron
parents:
diff changeset
   157
      <documentation>
cawthron
parents:
diff changeset
   158
         Carbide.c++ 1.2
cawthron
parents:
diff changeset
   159
      </documentation>
cawthron
parents:
diff changeset
   160
   </annotation>
cawthron
parents:
diff changeset
   161
cawthron
parents:
diff changeset
   162
   <annotation>
cawthron
parents:
diff changeset
   163
      <appinfo>
cawthron
parents:
diff changeset
   164
         <meta.section type="examples"/>
cawthron
parents:
diff changeset
   165
      </appinfo>
cawthron
parents:
diff changeset
   166
      <documentation>
cawthron
parents:
diff changeset
   167
         &lt;pre&gt;
cawthron
parents:
diff changeset
   168
&lt;extension point=&quot;com.nokia.carbide.templatewizard.wizardTemplate&quot;&gt;
cawthron
parents:
diff changeset
   169
  &lt;template
cawthron
parents:
diff changeset
   170
   templateId=&quot;com.nokia.cdt.templates.s60.controlapplication&quot;
cawthron
parents:
diff changeset
   171
   location=&quot;templates/projecttemplates/S60-ControlApplication/template.xml&quot;
cawthron
parents:
diff changeset
   172
   wizardId=&quot;com.nokia.carbide.cpp.project.ui.wizards.NewSymbianOSCppProjectWizard&quot; 
cawthron
parents:
diff changeset
   173
   groupLabel=&quot;S60&quot;
cawthron
parents:
diff changeset
   174
   filterArguments=&quot;S60:1.2;2.0-2.9&quot;
cawthron
parents:
diff changeset
   175
   image=&quot;icons/icon_S60.png&quot;
cawthron
parents:
diff changeset
   176
  /&gt;
cawthron
parents:
diff changeset
   177
&lt;/extension&gt;
cawthron
parents:
diff changeset
   178
&lt;/pre&gt;
cawthron
parents:
diff changeset
   179
      </documentation>
cawthron
parents:
diff changeset
   180
   </annotation>
cawthron
parents:
diff changeset
   181
cawthron
parents:
diff changeset
   182
   <annotation>
cawthron
parents:
diff changeset
   183
      <appinfo>
cawthron
parents:
diff changeset
   184
         <meta.section type="apiInfo"/>
cawthron
parents:
diff changeset
   185
      </appinfo>
cawthron
parents:
diff changeset
   186
      <documentation>
cawthron
parents:
diff changeset
   187
         No API implementation is required to provide a basic template. Templates requiring custom processing in code may implement &lt;code&gt;com.nokia.carbide.templatewizard.process.IProcess&lt;/code&gt;
cawthron
parents:
diff changeset
   188
      </documentation>
cawthron
parents:
diff changeset
   189
   </annotation>
cawthron
parents:
diff changeset
   190
cawthron
parents:
diff changeset
   191
   <annotation>
cawthron
parents:
diff changeset
   192
      <appinfo>
cawthron
parents:
diff changeset
   193
         <meta.section type="implementation"/>
cawthron
parents:
diff changeset
   194
      </appinfo>
cawthron
parents:
diff changeset
   195
      <documentation>
cawthron
parents:
diff changeset
   196
         This extension point registers an XML template. Implementation is not required.
cawthron
parents:
diff changeset
   197
      </documentation>
cawthron
parents:
diff changeset
   198
   </annotation>
cawthron
parents:
diff changeset
   199
cawthron
parents:
diff changeset
   200
   <annotation>
cawthron
parents:
diff changeset
   201
      <appinfo>
cawthron
parents:
diff changeset
   202
         <meta.section type="copyright"/>
cawthron
parents:
diff changeset
   203
      </appinfo>
cawthron
parents:
diff changeset
   204
      <documentation>
cawthron
parents:
diff changeset
   205
         (C) Copyright 2007 Nokia Corporation.
cawthron
parents:
diff changeset
   206
      </documentation>
cawthron
parents:
diff changeset
   207
   </annotation>
cawthron
parents:
diff changeset
   208
cawthron
parents:
diff changeset
   209
</schema>