Update-MarkdownHelp

Riferimento

Modulo:: platyPS

Aggiornare i file della Guida markdown di PlatyPS.

Sintassi

Update-MarkdownHelp
      [-Path] <String[]>
      [[-Encoding] <Encoding>]
      [[-LogPath] <String>]
      [-LogAppend]
      [-AlphabeticParamsOrder]
      [-UseFullTypeName]
      [-UpdateInputOutput]
      [-Force]
      [-Session <PSSession>]
      [-ExcludeDontShow]
      [<CommonParameters>]

Descrizione

Il Update-MarkdownHelp cmdlet aggiorna i file della Guida markdown di PlatyPS senza sostituire completamente il contenuto dei file.

Alcuni attributi dei parametri cambiano nel tempo. Ad esempio, set di parametri, tipi, valore predefinito e obbligatorio. Questo cmdlet aggiorna la Guida markdown per riflettere tali modifiche. Aggiunge inoltre testo segnaposto al file markdown per qualsiasi nuovo parametro.

Per propagare le modifiche ai file della Guida markdown, eseguire le operazioni seguenti:

Caricare la nuova versione del modulo nella sessione di Windows PowerShell.
Eseguire il Update-MarkdownHelp cmdlet per aggiornare i file.
Controllare i nuovi metadati dei parametri nei file markdown.

Esempio

Esempio 1: Aggiornare tutti i file in una cartella

PS C:\> Update-MarkdownHelp -Path ".\docs"

    Directory: D:\working\PlatyPS\docs


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        5/22/2016   6:54 PM           1496 Get-HelpPreview.md
-a----        5/22/2016   6:54 PM           3208 Get-MarkdownMetadata.md
-a----        5/22/2016   6:54 PM           3059 New-ExternalHelp.md
-a----        5/22/2016   6:54 PM           2702 New-ExternalHelpCab.md
-a----        5/22/2016   6:54 PM           6234 New-MarkdownHelp.md
-a----        5/22/2016   6:54 PM           2346 Update-MarkdownHelp.md
-a----        5/22/2016   6:54 PM           1633 Update-MarkdownHelpModule.md
-a----        5/22/2016   6:54 PM           1630 Update-MarkdownHelpSchema.md

Questo comando aggiorna tutti i file della Guida markdown nel percorso specificato in modo che corrispondano ai cmdlet correnti.

Esempio 2: Aggiornare un file e un log di acquisizione

PS C:\> Update-MarkdownHelp -Path ".\docs\Update-MarkdownHelp.md" -LogPath ".\markdown.log"

    Directory: D:\Working\PlatyPS\docs


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        5/22/2016   8:20 PM           9993 New-MarkdownHelp.md

Questo comando aggiorna un file della Guida markdown. Scrive le informazioni di log nel markdown.log file.

Parametri

-AlphabeticParamsOrder

Ordinare i parametri in ordine alfabetico in base al nome nella sezione PARAMETERS. Esistono 5 eccezioni: -Confirm, -WhatIf, -IncludeTotalCount, -Skipe -First i parametri saranno gli ultimi. Questi parametri sono comuni e quindi hanno un comportamento ben definito.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Encoding

Specifica la codifica dei caratteri per il file della Guida esterna. Specificare un oggetto System.Text.Encoding . Per altre informazioni, vedere about_Character_Encoding.

Type:	Encoding
Position:	1
Default value:	UTF8 without BOM
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ExcludeDontShow

Escludere i parametri contrassegnati con DontShow nell'attributo del parametro dal contenuto della Guida.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Force

Rimuovere i file della Guida che non esistono più all'interno delle sessioni (ad esempio, se la funzione è stata eliminata)

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-LogAppend

Indica che questo cmdlet aggiunge informazioni al log sovrascrivendolo.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-LogPath

Specifica un percorso di file per le informazioni di log. Il cmdlet scrive il flusso VERBOSE nel log. Se si specifica il parametro Verbose , questo cmdlet scrive anche tali informazioni nella console.

Type:	String
Position:	2
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Path

Specifica una matrice di percorsi di file e cartelle markdown da aggiornare.

Type:	String[]
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	True

-Session

Fornisce il supporto per i comandi remoti. Passare la sessione usata per creare i comandi con Import-PSSession. Questa operazione è necessaria per ottenere metadati accurati dei parametri dalla sessione remota.

Type:	PSSession
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-UpdateInputOutput

Aggiorna la sezione Input e Output per riflettere lo stato corrente del cmdlet. AVVISO: questo parametro rimuoverà eventuali aggiunte manuali a queste sezioni.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-UseFullTypeName

Indica che il documento di destinazione userà un nome di tipo completo anziché un nome breve per i parametri.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Input

String[]

È possibile inviare tramite pipe una matrice di percorsi a questo cmdlet.

Output

FileInfo[]

Questo cmdlet restituisce un oggetto FileInfo[] per i file aggiornati.

Note

Il modulo per cui si vuole aggiornare la Guida deve prima essere importato dal percorso contenente la versione precedente della Guida. Se questa condizione non viene soddisfatta, l'ordine dei parametri sarà alfabetico nella Guida aggiornata, anche se il parametro AlphabeticParamsOrder non è stato usato.

Condividi tramite