Delen via

New-HelpCabinetFile

Module:
Microsoft.PowerShell.PlatyPS Module

Hiermee maakt u een Help-cabinetbestand voor een module die kan worden gepubliceerd als updatebare Help-inhoud.

Syntaxis

__AllParameterSets 

New-HelpCabinetFile
    [-CabinetFilesFolder] <string>
    [-MarkdownModuleFile] <string>
    [-OutputFolder] <string>
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Met deze cmdlet maakt u .cab- en .zip-bestanden die Help-bestanden voor een module bevatten.

Opmerking

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.

Deze cmdlet maakt gebruik van metagegevens die zijn opgeslagen in het Markdown-modulebestand om uw .cab en .zip bestanden een naam te geven. Deze naamgeving komt overeen met het patroon dat het PowerShell Help-systeem nodig heeft voor gebruik als help-updatable.

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: Updatebare Help-bestanden voor een module maken

$params = @{
    CabinetFilesFolder = '.\maml\Microsoft.PowerShell.PlatyPS'
    MarkdownModuleFile = '.\Microsoft.PowerShell.PlatyPS\Microsoft.PowerShell.PlatyPS.md'
    OutputFolder       = '.\cab'
}
New-HelpCabinetFile @params

Parameters

-CabinetFilesFolder

Het pad naar de map met het MAML-bestand dat moet worden verpakt.

Parametereigenschappen

Type:String
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:0
Verplicht:True
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-Confirm

Voordat u de cmdlet uitvoert, vraagt het systeem om bevestiging.

Parametereigenschappen

Type:SwitchParameter
Default value:False
Ondersteunt jokertekens:False
DontShow:False
Aliassen:Cf

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-MarkdownModuleFile

Hiermee geeft u het volledige pad van het Markdown-modulebestand.

Parametereigenschappen

Type:String
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:1
Verplicht:True
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-OutputFolder

De locatie waar u de .cab, .zipen HelpInfo.xml bestanden wilt schrijven.

Parametereigenschappen

Type:String
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:2
Verplicht:True
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-WhatIf

Voert de opdracht uit in een modus die alleen rapporteert wat er zou gebeuren zonder de acties uit te voeren.

Parametereigenschappen

Type:SwitchParameter
Default value:False
Ondersteunt jokertekens:False
DontShow:False
Aliassen:Wi

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

CommonParameters

Deze cmdlet ondersteunt de algemene parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction en -WarningVariable. Zie about_CommonParametersvoor meer informatie.

Uitvoerwaarden

FileInfo

De FileInfo objecten die de bestanden vertegenwoordigen die door deze cmdlet zijn gemaakt.