Delen via


New-MarkdownCommandHelp

Hiermee maakt u Help-bestanden van Markdown voor PowerShell-modules en -opdrachten.

Syntaxis

__AllParameterSets

New-MarkdownCommandHelp
    -OutputFolder <string>
    [-CommandInfo <CommandInfo[]>]
    [-Encoding <Encoding>]
    [-Force]
    [-HelpUri <string>]
    [-HelpInfoUri <string>]
    [-HelpVersion <version>]
    [-Locale <string>]
    [-Metadata <hashtable>]
    [-ModuleInfo <psmoduleinfo[]>]
    [-WithModulePage]
    [-AbbreviateParameterTypename]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Hiermee maakt u Help-bestanden van Markdown voor PowerShell-modules en -opdrachten.

Voorbeelden

Voorbeeld 1: Help-bestanden voor Markdown maken voor een module

$newMarkdownCommandHelpSplat = @{
    ModuleInfo = Get-Module Microsoft.PowerShell.PlatyPS
    OutputFolder = '.'
    HelpVersion = '1.0.0.0'
    WithModulePage = $true
}
New-MarkdownCommandHelp @newMarkdownCommandHelpSplat

Voorbeeld 2: Help-bestanden voor Markdown maken op basis van een lijst met opdrachten

$newMarkdownCommandHelpSplat = @{
    CommandInfo = Get-Command -Module Microsoft.PowerShell.PlatyPS
    OutputFolder = '.'
    HelpVersion = '1.0.0.0'
    WithModulePage = $true
}
New-MarkdownCommandHelp @newMarkdownCommandHelpSplat

Parameters

-AbbreviateParameterTypename

Deze opdracht maakt standaard gebruik van volledige typenamen in de parametermetagegevens en voor de invoer- en uitvoertypen. Wanneer u deze parameter gebruikt, voert de cmdlet korte typenamen uit.

Parametereigenschappen

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

Parametersets

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

-CommandInfo

Een lijst met een of meer opdrachten voor het maken van help-informatie.

Parametereigenschappen

Type:

CommandInfo[]

Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:True
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

-Encoding

De codering die wordt gebruikt bij het maken van de uitvoerbestanden. Als deze niet is opgegeven, gebruikt de cmdlet de waarde die is opgegeven door $OutputEncoding.

Parametereigenschappen

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

Parametersets

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

-Force

Deze opdracht overschrijft standaard geen bestaande bestanden. Wanneer u deze parameter gebruikt, overschrijft de cmdlet bestaande bestanden.

Parametereigenschappen

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

Parametersets

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

-HelpInfoUri

Met deze parameter kunt u de URI opgeven die wordt gebruikt voor bijwerkbare help. De cmdlet gebruikt standaard de HelpInfoUri die is opgegeven in het modulemanifest.

Parametereigenschappen

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

Parametersets

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

-HelpUri

Met deze parameter kunt u de URI opgeven die wordt gebruikt voor online-help. De cmdlet gebruikt standaard de URI die is gedefinieerd in het kenmerk [CmdletBinding()] voor de opdracht.

Parametereigenschappen

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

Parametersets

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

-HelpVersion

Met deze parameter kunt u de versie van de Help opgeven. De standaardwaarde is 1.0.0.0. Deze versie wordt geschreven naar het HelpInfo.xml-bestand dat wordt gebruikt voor updatebare help.

Parametereigenschappen

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

Parametersets

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

-Locale

Met deze parameter kunt u de landinstellingen voor de Help-bestanden opgeven. De cmdlet gebruikt standaard de huidige CultureInfo. Gebruik de cmdlet Get-Culture om de huidige cultuurinstellingen op uw systeem te bekijken.

Parametereigenschappen

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

Parametersets

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

-Metadata

De metagegevens die moeten worden toegevoegd aan de frontmatter van het Markdown-bestand. De metagegevens zijn een hashtabel waarbij u de sleutel- en waardeparen opgeeft die moeten worden toegevoegd aan de frontmatter. Nieuwe sleutelnamen worden toegevoegd aan de bestaande frontmatter. De waarden van bestaande sleutels worden overschreven. U kunt de waarden van de document type of PlatyPS schema version sleutels niet overschrijven. Als deze sleutels aanwezig zijn in de hashtabel, negeert de cmdlet de waarden en voert een waarschuwing uit.

Parametereigenschappen

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

Parametersets

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

-ModuleInfo

Een lijst met een of meer modules waarvoor u hulp kunt maken. De cmdlet maakt Help-bestanden voor Markdown voor alle opdrachten in de module. De cmdlet maakt een map die overeenkomt met de naam van de module op de uitvoerlocatie. Alle Markdown-bestanden worden naar de modulemap geschreven.

Parametereigenschappen

Type:

PSModuleInfo[]

Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

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

-OutputFolder

Hiermee geeft u de locatie op van waar de Markdown Help-bestanden worden geschreven. De cmdlet maakt een map voor elke module die wordt verwerkt. Als de doelopdracht niet is gekoppeld aan een module, maakt de cmdlet een Markdown-bestand in de hoofdmap van de uitvoermap.

Parametereigenschappen

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

Parametersets

(All)
Position:Named
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

-WithModulePage

Deze cmdlet maakt standaard alleen Markdown-bestanden voor opdrachten. Wanneer u deze parameter gebruikt, maakt de cmdlet een Markdown-bestand voor de module. Dit Markdown-bestand bevat een lijst met alle opdrachten in de module en metagegevens die worden gebruikt om het HelpInfo.xml-bestand te maken.

Parametereigenschappen

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

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.

Invoerwaarden

CommandInfo

PSModuleInfo

Uitvoerwaarden

FileInfo