Freigeben über

New-ExternalHelpCab

  • Referenz
Modul:
platyPS

Generiert eine .cab Datei.

Syntax

New-ExternalHelpCab
   -CabFilesFolder <String>
   -LandingPagePath <String>
   -OutputFolder <String>
   [-IncrementHelpVersion]
   [<CommonParameters>]

Beschreibung

Das New-ExternalHelpCab Cmdlet generiert eine .cab Datei, die alle nicht rekursiven Inhalte in einem Ordner enthält. Dieses Cmdlet komprimiert die bereitgestellten Dateien.

Hinweis

Dieses Cmdlet hängt vom nativen Befehl ab, der MakeCab.exe nur unter Windows verfügbar ist. Dieses Cmdlet löst einen Fehler aus, wenn es auf Nicht-Windows-Computern verwendet wird.

Es wird empfohlen, als Inhalt nur about_ Themen und die Ausgabe des Cmdlets New-ExternalHelp für dieses Cmdlet bereitzustellen.

Dieses Cmdlet verwendet Metadaten, die in der Markdowndatei des Moduls gespeichert sind, um Ihre .cab Datei zu benennen. Diese Benennung entspricht dem Muster, das das PowerShell-Hilfesystem zur Verwendung als aktualisierbare Hilfe benötigt. Diese Metadaten sind Teil der Moduldatei, die mit dem Cmdlet New-MarkdownHelp mit dem Parameter WithModulePage erstellt wurde.

Dieses Cmdlet generiert oder aktualisiert auch eine vorhandene helpinfo.xml Datei. Diese Datei enthält Versionsverwaltungs- und Gebietsschemadetails für das PowerShell-Hilfesystem.

Beispiele

Beispiel 1: Erstellen einer CAB-Datei

$params = @{
    CabFilesFolder  = 'C:\Module\ExternalHelpContent'
    LandingPagePath = 'C:\Module\ModuleName.md'
    OutputPath      = 'C:\Module\Cab\'
}
New-ExternalHelpCab @params

Das Cmdlet erstellt eine .cab Datei, die die Inhaltsordnerdateien enthält. Die .cab Datei ist nach aktualisierbarer Hilfe basierend auf Metadaten benannt. Der Befehl platziert die .cab Datei im Ausgabeordner.

Parameter

-CabFilesFolder

Gibt den Ordner an, der den Hilfeinhalt enthält, den dieses Cmdlet in eine Datei packt .cab .

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-IncrementHelpVersion

Erhöhen Sie automatisch die Hilfeversion in der Markdowndatei des Moduls.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-LandingPagePath

Gibt den vollständigen Pfad der Modulmarkdowndatei an, die alle Metadaten enthält, die zum Benennen der .cab Datei erforderlich sind. Führen Sie für die erforderlichen Metadaten mit dem Parameter WithLandingPage ausNew-MarkdownHelp.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-OutputFolder

Gibt den Speicherort der Datei und helpinfo.xml Datei .cab an, die dieses Cmdlet erstellt.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Eingaben

None

Sie können keine Werte an dieses Cmdlet übergeben.

Ausgaben

None

Dieses Cmdlet generiert keine Ausgabe. Das Cmdlet speichert seine Ergebnisse im Ausgabeordner, den der OutputPath-Parameter angibt.