Condividi tramite

Update-MarkdownModuleFile

Modulo:
Microsoft.PowerShell.PlatyPS Module

Aggiorna il file del modulo Markdown.

Sintassi

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>]

Descrizione

Questo cmdlet aggiorna un file di modulo Markdown con CommandHelp informazioni sull'oggetto importate dai file di comando Markdown.

Esempio

Esempio 1 - Aggiornare un file di modulo dai nuovi file della Guida dei comandi

$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

Parametri

-CommandHelp

Oggetti CommandHelp da esportare. È possibile passare l'oggetto CommandHelp nella pipeline o usando questo parametro.

Proprietà dei parametri

Tipo:

Microsoft.PowerShell.PlatyPS.Model.CommandHelp[]

Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:1
Obbligatorio:True
Valore dalla pipeline:True
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-Confirm

Richiede conferma prima di eseguire il cmdlet.

Proprietà dei parametri

Tipo:SwitchParameter
Valore predefinito:False
Supporta i caratteri jolly:False
DontShow:False
Alias:cfr

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-Encoding

Codifica da utilizzare per la scrittura del file markdown. Se non viene specificato alcun valore, per impostazione predefinita la codifica corrisponde al valore della variabile di preferenza $OutputEncoding.

Proprietà dei parametri

Tipo:Encoding
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-Force

Usare il parametro Force per sovrascrivere il file di output, se già esistente.

Proprietà dei parametri

Tipo:SwitchParameter
Valore predefinito:False
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-HelpInfoUri

Questo parametro consente di specificare l'URI usato per la Guida aggiornabile. Per impostazione predefinita, il cmdlet usa l'HelpInfoUri specificato nel manifesto del modulo.

Proprietà dei parametri

Tipo:String
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-HelpVersion

Questo parametro consente di specificare la versione della Guida. Il valore predefinito è 1.0.0.0. Questa versione viene scritta nel file HelpInfo.xml usato per la Guida aggiornabile.

Proprietà dei parametri

Tipo:Version
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-LiteralPath

Specifica un percorso di uno o più file markdown del modulo. Il valore di LiteralPath viene usato esattamente come viene digitato. Nessun carattere viene interpretato come metacaratteri. Se il percorso include caratteri di escape, racchiudilo tra virgolette singole. Le virgolette singole indicano a PowerShell di non interpretare alcun carattere come sequenze di escape.

Per altre informazioni, vedere about_Quoting_Rules.

Proprietà dei parametri

Tipo:String
Valore predefinito:False
Supporta i caratteri jolly:False
DontShow:False
Alias:PSPath, UP

Set di parametri

literalpath
Posizione:Named
Obbligatorio:True
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-Locale

Questo parametro consente di specificare le impostazioni locali della lingua per i file della Guida. Per impostazione predefinita, il cmdlet usa l'CultureInfo corrente. Usare il cmdlet Get-Culture per visualizzare le impostazioni cultura correnti nel sistema.

Proprietà dei parametri

Tipo:String
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-Metadata

Metadati da aggiungere al frontmatter del file markdown. I metadati sono una tabella hash in cui si specificano le coppie chiave e valore da aggiungere al frontmatter. I nuovi nomi di chiave vengono aggiunti al frontmatter esistente. I valori delle chiavi esistenti vengono sovrascritti. Non è possibile sovrascrivere i valori delle chiavi document type o PlatyPS schema version. Se queste chiavi sono presenti nella tabella hash, il cmdlet ignora i valori e restituisce un avviso.

Proprietà dei parametri

Tipo:Hashtable
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-NoBackup

Per impostazione predefinita, il cmdlet crea un backup del file Markdown originale prima di aggiornarlo. Usare questo parametro per eliminare la creazione del file di backup.

Proprietà dei parametri

Tipo:SwitchParameter
Valore predefinito:False
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-Path

Specifica un percorso di uno o più file markdown del modulo.

Proprietà dei parametri

Tipo:String
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

path
Posizione:0
Obbligatorio:True
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-WhatIf

Esegue il comando in una modalità che segnala solo ciò che accadrebbe senza eseguire le azioni.

Proprietà dei parametri

Tipo:SwitchParameter
Valore predefinito:False
Supporta i caratteri jolly:False
DontShow:False
Alias:Wi

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

CommonParameters

Questo cmdlet supporta i parametri comuni: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Per altre informazioni, vedi about_CommonParameters.

Input

Microsoft.PowerShell.PlatyPS.Model.CommandHelp

Output

FileInfo