Update-MarkdownHelp

Reference

Modul:: platyPS

Aktualizujte soubory nápovědy k Markdownu Pro PlatyPS.

Syntax

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

Description

Rutina Update-MarkdownHelp aktualizuje soubory nápovědy Pro PlatyPS Markdown, aniž by zcela nahradila obsah souborů.

Některé atributy parametrů se v průběhu času mění. Například sady parametrů, typy, výchozí hodnota a povinné. Tato rutina aktualizuje nápovědu Markdownu tak, aby odrážela tyto změny. Přidá také zástupný text do souboru markdownu pro jakýkoli nový parametr.

Pokud chcete rozšířit změny do souborů nápovědy markdownu, postupujte takto:

Načtěte novou verzi modulu do relace Windows PowerShell.
Spusťte rutinu Update-MarkdownHelp a aktualizujte soubory.
Zkontrolujte metadata nových parametrů v souborech markdownu.

Příklady

Příklad 1: Aktualizace všech souborů ve složce

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

Tento příkaz aktualizuje všechny soubory nápovědy markdownu v zadané cestě tak, aby odpovídaly aktuálním rutinám.

Příklad 2: Aktualizace jednoho souboru a zachycení protokolu

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

Tento příkaz aktualizuje soubor nápovědy markdownu. Zapisuje do markdown.log souboru informace protokolu.

Parametry

-AlphabeticParamsOrder

Seřaďte parametry abecedně podle názvu v části PARAMETRY. Existuje 5 výjimek: -Confirm, -WhatIf, -IncludeTotalCount, -Skipa -First parametry budou poslední. Tyto parametry jsou běžné, a proto mají dobře definované chování.

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

-Encoding

Určuje kódování znaků pro externí soubor nápovědy. Zadejte objekt System.Text.Encoding . Další informace najdete v tématu about_Character_Encoding.

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

-ExcludeDontShow

Vylučte parametry označené parametrem DontShow v atributu parameter z obsahu nápovědy.

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

-Force

Odebrání souborů nápovědy, které už v rámci relací neexistují (například při odstranění funkce)

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

-LogAppend

Označuje, že tato rutina místo přepsání připojí informace do protokolu.

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

-LogPath

Určuje cestu k souboru pro informace protokolu. Rutina zapíše datový proud VERBOSE do protokolu. Pokud zadáte parametr Verbose , tato rutina také zapíše tyto informace do konzoly.

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

-Path

Určuje pole cest k souborům a složkám markdownu, které se mají aktualizovat.

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

-Session

Poskytuje podporu pro vzdálené příkazy. Předejte relaci, kterou jste použili k vytvoření příkazů, pomocí Import-PSSession. To je potřeba k získání přesných metadat parametrů ze vzdálené relace.

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

-UpdateInputOutput

Aktualizuje část Vstup a výstup tak, aby odrážela aktuální stav rutiny. UPOZORNĚNÍ: Tento parametr odebere všechna ruční přidání do těchto oddílů.

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

-UseFullTypeName

Označuje, že cílový dokument bude místo krátkého názvu parametrů používat úplný název typu.

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

Vstupy

String[]

K této rutině můžete připojit pole cest.

Výstupy

FileInfo[]

Tato rutina vrátí objekt FileInfo[] pro aktualizované soubory.

Poznámky

Modul, pro který chcete aktualizovat nápovědu, by se měl nejprve importovat z umístění obsahujícího předchozí verzi nápovědy. Pokud tato podmínka není splněna, bude pořadí parametrů v aktualizované nápovědě abecedně, i když nebyl použit parametr AlphabeticParamsOrder .