Metadata Element (VSX Schema)

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Required. Contains metadata about the package, its identity, and advertising information.

Copy 
<Metadata>
  <Identity>... </Identity>
  <DisplayName>... </DisplayName>
  <Description>... </Description>
  <MoreInfo>... </MoreInfo>
  <License>... </License>
  <ReleaseNotes>... </ReleaseNotes>
  <Icon>... </Icon>
  <PreviewImage>... </PreviewImage>
  <Tags>... </Tags>
  <GettingStartedGuide>... </GettingStartedGuide>
</Metadata>

The following sections describe attributes, child elements, and parent elements.

Attributes

Attribute

Description

None

Child Elements

Element

Description

Description Element

Optional. Describes the extension that is displayed in Extension Manager. Takes a text value that is limited to 1,000 characters.

DisplayName Element

Required. The extension name that is displayed in the Extension Manager. Takes a text value that is limited to 100 characters.

GettingStartedGuide Element

Optional. The relative path of an .html file, or a URL of a website that contains information about how to use the extension or the content in the package. The guide is opened as part of an installation.

Icon Element

Optional. The relative path of an image file (.png, .bmp, .jpeg, .ico) in the package that is displayed in the list view in Extension Manager. The image must be 32x32 pixels. If no image is specified, a default image is used.

Identity Element

Required. Defines the unique identification information for the package.

License Element

Optional. The relative path of a license file (.txt, .rtf) in the package, or the URL of a website that contains the license.

MoreInfo Element

Optional. The URL of a website that contains a description of the extension.

PreviewImage Element

Optional. The relative path of an image file (.png, .bmp, .jpeg) in the package that is displayed in the details view in Extension Manager. The image must be 200x200 pixels. If no image is specified, a default image is used.

ReleaseNotes Element

Optional. The relative path of a release notes file (.txt, .rtf) in the package, or the URL of a website that displays the release notes.

Tags Element

Optional. Text tags that are used for search hints. Limited to 100 characters.

Parent Elements

Element

Description

PackageManifest Element

Required. Provides the root element for a manifest that describes a Visual Studio extension deployment package.

Any child elements not listed in this document are exposed to the VSIX Manifest API as extra XmlElement objects.

Namespace

http://schemas.microsoft.com/developer/vsx-schema/2011

Schema Name

VSIX Manifest

Validation File

PackageManifestSchema.xsd

Can be Empty

No
Show: