Delen via

New-YamlHelp

Module:
platyPS Module

Converteert Markdown-help naar YAML om gemakkelijk te worden gelezen door externe hulpprogramma's

Syntaxis

Default (Standaard) 

New-YamlHelp
    [-Path] <String[]>
    -OutputFolder <String>
    [-Encoding <Encoding>]
    [-Force]
    [<CommonParameters>]

Description

De New-YamlHelp cmdlet werkt op dezelfde manier als de New-ExternalHelp cmdlet, maar in plaats van een MAML-bestand te maken ter ondersteuning van Get-Help, wordt er een set YAML-bestanden gemaakt die door externe hulpprogramma's kunnen worden gelezen om aangepaste rendering van Help-pagina's te bieden.

Voorbeelden

Voorbeeld 1: YAML-bestanden maken

PS C:\> New-YamlHelp -Path .\docs -OutputFolder .\out\yaml

    Directory: D:\Working\PlatyPS\out\yaml


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        6/15/2017  11:13 AM           2337 Get-HelpPreview.yml
-a----        6/15/2017  11:13 AM           3502 Get-MarkdownMetadata.yml
-a----        6/15/2017  11:13 AM           4143 New-ExternalHelp.yml
-a----        6/15/2017  11:13 AM           3082 New-ExternalHelpCab.yml
-a----        6/15/2017  11:13 AM           2581 New-MarkdownAboutHelp.yml
-a----        6/15/2017  11:13 AM          12356 New-MarkdownHelp.yml
-a----        6/15/2017  11:13 AM           1681 New-YamlHelp.yml
-a----        6/15/2017  11:13 AM           5053 Update-MarkdownHelp.yml
-a----        6/15/2017  11:13 AM           4661 Update-MarkdownHelpModule.yml
-a----        6/15/2017  11:13 AM           3350 Update-MarkdownHelpSchema.yml

Hiermee maakt u één YAML-bestand voor elke cmdlet, zodat externe hulpprogramma's de gestructureerde gegevens voor elke cmdlet kunnen lezen.

Voorbeeld 2: YAML-bestanden maken met specifieke codering

PS C:\> New-YamlHelp -Path .\docs -OutputFolder .\out\yaml -Force -Encoding ([System.Text.Encoding]::Unicode)

    Directory: D:\Working\PlatyPS\out\yaml


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        6/15/2017  11:13 AM           2337 Get-HelpPreview.yml
-a----        6/15/2017  11:13 AM           3502 Get-MarkdownMetadata.yml
-a----        6/15/2017  11:13 AM           4143 New-ExternalHelp.yml
-a----        6/15/2017  11:13 AM           3082 New-ExternalHelpCab.yml
-a----        6/15/2017  11:13 AM           2581 New-MarkdownAboutHelp.yml
-a----        6/15/2017  11:13 AM          12356 New-MarkdownHelp.yml
-a----        6/15/2017  11:13 AM           1681 New-YamlHelp.yml
-a----        6/15/2017  11:13 AM           5053 Update-MarkdownHelp.yml
-a----        6/15/2017  11:13 AM           4661 Update-MarkdownHelpModule.yml
-a----        6/15/2017  11:13 AM           3350 Update-MarkdownHelpSchema.yml

Hiermee worden zowel de bestanden in de opgegeven -Encoding gelezen als geschreven. De parameter Forceren overschrijft bestanden die al bestaan.

Parameters

-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: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

Hiermee wordt aangegeven dat met deze cmdlet een bestaand bestand met dezelfde naam wordt overschreven.

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

-OutputFolder

Hiermee geeft u de map voor het maken van de YAML-bestanden in

Parametereigenschappen

Type:String
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:True
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 of -mappen. Met deze cmdlet maakt u externe help op basis van deze bestanden en mappen.

Parametereigenschappen

Type:

String[]

Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:1
Verplicht:True
Waarde uit pijplijn:True
Waarde uit pijplijn op eigenschapsnaam:True
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

Deze cmdlet retourneert een FileInfo[]-object voor gemaakte bestanden.