Update-MarkdownHelp
Aktualizace souborů nápovědy markdownu PlatyPS
Syntax
Default (Výchozí)
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 markdownu PlatyPS bez úplné nahrazení obsahu 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 markdown, aby tyto změny odrážela. 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 PowerShellu.
- Spuštěním rutiny
Update-MarkdownHelpaktualizujte 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 zachytávání 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 informace protokolu do souboru markdown.log.
Parametry
-AlphabeticParamsOrder
Pořadí parametrů abecedně podle názvu v části PARAMETRY Existují 5 výjimek: -Confirm, -WhatIf, -IncludeTotalCount, -Skipa parametry -First budou poslední. Tyto parametry jsou běžné a proto mají dobře definované chování.
Vlastnosti parametru
| Typ: | SwitchParameter |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | 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.
Vlastnosti parametru
| Typ: | Encoding |
| Default value: | UTF8 without BOM |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
(All)
| Position: | 1 |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
-ExcludeDontShow
Vylučte parametry označené DontShow v atributu parametru z obsahu nápovědy.
Vlastnosti parametru
| Typ: | SwitchParameter |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
-Force
Odeberte soubory nápovědy, které už v relacích neexistují (například pokud byla odstraněna funkce).
Vlastnosti parametru
| Typ: | SwitchParameter |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
-LogAppend
Označuje, že tato rutina místo přepsání připojí informace do protokolu.
Vlastnosti parametru
| Typ: | SwitchParameter |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
-LogPath
Určuje cestu k souboru pro informace protokolu. Rutina zapíše do protokolu datový proud VERBOSE. Pokud zadáte parametr Podrobné, tato rutina tyto informace zapíše také do konzoly.
Vlastnosti parametru
| Typ: | String |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
(All)
| Position: | 2 |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
-Path
Určuje pole cest souborů a složek markdownu, které se mají aktualizovat.
Vlastnosti parametru
| Typ: | String[] |
| Default value: | None |
| Podporuje zástupné znaky: | True |
| DontShow: | False |
Sady parametrů
(All)
| Position: | 0 |
| Povinné: | True |
| Hodnota z kanálu: | True |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
-Session
Poskytuje podporu pro vzdálené příkazy. Předejte relaci, kterou jste použili k vytvoření příkazů s Import-PSSession. To je nutné k získání přesných metadat parametrů ze vzdálené relace.
Vlastnosti parametru
| Typ: | PSSession |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
-UpdateInputOutput
Aktualizuje oddíl Input a Output tak, aby odrážel aktuální stav rutiny. UPOZORNĚNÍ: Tento parametr odebere ručně přidané hodnoty do těchto oddílů.
Vlastnosti parametru
| Typ: | SwitchParameter |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
-UseFullTypeName
Označuje, že cílový dokument bude místo krátkého názvu parametrů používat úplný název typu.
Vlastnosti parametru
| Typ: | SwitchParameter |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
CommonParameters
Tato rutina podporuje běžné parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction a -WarningVariable. Další informace najdete v about_CommonParameters.
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, pořadí parametrů bude v aktualizované nápovědě abecední, i když parametr AlphabeticParamsOrder nebyl použit.
