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