Freigeben über

New-MarkdownAboutHelp

  • Referenz
Modul:
platyPS

Generiert eine neue Infothema-MD-Datei aus der Vorlage.

Syntax

New-MarkdownAboutHelp
   [-OutputFolder] <String>
   [[-AboutName] <String>]
   [<CommonParameters>]

Beschreibung

Das New-MarkdownAboutHelp Cmdlet generiert eine Markdowndatei, die mit den Standardelementen eines Infothemas vorab aufgefüllt ist. Das Cmdlet kopiert die Vorlage MD, benennt Header und Dateinamen gemäß dem AboutName-Parameter um und legt die Datei in dem verzeichnis ab, das durch den OutputFoler-Parameter festgelegt ist.

Das Infothema kann in das Txt-Format konvertiert werden. Themen müssen im TXT-Format vorliegen, andernfalls kann das PowerShell-Hilfemodul das Dokument nicht analysieren. Verwenden Sie das Cmdlet New-ExternalHelp , um Markdowndateien zu About Topic in About Topic TXT-Dateien zu konvertieren.

Beispiele

Beispiel 1

PS C:\> New-MarkdownAboutHelp -OutputFolder C:\Test -AboutName TestAboutTopic
PS C:\> Get-ChildItem C:\Test

    Directory: C:\Test


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        7/13/2016   2:12 PM           1491 about_TestAboutTopic.md

Erstellen und Anzeigen von Dateiinformationen für PowerShell About Topic Markdown File.

Beispiel 2

PS C:\> New-ExternalHelp -Path C:\Test\ -OutputPath C:\Test


    Directory: C:\Test


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        7/13/2016   2:15 PM           1550 about_TestAboutTopic.help.txt

Erstellen Sie eine PowerShell About Topic TXT-Datei aus einer vorhandenen Markdown About-Datei.

Parameter

-AboutName

Der Name des About-Themas.

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

-OutputFolder

Das Verzeichnis, in dem das About-Thema erstellt werden soll.

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

Eingaben

None

Ausgaben

Object

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

Hinweise

Die About-Themen müssen einer CAB-Datei hinzugefügt werden, um aktualisierbare Hilfe nutzen zu können.