Delen via


Update-MarkdownModuleFile

Hiermee werkt u het Markdown-modulebestand bij.

Syntaxis

path

Update-MarkdownModuleFile
    [-Path] <string>
    [-CommandHelp] <CommandHelp[]>
    [-Encoding <Encoding>]
    [-Force]
    [-HelpInfoUri <string>]
    [-HelpVersion <version>]
    [-Locale <string>]
    [-Metadata <hashtable>]
    [-NoBackup]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

literalpath

Update-MarkdownModuleFile
    [-CommandHelp] <CommandHelp[]>
    -LiteralPath <string>
    [-Encoding <Encoding>]
    [-Force]
    [-HelpInfoUri <string>]
    [-HelpVersion <version>]
    [-Locale <string>]
    [-Metadata <hashtable>]
    [-NoBackup]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Met deze cmdlet wordt een Markdown-modulebestand bijgewerkt met CommandHelp objectgegevens geïmporteerd uit Markdown-opdrachtbestanden.

Voorbeelden

Voorbeeld 1: Een modulebestand bijwerken vanuit nieuwe Help-opdrachtenbestanden

$mdfiles = Measure-PlatyPSMarkdown -Path .\Microsoft.PowerShell.PlatyPS\*.md
$mdfiles | Where-Object Filetype -match 'CommandHelp' |
    Import-MarkdownCommandHelp -Path {$_.FilePath} |
    Update-MarkdownModuleFile -Path .\Microsoft.PowerShell.PlatyPS\Microsoft.PowerShell.PlatyPS.md

Parameters

-CommandHelp

De CommandHelp objecten die u wilt exporteren. U kunt het CommandHelp-object doorgeven aan de pijplijn of met behulp van deze parameter.

Parametereigenschappen

Type:

Microsoft.PowerShell.PlatyPS.Model.CommandHelp[]

Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:1
Verplicht:True
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 moet worden gebruikt bij het schrijven van het Markdown-bestand. Als er geen waarde is opgegeven, wordt standaard de waarde van de $OutputEncoding voorkeursvariabele gecodeerd.

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

Gebruik de parameter Forceren om het uitvoerbestand te overschrijven als het al bestaat.

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

-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

-LiteralPath

Hiermee geeft u een pad naar een of meer markdown-bestanden van de module. De waarde van LiteralPath- wordt precies gebruikt zoals deze is getypt. Er worden geen tekens geïnterpreteerd als jokertekens. Als het pad escape-tekens bevat, zet het dan tussen enkele aanhalingstekens. Enkele aanhalingstekens zorgen ervoor dat PowerShell geen tekens als escapesequenties interpreteert.

Zie about_Quoting_Rulesvoor meer informatie.

Parametereigenschappen

Type:String
Default value:False
Ondersteunt jokertekens:False
DontShow:False
Aliassen:PSPath, LP

Parametersets

literalpath
Position:Named
Verplicht:True
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

-NoBackup

De cmdlet maakt standaard een back-up van het oorspronkelijke Markdown-bestand voordat u het bijwerkt. Gebruik deze parameter om het maken van het back-upbestand te onderdrukken.

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

-Path

Hiermee geeft u een pad naar een of meer markdown-bestanden van de module.

Parametereigenschappen

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

Parametersets

path
Position:0
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.

Invoerwaarden

Microsoft.PowerShell.PlatyPS.Model.CommandHelp

Uitvoerwaarden

FileInfo