core/com.nokia.carbide.templatewizard/plugin.xml
changeset 0 fb279309251b
equal deleted inserted replaced
-1:000000000000 0:fb279309251b
       
     1 <?xml version="1.0" encoding="UTF-8"?>
       
     2 <?eclipse version="3.0"?>
       
     3 
       
     4 <!--
       
     5  <copyright>
       
     6  </copyright>
       
     7 
       
     8  $Id: plugin.xml,v 1.3 2009/02/17 20:23:17 tkelly Exp $
       
     9 -->
       
    10 
       
    11 <plugin>
       
    12    <extension-point id="wizardTemplate" name="WizardTemplate" schema="schema/wizardTemplate.exsd"/>
       
    13    <extension-point id="templateProcesses" name="Template Processes" schema="schema/templateProcesses.exsd"/>
       
    14 
       
    15   <extension point="org.eclipse.emf.ecore.generated_package">
       
    16     <package 
       
    17        uri = "platform:/resource/com.nokia.carbide.templatewizard/schema/template.xsd" 
       
    18        class = "com.nokia.carbide.internal.template.gen.Template.TemplatePackage"
       
    19        genModel = "schema/template.genmodel" /> 
       
    20   </extension>
       
    21 
       
    22   <extension point="org.eclipse.emf.ecore.extension_parser">
       
    23     <parser 
       
    24        type="template" 
       
    25        class="com.nokia.carbide.internal.template.gen.Template.util.TemplateResourceFactoryImpl" />
       
    26   </extension>
       
    27   <extension
       
    28         point="com.nokia.carbide.templatewizard.templateProcesses">
       
    29      <templateProcess
       
    30            class="com.nokia.carbide.templatewizard.processes.CopyFiles"
       
    31            id="com.nokia.carbide.templatewizard.CopyFiles">
       
    32         <description>
       
    33 Copies files from the template to the project, optionally template-expanding contents.
       
    34 Parameters:
       
    35 
       
    36 parameter project (required): name of the project to copy into
       
    37 * attribute projectName (required): project name
       
    38 
       
    39 parameter tree (sequence, 0+): a tree of files to copy
       
    40 * attribute sourcePath (required): template.xml-relative folder for source content
       
    41 * attribute targetPath (required): project-relative folder for target content (does NOT use basename of sourcePath)
       
    42 * attribute subsitute (optional, default true): whether this file is parameterized and needs to be variable-substituted from variables in the template&apos;s value map.  
       
    43 When substituting, unrecognized variables are left intact.
       
    44 Optionally, any of three operators can be used to automatically uppercase, lowercase and titlecase (uppercase only the first character) the value prior to substitution. The syntax for using the operators is $(id$upper), $(id$lower) or $(id$title).
       
    45 * attribute overwrite (optional, default false): if true, allows overwriting existing files without error.
       
    46         </description>
       
    47      </templateProcess>
       
    48      <templateProcess
       
    49            class="com.nokia.carbide.templatewizard.processes.CopyFileTree"
       
    50            id="com.nokia.carbide.templatewizard.CopyFileTree">
       
    51         <description>
       
    52 Copies a tree of files from one location to another, optionally template-expanding contents along the way. The leaf of
       
    53 source is NOT placed into the target, so repeat the leaf directory in
       
    54 targetPath if required.
       
    55 
       
    56 Syntax:
       
    57 
       
    58 parameter project (required): name of the project to copy into
       
    59 * attribute projectName (required): project name
       
    60 
       
    61 parameter tree (sequence, 0+): a tree of files to copy
       
    62 * attribute sourcePath (required): template.xml-relative folder for source content
       
    63 * attribute targetPath (required): project-relative folder for target content (does NOT use basename of sourcePath)
       
    64 * attribute subsitute (optional): whether this file is parameterized and needs to be variable-substituted from variables in the template&apos;s value map (defaults to false, unlike CopyFiles).  
       
    65 When substituting, unrecognized variables are left intact.
       
    66 Optionally, any of three operators can be used to automatically uppercase, lowercase and titlecase (uppercase only the first character) the value prior to substitution. The syntax for using the operators is $(id$upper), $(id$lower) or $(id$title).
       
    67 
       
    68 * attribute excludedFileOrDirectoryPattern (optional):  a regular expression used to filter out files or directories (leaf name only).  If not specified, CVS and .svn directories are the default filter.
       
    69 
       
    70 * attribute noSubstituteFileOrDirectoryPattern (optional): a regular expression used to exclude files or directories from variable substitution (leaf name only).  If a directory matches, all its files and subdirectories are excluded from substitution.  If not specified, all files are substituted if &apos;substitute=true&apos;.
       
    71         </description>
       
    72      </templateProcess>
       
    73      
       
    74 	<templateProcess
       
    75            class="com.nokia.carbide.templatewizard.processes.CreateFolders"
       
    76            id="com.nokia.carbide.templatewizard.CreateFolders">
       
    77         <description>
       
    78 Creates folders in the project.
       
    79 
       
    80 Syntax:
       
    81 
       
    82 parameter project (required): name of the project to copy into
       
    83 * attribute projectName (required): project name
       
    84 
       
    85 parameter folder (sequence, 0+): folder to create
       
    86 * attribute path (required): project-relative folder to create.  This can create multiple levels of folders in one shot (e.g. src/my/folder).
       
    87         </description>
       
    88      </templateProcess>    
       
    89       
       
    90 	<templateProcess
       
    91            class="com.nokia.carbide.templatewizard.processes.CreateTemplateVariable"
       
    92            id="com.nokia.carbide.templatewizard.DefineTemplateVariable">
       
    93         <description>
       
    94 Defines template variables for use by other processes.  This augments the template's variable map for use by other processes
       
    95 (such as template substitution by CopyFiles).
       
    96 
       
    97 Syntax:
       
    98 
       
    99 parameter variable (sequence, 0+): a variable to define
       
   100 * attribute variableName (required): variable name
       
   101 * attribute value (required): variable value
       
   102         </description>
       
   103      </templateProcess>     
       
   104      
       
   105 	<templateProcess
       
   106            class="com.nokia.carbide.templatewizard.processes.OpenFileInEditor"
       
   107            id="com.nokia.carbide.templatewizard.OpenFileInEditor">
       
   108         <description>
       
   109 Opens the specified file in an editor.
       
   110  
       
   111 Syntax:
       
   112 
       
   113 parameter project (required): the project and file information
       
   114 * attribute projectName (required): project in which to find the file
       
   115 * attribute fileName (required): path in project to the file to open
       
   116 * attribute editorId (optional): the specific Eclipse editor used to open the file; if the id is not specified or
       
   117 the editor is not registered, a default editor is used
       
   118         </description>
       
   119      </templateProcess>     
       
   120   </extension>
       
   121 
       
   122 </plugin>
       
   123