Gewusst wie: Packen von Komponenten für die Verwendung des Visual Studio-Inhaltsinstallers

Artikel
08/10/2011

Der Visual Studio-Inhaltsinstaller bietet eine Möglichkeit zum Bereitstellen von Makros, Add-Ins und Codeausschnitten, um Visual Studio zu erweitern. Weitere Informationen zu anderen Bereitstellungsstrategien finden Sie unter Visual Studio Extension Deployment.

Um eine Erweiterung mit dem Visual Studio-Inhaltsinstaller installierbar zu machen, verpacken Sie die Erweiterung in einer VSI-Datei, die in der Regel als Communitykomponente bezeichnet wird. Der Visual Studio-Inhaltsinstaller kopiert die in den Communitykomponenten enthaltenen Elemente automatisch in die richtigen Verzeichnisse auf dem Computer eines Entwicklers, sodass diese Elemente in Visual Studio in den entsprechenden Dialogfeldern angezeigt werden.

Um den Visual Studio-Inhaltsinstaller zur Installation von Communitykomponenten zu verwenden, müssen Sie eine VSCONTENT-Datei für die Komponente erstellen. Nach der Erstellung der VSCONTENT-Datei komprimieren Sie die Komponentendateien und die VSCONTENT-Datei in eine ZIP-Datei und ändern die Dateinamenerweiterung von .zip in .vsi. Die VSI-Datei können Sie nun mit einer Methode Ihrer Wahl an andere Entwickler weitergeben, z. B. zum Herunterladen im Web bereitstellen, als E-Mail-Anhang senden oder in einer Netzwerkfreigabe speichern.

VSCONTENT-Dateien

VSCONTENT-Dateien verwenden auf dem Schemareferenz für den Visual Studio-Inhaltsinstaller basierenden XML-Code zur Beschreibung der Komponenten, die Sie erstellt und zur gemeinsamen Verwendung vorgesehen haben. Die VSCONTENT-Datei gibt mindestens die Art der Komponenten und die Version von Visual Studio an, mit der die Komponenten verwendet werden können. Nachdem Sie eine VSCONTENT-Datei erstellt haben, können Sie die VSI-Datei erstellen, die der Visual Studio-Inhaltsinstaller verwendet, um die Komponenten auf dem Computer eines Entwicklers zu installieren.

So erstellen Sie eine grundlegende VSCONTENT-Datei

Zeigen Sie im Menü Datei auf Neu, und klicken Sie auf Datei.
Wählen Sie in der Kategorie Allgemein die Option XML-Datei aus, und klicken Sie dann auf Öffnen.
Erstellen Sie eine gültige VSCONTENT-Datei auf der Grundlage der Schemareferenz für den Visual Studio-Inhaltsinstaller.

Tipp

XML-Beispielcode für VSCONTENT-Dateien finden Sie in den Beispielabschnitten dieses Themas.
Speichern Sie die VSCONTENT-Datei im selben Verzeichnis wie die anderen Dateien, die sich auf die Communitykomponente beziehen.

VSI-Dateien

VSI-Dateien (Dateien des Visual Studio-Inhaltsinstallers) werden verwendet, um Visual Studio-Inhalt innerhalb der Entwicklercommunity auszutauschen. Eine VSI-Datei ist eine umbenannte ZIP-Datei, die die folgenden Komponenten enthält:

Eine XML-Datei mit der Erweiterung .vscontent zur Beschreibung der Communitykomponente.
Die Dateien für die Komponente.

Der Visual Studio-Inhaltsinstaller verwendet VSI-Dateien, um gemeinsam genutzten Inhalt im richtigen Verzeichnis zu installieren. Weitere Informationen zum Installieren von VSI-Dateien finden Sie unter Gewusst wie: Suchen und Installieren von Communitykomponenten.

Einige Features des Visual Studio-Inhaltsinstallers erfordern die Implementierung zusätzlicher Tools oder Dienste.

Wenn im Visual Studio-Inhaltsinstaller Herausgeberinformationen über Ihre Communitykomponente angezeigt werden sollen, müssen Sie die VSI-Datei signieren. Weitere Informationen hierzu finden Sie unter Kryptografische Dienste.
Um einen Endbenutzer-Lizenzvertrag (EULA) im Visual Studio-Inhaltsinstaller anzuzeigen, müssen Sie diese Informationen in die ZIP-Datei einbetten. WinZip unterstützt die Einbeziehung eingebetteter Informationen über das Kommentarfeature. Weitere Informationen über WinZip finden Sie unter http://www.winzip.com. Weitere Informationen über das Kommentarfeature finden Sie in der WinZip-Hilfedatei.

So erstellen Sie eine einfache VSI-Datei

Erstellen Sie eine gültige VSCONTENT-Datei für die Komponente, falls dies noch nicht geschehen ist. Weitere Informationen finden Sie im Abschnitt über VSCONTENT-Dateien oben in diesem Thema.
Wählen Sie in Windows Explorer die Dateien aus, die für die Komponente erforderlich sind, einschließlich der VSCONTENT-Datei.
Klicken Sie mit der rechten Maustaste auf die ausgewählten Dateien, zeigen Sie auf Senden an, und klicken Sie auf ZIP-komprimierter Ordner.

Die ausgewählten Dateien werden in einer einzelnen ZIP-Datei komprimiert.
Ändern Sie die Erweiterung der ZIP-Datei in .vsi.

Beispiel

Im folgenden Beispiel wird eine VSCONTENT-Datei für eine VSI-Datei veranschaulicht, die ein Add-In enthält. Das <ContentVersion>-Element wird auf 2.0 festgelegt. Das bedeutet, dass das Add-In nur mit den Visual Studio-Versionen 9.0 und 10.0 kompatibel ist.

Die folgenden Dateien werden in die VSI-Datei für diesen Inhalt aufgenommen:

Eine VSCONTENT-Datei, die den in diesem Beispiel gezeigten XML-Code enthält.
Die Registrierungsdatei für das Add-In, MyAddin.Addin.
Die kompilierte DLL-Datei für das Add-In, MyAddin.dll.

Die Add-In-Dateien sind im folgenden Verzeichnis installiert:

n:\... \Eigene Dokumente\Visual-Studio <Version>\Addins\

Weitere Beispiele finden Sie unter Gewusst wie: Veröffentlichen von Projektvorlagen und unter Gewusst wie: Veröffentlichen von Codeausschnitten.

<VSContent xmlns="https://schemas.microsoft.com/developer/vscontent/2005"> 
    <Content>
        <FileName>MyAddin.Addin</FileName>
        <FileName>MyAddin.dll</FileName>
        <DisplayName>Example Add-in</DisplayName>
        <Description>An add-in created for this example.</Description>
        <FileContentType>Addin</FileContentType>
        <ContentVersion>2.0</ContentVersion>
    </Content>
</VSContent>

Im folgenden Beispiel wird eine VSCONTENT-Datei für eine VSI-Datei veranschaulicht. Diese enthält ein Makroprojekt, das mit den Visual Studio-Versionen 8.0, 9.0 und 10.0 verwendet werden kann. Die folgenden Dateien werden in die VSI-Datei für diesen Inhalt aufgenommen:

Eine VSCONTENT-Datei, die den in diesem Beispiel gezeigten XML-Code enthält.
Die Makrodatei MyMacroProject.vsmacros.

Die Makrodatei ist im folgenden Verzeichnis installiert:

n:\... \Eigene Dokumente\Visual-Studio <Version>\Projects\VSMacros80\

<VSContent xmlns="https://schemas.microsoft.com/developer/vscontent/2005">
    <Content>
        <FileName>MyMacroProject.vsmacros</FileName>
        <DisplayName>My Macro Project</DisplayName>
        <Description> A macro project created for this example.</Description>
        <FileContentType>Macro Project</FileContentType>
        <ContentVersion>1.0</ContentVersion>
    </Content>
</VSContent>