New-MarkdownHelp

Referentie

Module:: platyPS

Hiermee maakt u hulp in markdown-indeling.

Syntaxis

New-MarkdownHelp
   -Module <String[]>
   [-Session <PSSession>]
   [-Force]
   [-AlphabeticParamsOrder]
   [-Metadata <Hashtable>]
   -OutputFolder <String>
   [-NoMetadata]
   [-UseFullTypeName]
   [-Encoding <Encoding>]
   [-WithModulePage]
   [-ModulePagePath <String>]
   [-Locale <String>]
   [-HelpVersion <String>]
   [-FwLink <String>]
   [-ExcludeDontShow]
   [<CommonParameters>]

New-MarkdownHelp
   -Command <String[]>
   [-Session <PSSession>]
   [-Force]
   [-AlphabeticParamsOrder]
   [-Metadata <Hashtable>]
   [-OnlineVersionUrl <String>]
   -OutputFolder <String>
   [-NoMetadata]
   [-UseFullTypeName]
   [-Encoding <Encoding>]
   [-ExcludeDontShow]
   [<CommonParameters>]

New-MarkdownHelp
   -MamlFile <String[]>
   [-ConvertNotesToList]
   [-ConvertDoubleDashLists]
   [-Force]
   [-AlphabeticParamsOrder]
   [-Metadata <Hashtable>]
   -OutputFolder <String>
   [-NoMetadata]
   [-UseFullTypeName]
   [-Encoding <Encoding>]
   [-WithModulePage]
   [-ModulePagePath <String>]
   [-Locale <String>]
   [-HelpVersion <String>]
   [-FwLink <String>]
   [-ModuleName <String>]
   [-ModuleGuid <String>]
   [-ExcludeDontShow]
   [<CommonParameters>]

Description

Met de cmdlet New-MarkdownHelp maakt u hulp in markdown-indeling op basis van een module, een opdracht of een bestand in DE MAML-indeling (Microsoft Assistance Markup Language).

Voorbeelden

Voorbeeld 1: Help maken op basis van een opdracht

PS C:\> function Command03 {param([string]$Value)}
PS C:\> New-MarkdownHelp -Command "Command03" -OutputFolder ".\docs"


    Directory: D:\Working\docs


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        5/22/2016   6:53 PM            664 Command03.md

Met de eerste opdracht maakt u een functie met de naam Command03 met behulp van de standaard windows PowerShell-syntaxis.

Met de tweede opdracht maakt u help voor die stub-functie in de map .\docs.

Voorbeeld 2: Help maken op basis van een module

PS C:\> Import-Module -Module "PlatyPS"
PS C:\> New-MarkdownHelp -Module "PlatyPS" -OutputFolder ".\docs" -Force


    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 de eerste opdracht wordt de PlatyPS--module in de huidige sessie geladen met behulp van de Import-Module-cmdlet.

Met de tweede opdracht maakt u help voor alle cmdlets in de PlatyPS-module. Deze worden opgeslagen in de map .\docs. Met deze opdracht geeft u de parameter Force. Daarom worden bestaande Help Markdown-bestanden met dezelfde naam overschreven.

Voorbeeld 3: Help maken van een bestaand MAML-bestand

PS C:\> New-MarkdownHelp -OutputFolder "D:\PSReadLine\docs" -MamlFile 'C:\Program Files\WindowsPowerShell\Modules\PSReadLine\1.1\en-US\Microsoft.PowerShell.PSReadLine.dll-help.xml'

    Directory: D:\PSReadLine\docs


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        5/22/2016   6:56 PM           7443 Get-PSReadLineKeyHandler.md
-a----        5/22/2016   6:56 PM           3586 Get-PSReadLineOption.md
-a----        5/22/2016   6:56 PM           1549 Remove-PSReadLineKeyHandler.md
-a----        5/22/2016   6:56 PM           5947 Set-PSReadLineKeyHandler.md
-a----        5/22/2016   6:56 PM          15320 Set-PSReadLineOption.md

Met deze opdracht maakt u help in markdown-indeling voor het opgegeven HELP MAML-bestand. U hoeft de module niet te laden, zoals in het vorige voorbeeld. Als de module al is geladen, maakt deze opdracht help op basis van het MAML-bestand, niet op de momenteel geïnstalleerde module.

Voorbeeld 4: Help maken van een bestaand MAML-bestand voor gebruik in een CAB-bestand

PS C:\> New-MarkdownHelp -OutputFolder "D:\PSReadLine\docs" -MamlFile 'C:\Program Files\WindowsPowerShell\Modules\PSReadLine\1.1\en-US\Microsoft.PowerShell.PSReadLine.dll-help.xml' -WithModulePage  -Force -ModuleName "PSReadLine"


    Directory: D:\PSReadLine\docs


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        5/22/2016   6:59 PM           7443 Get-PSReadLineKeyHandler.md
-a----        5/22/2016   6:59 PM           3586 Get-PSReadLineOption.md
-a----        5/22/2016   6:59 PM           1549 Remove-PSReadLineKeyHandler.md
-a----        5/22/2016   6:59 PM           5947 Set-PSReadLineKeyHandler.md
-a----        5/22/2016   6:59 PM          15320 Set-PSReadLineOption.md
-a----        5/22/2016   6:59 PM            942 PSReadLine.md

Met deze opdracht maakt u help in markdown-indeling voor het opgegeven HELP MAML-bestand, zoals in het vorige voorbeeld. Met deze opdracht geeft u ook de parameter WithModulePage en de parameter ModuleName. Met de opdracht maakt u een bestand met de naam PSReadLine.md dat koppelingen bevat naar de andere Markdown-bestanden in deze module en metagegevens die kunnen worden gebruikt om .cab bestanden te maken.

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.

Type:	SwitchParameter
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-Command

Hiermee geeft u de naam van een opdracht in uw huidige sessie. Dit kan elke opdracht zijn die wordt ondersteund door PowerShell Help, zoals een cmdlet of een functie.

Type:	String[]
Position:	Named
Default value:	None
Vereist:	True
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-ConvertDoubleDashLists

Geeft aan dat deze cmdlet opsommingstekens met dubbele afbreekstreepjes converteert naar opsommingstekens met één afbreekstreepje. Lijsten met dubbele afbreekstreepjes zijn gebruikelijk in windows PowerShell-documentatie. Markdown accepteert enkele afbreekstreepjes voor lijsten.

Type:	SwitchParameter
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-ConvertNotesToList

Hiermee wordt aangegeven dat met deze cmdlet meerdere alinea-items in de sectie NOTES als één lijstitem worden opgemaakt.

Type:	SwitchParameter
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	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.

Type:	Encoding
Position:	Named
Default value:	UTF8 without BOM
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-ExcludeDontShow

Sluit de parameters uit die zijn gemarkeerd met DontShow in het parameterkenmerk van de Help-inhoud.

Type:	SwitchParameter
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-Force

Geeft aan dat met deze cmdlet bestaande bestanden met dezelfde namen worden overschreven.

Type:	SwitchParameter
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-FwLink

Hiermee geeft u de doorstuurkoppeling voor de modulepagina op. Deze waarde is vereist voor het maken van .cab bestand. Deze waarde wordt gebruikt als markdown-headermetagegevens op de modulepagina.

Type:	String
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-HelpVersion

Hiermee geeft u de versie van uw help. Deze waarde is vereist voor het maken van .cab bestand. Deze waarde wordt gebruikt als markdown-headermetagegevens op de modulepagina.

Type:	String
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-Locale

Hiermee geeft u de landinstelling van uw help. Deze waarde is vereist voor het maken van .cab bestand. Deze waarde wordt gebruikt als markdown-headermetagegevens op de modulepagina.

Type:	String
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-MamlFile

Hiermee geeft u een matrix van padenpaden van MAML .xml Help-bestanden.

Type:	String[]
Position:	Named
Default value:	None
Vereist:	True
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-Metadata

Hiermee geeft u metagegevens op die deze cmdlet in de Help Markdown-bestanden bevat als een hash-tabel met sleutel-waardeparen met tekenreeks-naar-sting. Deze cmdlet schrijft de metagegevens in de koptekst van elk Markdown Help-bestand.

De cmdlet New-ExternalHelp gebruikt deze metagegevens niet. Externe hulpprogramma's kunnen deze metagegevens gebruiken.

Type:	Hashtable
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-Module

Hiermee geeft u een matrix van namen van modules waarvoor deze cmdlet help maakt in markdown-indeling.

Type:	String[]
Position:	Named
Default value:	None
Vereist:	True
Pijplijninvoer accepteren:	True
Jokertekens accepteren:	False

-ModuleGuid

Hiermee geeft u de GUID van de module van uw Help. Deze waarde is vereist voor het maken van .cab bestand. Deze waarde wordt gebruikt als markdown-headermetagegevens op de modulepagina.

Type:	String
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-ModuleName

Hiermee geeft u de naam van de module van uw Help. Deze waarde is vereist voor het maken van .cab bestand. Deze waarde wordt gebruikt als markdown-headermetagegevens op de modulepagina.

Type:	String
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-ModulePagePath

Wanneer parameter WithModule standaard wordt gebruikt, wordt het MD-bestand op dezelfde locatie als alle andere documenten opgeslagen. Met deze parameter kunt u een nieuwe naam/locatie opgeven die betere plaatsingsopties biedt.

Type:	String
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-NoMetadata

Geeft aan dat deze cmdlet geen metagegevens schrijft in de gegenereerde Markdown.

Type:	SwitchParameter
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-OnlineVersionUrl

Hiermee geeft u het adres op waar de help-functie die kan worden bijgewerkt, wordt gedownload. Als u geen waarde opgeeft, gebruikt de cmdlet een lege tekenreeks.

Type:	String
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-OutputFolder

Hiermee geeft u het pad op van de map waarin deze cmdlet de Markdown Help-bestanden maakt.

Type:	String
Position:	Named
Default value:	None
Vereist:	True
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	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.

Type:	PSSession
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-UseFullTypeName

Geeft aan dat het doeldocument een volledige typenaam gebruikt in plaats van een korte naam voor parameters.

Type:	SwitchParameter
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-WithModulePage

Geeft aan dat deze cmdlet een modulepagina maakt in de uitvoermap. Dit bestand heeft de naam die de parameter ModuleName opgeeft. Als u die parameter niet hebt opgegeven, levert de cmdlet de standaardnaam MamlModule. U kunt deze instelling overschrijven met behulp van ModulePagePath- waarmee u een ander pad voor de modulepagina kunt definiëren

Type:	SwitchParameter
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

Invoerwaarden

String[]

U kunt modulenamen doorsluisen naar deze cmdlet. Dit zijn de modules waaruit deze cmdlet Help Markdown maakt.

Uitvoerwaarden

FileInfo[]

Met deze cmdlet wordt een FileInfo[]-object geretourneerd voor gemaakte bestanden.

Delen via