New-MarkdownHelp

Referenz

Modul:: platyPS

Erstellt Hilfe im Markdownformat.

Syntax

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

Beschreibung

Das New-MarkdownHelp Cmdlet erstellt Hilfe im Markdownformat basierend auf einem Modul, einem Befehl oder einer Datei im MAML-Format (Microsoft Assistance Markup Language).

Beispiele

Beispiel 1: Erstellen von Hilfe aus einem Befehl

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

Der erste Befehl erstellt eine Funktion namens Command03 mithilfe der Standardsyntax Windows PowerShell.

Der zweite Befehl erstellt Hilfe für diese Stubfunktion im Ordner .\docs.

Beispiel 2: Erstellen von Hilfe aus einem Modul

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

Der erste Befehl lädt das PlatyPS-Modul mithilfe des Cmdlets in die Import-Module aktuelle Sitzung.

Der zweite Befehl erstellt Hilfe für alle Cmdlets im PlatyPS-Modul. Sie werden im .\docs Ordner gespeichert. Dieser Befehl gibt den Force-Parameter an. Daher werden vorhandene Hilfemarkdowndateien mit dem gleichen Namen überschrieben.

Beispiel 3: Erstellen von Hilfe aus einer vorhandenen MAML-Datei

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

Dieser Befehl erstellt Hilfe im Markdownformat für die angegebene HILFE-MAML-Datei. Sie müssen das Modul nicht wie im vorherigen Beispiel laden. Wenn das Modul bereits geladen ist, erstellt dieser Befehl Hilfe basierend auf der MAML-Datei, nicht auf dem aktuell installierten Modul.

Beispiel 4: Erstellen von Hilfe aus einer vorhandenen MAML-Datei zur Verwendung in einer CAB-Datei

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

Dieser Befehl erstellt hilfe im Markdownformat für die angegebene Hilfe-MAML-Datei, wie im vorherigen Beispiel. Dieser Befehl gibt auch den WithModulePage-Parameter und den Parameter ModuleName an. Der Befehl erstellt eine Datei namens PSReadLine.md, die Links zu den anderen Markdowndateien in diesem Modul und Metadaten enthält, die zum Erstellen von .cab Dateien verwendet werden können.

Parameter

-AlphabeticParamsOrder

Ordnen Sie Parameter alphabetisch nach Name im Abschnitt PARAMETERS an. Es gibt fünf Ausnahmen: -ConfirmDie Parameter , -WhatIf, -IncludeTotalCount, -Skipund -First sind die letzten. Diese Parameter sind üblich und weisen daher ein klar definiertes Verhalten auf.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Command

Gibt den Namen eines Befehls in Ihrer aktuellen Sitzung an. Dies kann ein beliebiger Befehl sein, der von der PowerShell-Hilfe unterstützt wird, z. B. ein Cmdlet oder eine Funktion.

Type:	String[]
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ConvertDoubleDashLists

Gibt an, dass dieses Cmdlet Doppelbindestrichlistenaufzählungen in Einzelbindestriche konvertiert. Listen mit doppelten Bindestrichen sind in Windows PowerShell Dokumentation üblich. Markdown akzeptiert einzelne Bindestriche für Listen.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ConvertNotesToList

Gibt an, dass dieses Cmdlet mehrere Absatzelemente im Abschnitt NOTES als einzelne Listenelemente formatiert.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Encoding

Gibt die Zeichencodierung für Ihre externe Hilfedatei an. Geben Sie ein System.Text.Encoding-Objekt an. Weitere Informationen finden Sie unter about_Character_Encoding.

Type:	Encoding
Position:	Named
Default value:	UTF8 without BOM
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ExcludeDontShow

Schließen Sie die mit im Parameter-Attribut gekennzeichneten DontShow Parameter aus dem Hilfeinhalt aus.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Force

Gibt an, dass dieses Cmdlet vorhandene Dateien mit den gleichen Namen überschreibt.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-FwLink

Gibt den Vorwärtslink für die Modulseite an. Dieser Wert ist für die .cab Dateierstellung erforderlich. Dieser Wert wird als Markdownheadermetadaten auf der Modulseite verwendet.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-HelpVersion

Gibt die Version Ihrer Hilfe an. Dieser Wert ist für die .cab Dateierstellung erforderlich. Dieser Wert wird als Markdownheadermetadaten auf der Modulseite verwendet.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Locale

Gibt das Gebietsschema Ihrer Hilfe an. Dieser Wert ist für .cab Dateierstellung erforderlich. Dieser Wert wird als Markdownheadermetadaten auf der Modulseite verwendet.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-MamlFile

Gibt ein Array von Pfadpfaden für MAML-Hilfedateien .xml an.

Type:	String[]
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Metadata

Gibt Metadaten an, die dieses Cmdlet in den Hilfemarkdowndateien als Hashtabelle von Zeichenfolgen-wert-Paaren enthält. Dieses Cmdlet schreibt die Metadaten in den Header jeder Markdown-Hilfedatei.

Diese New-ExternalHelp Metadaten werden vom Cmdlet nicht verwendet. Externe Tools können diese Metadaten verwenden.

Type:	Hashtable
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Module

Gibt ein Array von Namen von Modulen an, für die dieses Cmdlet Hilfe im Markdownformat erstellt.

Type:	String[]
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ModuleGuid

Gibt die GUID des Moduls Ihrer Hilfe an. Dieser Wert ist für die .cab Dateierstellung erforderlich. Dieser Wert wird als Markdownheadermetadaten auf der Modulseite verwendet.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ModuleName

Gibt den Namen des Moduls Ihrer Hilfe an. Dieser Wert ist für die .cab Dateierstellung erforderlich. Dieser Wert wird als Markdownheadermetadaten auf der Modulseite verwendet.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ModulePagePath

Wenn der WithModule-Parameter standardmäßig verwendet wird, wird die MD-Datei an demselben Speicherort wie alle anderen Dokumentationen platziert. Mit diesem Parameter können Sie einen neuen Namen/Standort angeben, um bessere Platzierungsoptionen zu bieten.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-NoMetadata

Gibt an, dass dieses Cmdlet keine Metadaten in das generierte Markdown schreibt.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-OnlineVersionUrl

Gibt die Adresse an, an der die aktualisierbare Hilfefunktion aktualisierte Hilfe herunterlädt. Wenn Sie keinen Wert angeben, verwendet das Cmdlet eine leere Zeichenfolge.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-OutputFolder

Gibt den Pfad des Ordners an, in dem dieses Cmdlet die Markdown-Hilfedateien erstellt.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Session

Bietet Unterstützung für Remotebefehle. Übergeben Sie die Sitzung, die Sie zum Erstellen der Befehle mit Import-PSSessionverwendet haben. Dies ist erforderlich, um genaue Parametermetadaten aus der Remotesitzung abzurufen.

Type:	PSSession
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-UseFullTypeName

Gibt an, dass das Zieldokument einen vollständigen Typnamen anstelle eines kurzen Namens für Parameter verwendet.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WithModulePage

Gibt an, dass dieses Cmdlet eine Modulseite im Ausgabeordner erstellt. Diese Datei hat den Namen, den der Parameter ModuleName angibt. Wenn Sie diesen Parameter nicht angegeben haben, gibt das Cmdlet den Standardnamen an MamlModule. Sie können diese Einstellung mit ModulePagePath überschreiben, sodass Sie einen anderen Pfad für die Modulseite definieren können.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Eingaben

String[]

Sie können Modulnamen an dieses Cmdlet weiterleiten. Dies sind die Module, aus denen dieses Cmdlet Hilfemarkdown erstellt.

Ausgaben

FileInfo[]

Dieses Cmdlet gibt ein FileInfo[]-Objekt für erstellte Dateien zurück.

Freigeben über