Udostępnij za pośrednictwem

New-ExternalHelpCab

  • Odwołanie
Moduł:
platyPS

.cab Generuje plik.

Składnia

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

Opis

Polecenie New-ExternalHelpCab cmdlet generuje .cab plik zawierający całą niecykliczną zawartość w folderze. To polecenie cmdlet kompresuje podane pliki.

Uwaga

To polecenie cmdlet zależy od natywnego MakeCab.exe polecenia, które jest dostępne tylko w systemie Windows. To polecenie cmdlet zgłasza błąd, jeśli jest używany na maszynach innych niż Windows.

Zalecamy podanie jako zawartości tylko about_ tematów i danych wyjściowych polecenia cmdlet New-ExternalHelp do tego polecenia cmdlet.

To polecenie cmdlet używa metadanych przechowywanych w pliku markdown modułu w celu nadania nazwy .cab pliku. To nazewnictwo jest zgodne ze wzorcem wymaganym przez system pomocy programu PowerShell do użycia jako pomoc z możliwością aktualizacji. Te metadane są częścią pliku modułu utworzonego przy użyciu polecenia cmdlet New-MarkdownHelp z parametrem WithModulePage .

To polecenie cmdlet generuje również istniejący plik lub aktualizuje go helpinfo.xml . Ten plik zawiera szczegółowe informacje dotyczące wersji i ustawień regionalnych w systemie pomocy programu PowerShell.

Przykłady

Przykład 1. Tworzenie pliku CAB

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

Polecenie cmdlet tworzy .cab plik zawierający pliki folderów zawartości. Plik .cab ma nazwę updatable help na podstawie metadanych. Polecenie umieszcza .cab plik w folderze wyjściowym.

Parametry

-CabFilesFolder

Określa folder zawierający zawartość pomocy, którą ten polecenie cmdlet pakuje do .cab pliku.

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

-IncrementHelpVersion

Automatycznie zwiększa wersję pomocy w pliku Markdown modułu.

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

-LandingPagePath

Określa pełną ścieżkę pliku Markdown modułu, który zawiera wszystkie metadane wymagane do nadania .cab nazwy pliku. W przypadku wymaganych metadanych uruchom polecenie New-MarkdownHelp z parametrem WithLandingPage .

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

-OutputFolder

Określa lokalizację pliku i helpinfo.xml pliku tworzonego .cab przez to polecenie cmdlet.

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

Dane wejściowe

None

Nie można potokować wartości do tego polecenia cmdlet.

Dane wyjściowe

None

To polecenie cmdlet nie generuje danych wyjściowych. Polecenie cmdlet zapisuje wyniki w folderze wyjściowym, który określa parametr OutputPath .