Delen via

New-ExternalHelpCab

  • Referentie
Module:
platyPS

Hiermee wordt een .cab-bestand gegenereerd.

Syntaxis

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

Description

De cmdlet New-ExternalHelpCab genereert een .cab-bestand dat alle niet-recursieve inhoud in een map bevat. Met deze cmdlet worden de opgegeven bestanden gecomprimeerd.

Notitie

Deze cmdlet is afhankelijk van de MakeCab.exe systeemeigen opdracht, die alleen beschikbaar is in Windows. Deze cmdlet veroorzaakt een fout als deze wordt gebruikt op niet-Windows-computers.

U wordt aangeraden alleen inhoud op te geven about_ onderwerpen en de uitvoer van de cmdlet New-ExternalHelp naar deze cmdlet.

Deze cmdlet maakt gebruik van metagegevens die zijn opgeslagen in het markdown-modulebestand om uw .cab-bestand een naam te geven. Deze naamgeving komt overeen met het patroon dat het PowerShell Help-systeem nodig heeft voor gebruik als help-updatable. Deze metagegevens maken deel uit van het modulebestand dat is gemaakt met behulp van de cmdlet New-MarkdownHelp met de parameter WithModulePage.

Met deze cmdlet wordt ook een bestaand helpinfo.xml-bestand gegenereerd of bijgewerkt. Dat bestand bevat versiebeheer- en landinstellingen voor het Help-systeem van PowerShell.

Voorbeelden

Voorbeeld 1: Een CAB-bestand maken

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

De cmdlet maakt een .cab bestand dat de inhoudsmapbestanden bevat. Het .cab-bestand heeft de naam van de updatable Help op basis van metagegevens. Met de opdracht wordt het .cab bestand in de uitvoermap geplaatst.

Parameters

-CabFilesFolder

Hiermee geeft u de map die de Help-inhoud bevat die door deze cmdlet wordt verpakt in een .cab bestand.

Type:String
Position:Named
Default value:None
Vereist:True
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-IncrementHelpVersion

De Help-versie in het Markdown-modulebestand automatisch verhogen.

Type:SwitchParameter
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-LandingPagePath

Hiermee geeft u het volledige pad van het Markdown-modulebestand dat alle metagegevens bevat die nodig zijn om het .cab bestand een naam te geven. Voer voor de vereiste metagegevens New-MarkdownHelp uit met de parameter WithLandingPage.

Type:String
Position:Named
Default value:None
Vereist:True
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-OutputFolder

Hiermee geeft u de locatie van het .cab-bestand en helpinfo.xml-bestand dat door deze cmdlet wordt gemaakt.

Type:String
Position:Named
Default value:None
Vereist:True
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

Invoerwaarden

None

U kunt geen waarden doorsluisen naar deze cmdlet.

Uitvoerwaarden

None

Met deze cmdlet wordt geen uitvoer gegenereerd. De cmdlet slaat de resultaten op in de uitvoermap die de OutputPath parameter specificeert.