Dela via

Update-MarkdownModuleFile

Modul:
Microsoft.PowerShell.PlatyPS Module

Uppdaterar Markdown-modulfilen.

Syntax

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

Den här cmdleten uppdaterar en Markdown-modulfil med CommandHelp objektinformation som importerats från Markdown-kommandofiler.

Exempel

Exempel 1 – Uppdatera en modulfil från nya kommandohjälpfiler

$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

Parametrar

-CommandHelp

CommandHelp objekt som ska exporteras. Du kan skicka objektet CommandHelp i pipelinen eller med hjälp av den här parametern.

Parameteregenskaper

Typ:

Microsoft.PowerShell.PlatyPS.Model.CommandHelp[]

Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:1
Obligatorisk:True
Värde från pipeline:True
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Confirm

Uppmanar dig att bekräfta innan du kör cmdleten.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:False
Stöder jokertecken:False
DontShow:False
Alias:jfr

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Encoding

Den kodning som ska användas när du skriver markdown-filen. Om inget värde anges kodas som standard värdet för $OutputEncoding-inställningsvariabeln.

Parameteregenskaper

Typ:Encoding
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Force

Använd parametern Force för att skriva över utdatafilen om den redan finns.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:False
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-HelpInfoUri

Med den här parametern kan du ange den URI som används för uppdateringsbar hjälp. Som standard använder cmdleten den HelpInfoUri som anges i modulmanifestet.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-HelpVersion

Med den här parametern kan du ange vilken version av hjälpen som ska användas. Standardvärdet är 1.0.0.0. Den här versionen skrivs till den HelpInfo.xml fil som används för uppdateringsbar hjälp.

Parameteregenskaper

Typ:Version
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-LiteralPath

Anger en sökväg till en eller flera markdown-modulfiler. Värdet för LiteralPath- används exakt som det skrivs. Inga tecken tolkas som wildcards. Om sökvägen innehåller escape-tecken omger du den med enkla citattecken. Enkla citattecken gör att PowerShell inte tolkar några tecken som escape-sekvenser.

Mer information finns i about_Quoting_Rules.

Parameteregenskaper

Typ:String
Standardvärde:False
Stöder jokertecken:False
DontShow:False
Alias:PSPath, SP

Parameteruppsättningar

literalpath
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Locale

Med den här parametern kan du ange språkspråket för hjälpfilerna. Som standard använder cmdleten den aktuella CultureInfo-. Använd cmdleten Get-Culture för att se de aktuella kulturinställningarna i systemet.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Metadata

Metadata som ska läggas till i markdown-filens frontmatter. Metadata är en hashtable där du anger nyckel- och värdeparen som ska läggas till i frontmattern. Nya nyckelnamn läggs till i den befintliga frontmattern. Värdena för befintliga nycklar skrivs över. Du kan inte skriva över värdena för document type eller PlatyPS schema version nycklar. Om dessa nycklar finns i hashtabellen ignorerar cmdleten värdena och utdata en varning.

Parameteregenskaper

Typ:Hashtable
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-NoBackup

Som standard skapar cmdleten en säkerhetskopia av den ursprungliga Markdown-filen innan den uppdateras. Använd den här parametern för att förhindra att säkerhetskopieringsfilen skapas.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:False
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Path

Anger en sökväg till en eller flera markdown-modulfiler.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

path
Position:0
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-WhatIf

Kör kommandot i ett läge som bara rapporterar vad som skulle hända utan att utföra åtgärderna.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:False
Stöder jokertecken:False
DontShow:False
Alias:Wi

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

CommonParameters

Den här cmdleten stöder vanliga parametrar: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction och -WarningVariable. Mer information finns i about_CommonParameters.

Indata

Microsoft.PowerShell.PlatyPS.Model.CommandHelp

Utdata

FileInfo