Update-MarkdownHelp
Uppdatera hjälpfilerna för PlatyPS markdown.
Syntax
Default (Standard)
Update-MarkdownHelp
[-Path] <String[]>
[[-Encoding] <Encoding>]
[[-LogPath] <String>]
[-LogAppend]
[-AlphabeticParamsOrder]
[-UseFullTypeName]
[-UpdateInputOutput]
[-Force]
[-Session <PSSession>]
[-ExcludeDontShow]
[<CommonParameters>]
Description
Cmdleten Update-MarkdownHelp uppdaterar hjälpfilerna för PlatyPS markdown utan att helt ersätta innehållet i filerna.
Vissa parameterattribut ändras över tid. Till exempel parameteruppsättningar, typer, standardvärde och obligatoriskt. Den här cmdleten uppdaterar markdown för att återspegla dessa ändringar. Den lägger också till platshållartext i markdown-filen för alla nya parametrar.
Om du vill sprida ändringar till markdown-hjälpfilerna gör du följande:
- Läs in den nya versionen av modulen i Din Windows PowerShell-session.
- Kör cmdleten
Update-MarkdownHelpför att uppdatera filerna. - Kontrollera nya metadata för parametrar i markdown-filerna.
Exempel
Exempel 1: Uppdatera alla filer i en mapp
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
Det här kommandot uppdaterar alla markdown-hjälpfiler i den angivna sökvägen så att de matchar de aktuella cmdletarna.
Exempel 2: Uppdatera en fil och avbildningslogg
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
Det här kommandot uppdaterar en markdown-hjälpfil. Den skriver logginformation till markdown.log-filen.
Parametrar
-AlphabeticParamsOrder
Ordna parametrar alfabetiskt efter namn i avsnittet PARAMETRAR. Det finns fem undantag: -Confirm, -WhatIf, -IncludeTotalCount, -Skipoch -First parametrar blir de sista. Dessa parametrar är vanliga och har därför ett väldefinierat beteende.
Parameteregenskaper
| Typ: | SwitchParameter |
| Standardvärde: | None |
| Stöder jokertecken: | False |
| DontShow: | False |
Parameteruppsättningar
(All)
| Position: | Named |
| Obligatorisk: | False |
| Värde från pipeline: | False |
| Värde från pipeline efter egenskapsnamn: | False |
| Värde från återstående argument: | False |
-Encoding
Anger teckenkodning för den externa hjälpfilen. Ange ett System.Text.Encoding-objekt. Mer information finns i about_Character_Encoding.
Parameteregenskaper
| Typ: | Encoding |
| Standardvärde: | UTF8 without BOM |
| Stöder jokertecken: | False |
| DontShow: | False |
Parameteruppsättningar
(All)
| Position: | 1 |
| Obligatorisk: | False |
| Värde från pipeline: | False |
| Värde från pipeline efter egenskapsnamn: | False |
| Värde från återstående argument: | False |
-ExcludeDontShow
Undanta parametrarna som har markerats med DontShow i parameterattributet från hjälpinnehållet.
Parameteregenskaper
| Typ: | SwitchParameter |
| Standardvärde: | None |
| Stöder jokertecken: | False |
| DontShow: | False |
Parameteruppsättningar
(All)
| Position: | Named |
| Obligatorisk: | False |
| Värde från pipeline: | False |
| Värde från pipeline efter egenskapsnamn: | False |
| Värde från återstående argument: | False |
-Force
Ta bort hjälpfiler som inte längre finns i sessioner (till exempel om funktionen har tagits bort)
Parameteregenskaper
| Typ: | SwitchParameter |
| Standardvärde: | None |
| Stöder jokertecken: | False |
| DontShow: | False |
Parameteruppsättningar
(All)
| Position: | Named |
| Obligatorisk: | False |
| Värde från pipeline: | False |
| Värde från pipeline efter egenskapsnamn: | False |
| Värde från återstående argument: | False |
-LogAppend
Anger att den här cmdleten lägger till information i loggen i stället för att skriva över den.
Parameteregenskaper
| Typ: | SwitchParameter |
| Standardvärde: | None |
| Stöder jokertecken: | False |
| DontShow: | False |
Parameteruppsättningar
(All)
| Position: | Named |
| Obligatorisk: | False |
| Värde från pipeline: | False |
| Värde från pipeline efter egenskapsnamn: | False |
| Värde från återstående argument: | False |
-LogPath
Anger en filsökväg för logginformation. Cmdleten skriver VERBOSE-strömmen till loggen. Om du anger parametern Utförlig skriver den här cmdleten även den informationen till konsolen.
Parameteregenskaper
| Typ: | String |
| Standardvärde: | None |
| Stöder jokertecken: | False |
| DontShow: | False |
Parameteruppsättningar
(All)
| Position: | 2 |
| Obligatorisk: | False |
| Värde från pipeline: | False |
| Värde från pipeline efter egenskapsnamn: | False |
| Värde från återstående argument: | False |
-Path
Anger en matris med sökvägar för markdown-filer och mappar som ska uppdateras.
Parameteregenskaper
| Typ: | String[] |
| Standardvärde: | None |
| Stöder jokertecken: | True |
| DontShow: | False |
Parameteruppsättningar
(All)
| Position: | 0 |
| Obligatorisk: | True |
| Värde från pipeline: | True |
| Värde från pipeline efter egenskapsnamn: | False |
| Värde från återstående argument: | False |
-Session
Ger stöd för fjärrkommandon. Skicka sessionen som du använde för att skapa kommandona med Import-PSSession. Detta krävs för att få korrekta parametrar metadata från fjärrsessionen.
Parameteregenskaper
| Typ: | PSSession |
| Standardvärde: | None |
| Stöder jokertecken: | False |
| DontShow: | False |
Parameteruppsättningar
(All)
| Position: | Named |
| Obligatorisk: | False |
| Värde från pipeline: | False |
| Värde från pipeline efter egenskapsnamn: | False |
| Värde från återstående argument: | False |
-UpdateInputOutput
Uppdaterar avsnittet Indata och utdata för att återspegla cmdletens aktuella tillstånd. VARNING! Den här parametern tar bort alla manuella tillägg till dessa avsnitt.
Parameteregenskaper
| Typ: | SwitchParameter |
| Standardvärde: | None |
| Stöder jokertecken: | False |
| DontShow: | False |
Parameteruppsättningar
(All)
| Position: | Named |
| Obligatorisk: | False |
| Värde från pipeline: | False |
| Värde från pipeline efter egenskapsnamn: | False |
| Värde från återstående argument: | False |
-UseFullTypeName
Anger att måldokumentet använder ett fullständigt typnamn i stället för ett kort namn för parametrar.
Parameteregenskaper
| Typ: | SwitchParameter |
| Standardvärde: | None |
| Stöder jokertecken: | False |
| DontShow: | False |
Parameteruppsättningar
(All)
| Position: | Named |
| Obligatorisk: | False |
| Värde från pipeline: | False |
| Värde från pipeline efter egenskapsnamn: | False |
| Värde från återstående argument: | False |
CommonParameters
Den här cmdleten stöder vanliga parametrar: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction och -WarningVariable. Mer information finns i about_CommonParameters.
Indata
String
Du kan skicka en matris med sökvägar till den här cmdleten.
Utdata
FileInfo
Den här cmdleten returnerar ett FileInfo[]-objekt för uppdaterade filer.
Kommentarer
Modulen som du vill uppdatera hjälpen för ska först importeras från den plats som innehåller den tidigare versionen av hjälpen. Om det här villkoret inte uppfylls kommer parameterordningen att vara alfabetisk i den uppdaterade hjälpen, även om parametern AlphabeticParamsOrder inte har använts.
