Freigeben über

New-ExternalHelp

  • Referenz
Modul:
platyPS

Erstellt externe Hilfedatei basierend auf markdown unterstützt von PlatyPS.

Syntax

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

Beschreibung

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

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

Beispiele

Beispiel 1: Erstellen externer 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 von 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: Schreiben von Warnungen und Fehlern 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. Mit diesem Befehl werden die Warnungen und Fehler in die WarningsAndErrors.json Datei geschrieben.

Parameter

-ApplicableTag

Geben Sie ein Array von Tags an, die als Filter verwendet werden sollen. Wenn das Cmdlet in den Yaml-Metadaten applicable und keines der übergebenen Tags dort erwähnt wird, wird das Cmdlet in der generierten Hilfe ignoriert. Gleiches gilt für die Parameterebene applicable Yaml-Metadaten. Wenn applicable weggelassen wird, wären Cmdlets oder Parameter immer vorhanden. Weitere Informationen finden Sie unter Designproblem.

Typ:String[]
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Encoding

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

Typ:Encoding
Position:Named
Standardwert:UTF8 without BOM
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-ErrorLogFile

Der Pfad, in dem dieses Cmdlet formatierte Ergebnisprotokolldatei speichert.

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

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

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Force

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

Typ:SwitchParameter
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-MaxAboutWidth

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

Zeilen innerhalb von Codeblöcken werden nicht umbrochen und sind vom MaxAboutWidth-Parameter nicht betroffen.

Typ:Int32
Position:Named
Standardwert:80
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-OutputPath

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

Typ:String
Position:Named
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Path

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

Typ:String[]
Position:Named
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:True

-ShowProgress

Zeigen Sie Statusanzeigen unter der Analyse vorhandener Markdowndateien an.

Wenn dies verwendet wird, ist die Generierung von Hilfe viel langsamer.

Typ:SwitchParameter
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren: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.