Update-MarkdownHelpModule

Riferimento

Modulo:: platyPS

Aggiornare tutti i file in una cartella del modulo della Guida markdown.

Sintassi

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

Descrizione

Il Update-MarkdownHelpModule cmdlet aggiorna i file markdown della Guida esistenti e crea file markdown per i nuovi cmdlet in un modulo. Questo cmdlet combina le funzionalità dei cmdlet Update-MarkdownHelp e New-MarkdownHelp per eseguire un aggiornamento in blocco.

Esempio

Esempio 1: Aggiornare un modulo della Guida markdown

PS C:\> Update-MarkdownHelpModule -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 nella cartella specificata in base ai cmdlet caricati nella sessione corrente. Il comando crea argomenti della Guida markdown per tutti i cmdlet che non sono già inclusi nella cartella .\docs.

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

-ModulePagePath

Quando -RefreshModulePage viene usato per impostazione predefinita, inserisce il file md nella stessa posizione di tutti gli altri documenti. Con questo parametro è possibile specificare un nuovo nome/posizione che offre opzioni di posizionamento migliori.

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

-Path

Specifica una matrice di percorsi delle cartelle markdown da aggiornare. La cartella deve contenere una pagina del modulo da cui questo cmdlet può ottenere il nome del modulo.

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

-RefreshModulePage

Aggiornare la pagina del modulo durante l'aggiornamento del modulo della Guida.

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

-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 le sezioni 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 e nuovi.

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.

Share via