Sdílet prostřednictvím

New-ExternalHelpCab

  • Reference
Modul:
platyPS

Vygeneruje .cab soubor.

Syntax

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

Description

Rutina New-ExternalHelpCab vygeneruje .cab soubor, který obsahuje veškerý nerekurzivní obsah ve složce. Tato rutina komprimuje poskytnuté soubory.

Poznámka

Tato rutina závisí na nativním MakeCab.exe příkazu, který je k dispozici pouze ve Windows. Tato rutina vyvolá chybu, pokud se použije na počítačích s windows.

Doporučujeme, abyste jako obsah zadali pouze about_ témata a výstup z rutiny New-ExternalHelp pro tuto rutinu.

Tato rutina používá k pojmenování vašeho .cab souboru metadata uložená v souboru markdown modulu. Toto pojmenování odpovídá vzoru, který systém nápovědy PowerShellu vyžaduje pro použití jako aktualizovatelnou nápovědu. Tato metadata jsou součástí souboru modulu vytvořeného pomocí rutiny New-MarkdownHelp s parametrem WithModulePage .

Tato rutina také vygeneruje nebo aktualizuje existující helpinfo.xml soubor. Tento soubor poskytuje podrobnosti o správě verzí a národním prostředí systému nápovědy PowerShellu.

Příklady

Příklad 1: Vytvoření souboru CAB

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

Rutina vytvoří .cab soubor, který obsahuje soubory složky obsahu. Soubor .cab má název pro aktualizovatelnou nápovědu na základě metadat. Příkaz umístí soubor do .cab výstupní složky.

Parametry

-CabFilesFolder

Určuje složku obsahující obsah nápovědy, který tato rutina .cab zabalí do souboru.

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

-IncrementHelpVersion

Automaticky zvýší verzi nápovědy v souboru Markdown modulu.

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

-LandingPagePath

Určuje úplnou cestu k souboru Markdown modulu, který obsahuje všechna metadata potřebná k pojmenování .cab souboru. Pro požadovaná metadata spusťte New-MarkdownHelp příkaz s parametrem WithLandingPage .

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

-OutputFolder

Určuje umístění .cab souboru a helpinfo.xml souboru, který tato rutina vytvoří.

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

Vstupy

None

Hodnoty nelze do této rutiny převést.

Výstupy

None

Tato rutina negeneruje výstup. Rutina uloží výsledky do výstupní složky, kterou určuje parametr OutputPath .