Update-MarkdownHelp
Frissítse a PlatyPS markdown súgófájljait.
Syntax
Default (Alapértelmezett)
Update-MarkdownHelp
[-Path] <String[]>
[[-Encoding] <Encoding>]
[[-LogPath] <String>]
[-LogAppend]
[-AlphabeticParamsOrder]
[-UseFullTypeName]
[-UpdateInputOutput]
[-Force]
[-Session <PSSession>]
[-ExcludeDontShow]
[<CommonParameters>]
Description
A Update-MarkdownHelp parancsmag frissíti a PlatyPS markdown súgófájljait anélkül, hogy teljesen lecseréli a fájlok tartalmát.
Egyes paraméterattribútumok idővel változnak. Például paraméterkészletek, típusok, alapértelmezett érték és kötelező. Ez a parancsmag frissíti a Markdownt, hogy tükrözze ezeket a változásokat. Emellett helyőrző szöveget is hozzáad a Markdown-fájlhoz minden új paraméter esetében.
A markdown-súgófájlok módosításainak propagálásához tegye a következőket:
- Töltse be a modul új verzióját a Windows PowerShell-munkamenetbe.
- Futtassa a
Update-MarkdownHelpparancsmagot a fájlok frissítéséhez. - Ellenőrizze az új paraméterek metaadatait a Markdown-fájlokban.
Példák
1. példa: Egy mappában lévő összes fájl frissítése
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
Ez a parancs frissíti a megadott elérési úton található összes Markdown-súgófájlt, hogy megfeleljen az aktuális parancsmagoknak.
2. példa: Egy fájl frissítése és a rögzítési napló
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
Ez a parancs frissíti a Markdown súgófájlját. Naplóadatokat ír a markdown.log fájlba.
Paraméterek
-AlphabeticParamsOrder
A paraméterek sorrendje név szerint a PARAMETERS szakaszban. 5 kivétel van: -Confirm, -WhatIf, -IncludeTotalCount, -Skipés -First paraméterek lesznek az utolsók. Ezek a paraméterek gyakoriak, ezért jól meghatározott viselkedésük van.
Paramétertulajdonságok
| Típus: | SwitchParameter |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-Encoding
Megadja a külső súgófájl karakterkódolását. Adjon meg egy System.Text.Encoding objektumot. További információ: about_Character_Encoding.
Paramétertulajdonságok
| Típus: | Encoding |
| Alapértelmezett érték: | UTF8 without BOM |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | 1 |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-ExcludeDontShow
Zárja ki a súgótartalomból a paraméterattribútumban DontShow megjelölt paramétereket.
Paramétertulajdonságok
| Típus: | SwitchParameter |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-Force
Távolítsa el a munkameneteken belül már nem létező súgófájlokat (például ha a függvényt törölték)
Paramétertulajdonságok
| Típus: | SwitchParameter |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-LogAppend
Azt jelzi, hogy ez a parancsmag hozzáfűzi az adatokat a naplóhoz, és felülírja azt.
Paramétertulajdonságok
| Típus: | SwitchParameter |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-LogPath
A naplóadatok fájlelérési útját adja meg. A parancsmag a VERBOSE streamet a naplóba írja. Ha megadja a Részletes paramétert, ez a parancsmag a konzolra is írja ezeket az adatokat.
Paramétertulajdonságok
| Típus: | String |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | 2 |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-Path
A frissíteni kívánt Markdown-fájlok és mappák elérési útvonalainak tömbjét adja meg.
Paramétertulajdonságok
| Típus: | String[] |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | True |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | 0 |
| Kötelező: | True |
| Folyamatból származó érték: | True |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-Session
Támogatja a távoli parancsokat. Adja át a parancsok létrehozásához használt munkamenetet Import-PSSession. Ez szükséges a pontos paraméterek metaadatainak lekéréséhez a távoli munkamenetből.
Paramétertulajdonságok
| Típus: | PSSession |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-UpdateInputOutput
Frissíti a Bemenet és kimenet szakaszt, hogy tükrözze a parancsmag aktuális állapotát. FIGYELMEZTETÉS: ez a paraméter eltávolítja a szakaszok manuális hozzáadását.
Paramétertulajdonságok
| Típus: | SwitchParameter |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-UseFullTypeName
Azt jelzi, hogy a céldokumentum a paraméterek rövid neve helyett egy teljes típusú nevet fog használni.
Paramétertulajdonságok
| Típus: | SwitchParameter |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
CommonParameters
Ez a parancsmag a következő gyakori paramétereket támogatja: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction és -WarningVariable. További információért lásd about_CommonParameters.
Bevitelek
String
Ehhez a parancsmaghoz elérési utak tömbje csövezhető.
Kimenetek
FileInfo
Ez a parancsmag egy FileInfo[] objektumot ad vissza a frissített fájlokhoz.
Jegyzetek
A modult, amelyhez frissíteni szeretné a súgót, először a súgó előző verzióját tartalmazó helyről kell importálni. Ha ez a feltétel nem teljesül, a paraméter sorrendje betűrendben jelenik meg a frissített súgóban, még akkor is, ha a AlphabeticParamsOrder paramétert nem használták.
