Configuration Keys
Prev Chapter 1. Writing Wizards Next

Configuration Keys

The template.properties file is a standard Java property file (key = value syntax) that can be used to supply a template name, a template description, and other information.

Recognized property file keys:

templateName
The template’s display name. This is the name that appears in the tree in the template selection page. This property defaults to the name of the folder that holds the wizard files.
templateDescription
Description of the template. This may appear as a tooltip or in a description page in the wizard.
templateCategory
Template category is used for organizing the templates into a tree in the wizard’s template selection page. Defaults to the name of the project that provides the template.
templateImage
Name of the icon that appears with the name in the wizard’s template selection page.
supportedWizardTypes
Comma-separated or JSON-syntax list of wizard types (e.g. nedfile, simplemodule, project, inifile) that this template supports. If not specified, the wizard will support all known wizard types.
ignoreResources
Comma-separated or JSON-syntax list of non-template files or folders designating those files that will not get copied over to the new project. The template.properties file and custom wizard page files automatically count as non-templates, so they do not have to be listed. Wildcards (*, **, ?) are accepted. Note that *.foo is interpreted as ./*.foo; write **/*.foo to mean foo files anywhere.
verbatimFiles
Comma-separated or JSON-syntax list of files that need to be copied over into the target project verbatim, even if they have the .ftl extension. Wildcards (*, **, ?) are accepted. Note that *.foo is interpreted as ./*.foo; write **/*.foo to mean foo files anywhere.

The New OMNeT++ Project wizard also recognizes the following options (these options can be overridden from custom wizard pages):

addProjectReference
True or false; defaults to true. If true, the template’s project will be added to the referenced project’s list of the new project.
sourceFolders
Comma-separated or JSON-syntax list of C⁠+⁠+ source folders to be created and configured. By default, none.
nedSourceFolders
Comma-separated or JSON-syntax list of NED source folders to be created and configured. By default, none.
makemakeOptions
Comma-separated list of items in the syntax "folder:options", or a JSON-syntax map of strings; it sets opp_makemake options for the given folders. There is no default.

There are additional options for adding custom pages into the wizard, as described in the next section.

Prev Up Next
Wizard Types Home Templates