Using the Vsix Manifest Editor

  1. 1.

    The Vsix editor gets information about the extension and saves it in a file called extension.xdkmanifest. If you want to change the Vsix information, open the vsix editor by double-clicking the extension.xdkmanifest file, and change the information.



  2. 2.

    The more info dialog gets additional information about the kit, category and technolgy of the project.To open this dialog click More... button in the vsix manifest editor



Required Fields

Table 1. Required Fields
Option Description

Id

The unique identifier of the VSIX. This is used by the Extension Manager to manage the identity of each extension. In particular, when a new version of an extension is deployed, this allows the Extension Manager/Installer to ensure that the old version is replaced. (Maximum length is 100 characters)

Product Name

The name of the product. This is the header for the Extension Manager entry for the VSIX.

Org

Specifies the name of the Organization. This will be listed as the parent node in the new Example project dialog.

Short Name

Specify a short Name for the extension.

Author

The author of the VSIX. (Maximum length is 50 characters). This extension will be listed in the New Example Project window in the format of Author-ShortName under the node Organization.

Version

Specifies the version number of VSIX. Changing this value allows the Extension Manager to know if the VSIX has been updated. The Extension Manager will not permit installing a VSIX if there is already a VSIX with the same ID and same or older version. (Maximum length is 23 characters)

Description

The description of the VSIX. This is shown in the Extension Manager entry for the VSIX under the product name. (Maximum length is 1024 characters)

Optional Fields

Table 2. Optional Fields
Option Description

Getting Started Guide

An HTTP\HTTPS URL to a getting started guide for your extension(s). If specified, a Getting Started link will be provided in the Extension Manager under the detailed view of the extension which will navigate to this website.

More Info URL

An HTTP\HTTPS URL to a website containing more info for your VSIX. If specified, a More Information link will be provided in the Extension Manager under the detailed view of the extension which will navigate to this website.

Icon

This specifies which image will be displayed beside the product name for the VSIX in the Extension Manager's list of extensions.

Preview Image

This specifies which image will be displayed in the details for the VSIX in the Extension Manager's list of extensions.

License Terms

Specifies the licensing terms for the extension. This will be shown when a user attempts to install the extensions.

All Users

Specify whether to install the extension for All Users or the current user

Kit

Specify the kit in which the example project can run. This is used to classify and list the project under the specified kit in the new example project dialog. You can specify multiple kits separated by commas.

Category

Specify the category in which the example project belongs. The project will be classified and listed under the specified category in the new example project dialog. You can specify multiple categories like driver, Application etc, separated by commas.

Technology

Specify the technology for the example project. The project will be classified and listed under the specified technology in the new example project dialog. You can specify multiple technologies separated by commas.