Update-MarkdownHelp
PlatyPS Markdown Help-bestanden bijwerken.
Syntaxis
Default (Standaard)
Update-MarkdownHelp
[-Path] <String[]>
[[-Encoding] <Encoding>]
[[-LogPath] <String>]
[-LogAppend]
[-AlphabeticParamsOrder]
[-UseFullTypeName]
[-UpdateInputOutput]
[-Force]
[-Session <PSSession>]
[-ExcludeDontShow]
[<CommonParameters>]
Description
De Update-MarkdownHelp cmdlet werkt PlatyPS Markdown help-bestanden bij zonder de inhoud van de bestanden volledig te vervangen.
Sommige parameterkenmerken worden in de loop van de tijd gewijzigd. Bijvoorbeeld parametersets, typen, standaardwaarde en vereist. Met deze cmdlet wordt Markdown bijgewerkt om deze wijzigingen weer te geven. Er wordt ook tekst van tijdelijke aanduidingen toegevoegd aan het Markdown-bestand voor elke nieuwe parameter.
Ga als volgt te werk om wijzigingen door te geven aan uw Markdown Help-bestanden:
- Laad de nieuwe versie van de module in uw Windows PowerShell-sessie.
- Voer de cmdlet
Update-MarkdownHelpuit om de bestanden bij te werken. - Controleer de metagegevens van nieuwe parameters in de Markdown-bestanden.
Voorbeelden
Voorbeeld 1: Alle bestanden in een map bijwerken
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
Met deze opdracht worden alle Markdown Help-bestanden in het opgegeven pad bijgewerkt zodat deze overeenkomen met de huidige cmdlets.
Voorbeeld 2: Een bestand bijwerken en logboek vastleggen
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
Met deze opdracht wordt een Markdown Help-bestand bijgewerkt. Er worden logboekgegevens naar het markdown.log-bestand geschreven.
Parameters
-AlphabeticParamsOrder
Volgordeparameters alfabetisch op naam in de sectie PARAMETERS. Er zijn vijf uitzonderingen: -Confirm, -WhatIf, -IncludeTotalCount, -Skipen -First parameters zijn de laatste. Deze parameters zijn gebruikelijk en hebben daarom goed gedefinieerd gedrag.
Parametereigenschappen
| Type: | SwitchParameter |
| Default value: | None |
| Ondersteunt jokertekens: | False |
| DontShow: | False |
Parametersets
(All)
| Position: | Named |
| Verplicht: | False |
| Waarde uit pijplijn: | False |
| Waarde uit pijplijn op eigenschapsnaam: | False |
| Waarde van resterende argumenten: | False |
-Encoding
Hiermee geeft u de tekencodering voor uw externe Help-bestand. Geef een System.Text.Encoding--object op. Zie about_Character_Encodingvoor meer informatie.
Parametereigenschappen
| Type: | Encoding |
| Default value: | UTF8 without BOM |
| Ondersteunt jokertekens: | False |
| DontShow: | False |
Parametersets
(All)
| Position: | 1 |
| Verplicht: | False |
| Waarde uit pijplijn: | False |
| Waarde uit pijplijn op eigenschapsnaam: | False |
| Waarde van resterende argumenten: | False |
-ExcludeDontShow
Sluit de parameters uit die zijn gemarkeerd met DontShow in het parameterkenmerk van de Help-inhoud.
Parametereigenschappen
| Type: | SwitchParameter |
| Default value: | None |
| Ondersteunt jokertekens: | False |
| DontShow: | False |
Parametersets
(All)
| Position: | Named |
| Verplicht: | False |
| Waarde uit pijplijn: | False |
| Waarde uit pijplijn op eigenschapsnaam: | False |
| Waarde van resterende argumenten: | False |
-Force
Help-bestanden verwijderen die niet meer bestaan binnen sessies (bijvoorbeeld als de functie is verwijderd)
Parametereigenschappen
| Type: | SwitchParameter |
| Default value: | None |
| Ondersteunt jokertekens: | False |
| DontShow: | False |
Parametersets
(All)
| Position: | Named |
| Verplicht: | False |
| Waarde uit pijplijn: | False |
| Waarde uit pijplijn op eigenschapsnaam: | False |
| Waarde van resterende argumenten: | False |
-LogAppend
Geeft aan dat deze cmdlet informatie toevoegt aan het logboek in plaats daarvan overschrijft.
Parametereigenschappen
| Type: | SwitchParameter |
| Default value: | None |
| Ondersteunt jokertekens: | False |
| DontShow: | False |
Parametersets
(All)
| Position: | Named |
| Verplicht: | False |
| Waarde uit pijplijn: | False |
| Waarde uit pijplijn op eigenschapsnaam: | False |
| Waarde van resterende argumenten: | False |
-LogPath
Hiermee geeft u een bestandspad voor logboekgegevens. De cmdlet schrijft de UITGEBREIDE stream naar het logboek. Als u de parameter Uitgebreide opgeeft, schrijft deze cmdlet die informatie ook naar de console.
Parametereigenschappen
| Type: | String |
| Default value: | None |
| Ondersteunt jokertekens: | False |
| DontShow: | False |
Parametersets
(All)
| Position: | 2 |
| Verplicht: | False |
| Waarde uit pijplijn: | False |
| Waarde uit pijplijn op eigenschapsnaam: | False |
| Waarde van resterende argumenten: | False |
-Path
Hiermee geeft u een matrix van paden van Markdown-bestanden en -mappen die moeten worden bijgewerkt.
Parametereigenschappen
| Type: | String[] |
| Default value: | None |
| Ondersteunt jokertekens: | True |
| DontShow: | False |
Parametersets
(All)
| Position: | 0 |
| Verplicht: | True |
| Waarde uit pijplijn: | True |
| Waarde uit pijplijn op eigenschapsnaam: | False |
| Waarde van resterende argumenten: | False |
-Session
Biedt ondersteuning voor externe opdrachten. Geef de sessie door die u hebt gebruikt om de opdrachten te maken met Import-PSSession. Dit is vereist om nauwkeurige parametersmetagegevens van de externe sessie op te halen.
Parametereigenschappen
| Type: | PSSession |
| Default value: | None |
| Ondersteunt jokertekens: | False |
| DontShow: | False |
Parametersets
(All)
| Position: | Named |
| Verplicht: | False |
| Waarde uit pijplijn: | False |
| Waarde uit pijplijn op eigenschapsnaam: | False |
| Waarde van resterende argumenten: | False |
-UpdateInputOutput
Vernieuwt de sectie Invoer en Uitvoer om de huidige status van de cmdlet weer te geven. WAARSCHUWING: met deze parameter worden alle handmatige toevoegingen aan deze secties verwijderd.
Parametereigenschappen
| Type: | SwitchParameter |
| Default value: | None |
| Ondersteunt jokertekens: | False |
| DontShow: | False |
Parametersets
(All)
| Position: | Named |
| Verplicht: | False |
| Waarde uit pijplijn: | False |
| Waarde uit pijplijn op eigenschapsnaam: | False |
| Waarde van resterende argumenten: | False |
-UseFullTypeName
Geeft aan dat het doeldocument een volledige typenaam gebruikt in plaats van een korte naam voor parameters.
Parametereigenschappen
| Type: | SwitchParameter |
| Default value: | None |
| Ondersteunt jokertekens: | False |
| DontShow: | False |
Parametersets
(All)
| Position: | Named |
| Verplicht: | False |
| Waarde uit pijplijn: | False |
| Waarde uit pijplijn op eigenschapsnaam: | False |
| Waarde van resterende argumenten: | False |
CommonParameters
Deze cmdlet ondersteunt de algemene parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction en -WarningVariable. Zie about_CommonParametersvoor meer informatie.
Invoerwaarden
String
U kunt een matrix met paden naar deze cmdlet doorsluisen.
Uitvoerwaarden
FileInfo
Met deze cmdlet wordt een FileInfo[]-object geretourneerd voor bijgewerkte bestanden.
Notities
De module waarvoor u de Help wilt bijwerken, moet eerst worden geïmporteerd vanaf de locatie met de vorige versie van de Help. Als niet aan deze voorwaarde wordt voldaan, wordt de parametervolgorde alfabetisch weergegeven in de bijgewerkte Help, zelfs als de parameter AlphabeticParamsOrder niet is gebruikt.
