Sdílet prostřednictvím

New-MarkdownAboutHelp

  • Reference
Modul:
platyPS

Vygeneruje ze šablony nový soubor MD tématu.

Syntaxe

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

Description

Rutina New-MarkdownAboutHelp vygeneruje soubor Markdownu, který je předem vyplněný standardními prvky tématu. Rutina zkopíruje šablonu MD, přejmenuje hlavičky a název souboru podle parametru AboutName a uloží soubor do adresáře určeného parametrem OutputFolder.

Téma o produktu lze převést do formátu Txt. Informace o tématech musí být ve formátu txt nebo modul nápovědy PowerShellu nebude moct dokument analyzovat. Pomocí rutiny New-ExternalHelp převeďte soubory About Topic markdown na soubory Txt o tématu.

Příklady

Příklad 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

Vytvoření a zobrazení informací o souboru v PowerShellu o souboru Markdown tématu

Příklad 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

Vytvořte soubor PowerShellu o souboru Topic Txt z existujícího souboru Markdown About.

Parametry

-AboutName

Název tématu o produktu.

Typ:String
Position:1
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-OutputFolder

Adresář, ve který se má téma o tématu vytvořit.

Typ:String
Position:0
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

Vstupy

None

Výstupy

Object

Tato rutina vrátí objekt pro vytvořené soubory.

Poznámky

Informace o tématech bude potřeba přidat do souboru CAB, aby bylo možné využít aktualizovatelnou nápovědu.