Freigeben über

New-ExternalHelp

  • Referenz
Modul:
platyPS

Erstellt eine externe Hilfedatei basierend auf dem von PlatyPS unterstützten Markdown.

Syntax

New-ExternalHelp
   -Path <String[]>
   -OutputPath <String>
   [-ApplicableTag <String[]>]
   [-Encoding <Encoding>]
   [-MaxAboutWidth <Int32>]
   [-ErrorLogFile <String>]
   [-Force]
   [-ShowProgress]
   [<CommonParameters>]

Beschreibung

Das New-ExternalHelp Cmdlet erstellt eine externe Hilfedatei basierend auf Markdown-Hilfedateien, die von PlatyPS unterstützt werden. Sie können dies mit einem Modul versenden, um Mithilfe des Cmdlets Get-Help Hilfe bereitzustellen.

Wenn die von Ihnen angegebenen Markdowndateien nicht dem PlatyPS-Schema entsprechen, gibt dieses Cmdlet Fehlermeldungen zurück.

Beispiele

Beispiel 1: Erstellen einer externen Hilfe basierend auf dem Inhalt eines Ordners

PS C:\> New-ExternalHelp -Path ".\docs" -OutputPath "out\platyPS\en-US"

    Directory: D:\Working\PlatyPS\out\platyPS\en-US


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        5/19/2016  12:32 PM          46776 platyPS-help.xml

Mit diesem Befehl wird eine externe Hilfedatei am angegebenen Speicherort erstellt. Dieser Befehl verwendet die bewährte Methode, dass der Ordnername das Gebietsschema enthält.

Beispiel 2: Erstellen einer Hilfe, die benutzerdefinierte Codierung verwendet

PS C:\> New-ExternalHelp -Path ".\docs" -OutputPath "out\PlatyPS\en-US" -Force -Encoding ([System.Text.Encoding]::Unicode)


    Directory: D:\Working\PlatyPS\out\PlatyPS\en-US


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        5/22/2016   6:34 PM         132942 platyPS-help.xml

Mit diesem Befehl wird eine externe Hilfedatei am angegebenen Speicherort erstellt. Dieser Befehl gibt den Force-Parameter an, daher überschreibt er eine vorhandene Datei. Der Befehl gibt die Unicode-Codierung für die erstellte Datei an.

Beispiel 3: Schreibwarnungen und Fehler in die Datei

PS C:\> New-ExternalHelp -Path ".\docs" -OutputPath "out\platyPS\en-US" -ErrorLogFile ".\WarningsAndErrors.json"

    Directory: D:\Working\PlatyPS\out\platyPS\en-US


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        5/19/2016  12:32 PM          46776 platyPS-help.xml

Mit diesem Befehl wird eine externe Hilfedatei am angegebenen Speicherort erstellt. Dieser Befehl verwendet die bewährte Methode, dass der Ordnername das Gebietsschema enthält. Dieser Befehl schreibt die Warnungen und Fehler in die Datei WarningsAndErrors.json.

Parameter

-ApplicableTag

Geben Sie ein Array von Tags an, die als Filter verwendet werden sollen. Wenn das Cmdlet applicable über die Yaml-Metadaten verfügt und keines der übergebenen Tags dort erwähnt wird, wird das Cmdlet in der generierten Hilfe ignoriert. Gleiches gilt für die Yaml-Metadaten auf Parameterebene applicable . Wenn applicable nicht angegeben wird, ist das Cmdlet oder der Parameter immer vorhanden. Weitere Informationen finden Sie unter Entwurfsproblem .

Type:String[]
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

-ErrorLogFile

Der Pfad, in dem dieses Cmdlet die formatierte Ergebnisprotokolldatei speichert.

Der Pfad muss den Speicherort und den Namen des Ordners und den Dateinamen mit der Json-Erweiterung enthalten. Das JSON-Objekt enthält drei Eigenschaften: Message, FilePath und Severity (Warnung oder Fehler).

Wenn dieser Pfad nicht angegeben wird, wird kein Protokoll generiert.

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

-Force

Gibt an, dass dieses Cmdlet eine vorhandene Datei mit demselben Namen überschreibt.

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

-MaxAboutWidth

Gibt die maximale Zeilenlänge beim Generieren von Hilfetextdateien an. Andere Hilfedateitypen sind von diesem Parameter nicht betroffen. Weitere Informationen finden Sie unter New-MarkdownAboutHelp.

Zeilen in Codeblöcken werden nicht umschlossen und sind nicht vom MaxAboutWidth-Parameter betroffen.

Type:Int32
Position:Named
Default value:80
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-OutputPath

Gibt den Pfad eines Ordners an, in dem dieses Cmdlet Ihre externe Hilfedatei speichert. Der Ordnername sollte mit einem Gebietsschemaordner enden, wie im folgenden Beispiel gezeigt: .\out\PlatyPS\en-US\.

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

-Path

Gibt ein Array von Pfaden von Markdowndateien oder -ordnern an. Dieses Cmdlet erstellt externe Hilfe basierend auf diesen Dateien und Ordnern.

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

-ShowProgress

Zeigen Sie Statusleisten unter Analysieren vorhandener Markdowndateien an.

Wenn dies verwendet wird, ist das Generieren von Hilfe viel langsamer.

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

Eingaben

String[]

Sie können ein Array von Pfaden an dieses Cmdlet weiterleiten.

Ausgaben

FileInfo[]

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