Delen via

New-MarkdownAboutHelp

  • Referentie
Module:
platyPS

Hiermee wordt een nieuw Bestand Over onderwerp MD gegenereerd op basis van de sjabloon.

Syntaxis

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

Description

De New-MarkdownAboutHelp cmdlet genereert een Markdown-bestand dat vooraf wordt ingevuld met de standaardelementen van een About-onderwerp. De cmdlet kopieert de sjabloon MD, hernoemt headers en bestandsnaam volgens de parameter AboutName en zet het bestand in de map die is aangewezen door de parameter OutputFolder.

Het about-onderwerp kan worden geconverteerd naar de Txt-indeling. Over onderwerpen moet de txt-indeling hebben of de PowerShell Help-engine kan het document niet parseren. Gebruik de cmdlet New-ExternalHelp om About Topic Markdown-bestanden te converteren naar About Topic TXT-bestanden.

Voorbeelden

Voorbeeld 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

Bestandsinformatie maken en weergeven voor PowerShell Over onderwerp Markdown-bestand.

Voorbeeld 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

PowerShell About Topic Txt-bestand maken op basis van een bestaand Markdown About-bestand.

Parameters

-AboutName

De naam van het onderwerp.

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

-OutputFolder

De map waarin het over onderwerp moet worden gemaakt.

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

Invoerwaarden

None

Uitvoerwaarden

Object

Deze cmdlet retourneert een object voor gemaakte bestanden.

Notities

De informatie over onderwerpen moet worden toegevoegd aan een CAB-bestand om gebruik te kunnen maken van help-informatie die kan worden bijgewerkt.