Aktualisierbare Hilfeübersicht

Dieses Dokument enthält eine grundlegende Einführung in das Design und den Betrieb des PowerShell-Hilfefeatures. Sie wurde für Modulautoren und andere Personen entwickelt, die Windows PowerShell-Hilfethemen für Benutzer bereitstellen.

Einleitung

PowerShell-Hilfethemen sind ein integraler Bestandteil der PowerShell-Erfahrung. Wie PowerShell-Module werden Hilfethemen kontinuierlich von den Autoren und von den Beiträgen der Community von PowerShell-Benutzern aktualisiert und verbessert.

Das in Windows PowerShell 3.0 eingeführte feature Aktualisierbare Hilfe stellt sicher, dass Benutzer über die neuesten Versionen von Hilfethemen an der Eingabeaufforderung verfügen, auch für integrierte PowerShell-Befehle, ohne neue Module herunterzuladen oder Windows Update auszuführen. Die aktualisierbare Hilfe vereinfacht die Aktualisierung, indem Cmdlets bereitgestellt werden, die die neuesten Versionen von Hilfethemen aus dem Internet herunterladen und in den richtigen Unterverzeichnissen auf dem lokalen Computer des Benutzers installieren. Sogar Benutzer, die hinter Firewalls stehen, können die neuen Cmdlets verwenden, um aktualisierte Hilfe von einer internen Dateifreigabe zu erhalten.

Die aktualisierbare Hilfe wird von allen Windows PowerShell-Modulen in Windows 8 und Windows Server 2012 vollständig unterstützt, und die Features sind für alle Autoren von Windows PowerShell-Modulen verfügbar. Aktualisierbare Hilfe unterstützt nur XML-basierte Hilfedateien. Es unterstützt keine kommentarbasierte Hilfe.

Die aktualisierbare Hilfe umfasst die folgenden Features.

• Das Cmdlet Update-Help, das bestimmt, ob Benutzer über die neuesten Hilfedateien für ein Modul verfügen und falls nicht, die neuesten Hilfedateien aus dem Internet herunterlädt, sie entpackt und in den richtigen Modulunterverzeichnissen auf dem Computer des Benutzers installiert. Benutzer können das Cmdlet Get-Help verwenden, um die neu installierten Hilfethemen sofort anzuzeigen. Sie müssen PowerShell nicht neu starten.

• Das Cmdlet Save-Help, das die neuesten Hilfedateien aus dem Internet herunterlädt und sie in einem Dateisystemverzeichnis speichert. Benutzer können das Cmdlet Update-Help verwenden, um Hilfedateien aus dem Dateisystemverzeichnis abzurufen und sie in den Modulunterverzeichnissen auf dem Computer des Benutzers zu entpacken und zu installieren. Das Cmdlet Save-Help wurde für Benutzer entwickelt, die eingeschränkten oder keinen Internetzugang haben, und für Unternehmen, die den Internetzugriff lieber einschränken möchten.

• Hilfe für ein Modul-. Hilfedateien für ein Modul werden verwaltet und als Einheit bereitgestellt, sodass Benutzer alle Hilfedateien für die verwendeten Module abrufen können. Aktualisierbare Hilfe wird nur für Module unterstützt, nicht für Windows PowerShell-Snap-Ins.

• Version unterstützt. Die aktualisierbare Hilfe verwendet standardmäßige vier Positionen (N1. N2. N3. N4) Versionsnummern. Die aktualisierbare Hilfe lädt Hilfedateien herunter, wenn die Versionsnummer der Hilfedateien auf dem Computer des Benutzers (oder im Verzeichnis Save-Help) niedriger als die Versionsnummer der Hilfedateien am Internetspeicherort ist.

• Multisprachenunterstützung. Aktualisierbare Hilfe unterstützt Modulhilfedateien in mehreren Benutzeroberflächenkulturen. Aktualisierbare Hilfedateinamen umfassen Standardsprachencodes wie "en-US" und "ja-JP", und die Update-Help und Save-Help Cmdlets setzen die Hilfedateien in sprachspezifische Unterverzeichnisse des Modulverzeichnisses.

• automatisch generierte Hilfe. Das cmdlet Get-Help zeigt grundlegende Hilfe für Befehle an, die keine Hilfedateien enthalten. Die automatisch generierte Hilfe enthält die Befehlssyntax und Aliase sowie Anweisungen zur Verwendung der Onlinehilfe und der aktualisierbaren Hilfe.

• Enhanced Online help. Einfacher Zugriff auf Onlinehilfe erfordert keine Hilfedateien mehr. Der parameter Online- des Cmdlets Get-Help ruft jetzt die URL eines Onlinehilfethemas aus dem Wert der HelpUri- eigenschaft eines beliebigen Befehls ab, wenn die Url der Onlinehilfe in einer Hilfedatei nicht gefunden werden kann. Sie können die HelpUri-Eigenschaft auffüllen, indem Sie dem Code von Cmdlets, Funktionen und CIM-Befehlen ein HelpUri- Attribut hinzufügen oder das .LINK kommentarbasierte Hilfeschlüsselwort in Workflows und Skripts verwenden.

  Um unsere Hilfedateien aktualisierbar zu machen, enthalten die Windows PowerShell-Module in Windows keine Hilfedateien. Benutzer können die aktualisierbare Hilfe verwenden, um Hilfedateien zu installieren und zu aktualisieren. Autoren anderer Module können Hilfedateien in Modulen enthalten oder auslassen. Die Unterstützung für aktualisierbare Hilfe ist optional, wird jedoch empfohlen.