IDL Plugin Properties Page
The IDL Plugin Properties page allows you to specify the project properties that are used when converting a project to an IDL Workbench plug-in. This page is almost identical to the IDL Plug-in Wizard dialog, and in fact the two are closely associated. If you specify a project's plug-in properties on this page, the IDL Plugin Wizard will use those property values. Conversely, if you specify a project's plug-in properties on the wizard, the values are saved when the wizard is executed, and will be displayed on the IDL Plugin Properties page.
To display the IDL Plugin Properties page, expand the IDL Project Properties list item on the Project Properties dialog and select IDL Plugin Properties.
|
Property
|
Description
|
Default
|
|
ID
|
The ID value is used as the feature ID and the plug-in Bundle-SymbolicName keyword listed in the manifest.mf file.
The ID value is restricted to period-separated segments. Each segment must contain at least one valid character. Valid characters include upper and lower case alphabetical characters (A-Z and a-z), numerical digits (0-9), and the underscore ("_") character.
|
The project name converted to lowercase, with spaces replaced by periods.
|
|
Name
|
The Name value is used as both the feature name as well as the plug-in Bundle-Name keyword listed in the manifest.mf file.
|
The project name.
|
|
Version
|
The Version value is used as the feature version and the plug-in Bundle-Version keyword listed in the manifest.mf file.
The plug-in version value consists of one to four period-separated segments.
The first three segments must consist of non-negative integers. The fourth segment may contain upper and lower case alphabetical characters (A-Z and a-z), numeric digits (0-9), the underscore ("_") character, and the dash ("-") character.
Note that the number of digits used is important. If a segment will ever contain more than one digit, it should start with more than one. If any segment will ever have a value higher than 9, begin with at least two digits: e.g. 1.0.01
|
"1.0.0"
|
|
Provider
|
The author of the plug-in and feature.
|
None
|
|
Site Name
|
The name of the Update Site on which the plug-in will be hosted.
|
None
|
|
Site URL
|
The URL of the Update Site on which the plug-in will be hosted. IDL does not check the validity of this address.
|
None
|
|
Description
|
This is the feature description.
You must enter a non-null string (that is, this field may not be left empty). You can enter a maximum of 2048 characters.
If you import text into this field using the Import Text File button, only the first 2048 characters of the file will be imported.
If you need to reference a larger body of text, use this field to refer the user to more complete documentation, such as a web site or a file included in the plug-in.
|
"[Enter Feature Description. You may wish to include instructions on running the programs contained in your plug-in here.]"
|
|
Copyright
|
This is the plug-in copyright description.
You must enter a non-null string (that is, this field may not be left empty). You can enter a maximum of 2048 characters.
If you import text into this field using the Import Text File button, only the first 2048 characters of the file will be imported.
If you need to reference a larger body of text, use this field to refer the user to more complete documentation, such as a web site or a file included in the plug-in.
|
"[Enter Copyright Description here.]"
|
|
License Agreement
|
This is the plug-in license description.
You must enter a non-null string (that is, this field may not be left empty). You can enter a maximum of 2048 characters.
If you import text into this field using the Import Text File button, only the first 2048 characters of the file will be imported.
If you need to reference a larger body of text, use this field to refer the user to more complete documentation, such as a web site or a file included in the plug-in.
|
"[Enter License Description here.]"
|
Importing a Text File into the Description, Copyright, and License Agreement Fields
The Import Text File button allows you to import text into the Description, Copyright, or License Agreement fields directly from a file.
Note
Only the first 2048 characters of a file are imported. If you need to reference a larger body of text, use the field to refer the user to more complete documentation.
To import file text into one of these fields, click one of the tabs and click the Import Text File button. You can select a file from the browse dialog.
When you select a file, it is read as a text file and the text is placed in the current tab field. If a non-text file is selected, the text in the current tab is deleted.
