Aktualisierbare Hilfeerstellung: Ausführliche Anleitung

In diesem Dokument werden die Schritte zum Erstellen der updatable-Hilfe aufgeführt.

Erstellen von updatable Help: Step-by-Step

Die updatable-Hilfe ist für Endbenutzer konzipiert, bietet aber auch erhebliche Vorteile für Modulautoren und Schreiber, einschließlich der Möglichkeit, Inhalte hinzuzufügen, Fehler zu beheben, in mehreren Benutzeroberflächenkulturen zu liefern und auf Benutzerkommentare und -anforderungen zu reagieren, solange das Modul ausgeliefert wurde. In diesem Thema wird erläutert, wie Sie Hilfedateien packen und hochladen, damit Benutzer sie mithilfe der Cmdlets Update-Help und Save-Help herunterladen und installieren können.

Die folgenden Schritte bieten eine Übersicht über den Prozess der Unterstützung von updatable Help.

Schritt 1: Suchen einer Internetwebsite für Ihre Hilfedateien

Der erste Schritt beim Erstellen einer updatable-Hilfe besteht in der Suche nach einem Internetspeicherort für die Hilfedateien Ihres Moduls. Tatsächlich können Sie zwei verschiedene Speicherorte verwenden. Sie können die Hilfeinformationsdatei Ihres Moduls (HelpInfo XML – wie unten beschrieben) an einem Internetspeicherort und die HILFEinhalt-CAB-Dateien an einem anderen Internetspeicherort speichern. Alle CAB-Hilfeinhaltsdateien für ein Modul müssen sich am gleichen Speicherort befinden. Sie können Hilfeinhalts-CAB-Dateien für verschiedene Module am gleichen Speicherort platzieren.

Schritt 2: Hinzufügen eines HelpInfoURI-Schlüssels zum Modulmanifest

Fügen Sie Ihrem Modulmanifest einen HelpInfoURI-Schlüssel hinzu. Der Wert des Schlüssels ist der Uniform Resource Identifier (URI) des Speicherorts der HelpInfo-XML-Informationsdatei für Ihr Modul. Aus Sicherheitsgründen muss die Adresse mit "http" oder "https" beginnen. Der URI sollte einen Internetspeicherort angeben, darf jedoch nicht den HelpInfo-XML-Dateinamen enthalten.

Beispiel:

@{
RootModule = TestModule.psm1
ModuleVersion = '2.0'
HelpInfoURI = 'https://go.microsoft.com/fwlink/?LinkID=0123'
}

Schritt 3: Erstellen einer HelpInfo-XML-Datei

Die HelpInfo-XML-Informationsdatei enthält den URI des Internetspeicherorts Ihrer Hilfedateien und die Versionsnummern der neuesten Hilfedateien für Ihr Modul in jeder unterstützten Benutzeroberflächenkultur. Jedes Windows PowerShell verfügt über eine HelpInfo-XML-Datei. Wenn Sie Ihre Hilfedateien aktualisieren, bearbeiten oder ersetzen Sie die HelpInfo-XML-Datei. Sie fügen keine weitere hinzu. Weitere Informationen finden Sie unter Erstellen einer HelpInfo-XML-Datei.

Schritt 4: Erstellen von CAB-Dateien

Verwenden Sie ein Tool, das Cab-Dateien () erstellt, z. B. , um eine CAB-Datei zu erstellen, die .cab MakeCab.exe die Hilfedateien für Ihr Modul enthält. Erstellen Sie eine separate CAB-Datei für die Hilfedateien in jeder unterstützten Benutzeroberflächenkultur. Weitere Informationen finden Sie unter Vorbereiten von updatable Help CAB Files.

Schritt 5: Hochladen Dateien

Um neue oder aktualisierte Hilfedateien zu veröffentlichen, laden Sie die CAB-Dateien an den Internetspeicherort hoch, der durch das HelpContentUri-Element in der HelpInfo-XML-Datei angegeben wird. Laden Sie dann die HelpInfo-XML-Datei an den Internetspeicherort hoch, der durch den Wert des HelpInfoUri-Schlüssels im Modulmanifest angegeben wird.