Condividi tramite

New-ExternalHelpCab

  • Riferimento
Modulo:
platyPS

Genera un .cab file.

Sintassi

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

Descrizione

Il New-ExternalHelpCab cmdlet genera un .cab file che contiene tutto il contenuto non ricorsivo in una cartella. Questo cmdlet comprime i file forniti.

Nota

Questo cmdlet dipende MakeCab.exe dal comando nativo, disponibile solo in Windows. Questo cmdlet genera un errore se usato nei computer non Windows.

È consigliabile fornire come contenuto solo about_ argomenti e l'output del cmdlet New-ExternalHelp a questo cmdlet.

Questo cmdlet usa i metadati archiviati nel file markdown del modulo per denominare il .cab file. Questa denominazione corrisponde al modello richiesto dal sistema della Guida di PowerShell per l'uso come guida aggiornabile. Questi metadati fanno parte del file di modulo creato usando il cmdlet New-MarkdownHelp con il parametro WithModulePage .

Questo cmdlet genera o aggiorna anche un file esistente helpinfo.xml . Questo file fornisce informazioni dettagliate sul controllo delle versioni e sulle impostazioni locali per il sistema della Guida di PowerShell.

Esempio

Esempio 1: Creare un file CAB

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

Il cmdlet crea un .cab file contenente i file della cartella del contenuto. Il .cab file è denominato per la Guida aggiornabile in base ai metadati. Il comando inserisce il .cab file nella cartella di output.

Parametri

-CabFilesFolder

Specifica la cartella che contiene il contenuto della Guida che questo cmdlet inserisce in un .cab file.

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

-IncrementHelpVersion

Incrementare automaticamente la versione della Guida nel file Markdown del modulo.

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

-LandingPagePath

Specifica il percorso completo del file Markdown del modulo che contiene tutti i metadati necessari per denominare il .cab file. Per i metadati necessari, eseguire New-MarkdownHelp con il parametro WithLandingPage .

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

-OutputFolder

Specifica il percorso del file e helpinfo.xml del .cab file creato da questo cmdlet.

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

Input

None

Non è possibile inviare tramite pipe i valori a questo cmdlet.

Output

None

Questo cmdlet non genera output. Il cmdlet salva i risultati nella cartella di output specificata dal parametro OutputPath .