Update-MarkdownHelpModule

Reference

Modul:: platyPS

Aktualizujte všechny soubory ve složce modulu nápovědy markdownu.

Syntax

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

Description

Rutina Update-MarkdownHelpModule aktualizuje existující soubory markdownu nápovědy a vytvoří soubory Markdownu pro nové rutiny v modulu. Tato rutina kombinuje funkce rutin Update-MarkdownHelp a New-MarkdownHelp a provádí hromadnou aktualizaci.

Příklady

Příklad 1: Aktualizace modulu nápovědy markdownu

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

Tento příkaz aktualizuje všechny soubory v zadané složce na základě rutin načtených do aktuální relace. Příkaz vytvoří témata nápovědy markdownu pro všechny rutiny, které ještě nejsou součástí složky .\docs.

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

Odeberte soubory nápovědy, které už v relacích 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

-ModulePagePath

Když se ve výchozím nastavení používá -RefreshModulePage, umístí soubor .md do stejného umístění jako všechny ostatní dokumenty. Pomocí tohoto parametru můžete zadat nový název nebo umístění, které poskytuje lepší možnosti umístění.

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

-Path

Určuje pole cest ke složkám markdownu, které se mají aktualizovat. Složka musí obsahovat stránku modulu, ze které může tato rutina získat název modulu.

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

-RefreshModulePage

Stránka aktualizovat modul při aktualizaci modulu nápovědy

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

-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 oddíly Vstup a Výstup tak, aby odrážely 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é a nové 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 .